Chargeback Analysis
REST Sandbox URL:
https://sandbox.4levers.com/NewReportsApi/api/Reports/chargeback-analysis
REST Production URL: https://reports-api.4levers.com/api/Reports/chargeback-analysis
Chargeback Analysis report offers a complete set of data and statistics on your Sub-Account chargeback rates and volumes for a specified date.
Request Example (REST Production URL)
GET:https://reports-api.4levers.com/api/Reports/chargeback-analysis?DateFrom=2019-06-01&DateTo=2019-07-24
Request Parameters
| Name | Type | Required | Description | |
| 1 | dateFrom | datetime | ✓ | determines the selection starting time range |
| 2 | dateTo | datetime | ✓ | determines the selection ending time range |
| processors | string/array | optional | specify one or more clearing processors | |
| paymentmethods | enum | optional | specify the payment method
required in case credit card is populated.
Available Values:
|
|
| creditcards | enum | optional | specify a credit card type
Available Values:
|
|
| paymenttypes | enum | optional | specify a payment type
regular one-time payment
recurring subscription payments
installments recurring installments
deferred deferred payment
|
|
| daterangetype | enum | optional |
specify the report output date range type
systemdateprocessordate
|
|
| serviceproviders | integer/array | optional | enter your service provider id(s) | |
| operators | integer/array | optional | enter your operator id(s) | |
| accounts | integer/array | optional | enter your platform account id(s) | |
| subaccounts | string/array | optional | enter your sub-account id(s) | |
| skip | integer | optional | these parameters determine which records will be displayed in the report based on specified index number.
to get from fifth to twentieth record specify skip = 4 and take = 16 |
|
| take | integer | optional | ||
| currencies | string array | optional | enter currency type ids to filter sub-accounts by
Available Values:
|
Response Parameters
| Name | Description | |
| date | chargeback processing date | |
| numberofsales | deposit (sale) transactions count | |
| amountofsales | gross amount of all deposit (sale) transactions | |
| numberofchargebacks | chargeback transactions count | |
| amountofchargebacks | amount of all chargeback transactions | |
| ratiobynumber | chargeback transactions count share in the total count of deposit transactions | |
| ratiobyamount | chargeback transactions accumulated amount share in the total volume of deposit transactions | |
| accumulatedratiobynumber | chargeback transactions accumulated count share in the total count of deposit transactions | |
| accumulatedratiobyamount | chargeback transactions amount share in the total volume of deposit transactions | |
| currency | transaction currency | |
| subaccount | sub-account identifier and name | |
| platformaccount | platform account name |
[
{
"date": "2019-09-10",
"numberOfSales": "35",
"amountOfSales": "20.00",
"numberOfChargebacks": "8",
"amountOfChargebacks": "4.00",
"ratioByNumber": "22.86",
"ratioByAmount": "11.43",
"accumulatedRatioByNumber": "11.24",
"accumulatedRatioByAmount": "1.51",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Platform Account Name"
},
{
"date": "2019-09-10",
"numberOfSales": "0",
"amountOfSales": "0.00",
"numberOfChargebacks": "0",
"amountOfChargebacks": "0.00",
"ratioByNumber": "0",
"ratioByAmount": "0",
"accumulatedRatioByNumber": "0",
"accumulatedRatioByAmount": "0",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Platform Account Name"
}
]