94e98190ff
Generated the following references: - `api_key` - `auth` - `cart` - `cart_models` - `core_flows` - `currency` - `customer` - `event` - `file_service` - `fulfillment` - `fulfillment_provider` - `inventory_next` - `js_sdk` - `locking` - `medusa` - `modules` - `modules_sdk` - `notification_service` - `order` - `payment` - `payment_provider` - `pricing` - `product` - `promotion` - `region` - `sales_channel` - `stock_location_next` - `store` - `tax` - `types` - `user` - `utils` - `workflows` Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
63 lines
5.5 KiB
Plaintext
63 lines
5.5 KiB
Plaintext
---
|
||
displayed_sidebar: paymentReference
|
||
slug: /references/payment
|
||
---
|
||
|
||
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](/medusa-workflows-reference).
|
||
|
||
</Note>
|
||
|
||
The main service interface for the Payment Module.
|
||
|
||
## Methods
|
||
|
||
- [authorizePaymentSession](../../IPaymentModuleService/methods/payment.IPaymentModuleService.authorizePaymentSession/page.mdx)
|
||
- [cancelPayment](../../IPaymentModuleService/methods/payment.IPaymentModuleService.cancelPayment/page.mdx)
|
||
- [capturePayment](../../IPaymentModuleService/methods/payment.IPaymentModuleService.capturePayment/page.mdx)
|
||
- [completePaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.completePaymentCollections/page.mdx)
|
||
- [createAccountHolder](../../IPaymentModuleService/methods/payment.IPaymentModuleService.createAccountHolder/page.mdx)
|
||
- [createPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentCollections/page.mdx)
|
||
- [createPaymentMethods](../../IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentMethods/page.mdx)
|
||
- [createPaymentSession](../../IPaymentModuleService/methods/payment.IPaymentModuleService.createPaymentSession/page.mdx)
|
||
- [createRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.createRefundReasons/page.mdx)
|
||
- [deleteAccountHolder](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deleteAccountHolder/page.mdx)
|
||
- [deleteCaptures](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deleteCaptures/page.mdx)
|
||
- [deletePaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deletePaymentCollections/page.mdx)
|
||
- [deletePaymentSession](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deletePaymentSession/page.mdx)
|
||
- [deleteRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deleteRefundReasons/page.mdx)
|
||
- [deleteRefunds](../../IPaymentModuleService/methods/payment.IPaymentModuleService.deleteRefunds/page.mdx)
|
||
- [getWebhookActionAndData](../../IPaymentModuleService/methods/payment.IPaymentModuleService.getWebhookActionAndData/page.mdx)
|
||
- [listAndCountPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentCollections/page.mdx)
|
||
- [listAndCountPaymentMethods](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentMethods/page.mdx)
|
||
- [listAndCountPaymentProviders](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listAndCountPaymentProviders/page.mdx)
|
||
- [listCaptures](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listCaptures/page.mdx)
|
||
- [listPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentCollections/page.mdx)
|
||
- [listPaymentMethods](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentMethods/page.mdx)
|
||
- [listPaymentProviders](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentProviders/page.mdx)
|
||
- [listPayments](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPayments/page.mdx)
|
||
- [listPaymentSessions](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listPaymentSessions/page.mdx)
|
||
- [listRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listRefundReasons/page.mdx)
|
||
- [listRefunds](../../IPaymentModuleService/methods/payment.IPaymentModuleService.listRefunds/page.mdx)
|
||
- [refundPayment](../../IPaymentModuleService/methods/payment.IPaymentModuleService.refundPayment/page.mdx)
|
||
- [restorePaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.restorePaymentCollections/page.mdx)
|
||
- [restoreRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.restoreRefundReasons/page.mdx)
|
||
- [retrievePayment](../../IPaymentModuleService/methods/payment.IPaymentModuleService.retrievePayment/page.mdx)
|
||
- [retrievePaymentCollection](../../IPaymentModuleService/methods/payment.IPaymentModuleService.retrievePaymentCollection/page.mdx)
|
||
- [retrievePaymentSession](../../IPaymentModuleService/methods/payment.IPaymentModuleService.retrievePaymentSession/page.mdx)
|
||
- [softDeletePaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.softDeletePaymentCollections/page.mdx)
|
||
- [softDeleteRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.softDeleteRefundReasons/page.mdx)
|
||
- [updateAccountHolder](../../IPaymentModuleService/methods/payment.IPaymentModuleService.updateAccountHolder/page.mdx)
|
||
- [updatePayment](../../IPaymentModuleService/methods/payment.IPaymentModuleService.updatePayment/page.mdx)
|
||
- [updatePaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.updatePaymentCollections/page.mdx)
|
||
- [updatePaymentSession](../../IPaymentModuleService/methods/payment.IPaymentModuleService.updatePaymentSession/page.mdx)
|
||
- [updateRefundReasons](../../IPaymentModuleService/methods/payment.IPaymentModuleService.updateRefundReasons/page.mdx)
|
||
- [upsertPaymentCollections](../../IPaymentModuleService/methods/payment.IPaymentModuleService.upsertPaymentCollections/page.mdx)
|