References
Rampable API provides a collection of useful references for some of the most common things. You can use these references to build your own UI components or to create your own custom integrations. The references are available in the following endpoints:
List all currencies
This endpoint allows you to retrieve a list of all currencies supported by the API.
Request
curl -G "https://sandbox.rampable.co/v1/reference/currencies"
Response
{
"statusCode": 200,
"message": "getCurrencies executed successfully",
"data": [
{
"_id": "64daesdas6acf6644dd1a3c78",
"value": "UNITED STATES",
"currency": "USD",
"countryCode": "US",
"logo": "https://cdn-icons-png.flaticon.com/512/197/197484.png",
"name": "United States Dollar",
"requireBankName": false,
"requireIfsc": false,
"requireIban": false,
"requireAchOrWire": true,
"requireAccountNumber": false,
"country": "United States of America",
"symbol": "$",
"id": "64dae2716acf6ddsx1a3c78"
},
...
]
}
List all crypto
This endpoint allows you to retrieve a list of all countries supported by the API.
Query Params attributes
- Name
useSmartContract- Type
- boolean
- Description
Whether the results are filtered based on tokens that use Rampable smart contract proxy or not. By default, if the params is empty it will response all results
- Name
blockchainType- Type
- string
- Description
Whether the results are filtered based on blockchain type. By default, if the params is empty it will response all results Possible values are
EVM,STELLAR
Request
curl -G "https://sandbox.rampable.co/v1/reference/cryptos"
Response
{
"statusCode": 200,
"message": "getCrypto executed successfully",
"data": [
{
"_id": "64dae87a6acf6644dd1a212d",
"symbol": "usdt",
"id": "usdt-ethereum",
"name": "Tether",
"label": "USDT - Ethereum",
"address": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
"chainId": 1,
"is_native": false,
"logo": "https://raw.githubusercontent.com/Xellar-Protocol/xellar-assets/master/assets/tether/logo.png",
"currencies": [
"IDR",
"INR",
"THB",
"USD",
"EUR",
"SGD"
],
"decimal": 6,
"priceId": "tether"
}
...
]
}
List all banks
This endpoint allows you to retrieve a list of all banks supported by the API.
Query Params attributes
- Name
limit- Type
- integer
- Description
Limit the number of recipients returned.
- Name
sort- Type
- string
- Description
Sort the recipients by a specific field. You can sort by createdAt or updatedAt. By default, recipients are sorted by createdAt. You can also sort in reverse order by adding a hyphen (-) before the field you want to sort by.
- Name
country- Type
- string
- Description
Filter recipients by bank country and currency.
- Name
currency- Type
- string
- Description
Filter recipients by bank country and currency.
Request
curl -G "https://sandbox.rampable.co/v1/reference/banks"
Response
{
"statusCode": 200,
"message": "getBanks executed successfully",
"data": {
"docs": [
{
"_id": "64d71dcfd3452321f26653",
"name": "DOHA BANK",
"paymentCode": "doha_bank",
"country": "INDIA",
"currency": "INR",
"createdAt": "2023-08-12T05:51:11.494Z",
"updatedAt": "2023-08-12T05:51:11.494Z",
"__v": 0,
"id": "64d71dcfd345sdasddaf26653"
},
...
],
"totalDocs": 111,
"offset": 0,
"limit": 10,
"totalPages": 12,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}
}
List all banks for disbursement
This endpoint allows you to retrieve a list of all banks supported by the API that are available for disbursement.
Query Params attributes
- Name
limit- Type
- integer
- Description
Limit the number of recipients returned.
- Name
sort- Type
- string
- Description
Sort the banks by a specific field. You can sort by createdAt or updatedAt. By default, banks are sorted by createdAt. You can also sort in reverse order by adding a hyphen (-) before the field you want to sort by.
- Name
country- Type
- string
- Description
Filter recipients by bank country and currency.
- Name
currency- Type
- string
- Description
Filter recipients by bank country and currency.
Request
curl -G "https://sandbox.rampable.co/v1/reference/banks?disbursmentAvailable=true"
Response
{
"statusCode": 200,
"message": "getBanks executed successfully",
"data": {
"docs": [
{
"_id": "64d71dcfd3452321f26653",
"name": "DOHA BANK",
"paymentCode": "doha_bank",
"country": "INDIA",
"currency": "INR",
"createdAt": "2023-08-12T05:51:11.494Z",
"updatedAt": "2023-08-12T05:51:11.494Z",
"__v": 0,
"id": "64d71dcfd345sdasddaf26653"
},
...
],
"totalDocs": 111,
"offset": 0,
"limit": 10,
"totalPages": 12,
"page": 1,
"pagingCounter": 1,
"hasPrevPage": false,
"hasNextPage": true,
"prevPage": null,
"nextPage": 2
}
}
List all payment methods
This endpoint allows you to retrieve a list of payment methods supported for onramp transaction by the API.
Request
curl -G "https://sandbox.rampable.co/v1/reference/payment-methods"
Response
{
"statusCode": 200,
"message": "getPaymentMethodList executed successfully",
"data": [
{
"name": "Virtual Account Mandiri",
"code": "virtual_account_mandiri",
"group": "virtual_account",
"currency": "IDR",
"image": "https://cdn.rampable.co/mandiri.webp",
"isActive": true,
"flatFeeAmount": 2000,
"percentFeeAmount": 0,
"id": "65ae07a34bbef2a538a672e4"
},
...
]
}
List all payment methods for deposit
This endpoint allows you to retrieve a list of payment methods supported for deposit by the API.
Request
curl -G "https://sandbox.rampable.co/v1/reference/payment-methods?isForDeposit=true"
Response
{
"statusCode": 200,
"message": "getPaymentMethodList executed successfully",
"data": [
{
"name": "Virtual Account Mandiri",
"code": "virtual_account_mandiri",
"group": "virtual_account",
"currency": "IDR",
"image": "https://cdn.rampable.co/mandiri.webp",
"isActive": true,
"flatFeeAmount": 2000,
"percentFeeAmount": 0,
"id": "65ae07a34bbef2a538a672e4"
},
...
]
}