POST
/
v1
/
pay
/
withdrawals
/
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:

Authorizations

X-API-KEY
string
headerrequired

Headers

x-idempotency-key
string

Unique key to ensure idempotency of the request

Body

application/json
memberId
string
required

The unique identifier for a Member, prefixed with mem_

amount
object
required

A monetary value with currency.

Response

201 - application/json
withdrawalIntentId
string
required

The unique identifier for a PayWithdrawalIntent, prefixed with wi_

netAmount
object
required

A monetary value with currency.

fee
object
required

A monetary value with currency.

accountDetails
object
required
bankAccount
object
requireddeprecated

Deprecated in favour of bankAccount

Get Member WithdrawalsComplete Withdrawal