Skip to main content
POST
/
v1
/
pay
/
withdrawals
/
intent
Create a withdrawal intent
curl --request POST \
  --url https://api.onsi.com/v1/pay/withdrawals/intent \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "memberId": "mem_<id>",
  "amount": {
    "amount": 1050,
    "currency": "GBP"
  }
}
'
{
  "withdrawalIntentId": "wi_<id>",
  "netAmount": {
    "currency": "GBP",
    "amount": 950
  },
  "fee": {
    "currency": "GBP",
    "amount": 50
  },
  "accountDetails": {
    "accountHolder": "John Smith",
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "bankAccount": {
    "lastFour": "5678"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.onsi.com/llms.txt

Use this file to discover all available pages before exploring further.

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:
{ "currency": "GBP", "amount": 950 }
​
fee
Fee · object
required

A monetary value with currency.

Example:
{ "currency": "GBP", "amount": 50 }
​
accountDetails
BankAccountUK · object
required

A UK bank account

Example:
{
  "accountHolder": "John Smith",
  "sortCode": "123456",
  "accountNumber": "12345678"
}
​
bankAccount
object
required
deprecated

Deprecated in favour of accountDetails