Payment Gateway - Reports API
Tribe Payments Gateway Reports API (v3) providing merchants programmatic access to transaction reporting and reconciliation data over REST, with a report callback interface for delivering generated reports asynchronously. Harvested verbatim from the Tribe developer portal.
Payment Gateway - Reports API is one of 15 APIs that Tribe Payments publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments, Payment Gateway, Reporting, Reconciliation, and United Kingdom. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes 4 operations across 4 paths, organized into 4 resource areas, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.
Requests are made against a single base URL, http://127.0.0.1:10010/v3.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payment Gateway - Reports API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-auth-report-api-key (apiKey).
An API key is passed in the header as x-auth-report-api-password (apiPassword).
By default, every request must be authenticated.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 4 POST. They span 4 resource areas: Order status, Disputes, Transactions, Processing accounts. Each is listed below with its method, path, parameters, and response codes.
Schemas 23
The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are violationObjectDisputes (3 properties), responseTooManyRequests (3 properties), responseForbidden (3 properties), responseUnauthorized (3 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 Tribe Payments 12
Other APIs Tribe Payments publishes across the network.