Get Member Balance

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

available.amount

integer

required

Price in lowest denomination of currency (e.g. cents)

Example:

1050

available.currency

enum<string>

required

ISO 4217 currency code

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLF,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MXV,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

USN,

UYI,

UYU,

UYW,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

XSU,

XTS,

XUA,

XXX,

YER,

ZAR,

ZMW,

ZWL

Example:

"GBP"

Example:

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

lowerLimit

LowerLimit · object

required

The lower limit, the member cannot withdraw below this amount

Show child attributes

lowerLimit.amount

integer

required

Price in lowest denomination of currency (e.g. cents)

Example:

1050

lowerLimit.currency

enum<string>

required

ISO 4217 currency code

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLF,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MXV,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

USN,

UYI,

UYU,

UYW,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

XSU,

XTS,

XUA,

XXX,

YER,

ZAR,

ZMW,

ZWL

Example:

"GBP"

Example:

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

upperLimit

UpperLimit · object

required

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

Show child attributes

upperLimit.amount

integer

required

Price in lowest denomination of currency (e.g. cents)

Example:

1050

upperLimit.currency

enum<string>

required

ISO 4217 currency code

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BOV,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHE,

CHF,

CHW,

CLF,

CLP,

CNY,

COP,

COU,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MXV,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

USN,

UYI,

UYU,

UYW,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XAG,

XAU,

XBA,

XBB,

XBC,

XBD,

XCD,

XDR,

XOF,

XPD,

XPF,

XPT,

XSU,

XTS,

XUA,

XXX,

YER,

ZAR,

ZMW,

ZWL

Example:

"GBP"

Example:

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

payCycle

object

required

Show child attributes

payCycle.id

string

required

The unique identifier for a PayCycle, prefixed with pc_

Example:

"pc_<id>"

payCycle.startDate

string

required

Date in ISO8601 YYYY-MM-DD format

Example:

"2024-01-01"

payCycle.endDate

string

required

Date in ISO8601 YYYY-MM-DD format

Example:

"2024-01-15"

payCycle.lastPayDate

string | null

required

The last time pay was made available for this member in this cycle

Example:

"2024-01-07T11:55:39.676Z"

isTemporarilyUnavailable

boolean

required

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

Members

Tiering

On Demand Pay

Get Member Balance

Current Balance

Withdrawal Limits

Computation of Withdrawable Amount

Temporarily Unavailable

Authorizations

Path Parameters

Response

Members

Tiering

On Demand Pay

​Current Balance

​Withdrawal Limits

​Computation of Withdrawable Amount

​Temporarily Unavailable

Authorizations

Path Parameters

Response

Current Balance

Withdrawal Limits

Computation of Withdrawable Amount

Temporarily Unavailable