Get bank codes

Retrieve Bank List by Country

get

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

Authorizations

AuthorizationstringRequired

Authentication using a Bearer Token (Read-Only API Key). The token should be prefixed with "Bearer ".

Query parameters

countrystring · min: 2 · max: 2Required

Country ISO code (2 letters).

Example: BR

Responses

200

Bank list successfully retrieved.

application/json

codeinteger · int32Required

Bank code. It is the value you must send in the field bank_code of the cashouts and deposits requests.

Example: 1

namestringRequired

Name of the bank.

Example: BANCO DO BRASIL S.A.

401

Invalid credentials error.

application/json

get/banks

GET /v3/banks?country=text HTTP/1.1
Host: api-stg.onekeypayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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": 246,
    "name": "BANCO ABC BRASIL 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"
  }
]