Returns a paginated list of settlements (bank deposits) for a given date or date range, based on the settlement (deposit) date. Each settlement summarizes one deposit to the merchant's bank account; retrieve its settled-transaction line items with GET /settlements/{settlementId}.
Either date or fromDate/toDate must be provided.
The endpoint supports filtering and sorting via the filters and sorts parameters (see List Transactions for the filter operator table).
Examples:
- Single day:
?date=2026-07-01 - Date range, ACH only:
?fromDate=2026-07-01&toDate=2026-07-07&filters=type==Ach - Largest first:
?date=2026-07-01&sorts=-amount
Query parameters
-
A single day to report on. Either
dateor at least one offromDate/toDatemust be provided. Whendateis given it takes precedence and the range is that single day. Only the date part is used; any time component is ignored. -
Inclusive start of the date range. If omitted while
toDateis given, the range is the single daytoDate. Only the date part is used; any time component is ignored. -
Inclusive end of the date range. If omitted while
fromDateis given, the range is the single dayfromDate. Only the date part is used; any time component is ignored. -
Comma-separated list of merchant IDs to report on. Forward-compatible parameter for multi-merchant API keys; currently every ID must be the merchant resolved from the API key, and any other ID is rejected with
401. Omit it to default to that merchant. -
Filter criteria in the format: field==value,field!=value Multiple filters can be separated by commas. Available fields: settlementDate, type, amount, status. netAmount is accepted as a deprecated alias of amount until it is removed.
-
Sort criteria as comma-separated field names. Prefix a field with
-for descending order. Available fields: settlementDate, amount, status. netAmount is accepted as a deprecated alias of amount until it is removed. -
Page number to retrieve (starts at 1). For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.
Minimum value is
1. Default value is1. -
Number of records per page. For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.
Minimum value is
1, maximum value is100. Default value is10.
curl \
--request GET 'https://api.omni.integratedcommerce.io/v1/settlements' \
--header "x-api-key: $API_KEY"{
"totalCount": 2,
"page": 1,
"pageSize": 10,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false,
"items": [
{
"id": "stl_01JZ5G4K8WQT2XB7RD9NVMC3EH",
"type": "Card",
"settlementDate": "2026-07-14",
"currency": "USD",
"amount": 121875,
"fundingType": "Net",
"netAmount": 121875,
"transactionCount": 42,
"status": "Settled"
},
{
"id": "stl_01JZ5G4K8WYN6PSA3KTE5D2QVX",
"type": "Ach",
"settlementDate": "2026-07-14",
"currency": "USD",
"amount": 50000,
"fundingType": "Gross",
"netAmount": 50000,
"transactionCount": 1,
"status": "Settled"
}
]
}{
"code": 2000,
"status": "Rejected",
"message": "Either 'date' or 'fromDate'/'toDate' must be provided",
"traceId": "1-6838be96-74c62f8e2804352739e63476",
"timestamp": "2026-07-01T20:07:50.4723483Z",
"errorDetails": []
}{
"code": 1000,
"status": "Rejected",
"message": "API key cannot be empty",
"traceId": "1-6838be96-74c62f8e2804352739e63476",
"timestamp": "2025-05-29T20:07:50.4723483Z",
"errorDetails": []
}