Add Fiat Account

Add fiatAccount via API

This endpoint is intended for the purpose of adding fiatAccount for users from INR, TRY, AED, MXN, VND, NGN, BRL, PEN, COP, CLP, PHP, IDR, ZAR, USD, ARS, EUR.

Receive fiatAccountId from the API response, then wait for it to appear in the List FiatAccounts API, as background verification may be required for some fiat accounts. Proceed with transaction creation only after the same fiatAccountId is visible in the List FiatAccounts response.

If the name on the fiat account does not match the name provided during the user's KYC verification, the transaction will be declined.

Refer to the Fiat-Type Mapping field mapping for fiatType.

Required Parameters by Fiat Type

Below are the required fields for each fiatType when creating a fiat account.

1 → ["fiatAccount", "ifsc"]

2 → ["fiatAccount"]

3 → ["fiatAccount"]

4 → ["bankName", "beneficiary", "fiatAccount", "firstName"]

5 → ["bankName", "fiatAccount"]

6 → ["bankName", "fiatAccount"]

7 → ["accountType", "bankName", "branchName", "digit", "fiatAccount"]

8 → ["accountType", "address", "bankName", "city", "documentNumber", "documentType", "fiatAccount", "firstName", "phoneNumber"]

9 → ["accountType", "bankName", "documentNumber", "documentType", "fiatAccount", "firstName"]

10 → ["accountType", "bankName", "documentNumber", "documentType", "fiatAccount", "firstName"]

11 → ["bankName", "name", "fiatAccount"]

12 → ["fiatAccount"]

14 → ["bankName", "fiatAccount"]

17 → ["bankName", "branchName", "fiatAccount"]

21 → ["accountOwnerName", "fiatAccount", "routingNumber"]

29 → ["accountType", "address", "bankName", "documentNumber", "documentType", "fiatAccount", "firstName", "lastName"]

Supported Account Types (Required in few fiatType)

Some fiat types require a specific accountType value:

7 → ["savings", "check"]

8 → ["savings", "checking", "master"]

9 → ["savings", "checking"]

10 → ["savings", "checking"]

29 → ["savings", "checking"]

📘 Supported Document Types 📘

The following document types are supported for different fiat types:

8 → dni, passport, ce, ruc

9 → cc, ce, passport, nit, pep

10 → rut

29 → cuit, cuil

Add fiatAccount details.

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

Request Body

Name

Type

Description

customerId*

String

Unique User Id received from /kyc/url

fiatAccount*

String

fiat account number to withdraw off-ramped fiat to

ifsc

String

IFSC code for an Indian fiat account only.

details

JSON Object

Additional details except fiatAccount, ifsc, customerId (varies by fiatType)

{ 
    "status": 0,
    "code": 400,
    "error": "Missing parameter -> customerId, fiatAccount"
}

{
    "status": 0,
    "code": 409,
    "error": "The account has already been registered or has been linked to some other account"
}

{
    "status": 0,
    "code": 400,
    "error": "Missing parameter -> ifsc"
}

{
    "status": 0,
    "code": 400,
    "error": "Invalid IFSC"
}

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

//sample to add fiatAccount in Turkey
var CryptoJS = require('crypto-js');
var axios = require('axios');
async function addFiatAccount() {
  try {
    let body = {
      customerId: 'test_1234',
      fiatAccount: 'TR4512374K9876543210123457',
      details: JSON.stringify({
        bankName: "testBank",
        branchName: "test"
      })
    }
    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/addFiatAccount',
      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)
  }
}
addFiatAccount();

{
    "status": 1,
    "code": 200,
    "data": {
        "fiatAccountId": "af9b28d22cbea4a4b6a9b8111764613asd018"
    }
}

status -> 0 is for unsuccessful request, 1 is for a successful one.
bankUrl -> redirect to onramp widget to add fiat accounts.
fiatAccountId -> Unique ID of fiat account to withdraw off-ramped fiat to

PreviousBank List

NextBank Details

Last updated 4 months ago