Payment
Medusa Payment module
@medusajs/payment
Documentation | Website
Building blocks for digital commerce
Payment Module for Medusa: manages payment collections, payment sessions, payments, captures, refunds, refund reasons, account holders, and payment providers. Use it to process payments for carts, orders, or any resource through pluggable payment providers. It ships with and is registered by default, so Medusa applications don't install it directly.
At a glance
| Package | |
| Type | Commerce Module |
| Module key | () |
| Registered by default | Yes |
| Import from |
Features
- Group payment sessions and payments for a resource in a payment collection.
- Authorize, capture, and refund payments, with refund reasons.
- Store account holders to save customers' payment methods with a provider.
- Handle provider webhook events.
Payment providers
The module delegates payment processing to Payment Module Providers, registered through the option. A system provider () is always registered for manual payments.
Official providers in this repository:
Installation
No installation needed. The module is included in and registered by default.
Usage
Register payment providers in :
Configuration
| Option | Type | Description | Default |
|---|---|---|---|
| Payment Module Providers to register. |