Payment Gateway - Hosted Payments API (HPP)
Tribe Payments Gateway Hosted Payments Page API (v3) that lets merchants collect card payments through a Tribe-hosted checkout, offloading PCI scope, plus a webhook interface for asynchronous transaction status notifications. Specification harvested verbatim from the Tribe developer portal.
Payment Gateway - Hosted Payments API (HPP) 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, Hosted Payment Page, E-commerce, and United Kingdom. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.
This API exposes 1 operation across 1 path, 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 - Hosted Payments API (HPP) declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-auth-account-id (accountId).
An API key is passed in the header as x-auth-account-password (accountPassword).
By default, every request must be authenticated.
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.
Schemas 23
The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are PrepareCustomer (12 properties), PrepareSettings (11 properties), Prepare (4 properties), PrepareTransaction (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 Tribe Payments 12
Other APIs Tribe Payments publishes across the network.