Skip to main content
POST
Create a 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.

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.

Example:
fee
Fee · object
required

A monetary value with currency.

Example:
accountDetails
BankAccountUK · object
required

A UK bank account

Example:
bankAccount
object
required
deprecated

Deprecated in favour of accountDetails