Create a checkout link

post

https://api.tryspeed.com/checkout-links

The checkout link generates a shareable URL that directs your customer to a payment page where they can make a one-time on-chain, ethereum, solana, tron or lightning payment. You can request a checkout link in your preferred base currency in order to be paid in target cryptocurrency supported by the Speed platform API.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

currency

string

required

Defaults to USD

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

amount

string

required

Defaults to 100

This is the total amount you intend to collect from the customer via the checkout link.

customer_collections_status

object

Use this parameter if you wish to collect the below mentioned options from the customer.

custom_fields

array of objects

You can use this parameter to collect specific information from users while they are on payment page.

custom_fields

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.

metadata

json

Defaults to { "key_1": "value_1", "key_2": "value_2" }

You can use this to store additional information about the object in a structured format. In this parameter, you can add up to 50 key-value pairs in a raw JSON format.

cashback

object

Use this parameter to associate an active cashback with a checkout link.

title

string

You can use this parameter to add the header or title to your payment page.

title_description

string

You can use this parameter to provide a brief description of your payment page.

title_image

string

You can include a related image illustrating the purpose of a payment page along with the title and description. Image size must not be more than 2 MB.

Headers

speed-version

string

enum

Defaults to 2022-04-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

200200