Order Management System REST API - Balance Controller
The balance/settle URI provides alllows for performing cash settlements.
Perform Cash Settlement
Section titled “Perform Cash Settlement”POST /balance/settle
Submits settlement transactions for unsettled cash.
Requires the Alter feature permission .
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| id | Optional | An ID to assign to each settlement, identifying this batch of transactions. |
An array of CashSettlementRecord objects.
Response
Section titled “Response”| Code | Status | Description |
|---|---|---|
| 204 | Success | Update completed successfully, or the update would make no changes. |
| 403 | Failure | The authenticated identity does not have the Alter permission. |
| 422 | Failure | Invalid data was provided. Content is a JSON array of one or more error codes describing the problem. |