Transactions Summary
REST Sandbox URL:
https://sandbox.4levers.com/NewReportsApi/api/Reports/transactions-summary
REST Production URL: https://reports-api.4levers.com/api/Reports/transactions-summary
Transactions Summary Report provides Sales, Credits and Chargebacks transaction summary and payment method details for the selected time range and system entity.
Sales– Charges, Captures, Partial Captures.Credits– Credits, Refunds, Partial Refunds, Cancels.Chargebacks– Chargebacks, Reversals.Amount of Chargebacks– Amount of Chargebacks – Amount of Reversals.
Total Amount - Sales - Credits - Chargebacks. Can have both positive and negative values.
Request Example (REST Production URL)
GET:https://reports-api.4levers.com/api/Reports/transactions-summary?DateFrom=2020-12-10&DateTo=2020-12-22&DateRangeType=SystemDate&Processors={processorId}&ReportPeriodType=Monthly&Currencies=USD&Accounts={accountId}&SubAccounts={subAccountId}&Take=5
Request Parameters
| № | Name | Type | Required | Description |
| 1 | datefrom | datetime | ✓ | determines the selection starting/ending time range |
| 2 | dateto | datetime | ✓ | |
| 3 | daterangetype | enum | optional | select the output period for the report
Available Values:
|
| 4 | processors | integer/array | optional | enter your processor id(s) |
| 5 | reportperiodtype | enum | optional | select the output period for the report
Available Values:
|
| 6 | serviceproviders | integer/array | optional | enter your service provider id(s) |
| 7 | operators | integer/array | optional | enter your operator id(s) |
| 8 | accounts | integer/array | optional | enter your platform account id(s) |
| 9 | subaccounts | string/array | optional | enter your sub-account id(s) |
| 10 | 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 |
| 11 | take | integer | optional | |
| 12 | currencies | enum | optional | enter currency type ids to filter sub-account by
Available Values:
|
Responce Parameters
| № | Name | Description |
| 1 | date | record date and time |
| 2 | paymentmethod | transactions payment method |
| 3 | numberofsales | number of charges, captures, partial captures |
| 4 | amountofsales | amount of charges, captures, partial captures |
| 5 | numberofcredits | number of credit, refund, partial refund, cancel |
| 6 | amountofcredits | amount of credit, refund, partial refund, cancel |
| 7 | numberofchargebacks | number of chargebacks, reversals |
| 8 | amountofchargebacks | amount of chargebacks, reversals |
| 9 | totalamount | sales minus credits minus chargebacks |
| 10 | currency | transactions currency |
| 11 | subaccount | sub-account identifier |
| 12 | platformaccount | platform account name |
[
{
"date": "2020-07-01",
"paymentMethod": "Visa",
"numberOfSales": "308",
"amountOfSales": "20.00",
"numberOfCredits": "18",
"amountOfCredits": "20.00",
"numberOfChargebacks": "15",
"amountOfChargebacks": "10.00",
"totalAmount": "50.00",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Platform Account Name"
},
{
"date": "2020-07-01",
"paymentMethod": "Visa",
"numberOfSales": "10",
"amountOfSales": "10.00",
"numberOfCredits": "50",
"amountOfCredits": "30.00",
"numberOfChargebacks": "15",
"amountOfChargebacks": "10.00",
"totalAmount": "50.00",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Platform Account Name"
}
]