Create a withdrawal link

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

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

double
required

The total amount that you intend to send your customer.

string

When the withdrawal is successful, you can use this parameter to redirect the customer to the hosted page.

string

You can use this parameter to protect your withdrawal link using a password. It means, your customers need to enter this password set by you to access the QR code, allowing them to scan and receive SATS in their wallet. Password length must be between 8 to 20 characters.

string

You can use this parameter to provide the email of the customer with whom you want to share the withdrawal link.

string

You can add the name of the customer with whom you are sharing the withdrawal link. The name can only be added if an email has been entered; otherwise, the API will return an error.

Headers
string
enum
Defaults to 2022-10-15

In this parameter, you can specify the version you want. As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports on-chain, lightning, Ethereum, Solana and Tron payment methods. Whereas the 2022-04-15 version only supports lightning payments.

Allowed:
Response

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

Questions? Contact us