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     },
35     "source": "Credits",
36     "method": "Card",
37     "provider": "string",
38     "createdAt": "2024-01-15T09:30:00Z",
39     "updatedAt": "2024-01-15T09:30:00Z",
40     "signature": "string",
41     "reimbursementId": "string",
42     "invoicedAt": "2024-01-15T09:30:00Z",
43     "reason": "userCancellation",
44     "refundedBy": {
45       "editor": "string",
46       "editorType": "Coinflow",
47       "ipAddress": "string"
48     },
49     "failureReason": "string",
50     "cryptoRefundInfo": {
51       "refundAddress": "string",
52       "denominationType": "usd",
53       "refundTransactionHash": "string",
54       "refundTransactionUrl": "string",
55       "amountUSD": "string",
56       "tokenAmount": "string",
57       "paymentCurrency": "string"
58     },
59     "walletDebitStatus": "pending",
60     "walletDebitTxHash": "string",
61     "returnSignature": "string"
62   }
63 ]

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

signaturestring

reimbursementIdstring

invoicedAtdatetime

reasonenum

refundedByobject

failureReasonstring

cryptoRefundInfoobject

walletDebitStatusenum

walletDebitTxHashstring

returnSignaturestring