GET
/
v1
/
pay
/
members
/
{memberId}
/
balance
curl --request GET \
  --url https://api.onsi.com/v1/pay/members/{memberId}/balance \
  --header 'X-API-KEY: <api-key>'
{
  "available": {
    "currency": "GBP",
    "amount": 12500
  },
  "lowerLimit": {
    "currency": "GBP",
    "amount": 1000
  },
  "upperLimit": {
    "currency": "GBP",
    "amount": 20000
  },
  "payCycle": {
    "startDate": "2024-01-01",
    "endDate": "2024-01-15",
    "lastPayDate": "2024-01-07T11:55:39.676Z"
  }
}

Returns the balance of a member, and any withdrawal limits that apply to the member.

​
Current Balance

The available field represents the actual balance a member currently has for withdrawal.

​
Withdrawal Limits

The lowerLimit 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. 
    Maximum Withdrawable Amount = min(available, upperLimit)

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-idempotency-key
string

Unique key to ensure idempotency of the request

Path Parameters

​
memberId
string
required

The unique identifier for a Member, prefixed with mem_

Example:

"mem_<id>"

Response

200 - application/json
200
​
available
object
required

The balance for the member

Example:
{ "currency": "GBP", "amount": 12500 }
​
lowerLimit
object
required

The lower limit, the member cannot withdraw below this amount

Example:
{ "currency": "GBP", "amount": 1000 }
​
upperLimit
object
required

The upper limit, the member cannot have more than this amount

Example:
{ "currency": "GBP", "amount": 20000 }
​
payCycle
object
required