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

Telr Payments API API

Newer REST order API with HTTP Basic auth.

Telr Payments API API is one of 7 APIs that Telr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://secure.telr.com.

2 operations 2 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://secure.telr.com/gateway
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Telr Payments API API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth for the REST Service / Payments API: username = store id, password = API key (generated in Merchant Administration under Integrations Service A…

Paths & Operations 2

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

Payments API 2

Newer REST order API with HTTP Basic auth.

POST
/api/v1/orders
Create an order (REST Payments API)
createOrder body → 201400401
GET
/api/v1/orders/{ref}
Retrieve an order (REST Payments API)
getOrder 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are OrderRequest (8 properties), Order (5 properties), Customer (4 properties), ErrorResponse (4 properties). Each schema is shown below with its type and property counts.

OrderRequest
object
8 properties 4 required
Order
object
5 properties
ErrorResponse
object
4 properties
Customer
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telr-payments-api-api-openapi.yml Raw ↑

Other APIs Telr publishes across the network.

Telr Accounts and Split Payments API
Telr QuickLink and E-Invoicing API
Telr Click to Pay (C2P) API
Telr Agreements API
Telr Hosted Payment Page API
Telr Remote API