v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Returns available bank, institution, or mobile money providers. Use isMobileMoney=false for bank/institution providers and isMobileMoney=true for mobile money providers. Use code as institutionCode and displayName as institutionName in Authorize Transfer.

get/v1/global-payout/bank/providers

Query parameters

isMobileMoneyboolean

Set to true to return mobile money providers. Set to false to return bank or institution providers.

countryIsoCodestring
Example:US

ISO 3166-1 alpha-2 destination country code used to return providers for a specific country.

Headers

Authorizationstring required
Example:Bearer <token>

Bearer token for authentication.

accountIdstring required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Response

Providers retrieved successfully.

codestring
descriptionstring
statusboolean

Example response

{
  "code": "00",
  "description": "Success",
  "data": [
    {
      "code": "access_bank",
      "displayName": "Access Bank"
    }
  ]
}