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

Cashout Bank Codes

GET https://api-stg.onekeypayments.com/v3/banks?country={ISO_CODE}

This API allows you to retrieve the list of banks available in each country

Query Parameters

Name	Type	Description
country*	string	Country ISO code

Headers

Name	Type	Description
Authorization*	string	Authorization Header. Format: "Bearer your_read_only_key"

200 Bank list successfully retrieved

[
    {
        "code": 1,
        "name": "BANCO DO BRASIL S.A."
    },
    {
        "code": 3,
        "name": "BANCO DA AMAZONIA S.A."
    },
    {
        "code": 4,
        "name": "BANCO DO NORDESTE DO BRASIL S.A."
    },
    {
        "code": 21,
        "name": "BANESTES S.A. BANCO DO ESTADO DO ESPIRITO SANTO"
    },
    {
        "code": 33,
        "name": "BANCO SANTANDER BRASIL S.A."
    },
    {
        "code": 37,
        "name": "BANCO DO ESTADO DO PARA S.A. - BANPARA"
    },
    {
        "code": 41,
        "name": "BANCO DO ESTADO DO RIO GRANDE DO SUL S.A. - BANRISUL"
    },
    {
        "code": 47,
        "name": "BANCO DO ESTADO DE SERGIPE S.A. - BANESE"
    },
    {
        "code": 70,
        "name": "BANCO DE BRASILIA S.A. - BRB"
    },
    {
        "code": 77,
        "name": "BANCO INTER"
    },
    {
        "code": 104,
        "name": "CAIXA ECONOMICA FEDERAL - CEF"
    },
    {
        "code": 212,
        "name": "BANCO ORIGINAL"
    },
    {
        "code": 218,
        "name": "BANCO BONSUCESSO S.A."
    },
    {
        "code": 237,
        "name": "BANCO BRADESCO S.A."
    },
    {
        "code": 246,
        "name": "BANCO ABC BRASIL S.A."
    },
    {
        "code": 290,
        "name": "PagSeguro Internet S.A"
    },
    {
        "code": 336,
        "name": "BANCO C6 S.A"
    },
    {
        "code": 341,
        "name": "ITAU UNIBANCO S.A."
    },
    {
        "code": 389,
        "name": "BANCO MERCANTIL DO BRASIL S.A."
    },
    {
        "code": 399,
        "name": "HSBC BANK BRASIL S.A. - BANCO MULTIPLO"
    },
    {
        "code": 422,
        "name": "BANCO SAFRA S.A."
    },
    {
        "code": 477,
        "name": "CITIBANK N.A."
    },
    {
        "code": 637,
        "name": "BANCO SOFISA"
    },
    {
        "code": 707,
        "name": "BANCO DAYCOVAL S.A."
    },
    {
        "code": 745,
        "name": "BANCO CITIBANK"
    },
    {
        "code": 746,
        "name": "BANCO MODAL S.A."
    },
    {
        "code": 748,
        "name": "BANCO COOPERATIVO SICREDI S.A."
    },
    {
        "code": 756,
        "name": "BANCO COOPERATIVO DO BRASIL S/A - BANCOOB"
    }
]

401 Invalid credentials error

{
    "code": 100,
    "description": "Invalid credentials",
    "type": "INVALID_CREDENTIALS"
}

Introduction

This endpoint is used to retrieve and display to your customer the list of banks available on their country. In case we add or remove a bank, this endpoint will reflect those updates real-time and therefore it is a good idea to constantly check this endpoint for the list of banks.

Once the user selected their bank by its name, you need to send its code to us in the bank_code field of the requests.

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.

Bank Codes Request

Request Example

// URL
GET: https://api-stg.onekeypayments.com/v3/banks?country=BR

// HEADERS
Authorization: Bearer EKiFOWiHnI 

Request Fields

Type	Field	Format	Description
Query Param	country	String (length: 2)	Country ISO code
Header	Authorization	String	Bearer Token Authentication. It is a concatenation of the word "Bearer" and your Read Only API Key.

Bank Codes Response

Response Example

[
    {
        "code": 1,
        "name": "BANCO DO BRASIL S.A."
    },
    {
        "code": 3,
        "name": "BANCO DA AMAZONIA S.A."
    },
    {
        "code": 4,
        "name": "BANCO DO NORDESTE DO BRASIL S.A."
    },
    {
        "code": 21,
        "name": "BANESTES S.A. BANCO DO ESTADO DO ESPIRITO SANTO"
    },
    {
        "code": 33,
        "name": "BANCO SANTANDER BRASIL S.A."
    },
    {
        "code": 37,
        "name": "BANCO DO ESTADO DO PARA S.A. - BANPARA"
    },
    {
        "code": 41,
        "name": "BANCO DO ESTADO DO RIO GRANDE DO SUL S.A. - BANRISUL"
    },
    {
        "code": 47,
        "name": "BANCO DO ESTADO DE SERGIPE S.A. - BANESE"
    },
    {
        "code": 70,
        "name": "BANCO DE BRASILIA S.A. - BRB"
    },
    {
        "code": 75,
        "name": "BANCO ABN AMRO S.A"
    },
    {
        "code": 77,
        "name": "BANCO INTER"
    },
    {
        "code": 85,
        "name": "Cooperativa Central de Crédito Urbano-CECRED"
    },
    {
        "code": 93,
        "name": "POLOCRED SCMEPP"
    },
    {
        "code": 104,
        "name": "CAIXA ECONOMICA FEDERAL - CEF"
    },
    {
        "code": 121,
        "name": "BANCO AGIPLAN S.A."
    },
    {
        "code": 136,
        "name": "Confederação Nacional das Cooperativas Centrais Unicred"
    },
    {
        "code": 212,
        "name": "BANCO ORIGINAL"
    },
    {
        "code": 218,
        "name": "BANCO BONSUCESSO S.A."
    },
    {
        "code": 237,
        "name": "BANCO BRADESCO S.A."
    },
    {
        "code": 260,
        "name": "NU PAGAMENTOS"
    },
    {
        "code": 290,
        "name": "PagSeguro Internet S.A"
    },
    {
        "code": 318,
        "name": "BANCO BMG S.A"
    },
    {
        "code": 336,
        "name": "BANCO C6 S.A"
    },
    {
        "code": 341,
        "name": "ITAU UNIBANCO S.A."
    },
    {
        "code": 389,
        "name": "BANCO MERCANTIL DO BRASIL S.A."
    },
    {
        "code": 399,
        "name": "HSBC BANK BRASIL S.A. - BANCO MULTIPLO"
    },
    {
        "code": 422,
        "name": "BANCO SAFRA S.A."
    },
    {
        "code": 477,
        "name": "CITIBANK N.A."
    },
    {
        "code": 637,
        "name": "BANCO SOFISA"
    },
    {
        "code": 655,
        "name": "Banco Votorantim S.A."
    },
    {
        "code": 707,
        "name": "BANCO DAYCOVAL S.A."
    },
    {
        "code": 712,
        "name": "BANCO OURINVEST S.A"
    },
    {
        "code": 735,
        "name": "BANCO NEON"
    },
    {
        "code": 745,
        "name": "BANCO CITIBANK"
    },
    {
        "code": 746,
        "name": "BANCO MODAL S.A."
    },
    {
        "code": 748,
        "name": "BANCO COOPERATIVO SICREDI S.A."
    },
    {
        "code": 756,
        "name": "BANCO COOPERATIVO DO BRASIL S/A - BANCOOB"
    }
]

Response fields

Field	Format	Description
code	Number	Bank code. It is the value you must send in the field bank_code of the cashouts and deposits requests
name	String	Name of the bank