Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tabby Checkout API

Checkout is a whole process of customer data collection and payment authorization.

Tabby Checkout API is one of 4 APIs that Tabby publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Checkout. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 7 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.tabby.ai/, https://api.tabby.sa/.

2 operations 2 paths 39 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.tabby.ai/
https://api.tabby.sa/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Tabby Checkout API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Bearer authentication header of the form Bearer , where is your secretkey.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Checkout 2

Checkout is a whole process of customer data collection and payment authorization.

POST
/api/v2/checkout
Create a session
postCheckoutSession body → 200400401403404500
GET
/api/v2/checkout/{id}
Retrieve an existing checkout session
getCheckoutSession 1 param → 200400401403404500

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are OrderItemHistoryRequest (19 properties), OrderItem (19 properties), OrderItemResponse (15 properties), CheckoutCreation (10 properties). Each schema is shown below with its type and property counts.

BuyerHistory
object
Customer information. registeredsince (as a date of the customer's registration in the App), loyaltylevel (as a number of successful orders) and wishlistcount…
6 properties 2 required
FlightPointsSimple
object
2 properties 2 required
EducationDetails
object
Education-vertical risk signals for the current session.
3 properties 3 required
Buyer
object
Customer information
4 properties 3 required
OrderItem
object
19 properties 4 required
Error_400
object
3 properties
Meta
object
Merchant-defined data about the payment. This field is a key-value map. The example properties provided below.
2 properties
Attachment_V1
object
Extra data (booking info, insurance, flight reservations, ...) as serialized JSON
2 properties 2 required
CheckoutCreation
object
Payment object associated with the current session.
10 properties 7 required
OrderItemHistoryRequest
object
19 properties
PaymentAmount
string
Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.
HotelReservationDetails
object
5 properties 3 required
Currency
string
ISO 4217 currency code for the payment amount. Currently there are 3 possible currency options - depending on the country where the store is located: - AED - U…
Error_404
string
ShippingAddress
object
3 properties 3 required
CheckoutSession
object
6 properties
InsuranceDetails
object
3 properties 2 required
AttachmentPaymentHistoryFull
object
9 properties
Error_500
string
OrderItemResponse
object
15 properties 4 required
CheckoutProduct
object
3 properties 2 required
Marketplaces
object
Sellers' details within marketplaces.
7 properties 7 required
LanguageCode
string
Session language, used to launch HPP with desired language.
CheckoutConfigurationProduct
array
Error_401_merchantNull
object
3 properties
CheckoutProductRejectionReason
string
The reason why this product is not available to use Possible values: orderamounttoohigh - 'This purchase is above your current spending limit with Tabby, try a…
Error_400_CheckoutPost
object
3 properties
Order
object
6 properties 2 required
FlightReservationDetails
object
5 properties 3 required
Error_403
object
2 properties
PaymentCreatedAt
string
Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.
CheckoutResponsePayment
object
Payment object associated with the current session.
10 properties 7 required
CheckoutCreationOrderHistory
object
7 properties 5 required
AttachmentPaymentHistorySimple
object
4 properties
Error_401_key_doesnt_exist
object
3 properties
PaymentID
string
Unique identifier for the payment (UUID), assigned by Tabby. Save it on your side!
PaymentStatus
string
Status of the current payment: - CREATED means that the payment is created successfully, but not finished yet; - AUTHORIZED and CLOSED mark the successfully ap…
MerchantUrls
object
Used for redirecting the customer after Tabby Checkout flow. Required for Web integration, optional for Mobile App integration.
3 properties
OrderResponse
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabby-checkout-api-openapi.yml Raw ↑

Other APIs Tabby publishes across the network.

Tabby Disputes API
Tabby Payments API
Tabby Webhooks API