Files
medusa-store/www/apps/docs/content/references/js-client/classes/PaymentCollectionsResource.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

5.3 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: PaymentCollectionsResource

Hierarchy

  • default

    PaymentCollectionsResource

Methods

authorizePaymentSession

authorizePaymentSession(id, session_id, customHeaders?): ResponsePromise<StorePaymentCollectionsRes>

Parameters

Name Type
id string
session_id string
customHeaders Record<string, any>

Returns

ResponsePromise<StorePaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:29


authorizePaymentSessionsBatch

authorizePaymentSessionsBatch(id, payload, customHeaders?): ResponsePromise<StorePaymentCollectionsRes>

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:38


managePaymentSession

managePaymentSession(id, payload, customHeaders?): ResponsePromise<StorePaymentCollectionsRes>

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:56


managePaymentSessionsBatch

managePaymentSessionsBatch(id, payload, customHeaders?): ResponsePromise<StorePaymentCollectionsRes>

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:47


refreshPaymentSession

refreshPaymentSession(id, session_id, customHeaders?): ResponsePromise<StorePaymentCollectionsSessionRes>

Parameters

Name Type
id string
session_id string
customHeaders Record<string, any>

Returns

ResponsePromise<StorePaymentCollectionsSessionRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:65


retrieve

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

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionsRes>

Defined in

packages/medusa-js/src/resources/payment-collections.ts:14