Skip to main content

getAvailablePaymentMethods

Get list of available payment methods.

Import​

import { getAvailablePaymentMethods } from "@evershop/evershop/checkout/services";

Syntax​

getAvailablePaymentMethods(context?: PaymentMethodValidationContext): Promise<PaymentMethodInfo[]>

Parameters​

context — PaymentMethodValidationContext (optional, defaults to {})

Forwarded to every registered factory's validator. Its cartTotal field is the one core reads: when cartTotal is 0 or less, the returned list collapses to the built-in zero_checkout method regardless of what any validator returned. Omitting the argument keeps the legacy behavior.

interface PaymentMethodValidationContext {
  cartTotal?: number;
}

Return Value​

Returns Promise<PaymentMethodInfo[]>:

{
  code: string;
  name: string;
}[]

Errors​

Throws Duplicate payment method code: <code> when two registered methods return the same code, and the Value checkoutPaymentMethods is invalid: false error when a registered factory has no validator.

The result contains only { code, name }. It does not include the capture, void and refund handlers.

Examples​

Basic Usage​

import { getAvailablePaymentMethods } from "@evershop/evershop/checkout/services";

const methods = await getAvailablePaymentMethods();

methods.forEach(method => {
  console.log(`${method.name} (${method.code})`);
});

See Also​