The payment link object

A payment link is a shareable URL that can be used to take multiple payment on same link. A payment link can be shared and used multiple times to accept payment from your customers. You can create a payment link in your preferred base currency to be paid in cryptocurrency supported by the Speed platform API (currently SATS).

When a customer visits the payment link URL, it will open a new checkout session rendering a payment page with information such as payment QR code and branding details. Upon receiving the funds either through on-chain or lightning network payment methods, the status of the payment associated with that checkout session changes to paid. To ensure that you can receive both on-chain and lightning payments, remember to keep the “BTC On-chain” payment method enabled in payment methods in Speed web application.

You can use these checkout sessions to track payments through the payment links.

  "id": "plink_xxxxxxxxxxxxxxxxxxxxxxx",
  "object": "",
  "livemode": false,
  "status": "active",
  "url": "",
  "currency": null,
  "amount": null,
  "target_currency": null,
  "statement_descriptor": null,
  "success_url": "",
  "success_message": "Thank you for the payment",
  "title": "Donation",
  "title_description": "Joy of giving",
  "title_image": "",
  "metadata": {
    "key_1": "value_1",
    "key_2": "value_2"
  "cashback": {
    "id": "cb_xxxxxxxxxxxxxxxxx"
  "created": null,
  "modified": null

id string
Unique identifier for the object.

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

livemode boolean
If the object is in live mode, it has the value true; otherwise, it has the value false.

status string
A payment link can have 2 statuses as mentioned below.

  • active
  • Upon generation, by default, it will be active until deactivated.
  • deactivated
  • You can manually deactivate a payment link when you don't intend to get paid via it.

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

currency string
Your preferred currency (base currency) in which you want to create a payment link.

amount BigDecimal
Total amount for which the payment link was created. Values up to 32 digits can be handled by the amount param, which can have a decimal precision of up to 16 digits.

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

statement_descriptor string
Additional information about a payment made to an account via this payment link.

success_url string
If the payment is successful, the customer will be redirected to this URL.

success_message string
Message customers will see when they make payment via their wallet. Success_url and success-message are mutually exclusive request parameters—only one of them can be used.

title string
This attribute represents the header or title of the payment page.

title_description string
This attribute represents additional information about your payment page.

title_image string
Represents a public URL consisting of an image illustrating the purpose of a payment page along with the title and description.

Users won't see the image on payment page if the image path is removed or deleted after the payment link is created.

metadata object
You can use this to store additional information about the object in a structured format.

cashback object
You can use this parameter to associate an active cashback with a payment link.

  • id string
  • Unique identifier for the cashback object.

created timestamp
Time at which the payment link was created.

modified timestamp
Time at which the last modification was made.