LogoLogo
  • OKP APIs
  • Getting Started with OKP
  • API Documentation
    • Deposits API
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Deposit Creation Endpoint
          • Notifications
        • Transactional Account Endpoint
          • Understanding the Solution
        • PCI Deposit Creation Endpoint
        • Deposit Status Endpoint
        • Payment Methods Endpoint
        • Currency Exchange Endpoint
        • Crypto Exchange Endpoint
        • Country States Codes Endpoint
        • Refund Creation Endpoint
          • Notifications
        • Refund Status Endpoint
      • Payment Methods
        • 🌎America
          • 🇧🇷Brazil
            • PIX Biometric
      • API Codes
    • Cashouts API
      • Technical and Security Aspects
        • Calculating the Payload-Signature
      • Endpoints
        • Cashout Creation Endpoint
          • Notifications
        • Cashout Status Endpoint
        • Cashout Update Status Endpoint
        • Cashout Cancellation Endpoint
        • Cashout Bank Codes
      • Countries Validations
        • American Countries
          • 🇧🇷Brazil
      • API Codes
    • Subscriptions API
      • Technical and Security Aspects
        • Calculating the Signature
      • Subscription Creation Endpoints
        • OneShot Subscription Creation
        • PCI Subscription Creation Endpoint
        • Notifications
      • Subscription Cancellation Endpoint
      • Subscription Status Endpoint
    • Quickpay
      • Endpoints
        • Deposit creation endpoint
          • Notifications
        • Deposit status endpoint
    • Bank Account Validation
      • Technical and Security Aspects
        • Calculating the Signature
      • Endpoints
        • Bank Account Validation Endpoint
          • Pix Key Validation and Details Endpoint
      • API Codes
    • KYC API
      • Technical and Security Aspects
        • Calculating the Signature
      • KYC Endpoint
      • API Codes
  • Deposits Tools
    • Cards SDK
      • With User Interface
        • 🚀Color Customization
      • Without User Interface
    • Java SDK
    • PHP SDK
  • Knowledge Base
    • Deposits with Cards SDK
      • With User Interface
      • Without User Interface
    • Countries Specifications
  • PLUGINS
    • WooCommerce
      • Installation
      • Configuration
  • Status Page
Powered by GitBook
On this page
  • Cashout Bank List
  • Introduction
  • Bank Codes Request
  • Request Example
  • Request Fields
  • Response Example
  • Response fields
  • Retrieve information for a specific bank
  1. API Documentation
  2. Cashouts API
  3. Endpoints

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 List

GEThttps://api-stg.onekeypayments.com/v1/country/BR/authorized-banks

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

Query Parameters

Name
Type
Description

country*

string

Country ISO code, "BR" is for Brasil

Headers

Name
Type
Description

Authorization*

string

Authorization Header. Format: "Bearer your_read_only_key"

Introduction

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.

Bank Codes Request

Request Example

// URL
GET: https://api-stg.onekeypayments.com/v1/country/BR/authorized-banks

// HEADERS
Authorization: Bearer EKiFOWiHnI 

Request Fields

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.

Response Example

{ 
"bank_code": xxx, 
"ispb_code": xxxxxxxx, 
"bank_name" : "XXXXXX", 
"bank_licensed": true|false 
}
{ 
"bank_code": xxx, 
"ispb_code": xxxxxxxx, 
"bank_name" : "XXXXXX", 
"bank_licensed": true|false 
}

Response fields

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

Retrieve information for a specific bank

GET https://api-stg.onekeypayments.com/v1/country/{iso_code}/authorized-banks/{bank_code|ispb_code}

GET https://api-stg.onekeypayments.com/v1/country/BR/authorized-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

{ 
"bank_code": 33, 
"ispb_code": 90400888, 
"bank_name" : "BANCO SANTANDER BRASIL S.A.", 
"bank_licensed": true 
}
PreviousCashout Cancellation EndpointNextCountries Validations

Last updated 4 months ago

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, . Example:

which is provided here
Country ISO code