The withdraw session object

Speed’s Withdraw Session allows you to send a defined amount in a specific currency (converted to equivalent SATS by the system) to your customers for an indefinite time period.

Withdraw session automatically generates a new withdraw request upon the expiration of the Time-To-Live (TTL) period. Withdraw session ensures that the latest exchange rate is applied to the new withdraw request, enabling adjustments to the withdraw amount based on the current exchange rates.

    "id": "ws_live_xxxxxxxxxxxxx",
    "object": "withdraw_session",
    "status": "active",
    "url": "",
    "amount": 1,
    "currency": "USD",
    "target_currency": "SATS",
    "ttl": 600,
    "withdraw_request_type": "lnurl",
    "statement_descriptor": null,
    "description": null,
    "success_url": null,
    "cancel_url": null,
    "success_message": null,
    "withdraw_request": null,
    "amount_paid": null,
    "target_amount_paid": null,
    "exchange_rate": null,
    "withdraws": [],
    "api_version": "2022-10-15",
    "created": 1702873288259,
    "modified": 1702873288259


id string
Unique identifier for the object.

object string
The type of the object indicates to which entity this response belongs.

status enum
A withdraw object can have 4 statuses as mentioned below.

  • active
  • The withdraw object has active status after its generation until it is paid..
  • paid
  • The withdraw object is marked paid once your customer receives the withdraw amount.
  • deactivated
  • One can manually deactivate the withdraw session if it is not required.

url string
The public URL that can be shared with customers to withdraw payments.

amount string
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 of up to 16 digits.

currency string
Your preferred currency (base currency) in which you want to create a withdraw session.

target_currency string
The cryptocurrency in which you want to send funds to your customer. As of now, Speed only supports SATS.

ttl integer
Represents the time duration until which the withdraw session does not expire. (Specified in seconds).

withdraw_request_type string
This indicates the type of withdrawal request.

statement_descriptor string
Additional information about the withdraw session made to an account.

withdraw_request string
This specifies the LNURL or the On-chain address used.

amount_paid BigDecimal
Once the withdraw session is paid, this returns the amount transferred in the target_currency.

target_amount_paid BigDecimal
Once the withdraw session is paid, this returns the exact amount transferred in the target_currency.

exchange_rate BigDecimal
The exchange rate is used to convert the currency(base currency) into target_currency.

created timestamp
Time at which the withdraw session object was created.

modified timestamp
Time at which the last modification was made.