Skip to content

PaymentModule

Module in @evolve-framework/commercetools

Paying on commercetools: paymentCreate, paymentDetailsSubmit and paymentCancel for a payment the provider's component continues, and Apple Pay merchant validation.

import { PaymentModule } from "@evolve-framework/commercetools";

Serves the Payment part of the GraphQL API: applePayPaymentValidate, paymentCancel, paymentCreate, paymentDetailsSubmit, paymentExpressCheckoutUpdate.

new PaymentModule(options: PaymentModuleOptions)
OptionTypeDescription
clientFactoryClientFactory

The commercetools client its requests to the project go through, built with ClientFactory.create.

customTypesPaymentCustomTypeKeys

Keys of the custom types this project has provisioned for a payment. Required: a missing one is a configuration error, and the framework has no key of its own to fall back on.

payments?PaymentRegistry

The payment providers checkout can use. Required for payment mutations to resolve a provider.

routePrefix?string

Optional path prefix to mount every provider's webhook/redirect routes under (e.g. /payments). Defaults to the app root, preserving the per-provider /<identifier>/… paths.

Extends AbstractModule<CommercetoolsLoaderContext>.

The same module on medusa and sfcc.