Cashout Bank Codes
Learn how to use the Cashout Bank Codes Endpoint to retrieve the list of bank codes accepted for cashouts in each country
Last updated
Learn how to use the Cashout Bank Codes Endpoint to retrieve the list of bank codes accepted for cashouts in each country
Last updated
GET
https://api-stg.onekeypayments.com/country/{iso_code}/authorized-banks
This API allows you to retrieve the list of banks available in each country
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
This endpoint is used to retrieve a list of all the current available banks in Brazil, In case we add or remove a bank, this endpoint will reflect those updates in real-time and therefore it is a good idea to constantly check this endpoint for the list of banks.
Each bank includes information about our internal bank code, the ISPB code of the bank, name of the bank, and a check to see if the bank is licensed or not.
The endpoint is read-only and so it uses a read-only key. It can be used from the front end without major security concerns.
GET
https://api-stg.onekeypayments.com/country/{iso_code}/authorized-banks/{bank_code|ispb_code}
In case you need to retrieve the information for a specific bank, you can utilize this endpoint with either the bank's ISPB code or our internal bank code, which is provided here. Example:
GET
https://api-stg.onekeypayments.com/country/BR/authorize-banks/33
In this example, we would be utilizing the ISO code BR to indicate Brasil, and the "33" to indicate the internal bank code.
Otherwise, if you would like to use the ISPB code, the endpoint would look like this:
https://api-stg.onekeypayments.com/country/BR/authorize-banks/90400888
Response
country*
string
Country ISO code, "BR" is for Brasil
Authorization*
string
Authorization Header. Format: "Bearer your_read_only_key"
Type
Field
Format
Description
Query Param
country
String (length: 2)
Header
Authorization
String
Bearer Token Authentication. It is a concatenation of the word "Bearer" and your Read Only API Key.
Field
Format
Description
bank_code
Number
Bank code. It is our internal code to identify a bank institution within our system.
ispb_code
Number
"Identificador do Sistema de Pagamentos Brasileiro" - Unique 8 digit code that identifies a banking instituion in Brasil
bank_name
String
Name of the bank
bank_licensed
Boolean
TRUE
or FALSE