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>>;
    refundProcess?: Array<RefundProcess<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:
defaultPaymentProcess

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

refundProcess​

property
Array<RefundProcess<any>>
default:
defaultRefundProcess

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