1 of 73

Developers

Welcome

Learn how to integrate Tebex and leave the complexities of monetization to us.

Welcome to the Tebex developer documentation. If you're new, start with our quick start guide or explore one of our products below. If you need assistance during the integration process, don’t hesitate to reach out - we’re here to help.

Getting Started

Get started integrating Tebex into your website or game

Welcome to your journey of launching your first project with Tebex! This guide will walk you through the essential steps to create, set up, and launch your store, ensuring a seamless experience for your customers. From building your first project in the creator panel to implementing automatic product delivery, we'll cover everything you need to know to get started.

Create a project

Head over to the creator panel and kick things off by creating your first project.

Setup your store or integrate our APIs

Check out the docs for the integration method you’re going with. If needed, build the APIs into your website or game.

Create your packages

If your integration method requires it, create the packages your customers can buy.

Implement product delivery

Make sure your customers get their packages right away after they’ve made a purchase. For game studios, webhooks or license keys (like Steam keys) are the way to go. If you’re monetizing a game server, don’t forget to check out our official plugins for that.

Make a test payment

Before going live, give everything a test run by going through the checkout process using the test payment method. Don’t worry, no real money needed here!

Submit for review

Ready to roll? Submit your project for review by our Content & Safety team. We’ll give it a quick check, and if everything looks good, you’ll be ready to launch within a day.

Go live

Integration Methods

Learn which integration method is best for you

Tebex offers multiple integration options tailored to meet different business needs, each equipped with unique features for specific use cases.

There are three integration methods available, as highlighted below. Each method varies in complexity, with the Webstore Builder being the easiest to get started with.

Checkout: Maximize revenue by utilizing Tebex’s global Merchant of Record platform. With over 100 payment methods, Tebex handles the entire checkout process, offering chargeback protection, fraud monitoring, 14-day payouts, and international sales tax coverage.

Package Management: Effortlessly set up and manage packages for sale on your project through the creator panel. You can organize packages into categories and easily define details such as names, descriptions, pricing, and images. You're also able to invite other team members to manage these too.

Hosted Webstore: Tebex provides a customizable webstore that allows you to start selling in minutes. This enables you to focus on your business, while we handle the hosting infrastructure & technical requirements for you.

Which integration method is best for me?

Take a look at the example scenarios below to get a better understanding of which integration method is best for you. Whatever you choose, all of our integration methods come with access to over 100 payment methods, international sales tax coverage, fraud protection, webhooks, and seamless inline checkout through Tebex.js.

I want to sell packages via a pre-built webstore that's hosted for me

If you're looking for a pre-built, hosted webstore, we recommend using the Tebex Webstore Builder. This tool offers comprehensive package management through the Tebex creator panel, a fully customizable webstore displaying all your available packages, and a built-in add-to-cart feature. Webstores are seamlessly integrated with Tebex.js, our inline checkout solution. To see an example of a webstore created with the Webstore Builder, visit example.tebex.io.

I want to sell packages from my own website or in-game

If you want to sell packages directly through your own website or in-game, while managing package creation, updates, and configuration via Tebex, the Headless API is the ideal solution. By integrating the Headless API with Tebex.js, you can offer a seamless checkout experience, allowing customers to make purchases without leaving your site.

I want to sell packages that are dynamic in nature

If your packages require a high level of customization for each customer and cannot be created within the Tebex creator panel, the Checkout API is the ideal solution. For example, this could apply to packages with varying names, descriptions, pricing, or images tailored to individual customers. By integrating the Checkout API with Tebex.js, you can provide a smooth purchasing experience, allowing customers to complete transactions without leaving your website.

I want to sell hundreds or thousands of packages through my own backend system

If you manage a large volume of packages that would be impractical to create manually in the Tebex creator panel, or if your package offerings update based on your internal inventory system, the Checkout API is the optimal solution. By integrating the Checkout API with Tebex.js, you can offer a seamless purchasing experience, allowing customers to complete transactions without leaving your website.

I want to sell physical goods or launch a marketplace

Tebex cannot support projects that aim to sell physical goods or provide marketplace services. If you are looking to pursue either of these options, we regret to inform you that we cannot collaborate in this capacity, and you will need to seek a payment partner elsewhere.

Let's begin!

Now that you've chosen your integration method, you can begin by exploring the relevant documentation:

Learn how to design your own store using the Webstore Builder.
Sell packages directly from your website or in-game with the Headless API.
For more complex integrations, get started with the Checkout API.

SDKs

Tebex offers many different ways to integrate with your existing infrastructure.

Official SDKs

The SDKs below include support for Headless API, Checkout API, and Webhooks, complete with examples, making implementation of these APIs into your project as easy as possible.

OpenAPI Schema

Tebex APIs are documented using OpenAPI. These are used to generate our Endpoints documentation. Our schemas are available at the GitHub repositories below. The OpenAPI Generator can be used to generate an SDK in the language of your choice if we do not have your language available.

Other SDKs / Integration Options

Below are additional resources and projects that can help you implement Tebex into your project. If you've developed an SDK, please reach out to us at tebex-integrations@overwolf.com.

Webstore Builder

Overview

Customise your store to match your games brand using our Webstore Builder.

The Webstore Builder enables you to fully customise the design of your store using templates & themes, providing your customers with a seamless transition from your existing website when they're making a purchase.

If you haven't already done so, we recommend having a read of our quick start guide before continuing.

With the webstore builder, you can:

Use templates to change the HTML structure of each page and implement conditional logic via the TWIG templating engine.
Upload custom CSS, Javascript and images via Assets.
If you're a template designer, you can offer your customers the ability to customise their templates via Config Schema, and you're also eligible for free Plus via our Developer Plan.

Examples

Browse examples of other Tebex stores for some inspiration.

Certified Tebex Designers

If you're a designer who creates templates for others, either for free or to sell, let us know! We'll add you to the certified Tebex designers club. You'll gain access to insider help guides, a private community of other designers, feedback sessions with the Tebex product team, and also BETA features that are not yet available to others.

Feedback

If there are any functions, tags, filters or variables that you need to use in your template, but they're not available or documented, please let us know.

Getting Started

To create your first template, head over to the Appearance section within your creator panel.

Getting Started

The best way to understand the functionality of the Tebex templating engine is to create a copy of our default template, named Exo.

You can do this by navigating to Webstore -> Appearance in your control panel and creating a custom template based on Exo.

For a live demonstration of Exo in action, visit example.tebex.io.

Twig

Discover the power of the Twig templating engine used by Tebex.

Templates on the Tebex platform are written in the Twig Templating Engine. Twig allows you to customise your store with control structures, similar to any other language, while maintaining a sandboxed and safe environment for the Tebex infrastructure.

You're able to learn more information about the syntax of Twig by viewing the official documentation.

A common Twig file may look like the following:

<!DOCTYPE html>
<html>
    <head>
        <title>My Webpage</title>
    </head>
    <body>
        <ul id="navigation">
        {% for item in navigation %}
            <li><a href="{{ item.href }}">{{ item.caption }}</a></li>
        {% endfor %}
        </ul>

        <h1>My Webpage</h1>
        {{ a_variable }}
    </body>
</html>

If you're interested in becoming a pro at the Twig syntax, you can complete the official Twig certification programme.

Filters

Modify variable values with Twig filters.

Filters enable you to modify the content of variables within your template.

If you'd like access to a TWIG filter that is not available below, please let us know.

Available Filters

Filter

Documentation

escape

length

raw

money

slice

number_format

date

nl2br

replace

split

upper

lower

Filter Documentation

`money`

The money filter transforms a variable into a monetary format.

{% set value = 1 %}

{{ value|money }} // returns 1.00

Functions

View the available functions within your Twig template.

Functions generate content for you to use within your templates.

If you'd like access to a TWIG function that is not available below, please let us know.

Available Functions

Function

Documentation

__

_p

config

asset

path

query

range

Function Documentation

`__`

Returns the equivalent translation from within your translations settings.

{{ __('Redeem coupons / gift cards') }}

// prints "Redeems coupons / gift cards" (Or the equivalent translation if another language is selected)

`_p`

Returns the plural translation from within your translation settings.

{{ _p(":count items for :amount :currency", basket.packages|length, {'count' : basket.packages|length, 'amount' : basket.price|money, 'currency' : basket.currency}) }}

// prints "5 items for $5.00 USD"

`config`

Returns a config value from your template config schema.

{{ config("header-colour") }}

// prints the associated config value with the key header-colour

`asset`

Returns the full url path of an asset from within your template.

{{ asset("style.css") }}

// Prints the URL of style.css, such as https://your-store.tebex.io/template-assets/style.css"

`path`

Returns the full url path of the current page.

{{ path() }}

// Prints the full URL of the current page the customer is browsing on your store

`query`

Returns a GET parameter from the current url.

{{ query("test" }}

// Returns the GET param of "test" if it is provided in the URL.

Global Variables

Accessing global variables to help populate your template with live data.

Global variables are variables which are available across all pages of your store.

If you'd like access to a variable that is not currently available, please let us know.

basket

The global basket object contains all information relevant to the customers basket, such as price & packages.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

store

The global store object contains all information associated with the project itself, such as store name.

Variables

Type

Description

name

string

The name of the project.

currency

string

The base currency of the project.

css

string

The custom theme currently active on the project.

logo

string

The full url of the custom logo of the project.

favicon

string

The full url of the custom favicon of the project.

noLogin

Boolean

If the project requires no login (e.g. if no username system is being used).

categories

array[category]

An array of package categories of the project.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

Pages

The entry point for each page on your store.

Pages represent different landing points of your customers on your Tebex store. For example, when customers visit a category on your store, the category.html page will be rendered. For this reason, pages must be implemented in your templates and cannot be deleted (unlike Assets).

If you'd like access to a variable that is not currently available, please let us know.

The only pages that are not accessible to the public are the following:

index.html

The index.html page is the homepage of your store.

Root Object

Variables

Type

Description

description

string

The homepage content of the store.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

checkout.html

There is no specific variables for checkout.html. All checkout functionality is handled via opening a new Tebex.js session. To start a new Checkout session, you should do the following:

Add Tebex.js to your store
Receive the current baskets ident
Launch the Tebex.js modal

Receive an ident for Tebex.js

GET /checkout/ident

This endpoint will return an ident for the current basket, which is required by Tebex.js when launching a checkout modal.

Response

{
    "ident":"null if customer is not logged in"
}

Using Tebex.js

To learn how to add Tebex.js to your store, please view the associated documentation or view the demo over at https://js.tebex.io.

username.html

The username.html page is responsible for allowing your customers login to your store.

Root Object

Variables

Type

Description

external

Boolean

provider

String

The name of the login provider, such as FiveM, Discord or Steam.

url

String

The URL that the customer should be directed to so they can perform their login with the external provider.

If the external variable is true, let the user click a link to proceed to login via the external login provider:

<p>Please login with your {{ provider }} account to continue.</p>
<a href="{{ url }}">Login</a>

If the external variable is false, provide a form submitting to the current url, including an ign form parameter. The ign parameter should be a text field allowing the customer to enter their username freehand.

An example can be seen below:

<form method="post">
    <input type="text" name="ign" placeholder="Enter your in-game username" />
    <button type="submit">Login</button>
</form>

Full Working Example

An example of a flow supporting both external and non-external login providers is shown below:

{% if external %}
    <a href="{{ url }}">Login via {{ provider }}</a>
{% else %}
    <form method="post">
        <input
            type="text"
            name="ign"
            placeholder="Enter your in-game username"
        />
        <button type="submit">Login</button>
    </form>
{% endif %}

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

options.html

The options.html page is shown to the customer when adding a package that requires customisation, such as when you are using variables.

Root Object

Variables

Type

Description

options.package

An object containing information about the current package.

options.variables

Package Object

Variable

Type

Description

name

string

The name of the package.

chooseServer

boolean

customPrice

boolean

If the package requires the customer to enter how much they want to pay for the package.

category

string

The category ID of the package.

price

string

The price of the package.

Variable Object

Variable

Type

Description

description

string

A summary of the description of the variable.

type

string

Either dropdown, discord_id, or show an input field for freehand input by the customer.

id

string

The ID of the variable.

options

If the type is dropdown, we include an array of options the customer should select from.

value

string

The current value of the variable.

discord_tag

string

If the variable is type is discord_id and the value is not empty, this will include their discord tag once they have logged in.

Variable Option Object

Variable

Type

Description

default

boolean

If this variable option should be selected by default.

name

string

The name of the dropdown option.

price

string

The additional price the customer would pay by selecting this variable option.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

package.html

Root Object

Request Variable

cms/page.html

The cms/page.html page displays any custom pages that you have created on your store.

Root Object

Variables

Type

Description

id

string

The ID of the page.

category

string

The category of the page.

title

string

The title of the page.

metaData.content

string

The actual content of the page.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

category.html

Root Object

Request Variable

layout.html

There isn't any specific variables for layout.html. This page is usually extended by all other pages, providing your stores base layout structure.

An example of using layout.html can be seen below:

layout.html

<!DOCTYPE html>
<html>
    <body>
        {% block content %}{% endblock %} {# The content of checkout.html will be shown #}
    </body>
</html>

checkout.html

{% extends "layout.html" %}

{% block content %}
    Hello, world!
{% endblock %}

Sidebar Modules

Dynamic modules to display useful information on your store.

Modules allow you to add dynamic modules on your store, which you can configure from within your creator panel on the sidebar section.

Each modules HTML is configurable in their associated module.*.html page (documented onwards).

You can display the modules on your store by printing the modules variable, as seen below:

{{ modules|raw }}

Please ensure to use the raw filter, as the modules variable contains HTML that will be escaped automatically by TWIG if this filter is not used.

module.communitygoal.html

The community goal module displays the current progress of a community goal which you have configured within your creator panel on the community goals section.

Variables

Type

Description

module.header

string

The header of the module.

module.communitygoal.image

string

The URL of the image of the community goal hosted on our public CDN.

module.communitygoal.repeatable

boolean

If the community goal is repeatable.

module.communitygoal.times_achieved

string

The number of times the community goal has been reached.

module.communitygoal.description

string

The description of the community goal.

module.bar.style

string

The style of the goal, either striped or animated.

module.displayAmount

boolean

If the amount of the community goal should be displayed on your store.

module.total

string

The total the community goal has currently earned.

module.target

string

The target amount of the community goal.

module.percentage

string

The percentage equivalent of the current total against the target.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

module.featuredpackage.html

The featured package module allows you to feature a package, bringing more attention to it on your store.

Request Variable

module.giftcardbalance.html

The gift card balance module lets your customers enter a gift card and determine the amount of value that remains on the specified gift card.

Variables

Type

Description

module.header

string

The header of the module.

search

boolean

If the customer has attempted to search for a giftcard.

giftcard

object

If a giftcard was found from their search, it will be populated in this object.

giftcard.card_number

string

The gift card number the customer has searched for.

giftcard.void

boolean

If the giftcard that has been searched for has been voided by the store owner.

giftcard.remaining_balance

string

The remaining balance of the giftcard which has been searched for.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

module.goal.html

The goal module allows you to show a goal of how much money you'd like to earn over a specific period.

Request Variable

module.serverstatus.html

The server status module allows creators who operate Game Servers to display the status of their game server (e.g. player count or online status) on their store.

Variables

Type

Description

module.header

string

The header of the module.

module.online

boolean

If the game server is online.

module.ip

string

The IP address of the game server.

module.port

string

The port of the game server.

module.players.online

string

The total players on the game server.

module.players.max

string

The maximum players that can be online at one point on the game server.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

module.textbox.html

The textbox module allows a store owner to define a module with arbitrary text.

Request Variable

module.topdonator.html

The top donator module allows you to display the highest spending customer on your store.

Variables

Type

Description

module.header

string

The header of the module.

module.donor

boolean

If there is actually a top customer to show yet.

module.skin

string

The URL of the customers profile image to display.

module.ign

string

The username of the customer.

module.displayAmount

boolean

If to display the amount the customer has spent on your store.

module.total

string

The total amount the customer has spent on your store.

module.period

string

The period which calculates the above total. Can be either hourly, daily, weekly, monthly or yearly.

Request Variable

If you'd like access to a variable that is not currently available, please let us know.

Developer Plan

Let us support you develop custom templates for Tebex creators.

If you're a template developer, you're entitled to receive free Tebex Plus to enable you to freely develop templates for your clients. Stores that receive our developer plan won't be able to transact real payments on their store.

You're also eligible to gain access to the certified Tebex designers club. You'll get insider help guides, access to a private community of other elite designers, feedback sessions with the Tebex product team, and also BETA features that are not yet available to others.

If you'd like to apply to become a Tebex Certified Designer, please apply here.

Footer

Upon creating your store you may notice the footer at the bottom of your store stating that it is powered by Tebex and that we are the reseller & merchant of record.

Hiding the footer on your webstore will void our terms and conditions and will result in us having to disable your store from the public.

As a merchant of record platform we are under strict requirements by the card networks, such as Visa & Mastercard, to ensure customers understand which company they are purchasing from. You are authorising Tebex to operate a webstore on your behalf and sell content that we license from you, thus we need to let customers know about this as clearly as possible.

We don't place the footer for our own marketing/branding benefit - we simply have to do it to be able to provide you with all the benefits you receive as us being the Merchant Of Record, such as:

100 payment method integrations
Sales tax collection and remittance worldwide
Fraud protection & our chargeback guarantee
Easy to integrate product delivery for your game studio & server

Styling the footer to match your own brand

The colour scheme of the footer by default matches your Tebex Checkout theme. You're able to select between Dark or Light mode by viewing your Checkout settings within the creator panel.

The footer also listens to the following CSS variables which you can define in your template/theme, providing you with further customisation ability:

An example of setting the CSS variables can be seen below, which you could place in your templates CSS file:

Guides

Guides to help keep your custom template up-to-date.

In order to support certain features of Tebex, your custom template must be kept up-to-date. Please see the following guides:

Package Slugs

Package slugs allow you to customize your package's URL slug for better readability.

If you are using a custom template, you may need to update it to ensure the package slugs feature functions correctly on your webstore.

Template Changes

In your Twig templates, any instance of package.id should be updated to package.identifier. This property will use the package’s slug if available and default to the numeric ID if not.

Headless API

Checkout API

Tebex.js

Webhooks

Game Server API

Affiliate API

Overview

Receive real time notifications of payments, subscriptions, and much more.

Webhooks enable you to receive notifications upon certain webstore events, for example when a new payment is made. We will send a HTTP request containing a JSON object to any configured endpoints that are subscribing to the respective event. Webhooks are a great way to integrate Tebex with your own website, forum or internal database.

How To Setup Webhooks Endpoints

Go to Developers > Webhooks > Endpoints.
Click Add Endpoint.
Enter the URL of your webhook endpoint.
Select the types of webhooks that you'd like to subscribe to.
Click Add.

After adding your endpoint, you will receive a warning to inform you that we haven't been able to validate endpoint. Please see the section below for further information about handling validation webhooks.

Handling Validation Webhooks

Webhooks will not be sent to an endpoint unless it has been validated first. This is to ensure we are not sending HTTP requests to URLs that are not expecting our webhooks.

The validation webhook that we send will look similar to the example below. To identify a validation webhook you can check the type property in the JSON body.

{
  "id": "2c116b11-1110-91e0-b266-b792c8da5f11",
  "type": "validation.webhook",
  "date": "2021-08-24T12:21:47+00:00",
  "subject": {}
}

Upon receiving a validation webhook you must respond with a 200 OK response containing a JSON object that has an id property representing the validation webhook's ID, please see the example response below.

{
  "id": "2c116b11-1110-91e0-b266-b792c8da5f11"
}

Once your endpoint is setup to successfully handle validation webhooks, please visit Developers > Webhooks > Endpoints and click the Validate button next to the endpoint to re-send the validation webhook.

Verifying Webhook Authenticity

IP Address

Webhooks from Tebex will only ever be sent from the two IP addresses listed below.

18.209.80.3 54.87.231.232

When building your webhook endpoint, we suggest that you check the IP address of the sender and throw a 404 Not Found error if the IP address isn't in the above list.

Signature

In addition to checking the IP address, we strongly advise that you verify the X-Signature header that we send with all requests.

The signature is generated by SHA256 hashing the JSON body and then building a SHA256 HMAC with the body hash as the data/content and your webhook secret as the key.

Your webhook secret is displayed on the Developers > Webhooks > Endpoints page. Please see our example code snippets below of how to generate the signature.

$json = file_get_contents('php://input');
$secret = "0d45982a10e3a072d0c1261c55dd9918";
$signature = hash_hmac('sha256', hash('sha256', $json), $secret);

var bodyParser = require('body-parser');

var app = express();

app.use(bodyParser.json({
  verify: (req, res, buf) => {
    req.rawBody = buf
  }
}));

router.post('/webhook', function(req, res, next) {
  const secret = 'xxxxxxxxxxx';

  const bodyHash = crypto
      .createHash('sha256')
      .update(req.rawBody.toString(), 'utf-8')
      .digest('hex');
  const finalHash = crypto.createHmac('sha256', secret)
      .update(bodyHash)
      .digest('hex');
  console.log('finalHash', finalHash)

  // Compare hash...
});

If the signature that you generate doesn't match the X-Signature header, please disregard the webhook because it is not from Tebex.

Some frameworks such as Express (Node.js) automatically parse JSON request bodies which can result in a signature mismatch. Please ensure the signature is calculated using the raw request body and not a parsed version of the body.

Handling Webhooks

All of our webhooks are sent using the standardised format with the following properties:

id: This property represents the unique ID of the webhook. type: The type of webhook we are sending, for example payment.completed. date: This is the date that the webhook was generated. subject: The data within this property will differ depending on the type of webhook. To view the different subject formats please see the subject types below.

When handling a webhook, please ensure you respond with a 2XX status code (anywhere between 200-299). If your endpoint responds with any other status code we will automatically try to resend the webhook later-on.

After several attempts of retrying we will mark the webhook as failed and your endpoint may require validating again.

Webhook Types

payment.completed
payment.declined
payment.refunded
payment.dispute.opened
payment.dispute.won
payment.dispute.lost
payment.dispute.closed
recurring-payment.started
recurring-payment.renewed
recurring-payment.ended
recurring-payment.cancellation.requested
recurring-payment.cancellation.aborted
validation.webhook

Webhook Subjects

{
  "transaction_id": "tbx-xxxxxxxx",
  "status": {
    ,
    "description": "Refund"
  },
  "payment_sequence": "oneoff",
  "created_at": "2021-08-19T13:03:30.000000Z",
  "price": {
    "amount": 13.2,
    "currency": "GBP"
  },
  "price_paid": {
    "amount": 13.2,
    "currency": "GBP"
  },
  "payment_method": {
    "name": "PayPal",
    "refundable": true
  },
  "fees" : {
    "tax" : {
      "amount" : 0,
      "currency" : "USD"
    },
    "gateway" : {
      "amount" : 0.73,
      "currency" : "USD"
    }
  },
  "customer": {
    "first_name": "Test",
    "last_name": "Test",
    "email": "test@test.com",
    "ip": "1.2.3.4",
    "username": {
      "id": "1234",
      "username": "Test"
    },
    "marketing_consent": true,
    "country": "GB",
    "postal_code": "TE57 1NG"
  },
  "products": [
    {
      "id": 4,
      "name": "Example Package",
      "quantity": 1,
      "base_price": {
        "amount": 11,
        "currency": "GBP"
      },
      "paid_price": {
        "amount": 11,
        "currency": "GBP"
      },
      "variables": [
        {
          "identifier": "server",
          "option": "3"
        }
      ],
      "expires_at": null,
      "custom": null,
      "username": {
        "id": "1234",
        "username": "Test"
      }
    }
  ],
  "coupons": [],
  "gift_cards": [],
  "recurring_payment_reference": null,
  "decline_reason": {
    ,
    "message": "You entered incorrect card information. Please check your card details are correct and then try again."
  }
}

Useful Status IDs

Status

1

Complete

2

Refund

3

Chargeback

18

Declined

19

Pending Checkout

21

Refund Pending

Decline Reasons

Code

Message

rejected

The payment method was declined by the customers payment method provider. We recommend asking the customer to contact their bank/provider to have this issue resolved.

fraud_card_issuer

The payment method was declined by the customers card issuer or their bank due to suspected fraud. We recommend asking the customer to contact their bank to have this issue resolved.

fraud_tebex

Tebex implements artificial intelligence to determine if a transaction is fraudulent. Based on the data we have collected, we have decided this transaction to be too risky to accept. Do not tell the customer that they have been blocked due to fraud.

incorrect_card_information

The customer has entered incorrect card details during the checkout process. Please advise the customer to try again with the correct details.

network_failure

There was a failure in the payment network. Please advise the customer to try again later.

insufficient_funds

The payment method was declined due to the customer having insufficient funds.

fraud_history

Tebex reviews the fraud history of customers as part of our fraud assessment. Based on the data we have collected, the fraud history of this customer makes this transaction too risky to accept. Do not tell the customer that they have been blocked due to fraud.

{
  "reference": "tbx-r-xxxxx",
  "created_at": "2021-08-23T11:33:51.000000Z",
  "next_payment_at": "2021-09-23T11:34:13.000000Z",
  "status": {
    ,
    "description": "Cancelled"
  },
  "initial_payment": ,
  "last_payment": ,
  "fail_count": 0,
  "price": {
    "amount": 20,
    "currency": "GBP"
  },
  "cancelled_at": "2021-08-24T14:46:05.000000Z",
  "cancel_reason": "Cancelled by webstore on request"
}

Useful Status IDs

Status

Description

Active

2

Active

The recurring payment is active.

3

Overdue

We couldn't charge the customer for the renewal, but we will automatically retry tomorrow.

4

Expired

After multiple attempts, we couldn't renew the recurring payment.

5

Cancelled

The recurring payment has been cancelled as requested by the creator/customer.

7

Pending Downgrade

Only applies to recurring payments for packages in Tiered Categories:

The customer has requested to downgrade their recurring payment to a lower priced package.

Testing Webhooks

Our webhook testing feature allows you to manually trigger webhooks from your control panel. Please follow the steps below to send a test webhook.

Navigate to Developers > Webhooks in your control panel.
Click the Send Test button.
Choose the type of webhook you'd like to send.
Provide a valid transaction ID if you've selected a payment webhook type, or enter a recurring payment reference if you've chosen a recurring payment webhook type.
Click the Send Test button.

Developers

Welcome

Getting Started

Create a project

Setup your store or integrate our APIs

Create your packages

Implement product delivery

Make a test payment

Submit for review

Go live

Integration Methods

Which integration method is best for me?

Let's begin!

SDKs

Official SDKs

OpenAPI Schema

Other SDKs / Integration Options

Webstore Builder

Overview

Examples

Certified Tebex Designers

Feedback

Getting Started

Getting Started

Twig

Tags

Available Tags

Filters

Available Filters

Filter Documentation

money

Functions

Available Functions

Function Documentation

__

_p

config

asset

path

query

Global Variables

basket

Request Variable

store

Request Variable

page

Request Variable

Pages

index.html

Root Object

Request Variable

checkout.html

Receive an ident for Tebex.js

Using Tebex.js

username.html

Root Object

External Login

Non-External Login

Full Working Example

Request Variable

options.html

Root Object

Package Object

Variable Object

Variable Option Object

Request Variable

package.html

Root Object

Request Variable

cms/page.html

Root Object

Request Variable

category.html

Root Object

Request Variable

layout.html

layout.html

checkout.html

Sidebar Modules

module.communitygoal.html

`money`

`__`

`_p`

`config`

`asset`

`path`

`query`

`__`

`_p`

`config`

`asset`

`path`

`query`