ZeroSettle Transactions API
Query transaction status and history
ZeroSettle Transactions API is one of 12 APIs that ZeroSettle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transactions. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://api.zerosettle.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
ZeroSettle Transactions API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-ZeroSettle-Key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Your publishable API key. Use zspktest for sandbox or zspklive for production.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.
Query transaction status and history
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TransactionHistoryItem (9 properties), Transaction (8 properties), Error (2 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 ZeroSettle 11
Other APIs ZeroSettle publishes across the network.