List All Currencies

This method allows you to retrieve a list of all currencies supported by the API.

Method Signature

async listCurrencies(rampableAccessToken?: string): Promise<RampableCurrency[]>

Returns

Promise<RampableCurrency[]> - An array of currency objects with the following properties:

• value: string - The country name in uppercase (e.g., "UNITED STATES")
• currency: string - The currency code (e.g., "USD")
• countryCode: string - The two-letter country code (e.g., "US")
• logo: string - URL to the country's flag image
• name: string - Full name of the currency (e.g., "United States Dollar")
• requireBankName: boolean - Whether bank name is required for transactions
• requireIfsc: boolean - Whether IFSC code is required for transactions
• requireIban: boolean - Whether IBAN is required for transactions
• requireAchOrWire: boolean - Whether ACH or Wire information is required
• requireAccountNumber: boolean - Whether account number is required
• country: string - Full country name
• symbol: string - Currency symbol (e.g., "$")
• id: string - Unique identifier for the currency

Example Usage

const currencies = await sdk.rampableReference.listCurrencies();
console.log(currencies);

Response Example

[
   {
      "_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"
   }
    // ... more currencies
]

Additional Information

For more information, see the Rampable References API Documentation (opens in a new tab).