Holding Balance Resource

A holding account is used by Partners to hold funds for a customer that can be used to disburse payments at a later date. Holding accounts are funded using the Commit Holding Order request and settling using a "good funds" model.

Available and booked balances of a holding account for a particular currency can be viewed by the Partner on behalf of the customer. Available balance is used in the calculating which payments can be released after payments have cleared sanction scanning.

Holding Account Resource

{
    "customerId": string,
    "holdingBalances": [
        {
            "currency": string,
            "available": 0,
            "booked": 0
        }
    ]
}

Sample Response

{
    "customerId": "Customer123",
    "holdingBalances": [
        {
            "currency": "AUD",
            "available": 100000,
            "booked": 50000
        }
    ]
}