Order Management System REST API - Balance Controller
The Balance Controller is responsible for retrieving Cash Balances and submitting Cash Transactions.
GET all Balances
Section titled “GET all Balances”GET /balance
Performing a GET on this URL retrieves all Balances.
Query Parameters
Section titled “Query Parameters”| Parameter | Expected | Description |
|---|---|---|
| asAt | Optional | An ISO8601 date and time. The results returned will be those at the given timestamp. If omitted, returns the latest results. |
Response
Section titled “Response”On success, a 200 response containing an array of CashPosition objects.
POST Cash Transfer
Section titled “POST Cash Transfer”POST /balance
Performing a POST to this URL submits a Cash Transfer Request.
A single CashTransferRequest object.
Response
Section titled “Response”On success, a 204 response with no body. On failure, a 422 response with a body containing an array of one or more error codes describing the problem.