This endpoint returns the data for all countries and territories registered in our platform (about 250 of them, without pagination).
Each entry contains several fields of information, which are described in the table below:
| Property | Description |
|---|---|
| alpha2 | The ISO 3166-1 alpha-2 code for the country or territory, e.g. "US" or "FR". |
| currency | The ISO 4217 code of the official currency used in the country, e.g. "EUR" or "GBP". |
| name | The common or official name of the country or territory, e.g. "Portugal" or "North Macedonia". |
| phone | The country calling code (international phone number prefix) and an example phone number. |
| status | The status of the country regarding Uphold's regulatory compliance rules. Can be either "ok" or "blocked". |
Example request to get the list of countries and territories:
curl https://api.uphold.com/v0/countriesGET https://api.uphold.com/v0/countries
The above command returns the following JSON (truncated for conciseness):
[
{
"alpha2": "AD",
"currency": "EUR",
"name": "Andorra",
"phone": {
"code": "376",
"example": "312 345"
},
"status": "ok"
},
{
"alpha2": "PT",
"currency": "EUR",
"name": "Portugal",
"phone": {
"code": "351",
"example": "912 345 678"
},
"status": "ok"
},
{
"alpha2": "ZW",
"currency": "ZWL",
"name": "Zimbabwe",
"phone": {
"code": "263",
"example": "071 123 4567"
},
"status": "ok"
}
]Returns an array of country objects as described in the table above.
This endpoint allows fetching the data for a specific country, given its ISO 3166-1 alpha-2 code.
Example request to get the data for a specific country:
curl https://api.uphold.com/v0/countries/USGET https://api.uphold.com/v0/countries/:country
The above command returns the following JSON:
{
"alpha2": "US",
"currency": "USD",
"name": "United States of America",
"phone": {
"code": "1",
"example": "(201) 555-0123"
},
"status": "ok"
}Returns a single country object as described in the table above.
This endpoint returns a list of available payment methods and corresponding supported currencies for a given country or territory.
Example request to get the payment methods available in a given country:
curl https://api.uphold.com/v0/countries/PT/paymentsGET https://api.uphold.com/v0/countries/:country/payments
The above command returns the following JSON:
[
{
"currency": "EUR",
"method": "card"
},
{
"currency": "EUR",
"method": "sepa"
},
{
"currency": "GBP",
"method": "card"
},
{
"currency": "USD",
"method": "card"
}
]Returns an array of payment objects containing two fields:
| Property | Description |
|---|---|
| currency | The ISO 4217 code of the currency supported for this payment method in this country. |
| method | The type of payment method. One of "ach", "card", or "sepa". |
USD and EUR are supported for the card method, the list will contain two entries, one with the USD-card pair, and one with the EUR-card pair.
This endpoint provides a list of the subdivisions of a given country.
Example request to get the subdivisions of a given country:
curl https://api.uphold.com/v0/countries/BA/subdivisionsGET https://api.uphold.com/v0/countries/:country/subdivisions
The above command returns the following JSON:
[
{
"code": "BA-BIH",
"name": "Federacija Bosne i Hercegovine"
},
{
"code": "BA-BRC",
"name": "Brčko distrikt"
},
{
"code": "BA-SRP",
"name": "Republika Srpska"
}
]Returns an array of subdivision objects, containing the official name and the corresponding ISO 3166-2 code. If the country contains no subdivisions, an empty array is returned.