Sign in

v4

latestOpenAPI 3.1.02026-08-08186985685.3 KB
refund

View All Refunds for Payment

get/refunds/payment/{paymentId}/all

Path parameters

paymentIdstring required

Headers

Authorizationstring required

Response

Ok

_idstring required
signaturestring
status'Pending' | 'Invoiced' | 'Settled' | 'Failed' required
reimbursementStatus'Pending' | 'Complete' | 'Failure' | 'Returned' required
reimbursementIdstring
source'Credits' | 'Usdc' | 'Settlement' | 'None' required
method'Card' | 'Ach' | 'Pix' | 'Iban' | 'Wire' | 'Crypto' | 'CashApp' | 'APA' | 'PayPal' | 'Venmo' | 'Interac' required
providerstring required
invoicedAtstring date-time

Legacy invoice linkage used by the original invoice system.

invoiceIdstring

The Accruing invoice this refund's uncollected remainder was billed to.

createdAtstring date-time required
updatedAtstring date-time required
reason'userCancellation' | 'failedFulfillment' | 'buyerFraud' | 'other'
failureReasonstring
walletDebitStatus'pending' | 'success' | 'failed'
walletDebitTxHashstring
returnSignaturestring