Get chargeback data

GET

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

GET

/api/merchant/chargebacks/:paymentId

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

200Retrieved

1 {
2   "customer": {
3     "emails": [
4       "string"
5     ],
6     "payments": [
7       {
8         "_id": "string",
9         "paymentId": "string",
10         "totals": {
11           "subtotal": {
12             "cents": 1,
13             "currency": "USD"
14           },
15           "creditCardFees": {
16             "cents": 1,
17             "currency": "USD"
18           },
19           "chargebackProtectionFees": {
20             "cents": 1,
21             "currency": "USD"
22           },
23           "gasFees": {
24             "cents": 1,
25             "currency": "USD"
26           },
27           "fxFees": {
28             "cents": 1,
29             "currency": "USD"
30           },
31           "total": {
32             "cents": 1,
33             "currency": "USD"
34           },
35           "networkFees": {
36             "cents": 1,
37             "currency": "USD"
38           },
39           "merchantPaidCreditCardFees": {
40             "cents": 1,
41             "currency": "USD"
42           },
43           "merchantPaidChargebackProtectionFees": {
44             "cents": 1,
45             "currency": "USD"
46           },
47           "merchantPaidGasFees": {
48             "cents": 1,
49             "currency": "USD"
50           },
51           "merchantPaidFxFees": {
52             "cents": 1,
53             "currency": "USD"
54           },
55           "merchantPaidNetworkFees": {
56             "cents": 1,
57             "currency": "USD"
58           }
59         },
60         "customer": "string",
61         "merchant": "string",
62         "chargebackProtectionDecision": "approved",
63         "createdAt": "2024-01-15T09:30:00Z",
64         "error": "string",
65         "signature": "string",
66         "webhookInfo": null,
67         "cardInfo": {
68           "processor": "payarc",
69           "authCode": "string",
70           "status": "AUTHORIZED",
71           "storedTransactionType": "MOBILE",
72           "authorizationPaymentReference": "string",
73           "originalPaymentId": "string",
74           "statementDescriptor": "string",
75           "interchangeKey": "string",
76           "fraudReport": {
77             "requestId": "string",
78             "report": {},
79             "reportedAt": "2024-01-15T09:30:00Z"
80           },
81           "enhancedTxInfo": {
82             "firstName": "string",
83             "lastName": "string",
84             "streetAddress": "string",
85             "city": "string",
86             "state": "string",
87             "zip": "string",
88             "country": "string",
89             "email": "string",
90             "bin": "string",
91             "ip": "string",
92             "userAgent": "string",
93             "expMonth": "string",
94             "expYear": "string",
95             "eci": "string",
96             "avsResponseCode": "A",
97             "cvvResponseCode": "M",
98             "binLocation": {
99               "cardType": "credit",
100               "cardName": "string",
101               "cardSegment": "consumer",
102               "country": "AF",
103               "bankName": "string"
104             },
105             "ipLocation": {
106               "zip": "string",
107               "city": "string",
108               "isp": "string",
109               "region": "string",
110               "country": "string",
111               "lon": "string",
112               "lat": "string",
113               "hosting": true,
114               "mobile": true,
115               "proxy": true
116             },
117             "nsureDecisionInsights": {
118               "predictionInsights": [
119                 {
120                   "value": 1.1,
121                   "description": "string",
122                   "id": "string"
123                 }
124               ],
125               "decisionComponents": [
126                 {
127                   "description": "string",
128                   "type": "string"
129                 }
130               ],
131               "decision": "string"
132             },
133             "orchestrationInfo": {
134               "ruleId": "string",
135               "ruleUsed": "string",
136               "resolvedPath": "string",
137               "graphTraversal": [
138                 {
139                   "nodeId": "string",
140                   "nodeType": "action",
141                   "outcome": "string",
142                   "operation": "string"
143                 }
144               ],
145               "processorList": [
146                 "payarc"
147               ],
148               "successfulProcessor": "payarc",
149               "usedFallback": true
150             }
151           },
152           "transaction": "string",
153           "secureTransactionId": "string",
154           "processed3DS": "Required",
155           "cardType": "VISA",
156           "last4": "string",
157           "token": "string",
158           "mobileWallet": "applePay"
159         },
160         "bankTransferInfo": {
161           "refundReview": true,
162           "processor": "mock",
163           "status": "PENDING",
164           "reason": "string",
165           "token": "string",
166           "batchedAt": "2024-01-15T09:30:00Z",
167           "refundTransferId": "string",
168           "transaction": "string"
169         },
170         "pixInfo": {
171           "expiration": "2024-01-15T09:30:00Z",
172           "processor": "brla",
173           "status": "INITIATED",
174           "reason": "string",
175           "processed": "2024-01-15T09:30:00Z",
176           "transaction": "string",
177           "tokenSubtotal": {
178             "address": "string",
179             "amount": 1.1,
180             "decimals": 1.1
181           }
182         },
183         "ibanInfo": {
184           "expiration": "2024-01-15T09:30:00Z",
185           "token": "string",
186           "processor": "merge",
187           "status": "INITIATED",
188           "accountHolder": "string",
189           "reason": "string",
190           "transactionId": "string",
191           "processed": "2024-01-15T09:30:00Z",
192           "tokenSubtotal": {
193             "address": "string",
194             "amount": 1.1,
195             "decimals": 1.1
196           },
197           "transaction": "string"
198         },
199         "wireInfo": {
200           "status": "INITIATED",
201           "processor": "braid",
202           "token": "string",
203           "memo": "string",
204           "expiration": "2024-01-15T09:30:00Z",
205           "transaction": "string",
206           "tokenSubtotal": {
207             "address": "string",
208             "amount": 1.1,
209             "decimals": 1.1
210           },
211           "processed": "2024-01-15T09:30:00Z",
212           "transactionId": "string",
213           "reason": "string"
214         },
215         "cryptoInfo": {
216           "status": "INITIATED",
217           "overpaymentAmount": "string",
218           "actualPaymentAmountUSD": "string",
219           "depositAddress": "string",
220           "refundAddress": "string",
221           "refundTransactionUrl": "string",
222           "refundTransactionHash": "string",
223           "sessionId": "string",
224           "reason": "string",
225           "tokenLogoUrl": "string",
226           "blockchainLogoUrl": "string",
227           "tokenAmount": "string",
228           "token": "string",
229           "originatingTransactionHash": "string",
230           "originatingWallet": "string",
231           "processed": "2024-01-15T09:30:00Z",
232           "transaction": "string",
233           "tokenSubtotal": {
234             "address": "string",
235             "amount": 1.1,
236             "decimals": 1.1
237           }
238         },
239         "instantInfo": {
240           "ip": "string",
241           "userAgent": "string",
242           "token": "string",
243           "expiration": "2024-01-15T09:30:00Z",
244           "processor": "mock",
245           "status": "REGISTERED",
246           "ipLocation": {
247             "zip": "string",
248             "city": "string",
249             "isp": "string",
250             "region": "string",
251             "country": "string",
252             "lon": "string",
253             "lat": "string",
254             "hosting": true,
255             "mobile": true,
256             "proxy": true
257           },
258           "transaction": "string",
259           "tokenSubtotal": {
260             "address": "string",
261             "amount": 1.1,
262             "decimals": 1.1
263           },
264           "reason": "string",
265           "processed": "2024-01-15T09:30:00Z",
266           "url": "string"
267         },
268         "exchangeInfo": {
269           "amount": {
270             "gasFees": {
271               "cents": 1,
272               "currency": "USD"
273             },
274             "chargebackProtectionFees": {
275               "cents": 1,
276               "currency": "USD"
277             },
278             "creditCardFees": {
279               "cents": 1,
280               "currency": "USD"
281             },
282             "subtotal": {
283               "cents": 1,
284               "currency": "USD"
285             }
286           },
287           "rate": 1.1,
288           "base": {
289             "cents": 1,
290             "currency": "USD"
291           }
292         },
293         "subscription": "string",
294         "settlementType": "Credits",
295         "blockchain": "solana",
296         "redemptionCheck": true,
297         "marketplaceInfo": {
298           "marketplaceFee": {
299             "cents": 1,
300             "currency": "USD"
301           },
302           "marketplaceSettlement": {
303             "cents": 1,
304             "currency": "USD"
305           },
306           "sellerSettlement": {
307             "cents": 1,
308             "currency": "USD"
309           },
310           "feePercentage": 1.1,
311           "fixedFee": {
312             "cents": 1,
313             "currency": "USD"
314           }
315         },
316         "destination": "string",
317         "overrideAuditLog": {
318           "reason": "customer_override",
319           "editor": "string",
320           "editorType": "Coinflow",
321           "overriddenAt": "2024-01-15T09:30:00Z",
322           "ipAddress": "string",
323           "nsureOverrideReason": "internalTesting"
324         },
325         "customerUsdcTransferData": {
326           "from": "string",
327           "to": "string",
328           "value": "string",
329           "validAfter": "string",
330           "validBefore": "string",
331           "nonce": "string",
332           "v": 1.1,
333           "r": "string",
334           "s": "string"
335         },
336         "delayedSettlement": {
337           "isDisbursed": true,
338           "days": 1.1,
339           "scheduledDate": "2024-01-15T09:30:00Z",
340           "isScheduled": true,
341           "disbursedAt": "2024-01-15T09:30:00Z"
342         },
343         "refundInfo": {
344           "count": 1.1,
345           "refundedAt": "2024-01-15T09:30:00Z",
346           "amount": {
347             "cents": 1,
348             "currency": "USD"
349           }
350         }
351       }
352     ],
353     "payouts": [
354       {
355         "withdrawer": "string",
356         "transferId": "string",
357         "wallet": "string",
358         "blockchain": "solana",
359         "transaction": "string",
360         "accountId": "string",
361         "amount": {
362           "cents": 1,
363           "currency": "USD"
364         },
365         "usdToForeignExchangeRate": 1.1,
366         "userPaidFees": {
367           "swapFees": {
368             "cents": 1,
369             "currency": "USD"
370           },
371           "gasFees": {
372             "cents": 1,
373             "currency": "USD"
374           },
375           "fees": {
376             "cents": 1,
377             "currency": "USD"
378           },
379           "customFees": {
380             "cents": 1,
381             "currency": "USD"
382           }
383         },
384         "merchantPaidFees": {
385           "swapFees": {
386             "cents": 1,
387             "currency": "USD"
388           },
389           "gasFees": {
390             "cents": 1,
391             "currency": "USD"
392           },
393           "fees": {
394             "cents": 1,
395             "currency": "USD"
396           }
397         },
398         "status": "completed",
399         "expectedDeliveryDate": "2024-01-15T09:30:00Z",
400         "merchant": "string",
401         "createdAt": "2024-01-15T09:30:00Z",
402         "updatedAt": "2024-01-15T09:30:00Z",
403         "speed": "asap",
404         "provider": "string",
405         "returnStatus": "pending_return",
406         "returnTransaction": "string",
407         "userId": "string",
408         "detailMessage": "string",
409         "errorData": "string",
410         "pin": "string",
411         "payoutInitiated": true,
412         "idempotencyKey": "string"
413       }
414     ],
415     "purses": [
416       {
417         "pixes": [
418           {
419             "key": "string",
420             "accountHash": "string",
421             "token": "string"
422           }
423         ],
424         "ibans": [
425           null
426         ],
427         "cards": [
428           {
429             "data": {
430               "token": "string",
431               "expMonth": "string",
432               "expYear": "string",
433               "firstName": "string",
434               "lastName": "string",
435               "address1": "string",
436               "city": "string",
437               "country": "string",
438               "state": "string",
439               "zip": "string"
440             }
441           }
442         ],
443         "accounts": [
444           {
445             "plaidLinked": true
446           }
447         ],
448         "keys": [
449           {
450             "referenceId": "string",
451             "merchantId": "string"
452           }
453         ],
454         "_id": "string",
455         "paypal": null,
456         "venmo": null
457       }
458     ],
459     "linkedPurses": [
460       {
461         "pixes": [
462           {
463             "key": "string",
464             "accountHash": "string",
465             "token": "string"
466           }
467         ],
468         "ibans": [
469           null
470         ],
471         "cards": [
472           {
473             "data": {
474               "token": "string",
475               "expMonth": "string",
476               "expYear": "string",
477               "firstName": "string",
478               "lastName": "string",
479               "address1": "string",
480               "city": "string",
481               "country": "string",
482               "state": "string",
483               "zip": "string"
484             }
485           }
486         ],
487         "accounts": [
488           {
489             "plaidLinked": true
490           }
491         ],
492         "keys": [
493           {
494             "referenceId": "string",
495             "merchantId": "string"
496           }
497         ],
498         "_id": "string",
499         "paypal": null,
500         "venmo": null
501       }
502     ],
503     "verifications": [
504       {
505         "reference": "string",
506         "status": "pending",
507         "vendor": "middesk",
508         "name": "string",
509         "attested": true,
510         "shareToken": "string",
511         "shareTokenStatus": "string",
512         "hash": "string"
513       }
514     ],
515     "customerInfo": {
516       "verificationId": "string",
517       "displayName": "string",
518       "address": "string",
519       "city": "string",
520       "state": "string",
521       "zip": "string",
522       "country": "string",
523       "ip": "string",
524       "lat": "string",
525       "lng": "string",
526       "dob": "string",
527       "email": "string",
528       "firstName": "string",
529       "lastName": "string"
530     }
531   },
532   "payment": {
533     "_id": "string",
534     "paymentId": "string",
535     "totals": {
536       "subtotal": {
537         "cents": 1,
538         "currency": "USD"
539       },
540       "creditCardFees": {
541         "cents": 1,
542         "currency": "USD"
543       },
544       "chargebackProtectionFees": {
545         "cents": 1,
546         "currency": "USD"
547       },
548       "gasFees": {
549         "cents": 1,
550         "currency": "USD"
551       },
552       "fxFees": {
553         "cents": 1,
554         "currency": "USD"
555       },
556       "total": {
557         "cents": 1,
558         "currency": "USD"
559       },
560       "networkFees": {
561         "cents": 1,
562         "currency": "USD"
563       },
564       "merchantPaidCreditCardFees": {
565         "cents": 1,
566         "currency": "USD"
567       },
568       "merchantPaidChargebackProtectionFees": {
569         "cents": 1,
570         "currency": "USD"
571       },
572       "merchantPaidGasFees": {
573         "cents": 1,
574         "currency": "USD"
575       },
576       "merchantPaidFxFees": {
577         "cents": 1,
578         "currency": "USD"
579       },
580       "merchantPaidNetworkFees": {
581         "cents": 1,
582         "currency": "USD"
583       }
584     },
585     "customer": "string",
586     "merchant": "string",
587     "chargebackProtectionDecision": "approved",
588     "createdAt": "2024-01-15T09:30:00Z",
589     "error": "string",
590     "signature": "string",
591     "webhookInfo": null,
592     "cardInfo": {
593       "processor": "payarc",
594       "authCode": "string",
595       "status": "AUTHORIZED",
596       "storedTransactionType": "MOBILE",
597       "authorizationPaymentReference": "string",
598       "originalPaymentId": "string",
599       "statementDescriptor": "string",
600       "interchangeKey": "string",
601       "fraudReport": {
602         "requestId": "string",
603         "report": {},
604         "reportedAt": "2024-01-15T09:30:00Z"
605       },
606       "enhancedTxInfo": {
607         "firstName": "string",
608         "lastName": "string",
609         "streetAddress": "string",
610         "city": "string",
611         "state": "string",
612         "zip": "string",
613         "country": "string",
614         "email": "string",
615         "bin": "string",
616         "ip": "string",
617         "userAgent": "string",
618         "expMonth": "string",
619         "expYear": "string",
620         "eci": "string",
621         "avsResponseCode": "A",
622         "cvvResponseCode": "M",
623         "binLocation": {
624           "cardType": "credit",
625           "cardName": "string",
626           "cardSegment": "consumer",
627           "country": "AF",
628           "bankName": "string"
629         },
630         "ipLocation": {
631           "zip": "string",
632           "city": "string",
633           "isp": "string",
634           "region": "string",
635           "country": "string",
636           "lon": "string",
637           "lat": "string",
638           "hosting": true,
639           "mobile": true,
640           "proxy": true
641         },
642         "nsureDecisionInsights": {
643           "predictionInsights": [
644             {
645               "value": 1.1,
646               "description": "string",
647               "id": "string"
648             }
649           ],
650           "decisionComponents": [
651             {
652               "description": "string",
653               "type": "string"
654             }
655           ],
656           "decision": "string"
657         },
658         "orchestrationInfo": {
659           "ruleId": "string",
660           "ruleUsed": "string",
661           "resolvedPath": "string",
662           "graphTraversal": [
663             {
664               "nodeId": "string",
665               "nodeType": "action",
666               "outcome": "string",
667               "operation": "string"
668             }
669           ],
670           "processorList": [
671             "payarc"
672           ],
673           "successfulProcessor": "payarc",
674           "usedFallback": true
675         }
676       },
677       "transaction": "string",
678       "secureTransactionId": "string",
679       "processed3DS": "Required",
680       "cardType": "VISA",
681       "last4": "string",
682       "token": "string",
683       "mobileWallet": "applePay"
684     },
685     "bankTransferInfo": {
686       "refundReview": true,
687       "processor": "mock",
688       "status": "PENDING",
689       "reason": "string",
690       "token": "string",
691       "batchedAt": "2024-01-15T09:30:00Z",
692       "refundTransferId": "string",
693       "transaction": "string"
694     },
695     "pixInfo": {
696       "expiration": "2024-01-15T09:30:00Z",
697       "processor": "brla",
698       "status": "INITIATED",
699       "reason": "string",
700       "processed": "2024-01-15T09:30:00Z",
701       "transaction": "string",
702       "tokenSubtotal": {
703         "address": "string",
704         "amount": 1.1,
705         "decimals": 1.1
706       }
707     },
708     "ibanInfo": {
709       "expiration": "2024-01-15T09:30:00Z",
710       "token": "string",
711       "processor": "merge",
712       "status": "INITIATED",
713       "accountHolder": "string",
714       "reason": "string",
715       "transactionId": "string",
716       "processed": "2024-01-15T09:30:00Z",
717       "tokenSubtotal": {
718         "address": "string",
719         "amount": 1.1,
720         "decimals": 1.1
721       },
722       "transaction": "string"
723     },
724     "wireInfo": {
725       "status": "INITIATED",
726       "processor": "braid",
727       "token": "string",
728       "memo": "string",
729       "expiration": "2024-01-15T09:30:00Z",
730       "transaction": "string",
731       "tokenSubtotal": {
732         "address": "string",
733         "amount": 1.1,
734         "decimals": 1.1
735       },
736       "processed": "2024-01-15T09:30:00Z",
737       "transactionId": "string",
738       "reason": "string"
739     },
740     "cryptoInfo": {
741       "status": "INITIATED",
742       "overpaymentAmount": "string",
743       "actualPaymentAmountUSD": "string",
744       "depositAddress": "string",
745       "refundAddress": "string",
746       "refundTransactionUrl": "string",
747       "refundTransactionHash": "string",
748       "sessionId": "string",
749       "reason": "string",
750       "tokenLogoUrl": "string",
751       "blockchainLogoUrl": "string",
752       "tokenAmount": "string",
753       "token": "string",
754       "originatingTransactionHash": "string",
755       "originatingWallet": "string",
756       "processed": "2024-01-15T09:30:00Z",
757       "transaction": "string",
758       "tokenSubtotal": {
759         "address": "string",
760         "amount": 1.1,
761         "decimals": 1.1
762       }
763     },
764     "instantInfo": {
765       "ip": "string",
766       "userAgent": "string",
767       "token": "string",
768       "expiration": "2024-01-15T09:30:00Z",
769       "processor": "mock",
770       "status": "REGISTERED",
771       "ipLocation": {
772         "zip": "string",
773         "city": "string",
774         "isp": "string",
775         "region": "string",
776         "country": "string",
777         "lon": "string",
778         "lat": "string",
779         "hosting": true,
780         "mobile": true,
781         "proxy": true
782       },
783       "transaction": "string",
784       "tokenSubtotal": {
785         "address": "string",
786         "amount": 1.1,
787         "decimals": 1.1
788       },
789       "reason": "string",
790       "processed": "2024-01-15T09:30:00Z",
791       "url": "string"
792     },
793     "exchangeInfo": {
794       "amount": {
795         "gasFees": {
796           "cents": 1,
797           "currency": "USD"
798         },
799         "chargebackProtectionFees": {
800           "cents": 1,
801           "currency": "USD"
802         },
803         "creditCardFees": {
804           "cents": 1,
805           "currency": "USD"
806         },
807         "subtotal": {
808           "cents": 1,
809           "currency": "USD"
810         }
811       },
812       "rate": 1.1,
813       "base": {
814         "cents": 1,
815         "currency": "USD"
816       }
817     },
818     "subscription": "string",
819     "settlementType": "Credits",
820     "blockchain": "solana",
821     "redemptionCheck": true,
822     "marketplaceInfo": {
823       "marketplaceFee": {
824         "cents": 1,
825         "currency": "USD"
826       },
827       "marketplaceSettlement": {
828         "cents": 1,
829         "currency": "USD"
830       },
831       "sellerSettlement": {
832         "cents": 1,
833         "currency": "USD"
834       },
835       "feePercentage": 1.1,
836       "fixedFee": {
837         "cents": 1,
838         "currency": "USD"
839       }
840     },
841     "destination": "string",
842     "overrideAuditLog": {
843       "reason": "customer_override",
844       "editor": "string",
845       "editorType": "Coinflow",
846       "overriddenAt": "2024-01-15T09:30:00Z",
847       "ipAddress": "string",
848       "nsureOverrideReason": "internalTesting"
849     },
850     "customerUsdcTransferData": {
851       "from": "string",
852       "to": "string",
853       "value": "string",
854       "validAfter": "string",
855       "validBefore": "string",
856       "nonce": "string",
857       "v": 1.1,
858       "r": "string",
859       "s": "string"
860     },
861     "delayedSettlement": {
862       "isDisbursed": true,
863       "days": 1.1,
864       "scheduledDate": "2024-01-15T09:30:00Z",
865       "isScheduled": true,
866       "disbursedAt": "2024-01-15T09:30:00Z"
867     },
868     "refundInfo": {
869       "count": 1.1,
870       "refundedAt": "2024-01-15T09:30:00Z",
871       "amount": {
872         "cents": 1,
873         "currency": "USD"
874       }
875     }
876   },
877   "chargeback": {
878     "payment": "string",
879     "chargebackId": "string",
880     "reasonCode": "string",
881     "reasonDescription": "string",
882     "respondByDate": "2024-01-15T09:30:00Z",
883     "responded": true,
884     "createdAt": "2024-01-15T09:30:00Z",
885     "updatedAt": "2024-01-15T09:30:00Z",
886     "merchantRespondedAt": "2024-01-15T09:30:00Z",
887     "draftResponse": "string",
888     "responseFileKey": "string",
889     "notes": "string",
890     "ignore": true,
891     "discrepancy": true,
892     "loadedOn": "2024-01-15T09:30:00Z",
893     "decidedAt": "2024-01-15T09:30:00Z",
894     "updates": [
895       {
896         "transactionType": "string",
897         "code": "string",
898         "description": "string",
899         "postedAt": "2024-01-15T09:30:00Z"
900       }
901     ]
902   }
903 }

Get information about a Chargeback for a payment

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

Response

customerobject

paymentobject

chargebackobject