Request Withdrawal

post

https://api.testnet.octet.im/2.0/wallets/{walletIdx}/withdrawals

Requests a withdrawal from an address in the wallet. Withdrawals can be made from the main address, child addresses, and the fee address; in Centralized type (CENTRALIZED) wallets, withdrawals from child addresses are not allowed. Returns the uuid of the withdrawal transaction upon success.

For a withdrawal from an address that uses MPC key management, request signing from the MPC agent installed on your server using the mpc information (token, mpcSigningTargets) in the response. If MPC signing is not completed within 2 minutes (120 seconds; see mpc.expiredDate in the response for the exact time) of the request, the signing request expires (EXPIRED) and the withdrawal fails (FAILED). An expired withdrawal fails without a cancellation request, so request a new withdrawal to retry.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

walletIdx

number

required

Wallet index

Body Params

symbol

string

required

Symbol of the asset to withdraw. Enter it in English characters; it is not case-sensitive.

contractAddress

string

Contract address of the token. Required when withdrawing a token rather than a coin.

requestId

string

required

Unique ID you can assign to the withdrawal request. The request fails if a withdrawal with the same requestId already exists.

amount

string

required

Withdrawal amount

senderAddress

string

required

Sending address. Must be an address in the wallet.

receiverAddress

string

required

Receiving address.
On Ethereum- and Kaia-based platforms, the address must start with 0x and be either all lowercase or checksummed.

receiverMemo

string

Memo for the withdrawal transaction. Use only on platforms that require a memo for transfers, such as EOS and Ripple.

description

string

Description of the withdrawal that you can enter when requesting it. It is recorded only in the Octet database, not on the blockchain.

useFeeDelegation

boolean

Whether to create a fee delegation transaction. If true, the fee address of the wallet pays the transaction fee. Applies only to platforms that support fee delegation (e.g., Kaia); fee delegation is not applied when the sending address is the fee address.

string

PIN of the sending address. Required if the sending address is a child address that uses a PIN.

encryptedUserKey

string

User key encrypted with the RSA public key. Required if the following condition is met:

The key management type of 'senderAddress' is co-managed.

(Not required if 'autoSigning' is set to false.)

You can find the RSA public key under [Developer Tools] in the Octet console.

autoSigning

boolean

Whether Octet signs and broadcasts the transaction automatically. Behaves as follows depending on the key management type of senderAddress.

Co-managed: Defaults to true. If omitted or set to true, Octet handles everything from transaction creation to signing and broadcasting. If set to false, Octet only creates the transaction and you must sign it yourself. After signing, complete the withdrawal through the 'Register Signed Withdrawal Transaction API'. While the withdrawal status is AWAITING_SIGNING, you can get serializedUnsignedTransaction through the 'Get Withdrawal Request Information API'.
MPC: Must be set to false. After requesting the withdrawal, sign using the MPC information included in the response.

serializedUnsignedTransaction

string

Transaction data to be signed, serialized as a hexadecimal string.

Required for the MPC key management type.

See the Transaction Build Guide for how to build this value yourself, with example code and the supported transaction types and restrictions for each platform.

Headers

Authorization

string

required

Defaults to Bearer

API token

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success