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

Class: PaymentCollectionsResource

Hierarchy

• default

  ↳ PaymentCollectionsResource

Methods

authorize

▸ authorize(id, customHeaders?): ResponsePromise<StorePaymentCollectionRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<StorePaymentCollectionRes>

Defined in

medusa-js/src/resources/payment-collections.ts:28

---

manageSessions

▸ manageSessions(id, payload, customHeaders?): ResponsePromise<StorePaymentCollectionRes>

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionRes>

Defined in

medusa-js/src/resources/payment-collections.ts:36

---

refreshPaymentSession

▸ refreshPaymentSession(id, session_id, payload, customHeaders?): ResponsePromise<StorePaymentCollectionSessionRes>

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionSessionRes>

Defined in

medusa-js/src/resources/payment-collections.ts:45

---

retrieve

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

Parameters

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

Returns

ResponsePromise<StorePaymentCollectionRes>

Defined in

medusa-js/src/resources/payment-collections.ts:13