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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Tabby

Tabby Payments API

The core of tabby is a payments flow enabling you to handle payments at your webstore.

Documentation Provider Profile APIs.io OpenAPI GitHub

Tabby Payments 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 7 JSON Schemas.

This API exposes 6 operations across 5 paths, and defines 47 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/.

6 operations 5 paths 47 schemas 2 GET3 POST1 PUT

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 Payments 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 6

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

Payments 6

The core of tabby is a payments flow enabling you to handle payments at your webstore.

GET
/api/v2/payments/{id}
Retrieve a payment
getPayment 1 param → 200400401404500
PUT
/api/v2/payments/{id}
Update a payment
putPayment 1 param body → 200400401403404500
POST
/api/v2/payments/{id}/captures
Capture a payment
postPaymentCapture 1 param body → 200400401403404500
POST
/api/v2/payments/{id}/refunds
Refund a payment
postPaymentRefund 1 param body → 200400401403404409500
POST
/api/v2/payments/{id}/close
Close a payment
closePayment 1 param → 200400401403404500
GET
/api/v2/payments
List of all payments
getPayments 5 params → 200400401500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are OrderItem (19 properties), OrderItemHistoryResponse (19 properties), PaymentResponse (17 properties), PaymentUpdate (17 properties). Each schema is shown below with its type and property counts.

FlightPointsSimple
object
2 properties 2 required
EducationDetails
object
Education-vertical risk signals for the current session.
3 properties 3 required
OrderItem
object
19 properties 4 required
PaymentCaptureResponse
object
Payment object.
17 properties 7 required
OrderItemHistoryResponse
object
19 properties 4 required
PaymentUpdate
object
Payment object.
17 properties 7 required
PaymentAmountResponse
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.
Attachment_V1
object
Extra data (booking info, insurance, flight reservations, ...) as serialized JSON
2 properties 2 required
Meta
object
Merchant-defined data about the payment. This field is a key-value map. The example properties provided below.
2 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…
RefundResponse
object
6 properties 2 required
Error_401_missingBearer
object
3 properties
OrderPaymentUpdate
object
6 properties 2 required
BuyerResponse
object
Customer information
4 properties 3 required
InsuranceDetails
object
3 properties 2 required
AttachmentPaymentHistoryFull
object
9 properties
Error_500
string
OrderItemResponse
object
15 properties 4 required
Marketplaces
object
Sellers' details within marketplaces.
7 properties 7 required
RefundRequest
object
4 properties 2 required
CaptureResponse
object
8 properties 2 required
OrderHistoryResponse
object
7 properties 5 required
Error_400_PaymentsGet
object
3 properties
PaymentResponse
object
Payment object.
17 properties 7 required
Error_404_no_such_payment
object
3 properties
PaymentClose
object
Payment object.
17 properties 7 required
Error_400_PaymentsRefund
object
3 properties
FlightReservationDetails
object
5 properties 3 required
Error_403
object
2 properties
Error_400_PaymentsClose
object
3 properties
PaymentCreatedAt
string
Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.
Error_400_PaymentsCapture
object
3 properties
CaptureRequest
object
6 properties 2 required
AttachmentPaymentHistorySimple
object
4 properties
Error_401
object
2 properties
Error_400_failed
object
3 properties
ShippingAddressResponse
object
3 properties 3 required
PaymentRefundResponse
object
Payment object.
17 properties 7 required
Error_409
object
3 properties
PaymentExpiresAt
string
Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.
PaymentID
string
Unique identifier for the payment (UUID), assigned by Tabby. Save it on your side!
Pagination
object
3 properties
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…
BuyerHistoryResponse
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
OrderResponse
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabby-payments-api-openapi.yml Raw ↑

Other APIs Tabby publishes across the network.

Tabby Checkout API
AE Profile APIs.io
Tabby Disputes API
AE Profile APIs.io
Tabby Webhooks API
AE Profile APIs.io
#Payments
← Back to T APIs
API Details
ID
tabby:tabby-payments-api
Server
https://api.tabby.ai/
Docs
https://docs.tabby.ai/api-reference/checkout/create-a-session
Provider
Tabby
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network