Skip to main content

Class: AdminPaymentsResource

Hierarchy​

  • default

    ↳ AdminPaymentsResource

Methods​

capturePayment​

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

Parameters​

NameType
idstring
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentRes>

Defined in​

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


refundPayment​

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

Parameters​

NameType
idstring
payloadAdminPostPaymentRefundsReq
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminRefundRes>

Defined in​

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


retrieve​

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

Parameters​

NameType
idstring
query?GetPaymentsParams
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentRes>

Defined in​

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

Was this section helpful?