Create Withdrawal Intent

Create a withdrawal intent given an intended withdrawal amount, and the member who will receive the funds. We will process the request, calculate the fee (dependant on the member’s tier) and return:

netAmount - a Money object representing the amount that will be transferred to the member
fee - a Money object representing the fee that will be charged
accountDetails - An object containing the bank account details the netAmount will be transferred to

Please see the On Demand Pay documentation for more information on the lifecycle of a withdrawal intent.

Relevant Error Codes

The endpoint-specific error codes to pay attention to are:

In rare cases, you may receive a Unprocessable Entity Error which indicates that On Demand Pay is temporarily unavailable.

Authorizations

x-api-key

string

header

required

Headers

x-idempotency-key

string

Unique key to ensure idempotency of the request

Body

application/json

Body

memberId

string

required

The unique identifier for a Member, prefixed with mem_

Example:

"mem_<id>"

amount

Money · object

required

A monetary value with currency.

Show child attributes

amount.amount

integer

required

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

Example:

1050

amount.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"

Response

201 - application/json

201

withdrawalIntentId

string

required

The unique identifier for a PayWithdrawalIntent, prefixed with wi_

Example:

"wi_<id>"

netAmount

NetAmount · object

required

A monetary value with currency.

Show child attributes

netAmount.amount

integer

required

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

Example:

1050

netAmount.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": 950 }

fee

Fee · object

required

A monetary value with currency.

Show child attributes

fee.amount

integer

required

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

Example:

1050

fee.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": 50 }

accountDetails

BankAccountUK · object

required

A UK bank account

BankAccountUK
BankAccountEU

Show child attributes

accountDetails.accountHolder

string

required

accountDetails.sortCode

string

required

accountDetails.accountNumber

string

required

Example:

{
  "accountHolder": "John Smith",
  "sortCode": "123456",
  "accountNumber": "12345678"
}

bankAccount

object

required

deprecated

Deprecated in favour of accountDetails

Show child attributes

bankAccount.lastFour

string

required

Example:

"5678"

Members

Tiering

On Demand Pay

Create Withdrawal Intent

Relevant Error Codes

Authorizations

Headers

Body

Response

Members

Tiering

On Demand Pay

​Relevant Error Codes

Authorizations

Headers

Body

Response

Relevant Error Codes