Skip to main content
Retrieves available payment methods, optionally filtered by currency and country.
async getPaymentsMethods(
  parameters?: PaymentMethodsFilters
): Promise<PaymentMethod[]>

Parameters

parameters
PaymentMethodsFilters
Optional filters to narrow down payment methods.

Return value

return
Promise<PaymentMethod[]>
Promise that resolves to an array of available payment methods.
interface PaymentMethod {
  id: string;
  name: string;
  type: string;
  currencies: string[];
  countries: string[];
}

Examples

const payviox = new Payviox('your_api_token');

const methods = await payviox.getPaymentsMethods();
console.log('Available payment methods:', methods);

Error handling

try {
  const methods = await payviox.getPaymentsMethods();
  if (methods.length === 0) {
    console.warn('No payment methods available');
  }
} catch (error) {
  console.error('Failed to fetch payment methods:', error);
}