Sign in

v1

latestOpenAPI 3.0.02026-07-2613985.6 KB
Withdrawal

Withdraw BTC

Make an instant withdrawal from a cryptocurrency balance.

post/crypto/withdrawal_instant

Headers

X-Processing-Signaturestring required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Request body

sender_currencystring required

Currency to withdraw. For a list of all available currencies, see API currency codes.

sender_amountnumber required

Amount to withdraw in sender_currency.

addressstring required

Cryptocurrency address where you want to send funds.

{"stackTrail":"paths:/crypto/withdrawal_instant:post:requestBody:content:application/json:schema:properties:foreign_id","oasType":"schema","type":"unknown","description":"Unique ID of the withdrawal request."}
end_user_referencestring required

Persistent internal ID of the merchant's customer who initiates the withdrawal. Use the same value for the same customer across all requests. This value must refer to the same customer described in sender_data.

Do not include personal data, such as the customer's name or email address. Put personal details in sender_data.

sender_type'natural' | 'legal' required

Type of the merchant's customer who initiates the withdrawal. The sender must be the same customer identified by end_user_reference.

Use natural if the sender is an individual person and legal if the sender is a legal entity. The selected type determines which fields must be included in sender_data.

receiver_type'natural' | 'legal' | 'self' required

Type of the withdrawal recipient.

Use natural if the recipient is an individual person, legal if the recipient is a legal entity, or self if the recipient is the same person or legal entity as the sender.

The selected type determines whether receiver_data is required and which fields it must contain.

Response

Created