964927b597
* docs improvements and changes * updated module definition * modules + dml changes * fix build * fix vale error * fix lint errors * fixes to stripe docs * fix condition * fix condition * fix module defintion * fix checkout * disable UI action * change oas preview action * flatten provider module options * fix lint errors * add module link docs * pr comments fixes * fix vale error * change node engine version * links -> linkable * add note about database name * small fixes * link fixes * fix response code in api reference * added migrations step
140 lines
3.6 KiB
Plaintext
140 lines
3.6 KiB
Plaintext
import { CodeTabs, CodeTab } from "docs-ui"
|
|
import { Table } from "docs-ui"
|
|
|
|
export const metadata = {
|
|
title: `Payment Module`,
|
|
}
|
|
|
|
# {metadata.title}
|
|
|
|
The Payment Module is the `@medusajs/payment` NPM package that provides payment-related features in your Medusa and Node.js applications.
|
|
|
|
## Features
|
|
|
|
### Add Payment Functionalities to Any Resource
|
|
|
|
The Payment Module provides payment functionalities that allow you to process payment of any resource, such as a cart.
|
|
|
|
All payment processing starts with creating a payment collection.
|
|
|
|
```ts
|
|
const paymentCollection = await paymentModuleService.createPaymentCollections({
|
|
region_id: "reg_123",
|
|
currency_code: "usd",
|
|
amount: 5000,
|
|
})
|
|
```
|
|
|
|
### Authorize, Capture, and Refund Payment
|
|
|
|
The Payment Module provides essential features to receive and handle payments, including authorizing, capturing, and refunding payment.
|
|
|
|
```ts
|
|
await paymentModuleService.capturePayment({
|
|
payment_id: "pay_1",
|
|
})
|
|
```
|
|
|
|
### Integrate Third-Party Payment Providers
|
|
|
|
Use payment providers like Stripe to handle and process payments.
|
|
|
|
```ts
|
|
const payment = await paymentModuleService.createPaymentSession("pay_col_1", {
|
|
provider_id: "stripe",
|
|
amount: 1000,
|
|
currency_code: "usd",
|
|
data: {
|
|
// necessary data for the payment provider
|
|
},
|
|
})
|
|
```
|
|
|
|
### Handle Webhook Events
|
|
|
|
The Payment Module allows you to handle webhook events from third-party providers and process the associated payment.
|
|
|
|
```ts
|
|
await paymentModuleService.processEvent({
|
|
provider: "stripe",
|
|
payload: {
|
|
// webhook payload
|
|
},
|
|
})
|
|
```
|
|
|
|
---
|
|
|
|
## Configure Payment Module
|
|
|
|
Refer to [this documentation](./module-options/page.mdx) for details on the module's options.
|
|
|
|
---
|
|
|
|
## How to Use Payment Module's Service
|
|
|
|
You can use the Payment Module's main service by resolving from the Medusa container the resource `ModuleRegistrationName.PAYMENT` imported from `@medusajs/modules-sdk`.
|
|
|
|
For example:
|
|
|
|
<CodeTabs groupId="resource-type">
|
|
<CodeTab label="API Route" value="api-route">
|
|
|
|
```ts title="src/api/store/custom/route.ts"
|
|
import { MedusaRequest, MedusaResponse } from "@medusajs/medusa"
|
|
import { IPaymentModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
export async function GET(
|
|
req: MedusaRequest,
|
|
res: MedusaResponse
|
|
): Promise<void> {
|
|
const paymentModuleService: IPaymentModuleService = req.scope.resolve(
|
|
ModuleRegistrationName.PAYMENT
|
|
)
|
|
|
|
res.json({
|
|
payment_collections: await paymentModuleService.listPaymentCollections(),
|
|
})
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Subscriber" value="subscribers">
|
|
|
|
```ts title="src/subscribers/custom-handler.ts"
|
|
import { SubscriberArgs } from "@medusajs/medusa"
|
|
import { IPaymentModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
export default async function subscriberHandler({ container }: SubscriberArgs) {
|
|
const paymentModuleService: IPaymentModuleService = container.resolve(
|
|
ModuleRegistrationName.PAYMENT
|
|
)
|
|
|
|
const payment_collections =
|
|
await paymentModuleService.listPaymentCollections()
|
|
}
|
|
```
|
|
|
|
</CodeTab>
|
|
<CodeTab label="Workflow Step" value="workflow-step">
|
|
|
|
```ts title="src/workflows/hello-world/step1.ts"
|
|
import { createStep } from "@medusajs/workflows-sdk"
|
|
import { IPaymentModuleService } from "@medusajs/types"
|
|
import { ModuleRegistrationName } from "@medusajs/utils"
|
|
|
|
const step1 = createStep("step-1", async (_, { container }) => {
|
|
const paymentModuleService: IPaymentModuleService = container.resolve(
|
|
ModuleRegistrationName.PAYMENT
|
|
)
|
|
|
|
const payment_collections =
|
|
await paymentModuleService.listPaymentCollections()
|
|
})
|
|
```
|
|
|
|
</CodeTab>
|
|
</CodeTabs>
|