Request Withdrawal

post

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

Requests withdrawal from the address that belongs to the wallet. Withdrawals from the main address, child address, and fee address are available. When it is a custodial wallet, withdrawal from the child address is not available. uuid of the withdrawal transaction will be returned upon successful request.

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 be withdrawn. Symbols must be entered in English and are not case-sensitive.

contractAddress

string

Token contract address. For tokens, not coins, this must be entered.

requestId

string

required

Unique ID available to enter for withdrawal request. The request will fail when there is a duplicate requestId exists in the request.

amount

string

required

Withdrawal amount

senderAddress

string

required

Sending address. This must be an address in the wallet.

receiverAddress

string

required

Receiving Address. For Ethereum or Kaia-type platforms, the prefix is ‘0x’, and only lowercase addresses and checksum addresses are available.

receiverMemo

string

Withdrawal transaction memo. Use this only when a memo is required to transfer, such as EOS or Ripple.

description

string

Description of the withdrawal that can be entered when requesting a withdrawal. This does not involve blockchains and is recorded in Octet’s database.

useFeeDelegation

boolean

Decide whether to generate fee delegation transactions. When it is set to true, the wallet’s fee address will pay the fees of transactions. This only applies to the platforms that support fee delegation (e.g., Kaia), and when the sending address is a fee address, the payment will not be made.

string

Sending address PIN. This must be entered when the sending address is a child address using a PIN.

encryptedUserKey

string

Result of the user key being encrypted with the RSA public key. This must be entered when the key management method is joint management and the sending address is the main address. however, It is not necessary, if autoSigning is false. You can check RSA public key from the developer tool of the Octet console.

autoSigning

boolean

Decide whether to automatically complete transaction signing and propagation. This option is only available when senderAddress is the representative address and the wallet's key management is co-management. By default, it is set to true, so if this field is not used or set to true, transaction creation, signing, and propagation will be handled automatically. If set to false, only transaction creation will proceed, and the customer must sign the created transaction manually. Once signed, the serializedSignedTransaction can be set to withdraw via the signed withdrawal transaction transmission API. If the withdrawal status is AWAITING_SIGNING, you can check the serializedUnsignedTransaction through the withdrawal information retrieval API.

Headers

Authorization

string

required

Defaults to Bearer

API token

Response

201Success