Get chargeback analytics summary for time frame

GET

https://api-sandbox.coinflow.cash/api/merchant/chargebacks/analytics/summary

GET

/api/merchant/chargebacks/analytics/summary

$ curl https://api-sandbox.coinflow.cash/api/merchant/chargebacks/analytics/summary \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "vamp": {
3     "ratio": 0.035,
4     "settledPayments": 12500,
5     "fraudCount": 45,
6     "chargebackCount": 30
7   },
8   "savings": {
9     "balanceCents": 150000,
10     "feeCents": 12000,
11     "totalCents": 162000,
12     "disputesProtected": 28,
13     "disputesTotal": 35
14   },
15   "byBrand": [
16     {
17       "network": "Visa",
18       "settledPayments": 7000,
19       "chargebackCount": 15,
20       "chargebackVolumeCents": 450000,
21       "fraudCount": 20,
22       "chargebackRatio": 0.0021,
23       "fraudRatio": 0.0028,
24       "vampRatio": 0.0035
25     }
26   ],
27   "daily": [
28     {
29       "day": "2024-05-01",
30       "chargebackCount": 2,
31       "chargebackVolumeCents": 60000,
32       "fraudCount": 1,
33       "fraudVolumeCents": 30000
34     }
35   ]
36 }

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

— YYYY-MM-DD

untilstringOptional

— YYYY-MM-DD

timezonestringOptional

— IANA timezone the since/until dates and day buckets are interpreted in (defaults to UTC)

Response

vampobject

savingsobject

byBrandlist of objects

dailylist of objects