Speed platform API brings you a range of core resources that you can integrate into your product such as checkout links, payments, payment link and many others. You can request a checkout link in your preferred base currency, in order to be paid in cryptocurrency supported by the Speed platform API (currently SATS & BTC).
Checkout link API calls checkout session API to create a checkout link URL, which is used to accept one-time full payment until they are fully paid or deactivated. Checkout links are unique URLs that take your customer to a payment page. When a customer visits the checkout link URL, the payment page API is invoked in the background, which provides information such as payment QR code(BTC and lightning) and branding details. When you receive the full payment, the checkout link status changes to paid.
{
"id": "clink_xxxxxxxxxxxxxxxxxxx",
"object": "checkout.link",
"livemode": true,
"payment_id": [
"pi_xxxxxxxxxxxxxxxx",
"pi_xxxxxxxxxxxxxxxx",
"pi_xxxxxxxxxxxxxxxxxx"
],
"status": "active",
"url": null,
"currency": "USD",
"amount": 2000,
"target_currency": "SATS",
"statement_descriptor": null,
"created": 1652694517273,
"modified": 1652694517273
}
Attributes
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.
payment_id array of strings
Each payment made through a checkout link will have associated payment_ids. This is an array containing either a list of partial payment ids or a single payment_id.
status string
A Checkout link can have 3 statuses as mentioned below,
active
The checkout link is active after its generation until it is paid.
paid
The checkout link is already used and paid.
deactivated
You can manually deactivate a checkout link if it is not required.
url string
The public URL that can be shared with customers to receive payments.
currency string
The base currency in which you prefer to work.
amount BigDecimal
Total amount for which the checkout link was created. Values up to 32 digits can be handled by the amount param, which can have a decimal precision up to 16 digits.
target_currency string
The cryptocurrency in which you want to receive payment from you customer. As of now, Speed only supports SATS.
statement_descriptor string
Additional information about a payment made to an account via this checkout link.
created timestamp
Time at which the checkout link was created.
modified timestamp
Time at which the last modification was made.