Sign in
latestOpenAPI 3.0.3MIT2026-08-10121945.1 KB

a52c87b9a2b9

Checkout

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.

post/checkout

Request body

Example request

{
  "basket": {
    "first_name": "Neil",
    "last_name": "McNeil",
    "email": "example@tebex.io",
    "return_url": "https://tebex.io",
    "complete_url": "https://tebex.io",
    "custom": {
      "foo": "bar",
      "trackingId": 127,
      "list": [
        "1",
        "2",
        "3"
      ]
    }
  },
  "items": [
    {
      "package": {
        "name": "1000 Gold",
        "price": 1.27,
        "type": "subscription",
        "qty": 1,
        "expiry_period": "month",
        "expiry_length": 3,
        "custom": {
          "foo": "bar"
        }
      }
    }
  ],
  "sale": {
    "name": "Test Sale",
    "discount_type": "amount",
    "amount": 4.99
  }
}

Response

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

identstring
expirestring
pricenumber float
isPaymentMethodUpdateboolean
returnUrlstring nullable
completeboolean
taxnumber
usernamestring nullable
discountsDiscount[]
couponsCoupon[]
giftcardsGiftCard[]
fingerprintstring nullable

Browser fingerprint to identify the user

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

roundupboolean nullable
cancel_urlstring
complete_urlstring nullable
complete_auto_redirectboolean
customobject nullable

Example response

{
  "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
  },
  "address": {
    "name": "Ted Tebex",
    "first_name": "Ted",
    "last_name": "Tebex",
    "address": "37 Broadhurst Gardens, London, United Kingdom, NW6 3QT",
    "email": "example@tebex.io",
    "state_id": null,
    "country": "UK",
    "postal_code": "NW6 3QT"
  },
  "rows": [
    {
      "id": 173125385,
      "basket": 725572301,
      "quantity": 2,
      "price": 1.27,
      "meta": {
        "name": "1000 Gold",
        "rowprice": 2.54,
        "initialprice": 1.27,
        "requiredPackages": [],
        "allowsGiftCards": true,
        "servers": [],
        "deliverableTypes": [],
        "hasSellerProtection": true,
        "revenue_share": [],
        "realprice": 1.27
      }
    }
  ],
  "cancel_url": "https://tebex.io",
  "custom": {
    "foo": "bar",
    "ref": 1234
  },
  "links": {
    "payment": "https://checkout.tebex.io/api/payments/tbx-12345",
    "checkout": "https://checkout.tebex.io/checkout/1a-55fff4107740a1f40d844ff89607557f45bfafb3"
  }
}