AdminPaymentsResource
This class is used to send requests to Admin Payment API Routes. All its method
are available in the JS Client under the medusa.admin.payments
property.
All methods in this class require authentication.
A payment can be related to an order, swap, return, or more. It can be captured or refunded.
Methods
retrieve
Retrieve a payment's details.
Example
Parameters
id
stringRequiredThe payment's ID.
customHeaders
Record<string, any>RequiredCustom headers to attach to the request.
Default: {}
query
GetPaymentsParamsConfigurations to apply on the retrieved payment.
query
GetPaymentsParamsReturns
ResponsePromise
ResponsePromise<AdminPaymentRes>RequiredResolves to the payment's details.
ResponsePromise
ResponsePromise<AdminPaymentRes>RequiredcapturePayment
Capture a payment.
Example
Parameters
id
stringRequiredThe payment's ID.
customHeaders
Record<string, any>RequiredCustom headers to attach to the request.
Default: {}
Returns
ResponsePromise
ResponsePromise<AdminPaymentRes>RequiredResolves to the payment's details.
ResponsePromise
ResponsePromise<AdminPaymentRes>RequiredrefundPayment
Refund a payment. The payment must be captured first.
Example
import { RefundReason } from "@medusajs/medusa";
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.payments.refundPayment(paymentId, {
amount: 1000,
reason: RefundReason.RETURN,
note: "Do not like it",
})
.then(({ refund }) => {
console.log(refund.amount);
})
Parameters
id
stringRequiredThe payment's ID.
The refund to be created.
customHeaders
Record<string, any>RequiredCustom headers to attach to the request.
Default: {}
Returns
ResponsePromise
ResponsePromise<AdminRefundRes>RequiredResolves to the refund's details.
ResponsePromise
ResponsePromise<AdminRefundRes>RequiredWas this section helpful?