Create a withdraw session

Unique withdrawal sessions direct your customers to a dedicated withdrawal page where they can scan a QR code to receive SATS in their wallets.

Body Params
string
required

This is the total amount you intend to send to your customer via withdraw. Please add a positive value. Values up to 32 digits can be handled by the amount param, which can have a decimal precision up to 16 digits.

string
required

In this parameter, you must specify your preferred base currency (fiat or cryptocurrency) to create a withdraw session. A three-lettered ISO-compliant currency name must be used.

string

Using this parameter, you can protect your withdraw session using a password, which your customer have to enter while receiving the amount.

Response

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Questions? Contact us