Fund

Withdraw organization funds

Changed on

Creates a withdrawal. Requires fund.withdraw permission.

request_id is optional. When supplied, it must be a UUID and acts as the idempotency key. When the same merchant retries with the same request_id, the API returns the previously created withdrawal information with is_duplicate=true.

source_currency is optional and defaults to token_type. Set it to USD to deduct from the organization's USD Cash Account when withdrawing USDT or USDC. Other cross-currency pairs are rejected.

post/withdraw

Request

Headers

X-API-Key-IDstring required

32-character Base58 credential ID returned after public-key registration.

X-API-Timestampstring required

Unix timestamp in seconds; tolerance is ±300 seconds.

X-API-Noncestring required

16 cryptographically random bytes encoded as unpadded Base64URL; fresh on every attempt.

Digeststring required

SHA-256= followed by standard padded Base64 of SHA-256 of exact request body bytes. Required even for an empty body; included in the signing string.

Authorizationstring required

Use Ed25519 signature="BASE64_SIGNATURE", where BASE64_SIGNATURE is the standard padded Base64 signature. See /docs/en/4-authorization for the exact signing string.

Request body

request_idstring uuid

Optional idempotency key. Must be a UUID when supplied.

chainstring required

Public chain name. Use a currently enabled pair returned by the withdrawal fees endpoint.

token_typestring required

Token type. Use a currently enabled pair returned by the withdrawal fees endpoint.

source_currencystring

Source account currency. Defaults to token_type. Set to USD to deduct from the organization's USD Cash Account when withdrawing USDT or USDC; other cross-currency pairs are rejected.

amountstring required

Maximum amount deducted from the source account. Digits after the sixth decimal place are truncated without rounding; when source_currency is USD, at most two decimal places are allowed. The resulting amount must be at least 1 and greater than the applicable fees.

wallet_addressstring required

Destination wallet address valid for the selected chain.

notestring

Optional withdrawal note.

Example request

{
  "request_id": "e94b4e88-36c2-4550-907e-839742cf5fae",
  "chain": "ETHEREUM",
  "token_type": "USDT",
  "source_currency": "USD",
  "amount": "10.00",
  "wallet_address": "0x5f716e5775b18409917e2a2f0762d29d6c385cb0",
  "note": "Treasury withdrawal"
}

Response

Standard response envelope

OR

Example response

{
  "data": {
    "request_id": "e94b4e88-36c2-4550-907e-839742cf5fae",
    "status": "pending"
  }
}

Changes

    • breaking

      added the new required header request parameter X-API-Key-ID

    • breaking

      added the new required header request parameter X-API-Nonce

    • breaking

      added the new required header request parameter X-API-Timestamp

    • breaking

      the header request parameter Authorization became required

    • breaking

      the header request parameter Digest became required

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • warning

      deleted the header request parameter Date

    • info

      added the new optional request property