Withdraw Funds

POST 
/private/Withdraw

Make a withdrawal request.

API Key Permissions Required: Funds permissions - Withdraw

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

asset stringrequired

Asset being withdrawn

key stringrequired

Withdrawal key name, as set up on your account

address string

Optional, crypto address that can be used to confirm address matches key (will return Invalid withdrawal address error if different)

amount stringrequired

Amount to be withdrawn

max_fee string

Optional, if the processed withdrawal fee is higher than max_fee, withdrawal will fail with EFunding:Max fee exceeded

Responses

200

Withdrawal created.

application/json

Schema

Schema

result object

refid string

Reference ID

error string[]

Example (from schema)

{
  "error": [],
  "result": {
    "refid": "FTQcuak-V6Za8qrWnhzTx67yYHz8Tg"
  }
}

Loading...