API Reference
Offramps
Get Country Requirement [GET]

Get Country Requirements

https://sandboxapi.bitnob.co/api/v1/payouts/supported-countries-requirement/{country} (opens in a new tab)

Get the beneficiary requirements for all supported countries.

Path Parameters

ParametertypeRequired
countrystring

Country name, country code or dial code are all valid as parameters

Request

Offramps/Get Country Requirements [GET]
curl --location 'https://sandboxapi.bitnob.co/api/v1/payouts/supported-countries-requirement/country' \
--header 'Authorization: Bearer API-KEY'

Responses

🟢 200 - Result example
{
"status": true,
"message": "OffRamp country requirement retrieved successfully",
"data": {
  "code": "KE",
  "name": "Kenya",
  "flag": "🇰🇪",
  "dialCode": "254",
  "destination": {
    "MOBILEMONEY": [
      {
        "name": "type",
        "type": "string",
        "required": true,
        "const": "MOBILEMONEY"
      },
      {
        "name": "network",
        "type": "string",
        "required": true,
        "enum": [
          "MPESA"
        ]
      },
      {
        "name": "accountName",
        "type": "string",
        "required": true
      },
      {
        "name": "accountNumber",
        "type": "string",
        "required": true
      }
    ]
  }
}
}