API Reference

The Relinx API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL https://api.relinx.io/v1

Authentication

Authenticate your account by including your secret API key in the request. You can manage your API keys in the Dashboard.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

curl https://api.relinx.io/v1/products \
  -u sk_live_Relinx882:

POST

Create Order

Creates a new order for a gift card or top-up service. The response will include a payment address.

Parameters

product_id string REQUIRED

The unique identifier of the product (e.g., jd_e_card_100). Retrieve available IDs from the Products endpoint.
amount integer

Quantity of the product. Defaults to 1.
callback_url string

The HTTPS URL where the webhook events should be sent upon status change.