View Refund Information for Payment

GET

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

GET

/api/refunds/payment/:paymentId

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

200Retrieved

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

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

refundedByobject

reasonenum

updatedAtdatetime

createdAtdatetime

providerstring

methodenum

sourceenum

outstandingobject

reimbursementStatusenum

statusenum

paymentstring or object

merchantstring or object

customerstring or object

totalsobject

_idstring

returnSignaturestring

walletDebitTxHashstring

walletDebitStatusenum

cryptoRefundInfoobject

failureReasonstring

invoicedAtdatetime

reimbursementIdstring

signaturestring