List All Payment Methods

This method allows you to retrieve a list of payment methods supported for onramp transactions by the API.

Method Signature

async listPaymentMethods(rampableAccessToken?: string): Promise<RampablePaymentMethod[]>

ℹ️

A rampableAccessToken is required if you want to use rampable operations and not setup HTTP Signature Authentication (Personal Token)

Returns

Promise<RampablePaymentMethod[]> - An array of payment method objects with the following properties:

name: string - Name of the payment method
code: string - Unique identifier code
group: string - Payment method group category
currency: string - Supported currency
image: string - URL to payment method logo
isActive: boolean - Payment method availability status
flatFeeAmount: number - Fixed fee amount
percentFeeAmount: number - Percentage-based fee amount
id: string - Unique identifier

Example Usage

// List all payment methods
const paymentMethods = await sdk.rampableReference.listPaymentMethods();

Response Example

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

Additional Information

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

List All Currencies Personal Token