Skip to main content

Withdraw

Withdraws ETH or a currency token from the specified node wallet to a target address. This call is asynchronous — the handler creates a WithdrawType (1) node transaction and returns HTTP 204 immediately. The funds settle only once the wallet pipeline confirms the on-chain transfer. Poll Get Node Transactions for the most-recent WithdrawType row until its status reaches Done (3) or Error (4).

Request

POST /v2/admin/nodes/{nodeID}/withdraw

Parameters

NameTypeInDescription
nodeIDstringpathRequired. The ID of the node to withdraw from

Headers

NameDescription
Content-Typeapplication/json
AuthorizationRequired. Bearer token for authentication

Body (JSON)

FieldTypeRequiredDescription
currency_token_idstring or nullNoCurrency Token ID to withdraw. Use null to withdraw native coin (e.g., ETH)
addressstringYesRecipient wallet address
amountnumberYesAmount to withdraw

Example

curl --location 'http://localhost:3453/v2/admin/nodes/665ae536a6392b75cfd40352/withdraw' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"currency_token_id": null,
"address": "0xa112983907944387B64ba512daF256B3f28f93f5",
"amount": 0.01
}'

Response

  • Status: 204 No Content
  • Body: none

Status Codes

Status CodeDescription
204No Content - Withdrawal accepted
400Bad Request - Invalid input
401Unauthorized - Invalid or missing authentication token
404Not Found - Node does not exist
500Internal Server Error