refund

View All Refunds for Payment

Changed on
get/refunds/payment/{paymentId}/all

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/refunds/payment/{paymentId}/all
  • Auth
    API key in header Authorization

Path parameters

paymentIdstring 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

Changes

  • 96ee3929f3baRevision changes
    • info

      added the optional property /// to the response with the status

  • f7dc6dbf5437Revision changes
    • warning

      removed the optional property /// from the response with the status