Retrieve Financial Details of a Ledger

POST

https://api.mpay.com.au/ledger/v1/financials

This endpoint returns the automatcher details and financials for a ledger. The financials include the available balance, allowed spend & and allowed load, and the maximum balance that can be held within the ledger account.

acceptstringGenerated from available response content types

bodyobject

200Successful response.

400Bad Request - the request was malformed or contained invalid parameters.

401Unauthorized - authentication failed, or the API key was missing or invalid.

500Internal Server Error - an unexpected error occurred while processing the request.

curl --request POST \
     --url https://api.mpay.com.au/ledger/v1/financials \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "ledgerAccountNumber": "200000001",
     "includeClosed": "false"
     }'