Account Summary
REST Sandbox URL:
https://sandbox.4levers.com/NewReportsApi/api/Reports/account-summary
REST Production URL: https://reports-api.4levers.com/api/Reports/account-summary
Account Summary Report provides count and volumes of successful/declined transactions (Authorization, Charge, Void, Partial Void, Capture, Partial Capture, Refund, Partial Refund, Credit, Cancel) and approval rates for a selected time period.
Request Example (REST Production URL)
GET:https://reports-api.4levers.com/api/Reports/account-summary?DateFrom=2020-12-10&DateTo=2020-12-22&DateRangeType=SystemDate&ReportPeriodType=Daily&Currencies=USD&Accounts={accountId}&SubAccounts={subAccountId}
Request Parameters
| Name | Type | Required | Description | |
| datefrom | datetime | ✓ | determines the selection starting/ending time range | |
| dateto | datetime | ✓ | determines the selection starting/ending time range | |
| daterangetype | enum | optional | select the output period for the report
Available Values:
|
|
| processors | string/array | optional | specify your processor(s) | |
| reportperiodtype | enum | optional | select the output period for the report
Available Values:
|
|
| 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 | 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 |
|
| currencies | enum | optional | enter currency type ids to filter sub-account by
Available Values:
|
Response Parameters
| Name | Description | |
| date | record date and time | |
| transactiontype | transaction type | |
| numberofsuccessful | number of successful transactions of the specific transaction type. | |
| amountofsuccessful | amount of successful transactions of the specific transaction type. | |
| numberofdeclined | number of declined transactions of the specific transaction type | |
| amountofdeclined | amount of declined transaction of the specific transaction type | |
| approvalratebynumber | the percentage of successful from [successful + declined] | |
| approvalratebyamount | the percentage of successful from [successful + declined] | |
| currency | transactions currency | |
| subaccount | sub-account identifier | |
| platformaccount | platform account name |
[
{
"date": "2020-07-14T00:00:00",
"transactionType": "Capture",
"numberOfSuccessful": "2",
"amountOfSuccessful": "20.00",
"numberOfDeclined": "0",
"amountOfDeclined": "0.00",
"approvalRatebyNumber": "100.00",
"approvalRatebyAmount": "100.00",
"currency": "USD",
"subAccount": "Sub-Account Id",
"platformAccount": "Platform Account Id"
},
{
"date": "2020-07-14T00:00:00",
"transactionType": "Partial Capture",
"numberOfSuccessful": "3",
"amountOfSuccessful": "100.00",
"numberOfDeclined": "3",
"amountOfDeclined": "2.00",
"approvalRatebyNumber": "100.00",
"approvalRatebyAmount": "100.00",
"currency": "USD",
"subAccount": "Sub-Account Id",
"platformAccount": "Platform Account Id"
}
]