Ubicaciones

Aquí encontrarás las API necesarias para obtener el listado de países, estados/provincias y ciudades disponibles que podrás usar a través de nuestras API.

Producción: https://api.payvalida.com/utilities/locations

Sandbox: https://api-test.payvalida.com/utilities/locations

GET /utilities/locations

Request Body

Name	Type	Description
country	String	Con este campo, obtendrás la lista de estados/provincias de éste.
state	String	Con este campo y el campo country, obtendrás la lista de ciudades del estado/provincia.

200: OK Ejemplos de respuestas OK

Lista de países

Request: {} // Request vacío

Response: { 
    "CODE": "0000",
    "DESC": "OK",
    "DATA": {
        "countries": [
            "Colombia",
            "Argentina",
            "Ecuador",
            "Peru",
            "Guatemala",
            "..."
        ]
    }
}

Lista de estados/provincias

Request: {
    "country": "Colombia"
}

Response: {
    "CODE": "0000",
    "DESC": "OK",
    "DATA": {
        "states": [
            "Amazonas",
            "Antioquia",
            "Arauca",
            "..."
        ]
    }
}

Lista de ciudades

Request: {
    "country": "Colombia",
    "state": "Antioquia"
}

Response: {
    "CODE": "0000",
    "DESC": "OK",
    "DATA": {
        "cities": [
            "Abejorral",
            "Abriaquí",
            "Alejandría",
            "Amagá",
            "Medellín",
            "..."
        ]
    }
}

200: OK Respuesta con error

Request es incorrecto

Request: {
    "country": "InvalidCountry",
    "state": InvalidValue
}

Response: { 
    "CODE": "0001",
    "DESC": "solicitud incorrecta"
}

País/Estado no encontrados

Request: {
    "country": "InvalidCountry",
    "state": "InvalidState"
}

Response: { 
    "CODE": "0002",
    "DESC": "Error de procesamiento"
}