Bank List

Get bank list

This API endpoint returns the list of banks based on the provided fiatType.

Use this bank list to display options to the user.
The user should select a bank from the list and provide it as the bankName field when calling the Add Fiat Account API, wherever bankName is required.
The Bank List is only available for the following fiat types:
- Nigeria (countryCode: NGA, fiatType: 6, currency: NGN)
- Brazil (countryCode: BRA, fiatType: 7, currency: BRL)
- Peru (countryCode: PER, fiatType: 8, currency: PEN)
- Colombia (countryCode: COL, fiatType: 9, currency: COP)
- Chile (countryCode: CHL, fiatType: 10, currency: CLP)
- Philippines (countryCode: PHL, fiatType: 11, currency: PHP)
- Indonesia (countryCode: IDN, fiatType: 14, currency: IDR)
- Argentina (countryCode: ARG, fiatType: 29, currency: ARS)

Get Bank List

POST https://api.onramp.money/onramp/api/v2/whiteLabel/bank/bankList

Request Body

Name

Type

Description

fiatType*

Number

The fiat type identifier. Fiat-Type Mapping

//sample to add fiatAccount in Turkey
var CryptoJS = require('crypto-js');
var axios = require('axios');
async function fetchBankList() {
  try {
    let body = {
      fiatType: 21
    }
    let payload = {
      timestamp: new Date().getTime(),
      body
    }
    let apiKey = 'API_KEY', apiSecret = 'API_SECRET';
    payload = Buffer.from(JSON.stringify(payload)).toString('base64');
    let signature = CryptoJS.enc.Hex.stringify(CryptoJS.HmacSHA512(payload, apiSecret));
    let options = {
      url: 'https://api.onramp.money/onramp/api/v2/whiteLabel/bank/bankList',
      method: 'POST',
      headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json;charset=UTF-8',
        'X-ONRAMP-SIGNATURE': signature,
        'X-ONRAMP-APIKEY': apiKey,
        'X-ONRAMP-PAYLOAD': payload
      },
      data: JSON.stringify(body)
    };
    let data = await axios(options)
    console.log(data?.data);
  } catch (error) {
    console.log(error?.response?.data)
  }
}
fetchBankList();

{
    "status": 1,
    "code": 200,
    "data": [
        "allbank (a thrift bank), inc.",
        "asenso",
        "asia united bank",
        "bananapay",
        "bangko mabuhay",
        "bank of china",
        "bank of commerce",
        "banko, a subsidiary of bpi",
        "bdo bank",
        "bdo network bank"
    ]
}

{
    "status": 1,
    "code": 400,
    "error": "No bankList found for fiatType 2"
}

{
    "status": 0,
    "code": 400,
    "error": "Missing Required parameters -> customerId."
}

{
    "status": 0,
    "code": 400,
    "error": "Missing fiatType."
}

{ 
  "status": 0, 
  "code": 500, 
  "error": "Unable to fetch bank details at the moment. Please try again later" 
}

{
    "error": "Missing fiatType."
}

{
    "status": 1,
    "code": 200,
    "data": [
        "allbank (a thrift bank), inc.",
        "asenso",
        "asia united bank",
        "bananapay",
        "bangko mabuhay",
        "bank of china",
        "bank of commerce",
        "banko, a subsidiary of bpi",
        "bdo bank",
        "bdo network bank"
    ]
}

status -> 0 is for unsuccessful request, 1 is for a successful one.
code-> http status code
data -> this will contains the bank list array corresponding to given fiatType

PreviousBank Widget Url

NextAdd Fiat Account

Last updated 1 year ago