HyperPay Payments API
Server-to-Server payments and back-office operations.
HyperPay Payments API is one of 6 APIs that HyperPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against 2 base URLs: https://eu-prod.oppwa.com, https://test.oppwa.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HyperPay Payments API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (accessToken) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Access token issued by HyperPay, sent as Authorization: Bearer . Every request must ALSO carry an entityId channel identifier (as a form field on writes or a q…
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
Server-to-Server payments and back-office operations.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PaymentResponse (11 properties), PaymentRequest (10 properties), BackofficeRequest (4 properties), Result (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 HyperPay 5
Other APIs HyperPay publishes across the network.