As a user, you need to create a withdraw request if you intend to send payment to your customers. When you create the withdraw request, system provides you a payload (LNURL) which you can then share with your customers or you can create a QR code out of it.
Your customers can then either paste the URL into their wallet or scan the QR code to receive the amount specified by you only once.
{
"id": "wr_xxxxxxxxxxxxx",
"object": "withdraw_request",
"status": "active",
"min_amount": 10,
"max_amount": 10,
"currency": "SATS",
"target_currency": "SATS",
"exchange_rate": 1,
"ttl": 190,
"expires_at": 1702628098583,
"target_min_amount": 10,
"target_max_amount": 10,
"type": "lnurl",
"withdraw_request": "lnurl1dp68gurn8ghj7ctswpshq6fww3e8jumsv4jkgtnyv4mz7mrww4exc0m385ckxe3hvvurjdr9xqcxxc3sxqerjde3xenrvc3hxs6ryveevyunxcmrvg6nzvp5xumnxe3evvukzvpcxyurse33xa3kxv35v93xxefkabcd",
"statement_descriptor": null,
"created": 1702627908583,
"modified": 1702627908583
}
Attributes
id string
Unique identifier for the object.
object string
The type of the object indicates to which entity this response belongs.
status varchar(100)
The withdraw request can have three statuses, as mentioned below.
- active
- The withdraw request has an active status after its generation until it is paid or deactivated.
- paid
- The request will be marked as paid once your customer receives the payment.
- deactivated
- You can manually deactivate a withdraw request if you no longer wish to send the payment via it.
min_amount Decimal
This is the minimum amount that your customer can receive.
max_amount Decimal
This is the maximum amount that your customer can receive.
currency string
The base currency in which you prefer to work.
target_currency string
The cryptocurrency in which you want to send funds to your customer. As of now, Speed only supports SATS.
exchange_rate BigDecimal
The exchange rate is used to convert the currency (base currency) into the target currency.
ttl integer
Represents the time duration until which the withdraw request does not expire. (Specified in seconds). You can manually add the expiration time in seconds. The minimum time limit is 180 seconds, and the maximum is 1 year. The default is set at 600 seconds.
expires_at timestamp
Time at which the withdraw request expires.
target_min_amount decimal
This shows the minimum amount, after conversion from the base currency, that your customer can receive in SATS.
target_max_amount decimal
This shows the maximum amount, after conversion from the base currency, that your customer can receive in SATS.
type varchar
This indicates the type of withdrawal request. It will be only lnurl.
withdraw_request string
This specifies the LNURL for the withdraw request created .
statement_descriptor string
Additional information about the withdraw request made to an account.
created timestamp
Time at which the withdraw request object was created.
modified timestamp
Time at which the last modification was made.