Pay at Table

Pause a tab

Records a pause event on the tab. Strict semantics: only a tab in PAYING status can be paused — pause is a mid-split-payment operation. On success the tab moves to PAUSED and the ePOS receives a TAB_PAUSED SSE event.

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

Request

Base URL
https://api.teya.com
Auth
OAuth 2
Authorization codehttps://id.teya.com/oauth/v2/oauth-authorize
Token URLhttps://id.teya.com/oauth/v2/oauth-token
TypeScript
https://skmtc.dev/teya/apis/poslink-api/docs/poslink/v1/tabs/:tab_id/pauses/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tab_idstring uuid required

The tab identifier

Request body

terminal_idstring required

The terminal identifier

Example request

{
  "terminal_id": "term-001"
}

Response

Tab paused; pause event recorded

tab_idstring uuid

Tab identifier

status'OPEN' | 'PAYING' | 'PAUSED' | 'COMPLETED' | 'CLOSED'

Tab status after pause

total_paidinteger

Total amount paid so far, in the tab's currency

remaininginteger

Remaining amount to be paid, in the tab's currency

Example response

{
  "tab_id": "3f2b6a2e-9d3e-4a1f-8f1e-6b2e5a8c9d01",
  "status": "PAUSED",
  "total_paid": 1500,
  "remaining": 3500
}

Changes

No recorded changes to this operation across all 1 revision of this API.