Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HyperPay Registrations API

Tokenization of payment instruments for one-click and recurring.

HyperPay Registrations API is one of 6 APIs that HyperPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Registrations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 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.

4 operations 3 paths 4 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://eu-prod.oppwa.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

HyperPay Registrations 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 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Registrations 4

Tokenization of payment instruments for one-click and recurring.

POST
/v1/registrations
Register (tokenize) a payment instrument
createRegistration body → 200
GET
/v1/registrations/{id}
Retrieve a registration token
getRegistration 2 params → 200
DELETE
/v1/registrations/{id}
Delete a registration token
deleteRegistration 2 params → 200
POST
/v1/registrations/{id}/payments
Pay with a stored registration token
createRegistrationPayment 1 param body → 200

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), RegistrationRequest (7 properties), Result (2 properties). Each schema is shown below with its type and property counts.

PaymentRequest
object
10 properties 5 required
PaymentResponse
object
11 properties
RegistrationRequest
object
7 properties 2 required
Result
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperpay-registrations-api-openapi.yml Raw ↑

Other APIs HyperPay publishes across the network.

HyperPay HyperSplit
HyperPay HyperBill
HyperPay COPYandPAY API
HyperPay Payments API
HyperPay Query API