Skip to main content

Class: AdminPaymentCollectionsResource

Hierarchy​

  • default

    ↳ AdminPaymentCollectionsResource

Methods​

delete​

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

Parameters​

NameType
idstring
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentCollectionDeleteRes>

Defined in​

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


markAsAuthorized​

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

Parameters​

NameType
idstring
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentCollectionsRes>

Defined in​

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


retrieve​

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

Parameters​

NameType
idstring
query?GetPaymentCollectionsParams
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentCollectionsRes>

Defined in​

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


update​

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

Parameters​

NameType
idstring
payloadAdminUpdatePaymentCollectionsReq
customHeadersRecord<string, any>

Returns​

ResponsePromise<AdminPaymentCollectionsRes>

Defined in​

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

Was this section helpful?