TEteya
Pay at Table

Create a new tab

Creates a new tab for a store. The tab starts in OPEN status.

post/poslink/v1/tabs

Request

Headers

Idempotency-Keystring required

Unique key used to safely retry the request. Repeating the request with the same key and body returns the same tab. Reusing the same key with a different body returns HTTP 409. Keys are scoped to the store and retained for at least 24h.

Request body

store_idstring uuid required

The store identifier

tab_namestring required

Display name for the tab.

merchant_referencestring required

Merchant-assigned reference for this tab. Unique per store.

epos_instance_idstring

External ID of the ePOS instance that opened the tab.

currency_codestring required

ISO 4217 currency code for the tab

Example request

{
  "store_id": "eac4d470-4731-45b2-af6b-c828f03c1f9d",
  "tab_name": "Table 5",
  "merchant_reference": "ORDER-2026-001",
  "epos_instance_id": "epos-register-1",
  "currency_code": "GBP"
}

Response

Tab created successfully

tab_idstring uuid required

Tab identifier

store_idstring uuid required

Store identifier

tab_namestring required

Tab display name

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

Current tab status

total_paidinteger required

Total amount paid so far, in the same currency as total_amount

remaininginteger required

Remaining amount to be paid, in the same currency as total_amount

merchant_referencestring required

Merchant-assigned unique reference for the tab.

epos_instance_idstring

ePOS instance identifier

created_atstring date-time required

ISO 8601 creation timestamp (in UTC)

updated_atstring date-time required

ISO 8601 last update timestamp (in UTC)

Example response

{
  "tab_id": "3f2b6a2e-9d3e-4a1f-8f1e-6b2e5a8c9d01",
  "store_id": "eac4d470-4731-45b2-af6b-c828f03c1f9d",
  "tab_name": "Table 5",
  "status": "OPEN",
  "total_amount": {
    "amount": 1500,
    "currency": "EUR"
  },
  "remaining": 5000,
  "merchant_reference": "ORDER-2026-001",
  "epos_instance_id": "epos-register-1",
  "payment_requests": [
    {
      "payment_request_id": "9c1a7c2c-3e2a-4d5b-9f8a-6c2e5a8c9d01",
      "merchant_reference": "ORDER_123",
      "status": "SUCCESSFUL",
      "requested_amount": {
        "currency": "GBP",
        "amount": 50,
        "tip": 0
      },
      "payment_method": "CARD",
      "payment_type": "FULL",
      "created_at": "2026-04-14T10:00:00Z",
      "updated_at": "2026-04-14T10:05:00Z",
      "metadata": {
        "payment_method_details": {
          "card": {
            "last4": "4673",
            "issuing_country": "GB",
            "brand": "MASTERCARD",
            "type": "DEBIT",
            "bin": "123456"
          },
          "entry_mode": "EMV_CONTACTLESS",
          "verification_method": "NONE",
          "application_id": "A0000000041010",
          "mid": "5006544",
          "response_code": "00",
          "authorisation_code": "537001"
        }
      },
      "transaction_timestamp": "2026-04-14T10:04:30Z"
    }
  ],
  "created_at": "2026-04-14T10:00:00Z",
  "updated_at": "2026-04-14T10:00:00Z"
}

Changes

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