balance
balance
The balance method returns information about the merchant's balances in the format:
currency: amount.
If the curr argument is transmitted in the query, the method will return the balance
only of transmitted currency.
endpoint
Queries for the method are sent to endpoint https://api.any.money/.
Input method arguments
| Param | Required | Example | Description |
|---|---|---|---|
| curr | no | "UAH" | balance currency name |
Method response data
Params of the balances in the format:
{
"currency1": "amount",
"currency2": "amount",
...
}
Exceptions
- EParamCurrencyInvalid
- curr currency is not present in the system
total_balance
The total_balance method returns information about the merchant's balances including hold and roll balances. If the curr argument is transmitted in the query, the method will return the balances only of transmitted currency.
endpoint
Queries for the method are sent to endpoint https://api.any.money/.
Input method arguments
| Param | Required | Example | Description |
|---|---|---|---|
| curr | no | "UAH" | balance currency name |
Method response data
- total_balance
- the total balance of a currency including holds and rolling reserve
- total_hold
- the total amount of unavailable balance in the balance currency (reserved amount)
- avail_balance
- available balance of a currency
- hold_amount
- the total amount of active holds on a currency balance
- roll_amount
- the total amount of funds captured in the rolling reserve on a currency balance
Exceptions
- EParamCurrencyInvalid
- curr currency is not present in the system