medusa-store/docs/content/references/js-client/classes/AdminPaymentsResource.md

Class: AdminPaymentsResource

Hierarchy

• default

  ↳ AdminPaymentsResource

Methods

capturePayment

▸ capturePayment(id, customHeaders?): ResponsePromise<AdminPaymentRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPaymentRes>

Defined in

medusa-js/src/resources/admin/payments.ts:27

---

refundPayment

▸ refundPayment(id, payload, customHeaders?): ResponsePromise<AdminRefundRes>

Parameters

Name	Type
id	string
payload	AdminPostPaymentRefundsReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminRefundRes>

Defined in

medusa-js/src/resources/admin/payments.ts:35

---

retrieve

▸ retrieve(id, query?, customHeaders?): ResponsePromise<AdminPaymentRes>

Parameters

Name	Type
id	string
query?	GetPaymentsParams
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPaymentRes>

Defined in

medusa-js/src/resources/admin/payments.ts:12