getPaymentsMethods()

Retrieves available payment methods, optionally filtered by currency and country.

async getPaymentsMethods(
  parameters?: PaymentMethodsFilters
): Promise<PaymentMethod[]>

Parameters

PaymentMethodsFilters

Optional filters to narrow down payment methods.

Show PaymentMethodsFilters properties

string | string[]

Filter by currency code(s).

currencies: 'USD'
// or
currencies: ['USD', 'EUR', 'GBP']

string | string[]

Filter by country code(s) (ISO 3166-1 alpha-2).

countries: 'FR'
// or
countries: ['FR', 'DE', 'ES']

Return value

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);

const payviox = new Payviox('your_api_token');

const methods = await payviox.getPaymentsMethods({
  currencies: 'USD'
});
console.log('USD payment methods:', methods);

const payviox = new Payviox('your_api_token');

const methods = await payviox.getPaymentsMethods({
  currencies: ['USD', 'EUR'],
  countries: ['FR', 'DE']
});
console.log('Filtered methods:', methods);

const payviox = new Payviox('your_api_token');

const methods = await payviox.getPaymentsMethods({
  currencies: 'USD'
});

const container = document.getElementById('payment-methods');
methods.forEach(method => {
  container.innerHTML += `
    <div class="payment-method">
      <h3>${method.name}</h3>
      <p>Type: ${method.type}</p>
      <p>ID: ${method.id}</p>
    </div>
  `;
});

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);
}

SDK - Getting Started

SDK - Integration

SDK - API Reference

Parameters

Return value

Examples

Error handling

​Parameters

​Return value

​Examples

​Error handling

Parameters

Return value

Examples

Error handling