Skip to main content
POST
/
withdrawals
Create withdrawal
curl --request POST \
  --url https://{host}/withdrawals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <x-user-id>' \
  --data '
{
  "bankAccountId": "ba_64f0c51e7fb3fc001234abcd",
  "amount": 50,
  "currency": "EUR",
  "reference": "Withdraw to bank"
}
'
{
  "id": "wd_64f0c51e7fb3fc001234abcd",
  "ownerId": "bank-user-12345",
  "bankAccountId": "ba_64f0c51e7fb3fc001234abcd",
  "amount": 50,
  "currency": "EUR",
  "status": "pending",
  "reference": "Withdraw to bank",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-user-id
string
required

The external user identifier of the acting customer.

Example:

"bank-user-12345"

Body

application/json
​
bankAccountId
string
required
Example:

"ba_64f0c51e7fb3fc001234abcd"

​
amount
number
required

Amount as a positive number

Required range: x > 0
Example:

50

​
currency
string
required

ISO 4217 currency code

Example:

"EUR"

​
reference
string
Example:

"Withdraw to bank"

Response

Withdrawal created

​
id
string
required
Example:

"wd_64f0c51e7fb3fc001234abcd"

​
ownerId
string
required
Example:

"bank-user-12345"

​
bankAccountId
string
required
Example:

"ba_64f0c51e7fb3fc001234abcd"

​
amount
number
required

Withdrawal amount as a number

Required range: x >= 0.01
Example:

50

​
currency
string
required

ISO 4217 currency code

Example:

"EUR"

​
status
enum<string>
required

Status of the withdrawal

Available options:
pending,
completed,
failed
Example:

"pending"

​
reference
string
Example:

"Withdraw to bank"

​
createdAt
string<date-time>
​
updatedAt
string<date-time>