Get Payment By ID

GET

https://api-sandbox.coinflow.cash/api/merchant/payments/:paymentId

GET

/api/merchant/payments/:paymentId

1 import requests
2 
3 url = "https://api-sandbox.coinflow.cash/api/merchant/payments/paymentId"
4 
5 headers = {"Authorization": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

200Retrieved

1 {
2   "_id": "string",
3   "paymentId": "string",
4   "totals": {
5     "subtotal": {
6       "cents": 1,
7       "currency": "USD"
8     },
9     "creditCardFees": {
10       "cents": 1,
11       "currency": "USD"
12     },
13     "chargebackProtectionFees": {
14       "cents": 1,
15       "currency": "USD"
16     },
17     "gasFees": {
18       "cents": 1,
19       "currency": "USD"
20     },
21     "fxFees": {
22       "cents": 1,
23       "currency": "USD"
24     },
25     "total": {
26       "cents": 1,
27       "currency": "USD"
28     },
29     "networkFees": {
30       "cents": 1,
31       "currency": "USD"
32     },
33     "merchantPaidCreditCardFees": {
34       "cents": 1,
35       "currency": "USD"
36     },
37     "merchantPaidChargebackProtectionFees": {
38       "cents": 1,
39       "currency": "USD"
40     },
41     "merchantPaidGasFees": {
42       "cents": 1,
43       "currency": "USD"
44     },
45     "merchantPaidFxFees": {
46       "cents": 1,
47       "currency": "USD"
48     },
49     "merchantPaidNetworkFees": {
50       "cents": 1,
51       "currency": "USD"
52     }
53   },
54   "customer": "string",
55   "merchant": "string",
56   "chargebackProtectionDecision": "approved",
57   "createdAt": "2024-01-15T09:30:00Z",
58   "error": "string",
59   "signature": "string",
60   "webhookInfo": null,
61   "cardInfo": {
62     "processor": "payarc",
63     "authCode": "string",
64     "status": "AUTHORIZED",
65     "storedTransactionType": "MOBILE",
66     "authorizationPaymentReference": "string",
67     "originalPaymentId": "string",
68     "statementDescriptor": "string",
69     "interchangeKey": "string",
70     "fraudReport": {
71       "requestId": "string",
72       "report": {},
73       "reportedAt": "2024-01-15T09:30:00Z"
74     },
75     "enhancedTxInfo": {
76       "firstName": "string",
77       "lastName": "string",
78       "streetAddress": "string",
79       "city": "string",
80       "state": "string",
81       "zip": "string",
82       "country": "string",
83       "email": "string",
84       "bin": "string",
85       "ip": "string",
86       "userAgent": "string",
87       "expMonth": "string",
88       "expYear": "string",
89       "eci": "string",
90       "avsResponseCode": "A",
91       "cvvResponseCode": "M",
92       "binLocation": {
93         "cardType": "credit",
94         "cardName": "string",
95         "cardSegment": "consumer",
96         "country": "AF",
97         "bankName": "string"
98       },
99       "ipLocation": {
100         "zip": "string",
101         "city": "string",
102         "isp": "string",
103         "region": "string",
104         "country": "string",
105         "lon": "string",
106         "lat": "string",
107         "hosting": true,
108         "mobile": true,
109         "proxy": true
110       },
111       "nsureDecisionInsights": {
112         "predictionInsights": [
113           {
114             "value": 1.1,
115             "description": "string",
116             "id": "string"
117           }
118         ],
119         "decisionComponents": [
120           {
121             "description": "string",
122             "type": "string"
123           }
124         ],
125         "decision": "string"
126       },
127       "orchestrationInfo": {
128         "ruleId": "string",
129         "ruleUsed": "string",
130         "resolvedPath": "string",
131         "graphTraversal": [
132           {
133             "nodeId": "string",
134             "nodeType": "action",
135             "outcome": "string",
136             "operation": "string"
137           }
138         ],
139         "processorList": [
140           "payarc"
141         ],
142         "successfulProcessor": "payarc",
143         "usedFallback": true
144       }
145     },
146     "transaction": "string",
147     "secureTransactionId": "string",
148     "processed3DS": "Required",
149     "cardType": "VISA",
150     "last4": "string",
151     "token": "string",
152     "mobileWallet": "applePay"
153   },
154   "bankTransferInfo": {
155     "refundReview": true,
156     "processor": "mock",
157     "status": "PENDING",
158     "reason": "string",
159     "token": "string",
160     "batchedAt": "2024-01-15T09:30:00Z",
161     "refundTransferId": "string",
162     "transaction": "string"
163   },
164   "pixInfo": {
165     "expiration": "2024-01-15T09:30:00Z",
166     "processor": "brla",
167     "status": "INITIATED",
168     "reason": "string",
169     "processed": "2024-01-15T09:30:00Z",
170     "transaction": "string",
171     "tokenSubtotal": {
172       "address": "string",
173       "amount": 1.1,
174       "decimals": 1.1
175     }
176   },
177   "ibanInfo": {
178     "expiration": "2024-01-15T09:30:00Z",
179     "token": "string",
180     "processor": "merge",
181     "status": "INITIATED",
182     "accountHolder": "string",
183     "reason": "string",
184     "transactionId": "string",
185     "processed": "2024-01-15T09:30:00Z",
186     "tokenSubtotal": {
187       "address": "string",
188       "amount": 1.1,
189       "decimals": 1.1
190     },
191     "transaction": "string"
192   },
193   "wireInfo": {
194     "status": "INITIATED",
195     "processor": "braid",
196     "token": "string",
197     "memo": "string",
198     "expiration": "2024-01-15T09:30:00Z",
199     "transaction": "string",
200     "tokenSubtotal": {
201       "address": "string",
202       "amount": 1.1,
203       "decimals": 1.1
204     },
205     "processed": "2024-01-15T09:30:00Z",
206     "transactionId": "string",
207     "reason": "string"
208   },
209   "cryptoInfo": {
210     "status": "INITIATED",
211     "overpaymentAmount": "string",
212     "actualPaymentAmountUSD": "string",
213     "depositAddress": "string",
214     "refundAddress": "string",
215     "refundTransactionUrl": "string",
216     "refundTransactionHash": "string",
217     "sessionId": "string",
218     "reason": "string",
219     "tokenLogoUrl": "string",
220     "blockchainLogoUrl": "string",
221     "tokenAmount": "string",
222     "token": "string",
223     "originatingTransactionHash": "string",
224     "originatingWallet": "string",
225     "processed": "2024-01-15T09:30:00Z",
226     "transaction": "string",
227     "tokenSubtotal": {
228       "address": "string",
229       "amount": 1.1,
230       "decimals": 1.1
231     }
232   },
233   "instantInfo": {
234     "ip": "string",
235     "userAgent": "string",
236     "token": "string",
237     "expiration": "2024-01-15T09:30:00Z",
238     "processor": "mock",
239     "status": "REGISTERED",
240     "ipLocation": {
241       "zip": "string",
242       "city": "string",
243       "isp": "string",
244       "region": "string",
245       "country": "string",
246       "lon": "string",
247       "lat": "string",
248       "hosting": true,
249       "mobile": true,
250       "proxy": true
251     },
252     "transaction": "string",
253     "tokenSubtotal": {
254       "address": "string",
255       "amount": 1.1,
256       "decimals": 1.1
257     },
258     "reason": "string",
259     "processed": "2024-01-15T09:30:00Z",
260     "url": "string"
261   },
262   "exchangeInfo": {
263     "amount": {
264       "gasFees": {
265         "cents": 1,
266         "currency": "USD"
267       },
268       "chargebackProtectionFees": {
269         "cents": 1,
270         "currency": "USD"
271       },
272       "creditCardFees": {
273         "cents": 1,
274         "currency": "USD"
275       },
276       "subtotal": {
277         "cents": 1,
278         "currency": "USD"
279       }
280     },
281     "rate": 1.1,
282     "base": {
283       "cents": 1,
284       "currency": "USD"
285     }
286   },
287   "subscription": "string",
288   "settlementType": "Credits",
289   "blockchain": "solana",
290   "redemptionCheck": true,
291   "marketplaceInfo": {
292     "marketplaceFee": {
293       "cents": 1,
294       "currency": "USD"
295     },
296     "marketplaceSettlement": {
297       "cents": 1,
298       "currency": "USD"
299     },
300     "sellerSettlement": {
301       "cents": 1,
302       "currency": "USD"
303     },
304     "feePercentage": 1.1,
305     "fixedFee": {
306       "cents": 1,
307       "currency": "USD"
308     }
309   },
310   "destination": "string",
311   "overrideAuditLog": {
312     "reason": "customer_override",
313     "editor": "string",
314     "editorType": "Coinflow",
315     "overriddenAt": "2024-01-15T09:30:00Z",
316     "ipAddress": "string",
317     "nsureOverrideReason": "internalTesting"
318   },
319   "customerUsdcTransferData": {
320     "from": "string",
321     "to": "string",
322     "value": "string",
323     "validAfter": "string",
324     "validBefore": "string",
325     "nonce": "string",
326     "v": 1.1,
327     "r": "string",
328     "s": "string"
329   },
330   "delayedSettlement": {
331     "isDisbursed": true,
332     "days": 1.1,
333     "scheduledDate": "2024-01-15T09:30:00Z",
334     "isScheduled": true,
335     "disbursedAt": "2024-01-15T09:30:00Z"
336   },
337   "refundInfo": {
338     "count": 1.1,
339     "refundedAt": "2024-01-15T09:30:00Z",
340     "amount": {
341       "cents": 1,
342       "currency": "USD"
343     }
344   }
345 }

Authentication

Authorizationstring

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

Authorizationstring

API Key authentication via header

Path parameters

paymentIdstringRequired

ID of the payment to retrieve

Response

_idstring

paymentIdstring

totalsobject

customerstring or object

merchantstring or object

chargebackProtectionDecisionenum

createdAtdatetime

errorstring or null

signaturestring or null

webhookInfoany or null

cardInfoobject or null

bankTransferInfoobject or null

pixInfoobject or null

ibanInfoobject or null

wireInfoobject or null

cryptoInfoobject or null

instantInfoobject or null

exchangeInfoobject or null

subscriptionstring or object or null

settlementTypeenum or null

Allowed values:

blockchainenum or null

redemptionCheckboolean or null

marketplaceInfoobject or null

destinationstring or null

overrideAuditLogobject or null

customerUsdcTransferDataobject or null

Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains

delayedSettlementobject or null

refundInfoobject or null