Skip to navigation

List Banks for Country

Returns the banks available for bank-account payouts in a given country. A suitable processor is resolved automatically from your active bank-transfer processors, unless you pin a specific one with processorConfigurationId. Use this to populate bank selection UIs and to look up bankCode values for BankAccountRecipient.

Authentication

AuthorizationBearer
OAuth 2.0 access token issued by the CrissCross authorisation server.

Query parameters

countrystringRequired=3 characters

3-letter ISO country code (e.g. NGA).

processorConfigurationIdstringOptionalformat: "uuid"

Optional. Pin a specific processor configuration (UUID) to resolve banks for. If omitted, a suitable processor is chosen automatically from your active bank-transfer processors.

Response

Banks retrieved successfully.
bankslist of objects
Banks available in the requested country for the supplied processor configuration.

Errors

422
Unprocessable Entity Error
500
Internal Server Error