Current Balance
Theavailable
field represents the actual balance a member currently has for withdrawal.
Withdrawal Limits
ThelowerLimit
and upperLimit
fields define the range of amounts that a member is allowed to withdraw:
- Lower Limit (
lowerLimit
): The minimum amount a member can withdraw. - Upper Limit (
upperLimit
): The maximum amount a member can withdraw.
These limits do not directly factor into the balance but instead serve to restrict the amount a member can withdraw in
a single transaction.
Computation of Withdrawable Amount
Given the available balance and the limits, the withdrawable amount can be computed as follows:- Minimum Withdrawable Amount: Is always the
lowerLimit
, as if the balance is less than the lower limit they cannot withdraw. - Maximum Withdrawable Amount: This is the smaller value between the available balance and the upper limit.
Authorizations
Path Parameters
The unique identifier for a Member, prefixed with mem_
Example:
"mem_<id>"
Response
200 - application/json
200
The balance for the member
Example:
{ "currency": "GBP", "amount": 12500 }
The lower limit, the member cannot withdraw below this amount
Example:
{ "currency": "GBP", "amount": 1000 }
The upper limit, the member cannot have more than this amount
Example:
{ "currency": "GBP", "amount": 20000 }