Overview
Develop advanced custom checkout experiences.
Tebex Checkout API is designed to allow our creators to use Tebex payment acceptance capabilities without the need to set up a Tebex-powered webstore.
You must receive prior authorisation before the Checkout API is enabled on your account. Please contact customer support or your account manager to discover if you qualify to use the Checkout API before beginning integration.
Terminology
Term | Description |
---|---|
Basket | To start a transaction, a basket must be created. The basket, similar to a standard eCommerce basket will contain the items that the customer is purchasing |
Ident | A string identifier representing the basket |
Checkout API Flow
Below is the expected flow your application should follow when implementing the Checkout API. This should be considered a general guideline. For a full list of endpoints available, see the Endpoints page.
You have two options for implementing Checkout API. We include a Checkout request where all data about the customer and their desired packages can be provided in one request.
Option 1. Using the Checkout Request
If your app has existing basket functionality, we recommend using a Checkout request. You can send the details of your customer, basket, and sale information all in one request:
Option 2. Using the Tebex Basket
If you do not have existing basket functionality in your app, you can use the Checkout API to fully manage the customer's basket on Tebex:
Create a basket for the customer.
Your app should save the
ident
value for reference later, as this is the identifier for this customer's basket.
Add or remove packages from the customer's basket as desired.
Add any desired sales / discounts to the basket
Direct the user to the basket's
links.checkout
URL in order to complete payment.
After payment is complete, you may verify payment if you wish by checking the
links.payment
URL associated with the customer's basket.
Recurring Payments
Tebex Checkout supports recurring payments in addition to single, one-time payments. Below are the endpoints you can use for managing a customer's recurring payments.
OpenAPI Schema and SDKs
Tebex Checkout is documented with OpenAPI. To view the schema and available SDKs, see our releases on GitHub.
Postman Schema
An importable Postman collection can always be downloaded from Tebex Checkout's repository on GitHub.
Examples
The following websites are integrated using the Checkout API.
Last updated