Skip to main content
POST
Withdraw from the card balance

Authorizations

Api-Key
string
header
required

Partner API key. Must carry the cards permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. 2026-09.1. See Versioning.

Pattern: ^\d{4}-\d{2}\.\d+$
Idempotency-Key
string
required

1 to 64 characters. Required on every POST that creates something. A repeat returns the first result; the same key with a different body returns 409.

Required string length: 1 - 64

Path Parameters

customerId
string
required

An individual, a business or an employee (cus_).

Example:

"cus_1Xb7..."

Body

application/json
amount
object
required

At most the available balance.

chain
string
required

The chain to receive it on.

destination
object
required

Exactly one of the two.

Response

The withdrawal.

withdrawalId
string
Example:

"cwd_2Rt5..."

customerId
string
amount
object

A decimal string and a currency code.

chain
string
destination
object
transactionHash
string | null
fees
object[]

Endl fees on this withdrawal.

status
enum<string>
Available options:
pending,
completed,
failed
failureReason
any

Why the withdrawal failed; null otherwise.

createdAt
string<date-time>
completedAt
string<date-time> | null