Skip to navigation

Create a customer withdrawal

Sends funds from a customer balance to an address. amount is in base units unless useDecimal is true. A withdrawal needing approval emits a CUSTOMER_WITHDRAW_AWAITING_APPROVAL webhook; on broadcast, CUSTOMER_WITHDRAW.

Pass idempotencyKey (your own reference) to make retries safe: the same key with the same customer, mint, amount and address returns the original withdrawal (with its current status) even if it was later rejected or failed, so use a new key to try again; with anything different it is 409. The key is echoed on every withdrawal webhook. A 451 risk rejection does not reserve the key.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
mintIddoubleRequired
customerIdstringRequired
amountstringRequired
toAddressstringRequired
useDecimalbooleanOptional
requireApprovalbooleanOptional

When true, the withdraw is held for manual approval unless the customer’s organizationExternalEmail matches an active entry on the merchant’s withdrawal approval email allowlist (dashboard Organization security). An active allowlist entry also skips the customer USD withdraw-threshold approval hold. Destination-address whitelist, low-liquidity, and risk screening are not bypassed.

idempotencyKeystringOptional1-255 characters

Your own reference for this withdrawal (1-255 chars). Makes retries safe, and is returned as idempotencyKey on every withdrawal webhook.

Response

Withdrawal created, or the existing one for this idempotencyKey
withdrawalIdstringformat: "uuid"
customerIdstring
mintIdinteger
amountstring
toAddressstring
statusenum

Current status. On an idempotent replay this is the original withdrawal’s status now (e.g. REJECTED / FAILED: nothing will be sent; use a new key).

idempotencyKeystring or null
The idempotencyKey you sent, or null.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
451
Unavailable for Legal Reasons Error