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 Hosted Payment Page API

Redirect-based hosted checkout (order.json).

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

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

This API exposes 1 operation across 1 path, 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.

1 operations 1 paths 4 schemas 1 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 Hosted Payment Page 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 1

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

Hosted Payment Page 1

Redirect-based hosted checkout (order.json).

POST
/gateway/order.json
Create or check a hosted payment page order
createHostedOrder body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are HostedOrderRequest (7 properties), HostedOrder (7 properties), Customer (4 properties), HostedOrderResponse (4 properties). Each schema is shown below with its type and property counts.

HostedOrderResponse
object
4 properties
HostedOrder
object
7 properties
Customer
object
4 properties
HostedOrderRequest
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telr-hosted-payment-page-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 Payments API API
Telr Remote API