View All Refunds for Payment

GET

https://api-sandbox.coinflow.cash/api/refunds/payment/:paymentId/all

GET

/api/refunds/payment/:paymentId/all

$ curl https://api-sandbox.coinflow.cash/api/refunds/payment/paymentId/all \
>      -H "Authorization: <apiKey>"

200Retrieved

1 [
2   {
3     "_id": "string",
4     "totals": {
5       "subtotal": {
6         "cents": 1,
7         "currency": "USD"
8       },
9       "processorFees": {
10         "cents": 1,
11         "currency": "USD"
12       },
13       "total": {
14         "cents": 1,
15         "currency": "USD"
16       },
17       "rate": 1.1,
18       "resolution": {
19         "cents": 1,
20         "currency": "USD"
21       },
22       "adjustment": {
23         "cents": 1,
24         "currency": "USD"
25       }
26     },
27     "customer": "string",
28     "merchant": "string",
29     "payment": "string",
30     "status": "Pending",
31     "reimbursementStatus": "Pending",
32     "outstanding": {
33       "cents": 1,
34       "currency": "USD"
35     },
36     "source": "Credits",
37     "method": "Card",
38     "provider": "string",
39     "createdAt": "2024-01-15T09:30:00Z",
40     "updatedAt": "2024-01-15T09:30:00Z",
41     "signature": "string",
42     "reimbursementId": "string",
43     "invoicedAt": "2024-01-15T09:30:00Z",
44     "invoiceId": "string",
45     "reason": "userCancellation",
46     "refundedBy": {
47       "editor": "string",
48       "editorType": "Coinflow",
49       "ipAddress": "string"
50     },
51     "failureReason": "string",
52     "cryptoRefundInfo": {
53       "refundAddress": "string",
54       "denominationType": "usd",
55       "refundTransactionHash": "string",
56       "refundTransactionUrl": "string",
57       "amountUSD": "string",
58       "tokenAmount": "string",
59       "paymentCurrency": "string"
60     },
61     "walletDebitStatus": "pending",
62     "walletDebitTxHash": "string",
63     "returnSignature": "string"
64   }
65 ]

Authentication

Authorizationstring

API Key authentication via header

Authorizationstring

The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Path parameters

paymentIdstringRequired

Response

_idstring

totalsobject

customerstring or object

merchantstring or object

paymentstring or object

statusenum

reimbursementStatusenum

outstandingobject

sourceenum

methodenum

providerstring

createdAtdatetime

updatedAtdatetime

signaturestringOptional

reimbursementIdstringOptional

invoicedAtdatetimeOptional

Legacy invoice linkage used by the original invoice system.

invoiceIdstringOptional

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

reasonenumOptional

refundedByobjectOptional

failureReasonstringOptional

cryptoRefundInfoobjectOptional

walletDebitStatusenumOptional

walletDebitTxHashstringOptional

returnSignaturestringOptional