Settlements
REST Sandbox URL: https://sandbox.4levers.com/NewReportsApi/api/Reports/settlements
REST Production URL: https://reports-api.4levers.com/api/Reports/settlements
Settlement is the net calculated transfer amount from Buyers to Merchants (Sellers).
Transactions (sales) (credit card and/or ACH or other sales) generate a positive settlement balance.
Debit transactions (refunds, chargebacks and fees) generate a negative settlement balance.
Settlements report provides your Sub-Account settlement balance breakdown:
Settlement Balance = Sales – Refunds- Chargebacks – Fees
Settlement balance shows the Sub-Account net liquidity balance. You can use it to determine whether your Sub-Account has a positive or negative trade balance on a specific date or for a specific period.
Request Example (REST Production URL)
GET: https://reports-api.4levers.com/api/Reports/settlements?ReportPeriodType=Monthly&Processors={processorId}&DateFrom=2020-12-10&DateTo=2020-12-22&Currencies=USD&Take=5
Request Parameters
| Name | Type | Required | Description | |
| datefrom | datetime | ✓ | determines the selection starting/ending time range | |
| dateto | datetime | ✓ | determines the selection starting/ending time range | |
| reportperiodtype | enum | optional | select the output period for the report Available Values:
| |
| processors | string/array | optional | clearing processor name(s) | |
| 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 | system date and time | |
| numberofsales | deposit (sale) transactions count | |
| amountofsales | deposit (sale) transactions overall amount | |
| numberofcredits | credit transactions count | |
| amountofcredits | overall amount of credit transactions | |
| numberofchargebacks | chargebacks transactions count | |
| amountofchargebacks | overall amount of chargebacks transactions | |
| outgoingfees | outgoing fees amount | |
| interchangefees | interchange fees amount | |
| reservefees | reserve balance fees amount | |
| incomingfees | incoming fees amount | |
| amountofsettlement | total settlements amount. settlement balance = sales – refunds- chargebacks – fees. | |
| currency | transaction currency | |
| subaccount | sub-account identifier | |
| platformaccount | platform account name |
[
{
"date": "2022-03-03T12:59:59",
"numberOfSales": "1",
"amountOfSales": "5.00",
"numberOfCredits": "0",
"amountOfCredits": "0.00",
"numberOfChargebacks": "0",
"amountOfChargebacks": "0.00",
"outgoingFees": "0.000000",
"interchangeFees": "0.000000",
"reserveFees": "0.000000",
"incomingFees": "0.000000",
"amountOfSettlement": "5.000000",
"currency": "EUR",
"subAccount": "test_sub_account",
"platformAccount": "test_account"
},
{
"date": "2022-03-03T12:59:59",
"numberOfSales": "1",
"amountOfSales": "5.00",
"numberOfCredits": "0",
"amountOfCredits": "0.00",
"numberOfChargebacks": "0",
"amountOfChargebacks": "0.00",
"outgoingFees": "0.000000",
"interchangeFees": "0.000000",
"reserveFees": "0.000000",
"incomingFees": "0.000000",
"amountOfSettlement": "5.000000",
"currency": "EUR",
"subAccount": "test_sub_account",
"platformAccount": "test_account"
}
]