import { TypeList } from "docs-ui"

IPaymentModuleService Reference

This section of the documentation provides a reference to the IPaymentModuleService interface’s methods. This is the interface developers use to use the functionalities provided by the Payment Module.

<Note>

You should only use the methods in this reference when implementing complex customizations. For common cases, check out available workflows instead.

</Note>

The main service interface for the Payment Module.

Methods

• authorizePaymentSession
• cancelPayment
• capturePayment
• completePaymentCollections
• createAccountHolder
• createPaymentCollections
• createPaymentMethods
• createPaymentSession
• createRefundReasons
• deleteAccountHolder
• deleteCaptures
• deletePaymentCollections
• deletePaymentSession
• deleteRefundReasons
• deleteRefunds
• getWebhookActionAndData
• listAndCountPaymentCollections
• listAndCountPaymentMethods
• listAndCountPaymentProviders
• listCaptures
• listPaymentCollections
• listPaymentMethods
• listPaymentProviders
• listPayments
• listPaymentSessions
• listRefundReasons
• listRefunds
• refundPayment
• restorePaymentCollections
• restoreRefundReasons
• retrievePayment
• retrievePaymentCollection
• retrievePaymentSession
• softDeletePaymentCollections
• softDeleteRefundReasons
• updateAccountHolder
• updatePayment
• updatePaymentCollections
• updatePaymentSession
• updateRefundReasons
• upsertPaymentCollections