Class: AdminPaymentsResource
Hierarchy
defaultCopy to Clipboard↳
AdminPaymentsResourceCopy to Clipboard
Methods
capturePayment
▸ capturePayment(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPaymentResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPaymentResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/payments.ts:27
refundPayment
▸ refundPayment(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRefundResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
payloadCopy to Clipboard | AdminPostPaymentRefundsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRefundResCopy to Clipboard>
Defined in
medusa-js/src/resources/admin/payments.ts:35
retrieve
▸ retrieve(idCopy to Clipboard, query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPaymentResCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
idCopy to Clipboard | stringCopy to Clipboard |
query?Copy to Clipboard | GetPaymentsParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPaymentResCopy to Clipboard>