withdraw
Submit irreversible crypto transfers (confirm required) or retrieve transfer history. Choose submit to send funds out, records to view past activity.
Instructions
[VERB] Withdrawals by intent: submit (send funds out — irreversible, needs confirm) | records (withdrawal history).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Address Tag This is required for withdrawals of certain cryptocurrencies, like EOS. | |
| coin | No | Coin to withdraw, e.g. USDT. | |
| size | No | Withdrawal Quantity Special Notes for Bitcoin Lightning Network Withdrawals： This parameter must exactly match the amount on the Bitcoin Lightning Network deposit invoice; The withdrawal quantity for Bitcoin Lightning Network represents the amount received, excluding fees; The quantity precision can be obtained via the "Get Currency Information" API | |
| view | No | summary (default) trims null fields to save tokens; full returns the untouched payload. | |
| chain | No | Chain/network for the withdrawal. | |
| limit | No | Items per page The default value is 20, and the maximum value is 100. | |
| action | Yes | What to do — submit: submit a withdrawal (irreversible) (needs: coin, transferType, address, size) | records: withdrawal history (needs: startTime, endTime). | |
| amount | No | Amount to withdraw. | |
| cursor | No | Cursor ID - Used for pagination to reduce query response time - Do not send for the initial query. When querying the second page and subsequent data, use the smallest orderId returned from the previous query. The results will return data less than that value | |
| dryRun | No | Preview a write without sending it. | |
| fields | No | Optional list (array or comma-separated string) of fields to keep on each returned row. | |
| remark | No | Remark | |
| address | No | Destination address. | |
| confirm | No | Required to execute destructive (high-risk) writes; without it such a call returns { confirmationRequired: true }. | |
| endTime | No | Query record end time<ul><li>Unix millisecond timestamp, e.g., 1690196141868</li></ul> | |
| orderId | No | order ID - Either clientOid or orderId must be provided. If both are present or do not match, orderId will take priority | |
| areaCode | No | Area Code This parameter is required when innerToType = mobile | |
| fetchAll | No | Paged reads only: walk the cursor to bounded completion (returns { items, pages, truncated }). | |
| lastName | No | Last Name Fill in this parameter when identity=user | |
| clientOid | No | Idempotency key. Auto-generated for `submit` when omitted (P7). | |
| firstName | No | First Name Fill in this parameter when identity=user | |
| startTime | No | Query record start time<ul><li>Unix millisecond timestamp, e.g., 1690196141868</li></ul> | |
| memberCode | No | Member Code bithumb korbit coinone | |
| companyName | No | Company Name Fill in this parameter when identity=company | |
| innerToType | No | Internal Withdrawal Address Type uidUser ID email Email mobile Mobile phone number - If not filled, the default value is uid | |
| identityType | No | Identity Type companyInstitutional Company user Individual User | |
| transferType | No | Withdrawal Type on_chainOn-chain deposit internal_transferInternal transfer |