Telr Agreements API
Repeat billing / recurring agreement management.
Telr Agreements API is one of 7 APIs that Telr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agreements. 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 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://secure.telr.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Telr Agreements 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.
Repeat billing / recurring agreement management.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is AgreementRequest (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Telr 6
Other APIs Telr publishes across the network.