Get All Payments

GET

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

GET

/api/merchant/payments

1 curl https://api-sandbox.coinflow.cash/api/merchant/payments \
2      -H "Authorization: <apiKey>"

200Retrieved

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

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

Query parameters

sincestringOptional

UTC epoch milliseconds of the earliest date to include in the results

untilstringOptional

UTC epoch milliseconds of the latest date to include in the results

pagedoubleOptional

Page number to return starting from 1. Must be used with limit param.

limitdoubleOptional

amount of records per page (def. 100). Must be used with page param.

statusstringOptional

searchstringOptional

sortByenumOptional

Allowed values:

sortDirectiondoubleOptional

methodstringOptional

protectionstringOptional

merchantIdstringOptional

amountstringOptional

authCodestringOptional

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