Skip to main content

PaymentOptions

PaymentOptions​

@vendure/corevendure-config.ts

Defines payment-related options in the VendureConfig.

Signature
interface PaymentOptions {
    paymentMethodHandlers: PaymentMethodHandler[];
    paymentMethodEligibilityCheckers?: PaymentMethodEligibilityChecker[];
    customPaymentProcess?: Array<PaymentProcess<any>>;
    process?: Array<PaymentProcess<any>>;
}

paymentMethodHandlers​

property
PaymentMethodHandler[]

Defines which PaymentMethodHandlers are available when configuring

PaymentMethods ### paymentMethodEligibilityCheckers
property
PaymentMethodEligibilityChecker[]

Defines which PaymentMethodEligibilityCheckers are available when configuring

PaymentMethods ### customPaymentProcess
property
Array<PaymentProcess<any>>

process​

property
v2.0.0
Array<PaymentProcess<any>>
default:
<a href='/reference/typescript-api/payment/default-payment-process#defaultpaymentprocess'>defaultPaymentProcess</a>

Allows the definition of custom states and transition logic for the payment process state machine. Takes an array of objects implementing the PaymentProcess interface.