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 PayByLink API

APIs exposed for pay by link customers

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

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

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

3 operations 3 paths 9 schemas 1 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 3

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

PayByLink 3

APIs exposed for pay by link customers

POST
/v2/payment-links
Creates a new payment link
createPaymentLinkV2 1 param body → 201400401403429500
GET
/v1/payment-links/{payment_link_id}
Gets a payment link by id
getPaymentLink 1 param → 200400401403404429500
PATCH
/v2/payment-links/{payment_link_id}
Updates an existing payment link
updatePaymentLink 1 param body → 200400401403404429500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are pbl_CreatePaymentLinkRequestV2 (20 properties), pbl_GetPaymentLinkResponse (17 properties), pbl_AddressDto (7 properties), pbl_PaymentLinkLineItem (3 properties). Each schema is shown below with its type and property counts.

pbl_Customer
object
3 properties
pbl_CreatePaymentLinkResponse
object
The created payment link information
2 properties 1 required
pbl_CreatePaymentLinkRequestV2
object
A request to create a payment link. When used with a user token, the field storeid is mandatory. When used with a terminal token, the field deliveryinfo is man…
20 properties 1 required
pbl_AddressDto
object
An address
7 properties 1 required
pbl_Amount
object
The transaction amount in the smallest currency unit according to ISO 4217 format. For example: - 100 ISK (Icelandic króna): the amount is 100 (since 1 ISK = 1…
2 properties 2 required
pbl_PaymentLinkLineItem
object
Basket information to be shown in payment page
3 properties 3 required
pbl_DeliveryInfo
object
2 properties
pbl_GetPaymentLinkResponse
object
The requested payment link data
17 properties 3 required
pbl_UpdatePaymentLinkRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teya-paybylink-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 Payment Requests API
Teya Print Receipts (ePOS) API
Teya '@public' API
Teya Refunds API
Teya Reversals API
Teya Stores API