Account Balances
REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/account-balances
REST Production URL: https://reports-api.4levers.com/api/Reports/account-balances
Account Balance is a fundamental high-level report. Account Balance report displays the current state of your Sub-Account balance, a complete high-level overview of all the Sub-Account incoming settlements, outgoing payouts, reserve balance and other fees for a selected time range.
This report allows to control your Sub-Account completed and pending payouts and get the current and pending Sub-Account balances.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/account-balances?DateFrom=2020-12-10&DateTo=2020-12-22&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 | serviceProviders | integer/array | optional | enter your service provider id(s) |
| 4 | operators | integer/array | optional | enter your operator id(s) |
| 5 | accounts | integer/array | optional | enter your platform account id(s) |
| 6 | subAccounts | string/array | optional | enter your sub-account id(s) |
| 7 | skip | integer/array | 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 |
| 8 | take | integer/array | optional |
Response Parameters
| № | Name | Description |
| 1 | date | system date and time |
| 2 | Description | balance record description |
| 3 | reference | balance record reference number |
| 4 | amount | balance record amount |
| 5 | balance | total balance on a specific date |
| 6 | currency | code of the transaction currency |
| 7 | subAccount | sub-account identifier |
| 8 | platformAccount | platform account name |
[
{
"date": "2020-05-17T00:00:00",
"description": "Current Account Balance",
"reference": "20200517",
"amount": "1.000000",
"balance": "859.570000",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Reserve Release Never"
},
{
"date": "2020-05-17T00:00:00",
"description": "Current Reserve Balance",
"reference": "20200517",
"amount": "2.000000",
"balance": "500.200000",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Reserve Release Never"
},
{
"date": "2019-10-10T01:59:58",
"description": "Daily Settlement Amount",
"reference": "20191010",
"amount": "20.000000",
"balance": "810.000000",
"currency": "USD",
"subAccount": "Sub-Account Id - Sub-Account Name",
"platformAccount": "Reserve Release Never"
}
]