Type Alias PaymentPluginOptions<M, P>

Configuration for the payment plugin.

type PaymentPluginOptions<
    M extends readonly PaymentMethod[],
    P extends readonly AnyPaymentProviderInterface[],
> = {
    paymentMethods: M;
    paymentProviders: P;
    providerNameForMethod: Record<M[number], P[number]["name"]>;
}

Type Parameters

M extends readonly PaymentMethod[]
P extends readonly AnyPaymentProviderInterface[]

Index

Properties

paymentMethods paymentProviders providerNameForMethod

Properties

`Readonly`paymentMethods

paymentMethods: M

The payment methods to use (credit card, bank transfer etc.).

`Readonly`paymentProviders

paymentProviders: P

The payment providers to register (Stripe, PayPal etc.).

`Readonly`providerNameForMethod

providerNameForMethod: Record<M[number], P[number]["name"]>

The mapping of which payment provider should be used for what payment method.