Configuración
Listar países
Obtén la lista completa de países que admite VelaFi. Filtra por estado de validez para devolver solo los países activos o incluir todos los registros.
GET
/
v2
/
base
/
countrys
Listar países
curl --request GET \
--url https://api-test.velafi.com/v2/base/countrys \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/base/countrys"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/base/countrys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/base/countrys")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"country": "<string>",
"abbr": "<string>"
}
]
}Usa el endpoint GET
/v2/base/countrys para obtener todos los países que VelaFi admite en sus servicios de on-ramp, off-ramp y pagos globales. De forma predeterminada, la respuesta incluye solo los países activos (válidos); envía hasFindAll=true para obtener la lista completa, incluidos los inactivos. Usa los códigos ISO 3166-1 devueltos al construir las solicitudes posteriores que requieran un parámetro country.
Solicitud
GET /v2/base/countrys
Headers
| Header | Valor | Obligatorio |
|---|---|---|
X-BH-TOKEN | Tu token de GET /v2/token/generate | ✓ |
Parámetros de consulta
boolean
Cuando es
true, devuelve todos los países, incluidos los inactivos. El valor predeterminado es false, que devuelve solo los países válidos (activos).Campos de la respuesta
number
Código de estado de tipo HTTP.
200 indica éxito.string
Mensaje de estado legible, por ejemplo
"SUCCESS".array
Ejemplos
curl --request GET \
--url 'https://api.velafi.com/v2/base/countrys' \
--header 'X-BH-TOKEN: YOUR_TOKEN'
curl --request GET \
--url 'https://api.velafi.com/v2/base/countrys?hasFindAll=true' \
--header 'X-BH-TOKEN: YOUR_TOKEN'
Respuesta
{
"code": 200,
"msg": "SUCCESS",
"data": [
{
"country": "Mexico",
"abbr": "MX"
},
{
"country": "Argentina",
"abbr": "AR"
},
{
"country": "Brazil",
"abbr": "BR"
}
]
}
El campo
abbr devuelve el código ISO 3166-1 alfa-2 de cada país. Usa este valor en cualquier solicitud a la API que espere una abreviatura de country.⌘I
Listar países
curl --request GET \
--url https://api-test.velafi.com/v2/base/countrys \
--header 'X-BH-TOKEN: <api-key>'import requests
url = "https://api-test.velafi.com/v2/base/countrys"
headers = {"X-BH-TOKEN": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-BH-TOKEN': '<api-key>'}};
fetch('https://api-test.velafi.com/v2/base/countrys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api-test.velafi.com/v2/base/countrys")
.header("X-BH-TOKEN", "<api-key>")
.asString();{
"code": 123,
"msg": "<string>",
"data": [
{
"country": "<string>",
"abbr": "<string>"
}
]
}