API ReferencePayments

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.

Authentication

x-api-keystring
API Key authentication via header

Request

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

Response

Withdrawal created
withdrawalIdstring
customerIdstring
mintIdinteger
amountstring
toAddressstring

Errors

400
Bad Request Error
401
Unauthorized Error
451
Unavailable for Legal Reasons Error