Fetch Countries

Fetch countries

curl --request GET \
  --url https://gateway.useyala.com/api/public/auth/countries \
  --header 'x-api-key: <api-key>'

{
  "statusCode": 200,
  "message": "success",
  "data": [
    {
      "id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
      "name": "Nigeria",
      "code": "NGA",
      "currencyCode": "NGN",
      "score": 0,
      "payoutCurrencies": [
        {
          "code": "USD",
          "name": "Dollars"
        }
      ],
      "tradingStartTime": "00:00:00",
      "tradingEndTime": "23:00:00",
      "timeZone": 1,
      "cpi": 0,
      "gdpPerCapitaInUsd": 0,
      "globalRating": "B-",
      "isProhibited": false,
      "henleyPassportIndex": 45,
      "createdAt": "2024-05-12T16:42:58.176Z",
      "updatedAt": "2025-05-21T15:26:56.000Z",
      "deletedAt": null
    }
  ],
  "meta": {
    "total": 199,
    "page": 1,
    "limit": 10,
    "size": 5
  }
}

GET

auth

countries

Fetch countries

curl --request GET \
  --url https://gateway.useyala.com/api/public/auth/countries \
  --header 'x-api-key: <api-key>'

{
  "statusCode": 200,
  "message": "success",
  "data": [
    {
      "id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
      "name": "Nigeria",
      "code": "NGA",
      "currencyCode": "NGN",
      "score": 0,
      "payoutCurrencies": [
        {
          "code": "USD",
          "name": "Dollars"
        }
      ],
      "tradingStartTime": "00:00:00",
      "tradingEndTime": "23:00:00",
      "timeZone": 1,
      "cpi": 0,
      "gdpPerCapitaInUsd": 0,
      "globalRating": "B-",
      "isProhibited": false,
      "henleyPassportIndex": 45,
      "createdAt": "2024-05-12T16:42:58.176Z",
      "updatedAt": "2025-05-21T15:26:56.000Z",
      "deletedAt": null
    }
  ],
  "meta": {
    "total": 199,
    "page": 1,
    "limit": 10,
    "size": 5
  }
}

Overview

Use this endpoint to discover which countries and currencies are supported for payouts. Filter by currency code to find all countries that support a specific currency.

Query Parameters

Parameter	Type	Required	Description
`limit`	integer	No	Maximum number of results to return (default: 50)
`filter[currencyCode]`	string	No	Filter countries by currency code (e.g., `YER`, `NGN`, `USD`)

Usage Notes

Use this endpoint to build country and currency selection dropdowns in your UI.
The payoutCurrencies array indicates which currencies can be sent to each country.
tradingStartTime and tradingEndTime indicate when payout processing is available for each country.
Check isProhibited to determine if a country is blocked for payouts.

Filter by currency code to show users which destinations accept their selected currency. For example, filter by USD to show all countries where USD payouts are supported.

Authorizations

x-api-key

string

header

required

Query Parameters

limit

integer

default:50

Maximum number of results to return

filter[currencyCode]

string

Filter countries by currency code

Example:

"YER"

Response

A successful response

statusCode

integer

Example:

200

message

string

Example:

"success"

data

object[]

Show child attributes

data.id

string<uuid>

Example:

"0d75ba90-1392-4442-81b6-5fc76c32d19b"

data.name

string

Example:

"Nigeria"

data.code

string

Example:

"NGA"

data.currencyCode

string

Example:

"NGN"

data.score

integer

Example:

0

data.payoutCurrencies

object[] | null

Show child attributes

data.payoutCurrencies.code

string

Example:

"USD"

data.payoutCurrencies.name

string

Example:

"Dollars"

data.tradingStartTime

string | null

Example:

"00:00:00"

data.tradingEndTime

string | null

Example:

"23:00:00"

data.timeZone

integer | null

Example:

1

data.cpi

number

Example:

0

data.gdpPerCapitaInUsd

number

Example:

0

data.globalRating

string

Example:

"B-"

data.isProhibited

boolean

Example:

false

data.henleyPassportIndex

integer

Example:

45

data.createdAt

string<date-time>

Example:

"2024-05-12T16:42:58.176Z"

data.updatedAt

string<date-time>

Example:

"2025-05-21T15:26:56.000Z"

data.deletedAt

string<date-time> | null

Example:

null

Overview

Countries

Payouts

Transactions

Overview

Query Parameters

Usage Notes

Authorizations

Query Parameters

Response

Overview

Countries

Payouts

Transactions

​Overview

​Query Parameters

​Usage Notes

Authorizations

Query Parameters

Response

Overview

Query Parameters

Usage Notes