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

Teya Payment Requests API

The Payment Requests API from Teya — 4 operation(s) for payment requests.

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

Tagged areas include Payment Requests. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 15 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.

4 operations 4 paths 15 schemas 2 GET1 PATCH1 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
1

Paths & Operations 4

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

Payment Requests 4
POST
/poslink/v3/payment-requests
Create a payment request
createPaymentV3 1 param body → 201400401403408409415422
GET
/poslink/v2/payment-requests
List payments and refunds
getPaymentsV2 9 params → 500400408200401403429
PATCH
/poslink/v2/payment-requests/{payment-request-id}
Update a payment request
updatePayment 1 param body → 200400401403408415429500
GET
/poslink/v3/payment-requests/{payment-request-id}
Follow a payment or refund live
getPaymentByIdV3 1 param → 500400408200404401403429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RetrievePaymentResponse (16 properties), RetrieveStreamPaymentResponse (15 properties), CreatePaymentResponseV3 (13 properties), CreatePaymentRequestV3 (10 properties). Each schema is shown below with its type and property counts.

CreatePaymentResponseV3
object
Response to a request to create a new payment request. Includes tabid and paymenttype when the payment is linked to a tab.
13 properties
ExceptionResponse
object
3 properties
RequestedAmount
object
3 properties 2 required
CreatePaymentRequestV3
object
Request to create a new payment request. Supports standalone payments (SALE or REFUND) and Pay at Table payments (SALE only, when tabid is provided). See trans…
10 properties 5 required
InvalidParams
object
A single failed parameter from a 4xx validation response.
2 properties 2 required
Card
object
5 properties
GetAllPaymentRequestsResponse
object
2 properties
RetrievePaymentResponse
object
16 properties
Paging
object
4 properties
PaymentMethodDetails
object
8 properties
CancelPaymentRequestResponse
object
3 properties
TransactionMetadata
object
2 properties
RetrieveStreamPaymentResponse
object
15 properties
DccData
object
Dynamic Currency Conversion data. If present, all fields are required.
5 properties 5 required
NewCancelPaymentRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teya-payment-requests-api-openapi.yml Raw ↑

Other APIs Teya publishes across the network.

Teya Captures API
Teya DCC API
Teya ePOS Registration API
Teya Hosted Checkout API
Teya '@internal' API
Teya Pay at Table API
Teya PayByLink API
Teya Print Receipts (ePOS) API
Teya '@public' API
Teya Refunds API
Teya Reversals API
Teya Stores API