Skip to main content

payments — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module idpayments
NamePayments
Version1.0.0
Ships from@endora-commerce/mod-payments
LicenceMIT

Activation​

An operator switches this module on and off on /platform/modules. The choice is the setting payments.enabled, and it defaults to on.

Dependencies​

ModuleBindingWhat it means
authyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
customer_accountsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
delivery_methodsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
ordersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
organizationsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
payment_methodsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
transactional_emailsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module

Permissions​

CodeLabelAlso needs
payments:readView payments—
payments:writeRecord and retry payments—

Command palette​

None.

Settings​

CodeNameType
payments.enabledPayments enabledboolean

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.