v1

latestOpenAPI 3.0.02026-07-2613985.6 KB
Withdrawal

Withdraw crypto

Withdraw in crypto to any address.

post/withdrawal/crypto

Headers

X-Processing-Signaturestring required

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

Request body

currencystring required

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

convert_tostring

Target currency to convert funds into before sending. If omitted, funds are sent in the source currency without conversion.

amountnumber required

Amount to withdraw in the source currency. You can only specify either amount_to or amount.

amount_tonumber

Amount to send in the convert_to currency. Use this field when you want to convert funds and send a specific amount in the target currency set in convert_to. You can only specify either amount_to or amount.

addressstring required

Cryptocurrency address where you want to send funds.

tagstring

Tag/memo for currencies and destination wallets that support or require it. On withdrawal forms, display this field to the user, but allow it to be empty because some wallets do not require a tag/memo. Warn the user that if the destination wallet requires a tag/memo and it is not provided, the funds may be lost.

{"stackTrail":"paths:/withdrawal/crypto: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