Skip to main content

Execute Crypto Withdraw

Deprecated

This endpoint is deprecated. Use POST /v3/crypto/withdrawals. It keeps working for now, and its responses carry Deprecation: true and a Link header naming the v3 page; BlockWyre will tell you the date before it stops, from when it answers 410 Gone. See Crypto v3.

This endpoint executes a crypto withdrawal transaction. Funds will be sent to the specified beneficiary address.

Technical Details​

  • Grace Period: All withdrawals are subject to a 5-minute grace period. During this time, the transaction remains in pending status and can be cancelled.
  • Processing: After the grace period expires, the transaction is automatically picked up for processing and sent to the blockchain.
  • Webhooks: This operation triggers the crypto_transaction_created webhook.
Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

POST

/api/v2/crypto/withdraw

Request Body Sample​

{
"accountId": "00000000-0000-0000-0000-000000000000",
"beneficiaryId": "00000000-0000-0000-0000-000000000000",
"coin": "BTC",
"amount": "0.0001",
"description": "Withdrawal to my wallet",
"previewId": "00000000-0000-0000-0000-000000000000",
"reference": "client-reference-123"
}

Request Body Schema​

FieldTypeDescription
accountIduuidRequired. The account ID to withdraw from.
beneficiaryIduuidRequired. The beneficiary ID to withdraw to.
coinstringRequired. The coin to withdraw (e.g., BTC).
amountdecimalRequired. The amount to withdraw, greater than zero.
descriptionstringOptional. The description of the withdrawal.
previewIduuidOptional. Preview ID from the preview response.
referencestringRequired. Your own reference for the withdrawal, 1 to 255 characters.

Response Sample​

{
"transactionId": "00000000-0000-0000-0000-000000000000"
}

Errors​

StatusMessageMeaning
400account_id_requiredThe request names no account: a workspace-scoped key must send accountId.
403account_frozenThe account is frozen or blocked.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!