Endpoints

Fetch a basket by its identifier

Gets the basket associated with the provided identifier.

GEThttps://checkout.tebex.io/api/baskets/{ident}

Path parameters

ident*string

The basket identifier.

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Response

200404

Successful response returns the basket.

The links.payment property is only returned if the basket has been paid for, and a payment exist with the complete/refund/chargeback status.

The links.checkout property is only returned if the basket has not been paid, and is the URL to send the customer to in order to complete payment.

Body

application/json

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

expirestring

Example: "2022-10-25 15:15:40"

pricenumber (float)

Example: 1.27

priceDetailsPriceDetails (object)

isPaymentMethodUpdateboolean

Example: false

returnUrlnullable string

completeboolean

Example: false

taxnumber (int32)

usernamenullable string

discountsarray of Discount (object)

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

addressAddress (object)

rowsarray of BasketRow (object)

fingerprintnullable string

Browser fingerprint to identify the user

Example: ""

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

roundupnullable boolean

Example: false

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/baskets/{ident}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "discounts": [],
    "total": 1.4,
    "surcharges": [],
    "tax": 0.13,
    "balance": 0,
    "sales": [],
    "giftcards": [],
    "roundUp": null
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 0,
  "username": null,
  "discounts": [],
  "coupons": [],
  "giftcards": [],
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiredPackages": [],
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "servers": [],
        "limits": {
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "packageExpiryTime": 0
        },
        "hasDeliverables": false,
        "deliverableTypes": [],
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "revenue_share": [],
        "image": null,
        "realprice": 1.27
      },
      "custom": null,
      "image_url": null,
      "recurring_price": null
    }
  ],
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Create a basket that can be used to pay for items

This will create and return a Basket that can be paid for by redirecting the user to links.checkout

POSThttps://checkout.tebex.io/api/baskets

Body

application/json

Create a basket, returning the full basket object and payment link.

return_urlstring

The URL a customer can return to without completing checkout

Example: "https://example.tebex.io/"

complete_urlstring

URL the customer can return to after completing payment

Example: "https://example.tebex.io/complete"

customobject

Any custom data to be passed through the request. This will be returned in a post-completion webhook.

first_namestring

The first name of the customer

Example: "Neil"

last_namestring

The last name of the customer

Example: "McNeil"

emailstring

The email address of the customer

Example: "[e-mail]"

expires_atstring

An ISO8601 formatted date. After this date the basket cannot be used to checkout.

Example: "2025-01-27T18:09:51Z"

complete_auto_redirectboolean

Automatically redirect to the complete_url provided

Example: true

countrystring

An ISO 3166-1 alpha-2 character code representing the customer's country.

Example: "US"

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

ipstring

The IP address of the customer using this basket. Provide the IP if creating a basket on your server backend.

Example: "1.2.3.4"

Response

200

Basket created successfully

Body

application/json

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

expirestring

Example: "2022-10-25 15:15:40"

pricenumber (float)

Example: 1.27

priceDetailsPriceDetails (object)

isPaymentMethodUpdateboolean

Example: false

returnUrlnullable string

completeboolean

Example: false

taxnumber (int32)

usernamenullable string

discountsarray of Discount (object)

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

addressAddress (object)

rowsarray of BasketRow (object)

fingerprintnullable string

Browser fingerprint to identify the user

Example: ""

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

roundupnullable boolean

Example: false

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/baskets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "discounts": [],
    "total": 1.4,
    "surcharges": [],
    "tax": 0.13,
    "balance": 0,
    "sales": [],
    "giftcards": [],
    "roundUp": null
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 0,
  "username": null,
  "discounts": [],
  "coupons": [],
  "giftcards": [],
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiredPackages": [],
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "servers": [],
        "limits": {
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "packageExpiryTime": 0
        },
        "hasDeliverables": false,
        "deliverableTypes": [],
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "revenue_share": [],
        "image": null,
        "realprice": 1.27
      },
      "custom": null,
      "image_url": null,
      "recurring_price": null
    }
  ],
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Add a package to the basket

This adds a package (an object describing the product) to the basket {ident}. For subscriptions, only one subscription item may be in a basket at a time, and it cannot be included with one-time payment items. This endpoint requires prior approval. Please contact your account manager.

POSThttps://checkout.tebex.io/api/baskets/{ident}/packages

Path parameters

ident*string

The basket identifier.

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Body

application/json

packagePackage (object)

qtyinteger

The quantity of package in this basket. This is not the total quantity of overall items in the basket.

Example: 2

typeenum

The type of payment, either single for one-time payments or subscription.

Example: "single"

singlesubscription

revenue_sharearray of nullable RevenueShare (object)

An array of payment destination objects describing how the purchase should be split between multiple wallets. Only available with pre-agreement from Tebex.

Response

200400404

Package is successfully added to the basket, and basket is returned.

Body

application/json

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

expirestring

Example: "2022-10-25 15:15:40"

pricenumber (float)

Example: 1.27

priceDetailsPriceDetails (object)

isPaymentMethodUpdateboolean

Example: false

returnUrlnullable string

completeboolean

Example: false

taxnumber (int32)

usernamenullable string

discountsarray of Discount (object)

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

addressAddress (object)

rowsarray of BasketRow (object)

fingerprintnullable string

Browser fingerprint to identify the user

Example: ""

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

roundupnullable boolean

Example: false

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/baskets/{ident}/packages', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "discounts": [],
    "total": 1.4,
    "surcharges": [],
    "tax": 0.13,
    "balance": 0,
    "sales": [],
    "giftcards": [],
    "roundUp": null
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 0,
  "username": null,
  "discounts": [],
  "coupons": [],
  "giftcards": [],
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiredPackages": [],
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "servers": [],
        "limits": {
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "packageExpiryTime": 0
        },
        "hasDeliverables": false,
        "deliverableTypes": [],
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "revenue_share": [],
        "image": null,
        "realprice": 1.27
      },
      "custom": null,
      "image_url": null,
      "recurring_price": null
    }
  ],
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Remove a row from the basket

This will remove the given {rows.id} from the basket {ident}. The basket must be re-fetched after running to receive updated totals.

DELETEhttps://checkout.tebex.io/api/baskets/{ident}/packages/{rows.id}

Path parameters

ident*string

The basket identifier.

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

rows.id*integer

The id of the basket.rows row to remove.

Example: 1

Response

204404

Successfully deleted a row from the basket.

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/baskets/{ident}/packages/{rows.id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add a sale to the basket

Adds a Sale to the basket with {ident}. Sales cannot be applied to baskets with revenue_share set.

POSThttps://checkout.tebex.io/api/baskets/{ident}/sales

Path parameters

ident*string

The basket identifier.

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

Body

application/json

Provide a Sale as an object to apply it to the basket.

namestring

The name of the sale (displayed to the customer)

Example: "Test Sale"

discount_typeenum

The type of discount, either percentage for deducting a percentage of each item, or amount to deduct a fixed amount from each item.

Example: "amount"

percentageamount

amountnumber

The amount or percentage to deduct

Example: 4.99

Response

200400404

Successfully adds sale to basket.

Body

application/json

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

expirestring

Example: "2022-10-25 15:15:40"

pricenumber (float)

Example: 1.27

priceDetailsPriceDetails (object)

isPaymentMethodUpdateboolean

Example: false

returnUrlnullable string

completeboolean

Example: false

taxnumber (int32)

usernamenullable string

discountsarray of Discount (object)

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

addressAddress (object)

rowsarray of BasketRow (object)

fingerprintnullable string

Browser fingerprint to identify the user

Example: ""

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

roundupnullable boolean

Example: false

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/baskets/{ident}/sales', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "discounts": [],
    "total": 1.4,
    "surcharges": [],
    "tax": 0.13,
    "balance": 0,
    "sales": [],
    "giftcards": [],
    "roundUp": null
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 0,
  "username": null,
  "discounts": [],
  "coupons": [],
  "giftcards": [],
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiredPackages": [],
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "servers": [],
        "limits": {
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "packageExpiryTime": 0
        },
        "hasDeliverables": false,
        "deliverableTypes": [],
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "revenue_share": [],
        "image": null,
        "realprice": 1.27
      },
      "custom": null,
      "image_url": null,
      "recurring_price": null
    }
  ],
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Create a checkout request

This API call allows the complete checkout flow (create basket, add items, add sale) to be made in a single API call, for when the Seller is managing the basket locally. This endpoint requires prior approval - please contact your account manager.

POSThttps://checkout.tebex.io/api/checkout

Body

application/json

Provide a Basket, an array of Packages to be added to the basket, and an optional Sale to complete the full checkout flow in one call. Only one subscription item may be in the basket at a time.

basket*object

An object containing the customer's information, relevant links, and any custom tracking data.

items*array of CheckoutItem (object)

An array of Packages in the basket.

saleSale (object)

Response

200400

Successfully created basket. The basket will be returned with links containing the URLs you should direct the customer to in order to complete payment.

Body

application/json

identstring

Example: "1a-55fff4107740a1f40d844ff89607557f45bfafb3"

expirestring

Example: "2022-10-25 15:15:40"

pricenumber (float)

Example: 1.27

priceDetailsPriceDetails (object)

isPaymentMethodUpdateboolean

Example: false

returnUrlnullable string

completeboolean

Example: false

taxnumber (int32)

usernamenullable string

discountsarray of Discount (object)

couponsarray of Coupon (object)

giftcardsarray of GiftCard (object)

addressAddress (object)

rowsarray of BasketRow (object)

fingerprintnullable string

Browser fingerprint to identify the user

Example: ""

creator_codestring

The creator code is used to share a percentage of the payment with another party. See more about creator codes at https://docs.tebex.io/creators/tebex-control-panel/engagement/creator-codes

roundupnullable boolean

Example: false

cancel_urlstring

Example: "https://tebex.io"

complete_urlnullable string

complete_auto_redirectboolean

Example: false

customnullable object

linksBasketLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/checkout', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "basket": {
        "first_name": "Neil",
        "last_name": "McNeil",
        "email": "[e-mail]",
        "return_url": "https://tebex.io",
        "complete_url": "https://tebex.io",
        "custom": {
          "foo": "bar",
          "trackingId": 127,
          "list": [
            "1",
            "2",
            "3"
          ]
        }
      },
      "items": [
        {}
      ]
    }),
});
const data = await response.json();

Response

200

{
  "ident": "1a-55fff4107740a1f40d844ff89607557f45bfafb3",
  "expire": "2022-10-25 15:15:40",
  "price": 1.27,
  "priceDetails": {
    "fullPrice": 1.4,
    "subTotal": 1.27,
    "discounts": [],
    "total": 1.4,
    "surcharges": [],
    "tax": 0.13,
    "balance": 0,
    "sales": [],
    "giftcards": [],
    "roundUp": null
  },
  "isPaymentMethodUpdate": false,
  "returnUrl": null,
  "complete": false,
  "tax": 0,
  "username": null,
  "discounts": [],
  "coupons": [],
  "giftcards": [],
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "[e-mail]",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "package": null,
      "override": 0,
      "quantity": 2,
      "server": null,
      "price": 1.27,
      "gift_username_id": null,
      "options": null,
      "recurring": false,
      "recurring_period": null,
      "recurring_next_payment_date": null,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "isCumulative": false,
        "requiredPackages": [],
        "requiresAny": false,
        "category": false,
        "producesGiftCard": false,
        "allowsGiftCards": true,
        "servers": [],
        "limits": {
          "user": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "global": {
            "enabled": false,
            "timestamp": 0,
            "limit": false
          },
          "packageExpiryTime": 0
        },
        "hasDeliverables": false,
        "deliverableTypes": [],
        "downloadLink": "",
        "hasSellerProtection": true,
        "itemType": null,
        "revenue_share": [],
        "image": null,
        "realprice": 1.27
      },
      "custom": null,
      "image_url": null,
      "recurring_price": null
    }
  ],
  "fingerprint": "",
  "creator_code": "text",
  "roundup": false,
  "cancel_url": "https://tebex.io",
  "complete_url": null,
  "complete_auto_redirect": false,
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}

Fetch a payment by its transaction ID

This will fetch the given payment associated with this transaction id. Single payment transaction IDs begin with tbx-

GEThttps://checkout.tebex.io/api/payments/{txnId}?type=txn_id

Path parameters

txnId*string

The payment reference to fetch.

Example: "tbx-55fff4107740a1f40d844ff89607557f45bfafb3"

Response

200404

Payment fetched successfully.

Body

application/json

transaction_idstring

Example: "tbx-26929122a56954-0e15be"

statusobject

payment_sequencestring

Example: "oneoff"

created_atstring (date-time)

Example: "2022-10-19T15:49:15.000000Z"

priceobject

feesobject

customerobject

productsarray of object

couponsarray of object

gift_cardsarray of object

recurring_payment_referencenullable string

customobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/payments/{txnId}?type=txn_id', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "transaction_id": "tbx-26929122a56954-0e15be",
  "status": {
    "id": 1,
    "description": "Complete"
  },
  "payment_sequence": "oneoff",
  "created_at": "2022-10-19T15:49:15.000000Z",
  "price": {
    "amount": 5.35,
    "currency": "USD"
  },
  "fees": {
    "tax": {
      "amount": 0,
      "currency": "USD"
    },
    "gateway": {
      "amount": 0.45,
      "currency": "USD"
    }
  },
  "customer": {
    "first_name": "Test",
    "last_name": "Test",
    "email": "[e-mail]",
    "ip": "1.2.3.4",
    "username": "text",
    "marketing_consent": false,
    "country": "TS",
    "postal_code": "text"
  },
  "products": [
    {
      "id": "text",
      "name": "text",
      "base_price": {
        "amount": 0,
        "currency": "text"
      },
      "paid_price": {
        "amount": 0,
        "currency": "text"
      },
      "variables": [
        "text"
      ],
      "expires_at": "2024-11-18T04:20:47.769Z",
      "username": "text"
    }
  ],
  "coupons": [],
  "gift_cards": [],
  "recurring_payment_reference": "text"
}

Refund a payment by its transaction ID

This will refund the given payment associated with this transaction id.

POSThttps://checkout.tebex.io/api/payments/{txnId}/refund?type=txn_id

Path parameters

txnId*string

The payment reference to refund.

Example: "tbx-55fff4107740a1f40d844ff89607557f45bfafb3"

Response

200404422

Payment refunded successfully. The payment details are returned.

Body

application/json

transaction_idstring

Example: "tbx-26929122a56954-0e15be"

statusobject

payment_sequencestring

Example: "oneoff"

created_atstring (date-time)

Example: "2022-10-19T15:49:15.000000Z"

priceobject

feesobject

customerobject

productsarray of object

couponsarray of object

gift_cardsarray of object

recurring_payment_referencenullable string

customobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/payments/{txnId}/refund?type=txn_id', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "transaction_id": "tbx-26929122a56954-0e15be",
  "status": {
    "id": 1,
    "description": "Complete"
  },
  "payment_sequence": "oneoff",
  "created_at": "2022-10-19T15:49:15.000000Z",
  "price": {
    "amount": 5.35,
    "currency": "USD"
  },
  "fees": {
    "tax": {
      "amount": 0,
      "currency": "USD"
    },
    "gateway": {
      "amount": 0.45,
      "currency": "USD"
    }
  },
  "customer": {
    "first_name": "Test",
    "last_name": "Test",
    "email": "[e-mail]",
    "ip": "1.2.3.4",
    "username": "text",
    "marketing_consent": false,
    "country": "TS",
    "postal_code": "text"
  },
  "products": [
    {
      "id": "text",
      "name": "text",
      "base_price": {
        "amount": 0,
        "currency": "text"
      },
      "paid_price": {
        "amount": 0,
        "currency": "text"
      },
      "variables": [
        "text"
      ],
      "expires_at": "2024-11-18T04:20:47.769Z",
      "username": "text"
    }
  ],
  "coupons": [],
  "gift_cards": [],
  "recurring_payment_reference": "text"
}

Fetch a recurring payment (subscription) by its reference

GEThttps://checkout.tebex.io/api/recurring-payments/{reference}

Path parameters

reference*string

The recurring payment reference to fetch.

Example: "tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3"

Response

200404

Successfully fetched recurring payment.

Body

application/json

idinteger

Example: 5000

created_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

updated_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

paused_atnullable string (date-time)

paused_untilnullable string (date-time)

next_payment_datestring

Example: "2022-12-30T16:43:06"

referencestring

Example: "88"

account_idinteger

Example: 1

intervalstring

Example: "P2W"

cancelled_atnullable string (date-time)

cancellation_requested_atnullable string (date-time)

Example: "2024-07-25 14:01:03"

statusobject

amountobject

cancel_reasonnullable string

linksobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/recurring-payments/{reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2024-11-18T04:20:47.769Z",
  "paused_until": "2024-11-18T04:20:47.769Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2024-11-18T04:20:47.769Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "cancel_reason": "text",
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Update a subscription with a new product / amount to pay - replacing the existing product

If the new subscription amount is higher than the existing amount, a pro-rata charge will be made to cover the cost of the new price up until the next billing date.

This endpoint requires prior approval - please contact your account manager.

PUThttps://checkout.tebex.io/api/recurring-payments/{reference}

Path parameters

reference*string

The recurring payment reference to fetch.

Example: "tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3"

Body

application/json

itemsarray of object

An array containing the items to be added to the recurring payment. Only 1 item is supported at this time.

Response

200400404

Successfully updated subscription. The updated RecurringPayment is returned.

Body

application/json

idinteger

Example: 5000

created_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

updated_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

paused_atnullable string (date-time)

paused_untilnullable string (date-time)

next_payment_datestring

Example: "2022-12-30T16:43:06"

referencestring

Example: "88"

account_idinteger

Example: 1

intervalstring

Example: "P2W"

cancelled_atnullable string (date-time)

cancellation_requested_atnullable string (date-time)

Example: "2024-07-25 14:01:03"

statusobject

amountobject

cancel_reasonnullable string

linksobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/recurring-payments/{reference}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2024-11-18T04:20:47.769Z",
  "paused_until": "2024-11-18T04:20:47.769Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2024-11-18T04:20:47.769Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "cancel_reason": "text",
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Cancel a recurring payment

This cancels the recurring payment for the reference provided. Recurring payment references start with tbx-r-

DELETEhttps://checkout.tebex.io/api/recurring-payments/{reference}

Path parameters

reference*string

The recurring payment reference to cancel.

Example: "tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3"

Response

200404

Recurring payment cancelled successfully.

Body

application/json

idinteger

Example: 5000

created_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

updated_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

paused_atnullable string (date-time)

paused_untilnullable string (date-time)

next_payment_datestring

Example: "2022-12-30T16:43:06"

referencestring

Example: "88"

account_idinteger

Example: 1

intervalstring

Example: "P2W"

cancelled_atnullable string (date-time)

cancellation_requested_atnullable string (date-time)

Example: "2024-07-25 14:01:03"

statusobject

amountobject

cancel_reasonnullable string

linksobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/recurring-payments/{reference}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2024-11-18T04:20:47.769Z",
  "paused_until": "2024-11-18T04:20:47.769Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2024-11-18T04:20:47.769Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "cancel_reason": "text",
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}

Pause or reactivate a recurring payment

PUThttps://checkout.tebex.io/api/recurring-payments/{reference}/status

Path parameters

reference*string

The recurring payment reference to update.

Example: "tbx-r-55fff4107740a1f40d844ff89607557f45bfafb3"

Body

application/json

status*enum

Your desired state of the recurring payment. Provide Paused with paused_until to pause a recurring payment. Otherwise, provide Active to resume a recurring payment.

Example: "Paused"

PausedActive

paused_untilstring

To pause a payment, provide a ISO8601 formatted date on which the payment should be reactivated.

Example: "2025-01-27T16:43:53.000000Z"

Response

200404422

Successfully paused or reactivated a payment. The RecurringPayment is returned.

Body

application/json

idinteger

Example: 5000

created_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

updated_atstring (date-time)

Example: "2022-12-16T16:43:06.000000Z"

paused_atnullable string (date-time)

paused_untilnullable string (date-time)

next_payment_datestring

Example: "2022-12-30T16:43:06"

referencestring

Example: "88"

account_idinteger

Example: 1

intervalstring

Example: "P2W"

cancelled_atnullable string (date-time)

cancellation_requested_atnullable string (date-time)

Example: "2024-07-25 14:01:03"

statusobject

amountobject

cancel_reasonnullable string

linksobject

Request

JavaScriptCurlPython

const response = await fetch('https://checkout.tebex.io/api/recurring-payments/{reference}/status', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "status": "Paused"
    }),
});
const data = await response.json();

Response

200

{
  "id": 5000,
  "created_at": "2022-12-16T16:43:06.000000Z",
  "updated_at": "2022-12-16T16:43:06.000000Z",
  "paused_at": "2024-11-18T04:20:47.769Z",
  "paused_until": "2024-11-18T04:20:47.769Z",
  "next_payment_date": "2022-12-30T16:43:06",
  "reference": "88",
  "account_id": 1,
  "interval": "P2W",
  "cancelled_at": "2024-11-18T04:20:47.769Z",
  "cancellation_requested_at": "2024-07-25 14:01:03",
  "status": {
    "id": 2,
    "class": "success",
    "description": "Active",
    "active": 1
  },
  "amount": {
    "amount": 7,
    "tax": 1.4,
    "period": "P2W"
  },
  "cancel_reason": "text",
  "links": {
    "initial_payment": "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id",
    "payment_history": [
      "https://checkout.tebex.io/api/payments/tbx-123123aabccd123-bf71ad?type=txn_id"
    ]
  }
}