Payout countries

Returns the countries that have at least one active payer, optionally narrowed by service and currency.

Endpoint

GET/api/v1/pay-out/countries

Authentication: HTTP Basic with your API key and secret. See Authentication.

Query parameters

All parameters are optional.

Parameter	Type	Description
country_iso	string	3-letter country code (ISO 3166-1 alpha-3), for example COL. Returns only that country if it is available.
service_slug	string	Only countries served by this service. Use a slug from Payout services.
currency	string	Only countries with payers in this currency (ISO 4217), for example COP.
name	string	Only countries whose name contains this text.

country_iso_code is accepted as an alias of country_iso. Codes are case-insensitive.

Example

curl "https://sandbox-api.cashela.com/api/v1/pay-out/countries?service_slug=bank-deposit" \
  -u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
  -H "Accept: application/json"

{
  "success": true,
  "data": [
    { "id": 48, "name": "Colombia", "country_iso": "COL", "iso_code": "COL" },
    { "id": 62, "name": "Dominican Republic", "country_iso": "DOM", "iso_code": "DOM" }
  ],
  "message": "Countries retrieved successfully."
}

Countries are sorted by name. The IDs and countries above are illustrative.

Response fields

Field	Type	Description
id	integer	Cashela country ID.
name	string	Country name.
country_iso	string	3-letter country code. Use it in destination.country_iso_code when you create a quotation.
iso_code	string	Same value as country_iso.

Errors

Status	When
422	A filter has an unknown value (for example a country_iso, currency or service_slug that does not exist).