asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat: Refund payment (#6610)

Browse Source 
Essentially the same as #6601 but for refunds
This commit is contained in:
Oli Juhl
2024-03-07 13:34:36 +01:00
committed by GitHub
parent 7dee1a3fd3
commit e5cbe28d54
10 changed files with 246 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
integration-tests/modules/__tests__/payment/payments.spec.ts
View File

@@ -1,4 +1,7 @@
import { capturePaymentWorkflow } from "@medusajs/core-flows"
import {
capturePaymentWorkflow,
refundPaymentWorkflow,
} from "@medusajs/core-flows"
import {
LinkModuleUtils,
ModuleRegistrationName,
@@ -120,7 +123,7 @@ medusaIntegrationTestRunner({
)
})
it("should capture a payment with custom amount", async () => {
it("should partially capture a payment", async () => {
const paymentCollection = await paymentService.createPaymentCollections(
{
region_id: "test-region",
@@ -176,6 +179,109 @@ medusaIntegrationTestRunner({
})
)
})
it("should refund a payment", async () => {
const paymentCollection = await paymentService.createPaymentCollections(
{
region_id: "test-region",
amount: 1000,
currency_code: "usd",
}
)
const paymentSession = await paymentService.createPaymentSession(
paymentCollection.id,
{
provider_id: "pp_system_default",
amount: 1000,
currency_code: "usd",
data: {},
}
)
const payment = await paymentService.authorizePaymentSession(
paymentSession.id,
{}
)
await capturePaymentWorkflow(appContainer).run({
input: {
payment_id: payment.id,
},
throwOnError: false,
})
await refundPaymentWorkflow(appContainer).run({
input: {
payment_id: payment.id,
},
throwOnError: false,
})
const [refund] = await paymentService.listRefunds({
payment_id: payment.id,
})
expect(refund).toEqual(
expect.objectContaining({
id: expect.any(String),
payment: expect.objectContaining({ id: payment.id }),
amount: 1000,
})
)
})
it("should partially refund a payment", async () => {
const paymentCollection = await paymentService.createPaymentCollections(
{
region_id: "test-region",
amount: 1000,
currency_code: "usd",
}
)
const paymentSession = await paymentService.createPaymentSession(
paymentCollection.id,
{
provider_id: "pp_system_default",
amount: 1000,
currency_code: "usd",
data: {},
}
)
const payment = await paymentService.authorizePaymentSession(
paymentSession.id,
{}
)
await capturePaymentWorkflow(appContainer).run({
input: {
payment_id: payment.id,
},
throwOnError: false,
})
await refundPaymentWorkflow(appContainer).run({
input: {
payment_id: payment.id,
amount: 500,
},
throwOnError: false,
})
const [refund] = await paymentService.listRefunds({
payment_id: payment.id,
})
expect(refund).toEqual(
expect.objectContaining({
id: expect.any(String),
payment: expect.objectContaining({ id: payment.id }),
amount: 500,
})
)
})
})
},
})

2
packages/core-flows/src/payment/steps/index.ts
View File

@@ -1 +1,3 @@
export * from "./capture-payment"
export * from "./refund-payment"

23
packages/core-flows/src/payment/steps/refund-payment.ts Normal file
View File

@@ -0,0 +1,23 @@
import { ModuleRegistrationName } from "@medusajs/modules-sdk"
import { IPaymentModuleService } from "@medusajs/types"
import { StepResponse, createStep } from "@medusajs/workflows-sdk"
type StepInput = {
payment_id: string
created_by?: string
amount?: number
}
export const refundPaymentStepId = "refund-payment-step"
export const refundPaymentStep = createStep(
refundPaymentStepId,
async (input: StepInput, { container }) => {
const paymentModule = container.resolve<IPaymentModuleService>(
ModuleRegistrationName.PAYMENT
)
const payment = await paymentModule.refundPayment(input)
return new StepResponse(payment)
}
)

2
packages/core-flows/src/payment/workflows/index.ts
View File

@@ -1 +1,3 @@
export * from "./capture-payment"
export * from "./refund-payment"

17
packages/core-flows/src/payment/workflows/refund-payment.ts Normal file
View File

@@ -0,0 +1,17 @@
import { WorkflowData, createWorkflow } from "@medusajs/workflows-sdk"
import { refundPaymentStep } from "../steps/refund-payment"
export const refundPaymentWorkflowId = "refund-payment-workflow"
export const refundPaymentWorkflow = createWorkflow(
refundPaymentWorkflowId,
(
input: WorkflowData<{
payment_id: string
created_by?: string
amount?: number
}>
) => {
const payment = refundPaymentStep(input)
return payment
}
)

42
packages/medusa/src/api-v2/admin/payments/[id]/refund/route.ts Normal file
View File

@@ -0,0 +1,42 @@
import { refundPaymentWorkflow } from "@medusajs/core-flows"
import { Modules } from "@medusajs/modules-sdk"
import {
ContainerRegistrationKeys,
remoteQueryObjectFromString,
} from "@medusajs/utils"
import {
AuthenticatedMedusaRequest,
MedusaResponse,
} from "../../../../../types/routing"
import { defaultAdminPaymentFields } from "../../query-config"
export const POST = async (
req: AuthenticatedMedusaRequest,
res: MedusaResponse
) => {
const remoteQuery = req.scope.resolve(ContainerRegistrationKeys.REMOTE_QUERY)
const { id } = req.params
const { errors } = await refundPaymentWorkflow(req.scope).run({
input: {
payment_id: id,
created_by: req.auth?.actor_id,
},
throwOnError: false,
})
if (Array.isArray(errors) && errors[0]) {
throw errors[0].error
}
const query = remoteQueryObjectFromString({
entryPoint: Modules.PAYMENT,
variables: { id },
fields: defaultAdminPaymentFields,
})
const [payment] = await remoteQuery(query)
res.status(200).json({ payment })
}

11
packages/medusa/src/api-v2/admin/payments/middlewares.ts
View File

@@ -35,10 +35,9 @@ export const adminPaymentRoutesMiddlewares: MiddlewareRoute[] = [
matcher: "/admin/payments/:id/capture",
middlewares: [],
},
// TODO: Add in follow-up PR
// {
// method: ["POST"],
// matcher: "/admin/payments/:id/refund",
// middlewares: [],
// },
{
method: ["POST"],
matcher: "/admin/payments/:id/refund",
middlewares: [],
},
]

34
packages/payment/integration-tests/__tests__/services/payment-module/index.spec.ts
View File

@@ -642,23 +642,23 @@ moduleIntegrationTestRunner({
)
})
// it("should throw if refund is greater than captured amount", async () => {
// await service.capturePayment({
// amount: 50,
// payment_id: "pay-id-1",
// })
//
// const error = await service
// .refundPayment({
// amount: 100,
// payment_id: "pay-id-1",
// })
// .catch((e) => e)
//
// expect(error.message).toEqual(
// "Refund amount for payment: pay-id-1 cannot be greater than the amount captured on the payment."
// )
// })
it("should throw if refund is greater than captured amount", async () => {
await service.capturePayment({
amount: 50,
payment_id: "pay-id-1",
})
const error = await service
.refundPayment({
amount: 100,
payment_id: "pay-id-1",
})
.catch((e) => e)
expect(error.message).toEqual(
"You cannot refund more than what is captured on the payment."
)
})
})
describe("cancel", () => {

8
packages/payment/src/migrations/Migration20240225134525.ts
View File

@@ -6,7 +6,7 @@ export class Migration20240225134525 extends Migration {
const paymentCollectionExists = await this.execute(
`SELECT * FROM information_schema.tables where table_name = 'payment_collection' and table_schema = 'public';`
)
if (paymentCollectionExists.length) {
this.addSql(`
${generatePostgresAlterColummnIfExistStatement(
@@ -39,6 +39,12 @@ export class Migration20240225134525 extends Migration {
ALTER TABLE IF EXISTS "refund" ADD COLUMN IF NOT EXISTS "raw_amount" JSONB NOT NULL;
ALTER TABLE IF EXISTS "refund" ADD COLUMN IF NOT EXISTS "deleted_at" TIMESTAMPTZ NULL;
ALTER TABLE IF EXISTS "refund" ADD COLUMN IF NOT EXISTS "created_by" TEXT NULL;
${generatePostgresAlterColummnIfExistStatement(
"refund",
["reason"],
"DROP NOT NULL"
)}
CREATE TABLE IF NOT EXISTS "capture" (
"id" TEXT NOT NULL,

34
packages/payment/src/services/payment-module.ts
View File

@@ -450,9 +450,9 @@ export default class PaymentModuleService<
)
}
const capturedAmount = payment.captures.reduce((acc, next) => {
const bn = new BigNumber(next.raw_amount.value)
return acc.plus(bn)
const capturedAmount = payment.captures.reduce((captureAmount, next) => {
const amountAsBigNumber = new BigNumber(next.raw_amount.value)
return captureAmount.plus(amountAsBigNumber)
}, BigNumber(0))
const authorizedAmount = BigNumber(payment.raw_amount.value)
@@ -507,17 +507,29 @@ export default class PaymentModuleService<
): Promise<PaymentDTO> {
const payment = await this.paymentService_.retrieve(
data.payment_id,
{ select: ["id", "data", "provider_id"] },
{
select: ["id", "data", "provider_id", "amount", "raw_amount"],
relations: ["captures.raw_amount"],
},
sharedContext
)
// TODO: revisit when https://github.com/medusajs/medusa/pull/6253 is merged
// if (payment.captured_amount < input.amount) {
// throw new MedusaError(
// MedusaError.Types.INVALID_DATA,
// `Refund amount for payment: ${payment.id} cannot be greater than the amount captured on the payment.`
// )
// }
if (!data.amount) {
data.amount = payment.amount as number
}
const capturedAmount = payment.captures.reduce((captureAmount, next) => {
const amountAsBigNumber = new BigNumber(next.raw_amount.value)
return captureAmount.plus(amountAsBigNumber)
}, BigNumber(0))
const refundAmount = BigNumber(data.amount)
if (capturedAmount.lt(refundAmount)) {
throw new MedusaError(
MedusaError.Types.INVALID_DATA,
`You cannot refund more than what is captured on the payment.`
)
}
const paymentData = await this.paymentProviderService_.refundPayment(
{