Get Member Balance

GET

pay

members

{memberId}

balance

Show available balance for the member

curl --request GET \
  --url https://api.onsi.com/v1/pay/members/{memberId}/balance \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.onsi.com/v1/pay/members/{memberId}/balance"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.onsi.com/v1/pay/members/{memberId}/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/pay/members/{memberId}/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/pay/members/{memberId}/balance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.onsi.com/v1/pay/members/{memberId}/balance")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/pay/members/{memberId}/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "available": {
    "currency": "GBP",
    "amount": 12500
  },
  "lowerLimit": {
    "currency": "GBP",
    "amount": 1000
  },
  "upperLimit": {
    "currency": "GBP",
    "amount": 20000
  },
  "payCycle": {
    "id": "pc_<id>",
    "startDate": "2024-01-01",
    "endDate": "2024-01-15",
    "lastPayDate": "2024-01-07T11:55:39.676Z"
  },
  "isTemporarilyUnavailable": true
}

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)

Temporarily Unavailable

In rare cases, On Demand Pay may be temporarily unavailable. To show this, we return temporarilyUnavailable: true in the balance response. If this happens, withdrawals will be temporarily unavailable and any calls to create withdrawal intent or complete withdrawal endpoints will be rejected.

Authorizations

x-api-key

string

header

required

Path Parameters

memberId

string

required

The unique identifier for a Member, prefixed with mem_

Example:

"mem_<id>"

Response

200 - application/json

200

available

AvailableBalance · object

required

The balance for the member

Show child attributes

Example:

{ "currency": "GBP", "amount": 12500 }

lowerLimit

LowerLimit · object

required

The lower limit, the member cannot withdraw below this amount

Show child attributes

Example:

{ "currency": "GBP", "amount": 1000 }

upperLimit

UpperLimit · object

required

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

Show child attributes

Example:

{ "currency": "GBP", "amount": 20000 }

payCycle

object

required

Show child attributes

isTemporarilyUnavailable

boolean

required

If true, On Demand Pay withdrawals are temporarily unavailable and calls to confirmWithdrawal will be rejected

Get Withdrawals

⌘I

Show available balance for the member

curl --request GET \
  --url https://api.onsi.com/v1/pay/members/{memberId}/balance \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.onsi.com/v1/pay/members/{memberId}/balance"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.onsi.com/v1/pay/members/{memberId}/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/pay/members/{memberId}/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/pay/members/{memberId}/balance"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.onsi.com/v1/pay/members/{memberId}/balance")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/pay/members/{memberId}/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "available": {
    "currency": "GBP",
    "amount": 12500
  },
  "lowerLimit": {
    "currency": "GBP",
    "amount": 1000
  },
  "upperLimit": {
    "currency": "GBP",
    "amount": 20000
  },
  "payCycle": {
    "id": "pc_<id>",
    "startDate": "2024-01-01",
    "endDate": "2024-01-15",
    "lastPayDate": "2024-01-07T11:55:39.676Z"
  },
  "isTemporarilyUnavailable": true
}

Members

Tiering

On Demand Pay

Get Member Balance

Current Balance

Withdrawal Limits

Computation of Withdrawable Amount

Temporarily Unavailable

Authorizations

Path Parameters

Response

​Current Balance

​Withdrawal Limits

​Computation of Withdrawable Amount

​Temporarily Unavailable

Authorizations

Path Parameters

Response

Current Balance

Withdrawal Limits

Computation of Withdrawable Amount

Temporarily Unavailable