Teya Pay at Table API

The Pay at Table API from Teya — 9 operation(s) for pay at table.

Documentation Provider Profile APIs.io OpenAPI GitHub

Teya Pay at Table API is one of 16 APIs that Teya publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pay at Table. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 2 base URLs: https://api.teya.com, https://api.teya.xyz.

13 operations 9 paths 53 schemas 1 DELETE4 GET1 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

1.0.0

Base URL

https://api.teya.com

Resource Areas

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 4 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Pay at Table 13

GET

/poslink/v1/tabs

List tabs for a store

listTabs 6 params → 200400401403408429500

POST

/poslink/v1/tabs

Create a new tab

createTab 1 param body → 201400401403408409415429

POST

/poslink/v1/tabs/{tab_id}/show-bill-intents

Create a show-bill intent

createShowBillIntent 1 param body → 202400401403404408409415

POST

/poslink/v1/tabs/{tab_id}/payment-intents

Create a payment intent

createPaymentIntent 1 param body → 202400401403404408409415

POST

/poslink/v1/tabs/{tab_id}/pauses

Pause a tab

pauseTab 1 param body → 201400401403404408409415

POST

/poslink/v1/tabs/{tab_id}/hide-bill-intents

Create a hide-bill intent

createHideBillIntent 1 param body → 202400401403404408409415

POST

/poslink/v1/tabs/{tab_id}/errors

Report a tab error

reportError 1 param body → 202400401403404408415429

GET

/poslink/v1/tabs/{tab_id}/bill

Retrieve the current bill for a tab

getBill 1 param → 200400401403404408429500

POST

/poslink/v1/tabs/{tab_id}/bill

Send bill content to the server

sendBillContent 1 param body → 202400401403404408409415

GET

/poslink/v1/tabs/{tab_id}

Retrieve a tab

getTab 1 param → 200400401403404408429500

DELETE

/poslink/v1/tabs/{tab_id}

Close a tab

closeTab 1 param → 200400401403404408409429

PATCH

/poslink/v1/tabs/{tab_id}

Update a tab

updateTab 1 param body → 200400401403404408409415

GET

/poslink/v1/tabs/events

Stream tab events for a store

streamTabEvents 1 param → 200400401403408429500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are TabDetailResponse (17 properties), BillDetailResponse (13 properties), TabResponse (12 properties), PaymentRequestSummary (10 properties). Each schema is shown below with its type and property counts.

TabAmountWithCurrency

object

Amount with currency for tab operations

2 properties 2 required

ExceptionResponse

object

3 properties

RequestedAmount

object

3 properties 2 required

Cursors

object

Opaque cursors for paginating forward (after) and backward (before)

2 properties

InvalidParams

object

A single failed parameter from a 4xx validation response.

2 properties 2 required

TabResumedEvent

SSE event: tab has been resumed

2 required

Row

object

1 property 1 required

SpacerRow

TableInnerRow

object

1 property 1 required

PayIntentRequest

object

Request from terminal to initiate a payment intent

4 properties 4 required

ShowBillResponse

object

Response after sending bill to a terminal (ePOS-facing)

4 properties

DccData

object

Dynamic Currency Conversion data. If present, all fields are required.

5 properties 5 required

ShowBillRequestEvent

SSE event: terminal requested to show bill

2 required

TabItem

object

An individual item on a tab bill

3 properties 3 required

TabErrorRequest

object

Request to report an error on a tab

3 properties 3 required

TabErrorResponse

object

Response after reporting a tab error

2 properties

ShowBillRequest

object

Request to push a structured bill to a terminal for display

4 properties 2 required

QrCodeElement

1 required

Element

object

1 property 1 required

TabDetailResponse

object

Detailed tab response including bill state and linked payment requests.

17 properties 11 required

PaymentMethodDetails

object

8 properties

CreateTabRequest

object

Request to create a new tab

5 properties 4 required

BillDetailResponse

object

Detailed bill information for terminal

13 properties 7 required

TabSummary

object

Summary of a tab

8 properties 7 required

TableRow

TabPausedEvent

SSE event: tab has been paused

2 required

TabCompletedEvent

SSE event: tab fully paid and completed

2 required

HideBillIntentResponse

object

Response for a hide-bill intent — the request has been accepted and forwarded to the ePOS

2 properties

TabPaymentCompletedEvent

SSE event: individual payment completed

2 required

PrintDocument

object

1 property 1 required

TabPaymentProgressEvent

SSE event: payment progress update

2 required

CursorPaging

object

2 properties

TabEvent

object

Union of all SSE events emitted by the tab stream. See discriminator eventtype for the concrete variant.

1 property 1 required

TabBillHiddenEvent

SSE event: bill has been hidden from terminal

2 required

PayRequestEvent

SSE event: terminal initiated a payment request

2 required

TabListResponse

object

Paginated list of tabs

2 properties

PaymentRequestSummary

object

Summary of a payment request on a tab

10 properties 5 required

DividerRow

TextElement

1 required

SendBillImageForm

object

multipart/form-data payload for pushing a pre-rendered bill image

4 properties 4 required

TableHeaderCell

object

2 properties 1 required

Card

object

5 properties

TerminalIdRequest

object

Request containing a terminal identifier

1 property 1 required

Paths

object

Relative paths for navigating to the previous and next pages

2 properties

CloseTabResponse

object

Response for tab closure (soft delete)

3 properties 3 required

ShowBillIntentResponse

object

Response for a show-bill intent — the request has been accepted and forwarded to the ePOS

4 properties

ImageElement

1 required

ItemsRow

1 required

TransactionMetadata

object

2 properties

PayIntentResponse

object

Response after creating a pay intent

7 properties

UpdateTabRequest

object

Request to update a tab's content. All fields optional; only the ones provided are applied.

2 properties

PauseTabResponse

object

Response after pausing a tab

4 properties

TabResponse

object

Response for tab creation

12 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Teya publishes across the network.

Teya Captures API

AE Profile APIs.io

Teya DCC API

AE Profile APIs.io

Teya ePOS Registration API

AE Profile APIs.io

Teya Hosted Checkout API

AE Profile APIs.io

Teya '@internal' API

AE Profile APIs.io

Teya PayByLink API

AE Profile APIs.io

Teya Payment Requests API

AE Profile APIs.io

Teya Print Receipts (ePOS) API

AE Profile APIs.io

Teya '@public' API

AE Profile APIs.io

Teya Refunds API

AE Profile APIs.io

Teya Reversals API

AE Profile APIs.io

Teya Stores API

AE Profile APIs.io

#Pay at Table

← Back to T APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Teya Pay at Table API

Metadata

Paths & Operations 13

Schemas 53

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Teya Pay at Table API

Metadata

Paths & Operations 13

Schemas 53

Specification

Source

More from Teya 12

API Details

Provider

Explore more