Skip to main content
POST
Create Funding Withdrawal

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

API-Nonce
string
header
required

The "API-Nonce" header should contain an always-increasing 64-bit integer, most commonly a Unix timestamp in milliseconds. Each request must use a nonce greater than the nonce of the previous request signed with the same API key.

Query Parameters

account_id
string

Account ID

Body

application/json
scope
method_id · object
required
address_id
string
required

Unique identifier of the address to withdraw to.

Pattern: ^AB[a-zA-Z0-9]{5}-[a-zA-Z0-9]{5}-[a-zA-Z0-9]{6}$
amount
object
required

Amount to withdraw.

fee
current_fee · object

Fee options for the withdrawal.

expected_address
string

Crypto address used to validate the withdrawal destination. Must match the address stored for address_id.

Minimum string length: 1

Response

200 - application/json
withdrawal_id
string
required

Unique identifier of the withdrawal.

Pattern: ^[Ff][Tt][a-zA-Z0-9]{5}-[a-zA-Z0-9]{22}$
net_amount
object
required

Amount sent after fees.

gross_amount
object
required

Total amount deducted, including fees.

fee
object
required

Fee charged for the withdrawal.

approval_request_id
string

Set when the withdrawal needs to be approved before it is processed. It is parked until the request is granted, and cancelled if it is not.