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

Class: AdminPaymentCollectionsResource

Hierarchy

• default

  ↳ AdminPaymentCollectionsResource

Methods

delete

▸ delete(id, customHeaders?): ResponsePromise<AdminPaymentCollectionDeleteRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionDeleteRes>

Defined in

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

---

markAsAuthorized

▸ markAsAuthorized(id, customHeaders?): ResponsePromise<AdminPaymentCollectionRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminPaymentCollectionRes>

Defined in

medusa-js/src/resources/admin/payment-collections.ts:44

---

retrieve

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

Parameters

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

Returns

ResponsePromise<AdminPaymentCollectionRes>

Defined in

medusa-js/src/resources/admin/payment-collections.ts:12

---

update

▸ update(id, payload, customHeaders?): ResponsePromise<AdminPaymentCollectionRes>

Parameters

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

Returns

ResponsePromise<AdminPaymentCollectionRes>

Defined in

medusa-js/src/resources/admin/payment-collections.ts:27