Configuration
List Countries
Retrieve the full list of countries supported by VelaFi. Filter by validity status to return only active countries or include all records.
GET
/
v2
/
base
/
countrys
List Countries
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>"
}
]
}Use the GET
/v2/base/countrys endpoint to fetch every country that VelaFi supports across its on-ramp, off-ramp, and global payment services. By default the response includes only active (valid) countries; pass hasFindAll=true to retrieve the complete list including inactive ones. Use the returned ISO 3166-1 codes when constructing subsequent requests that require a country parameter.
Request
GET /v2/base/countrys
Headers
| Header | Value | Required |
|---|---|---|
X-BH-TOKEN | Your token from GET /v2/token/generate | ✓ |
Query Parameters
boolean
When
true, returns all countries including inactive ones. Defaults to false, which returns only valid (active) countries.Response Fields
number
HTTP-style status code.
200 indicates success.string
Human-readable status message, e.g.
"SUCCESS".array
Examples
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'
Response
{
"code": 200,
"msg": "SUCCESS",
"data": [
{
"country": "Mexico",
"abbr": "MX"
},
{
"country": "Argentina",
"abbr": "AR"
},
{
"country": "Brazil",
"abbr": "BR"
}
]
}
The
abbr field returns the ISO 3166-1 alpha-2 code for each country. Use this value in any API request that expects a country abbreviation.Was this page helpful?
⌘I
List Countries
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>"
}
]
}