listPaymentMethods - Payment Module Reference

This documentation provides a reference to the listPaymentMethods method. This belongs to the Payment Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves all payment methods based on the context and configuration.

Example#

To retrieve a list of payment methods for a customer:

Code
1const paymentMethods =2  await paymentModuleService.listPaymentMethods({3    provider_id: "pp_stripe_stripe",4    context: {5      customer: {6        id: "cus_123",7        metadata: {8          pp_stripe_stripe_customer_id: "str_1234"9        }10      },11    },12  })

Parameters#

filtersFilterablePaymentMethodProps

The filters to apply on the retrieved payment methods.

configFindConfig<PaymentMethodDTO>Optional

The configurations determining how the payment method is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a payment method.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PaymentMethodDTO[]>

The list of payment methods.