Files
medusa-store/www/apps/docs/content/references/js-client/classes/AdminPaymentsResource.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

2.4 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

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

packages/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

packages/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

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