HyperPay Open Payment Platform API

Name: HyperPay Open Payment Platform API API
Brand: HyperPay Open Payment Platform API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment Processingbearer5 EndpointsREST

For Agents

Prepare checkouts, run server-to-server payments, and execute capture, reversal, refund, or rebill back-office operations on HyperPay's Open Payment Platform.

Connect the HyperPay Open Payment Platform API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HyperPay Open Payment Platform API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with HyperPay Open Payment Platform API API.

Prepare a hosted checkout session and receive a checkout ID for the payment widget

Run a server-to-server payment with stored card credentials or registration tokens

Look up the status of a payment after the customer completes checkout

Capture a previously authorised payment to settle the funds

GET STARTED

Start building with HyperPay Open Payment Platform API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for HyperPay Open Payment Platform API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for HyperPay Open Payment Platform API, keeping it validated and agent-ready. The HyperPay Open Payment Platform (OPP) provides a server-to-server payment integration covering credit and debit cards, digital wallets, bank transfers, and a long list of alternative payment methods popular across the Middle East and Europe. Agents can prepare a checkout, run a server-to-server payment, look up payment status, and run back-office operations such as capture, reversal, refund, and rebill. Authentication is a bearer access token issued by the HyperPay merchant backend.

Use Cases

Patterns agents use HyperPay Open Payment Platform API API for, with concrete tasks.

★ Hosted-checkout payment flow

Merchants embedding HyperPay's hosted widget call POST /v1/checkouts to prepare a session, then redirect the shopper to the widget keyed by checkoutId. After the shopper submits, the merchant agent calls GET /v1/checkouts/{checkoutId}/payment to read the result and reconcile the order. This pattern offloads PCI scope to HyperPay while keeping the merchant in control of order state.

POST /v1/checkouts with amount=49.99, currency=EUR, paymentType=DB, then poll GET /v1/checkouts/{checkoutId}/payment until a final result code is returned.

Subscription rebilling with registration tokens

SaaS merchants storing HyperPay registration tokens can run recurring charges entirely server-to-server through POST /v1/payments referencing the token. When a renewal date arrives, the agent calls /v1/payments with paymentType=DB and the registration ID, then checks the response to drive subscription state in the merchant's own database.

POST /v1/payments with the stored registration ID, paymentType=DB, amount, and currency to rebill the customer for the next subscription cycle.

Refunds and reversals

Customer-support agents handling chargebacks and goodwill refunds use POST /v1/payments/{paymentId} with paymentType=RF (refund) or RV (reversal) to reverse the original capture without leaving the support workflow. This is the same back-office endpoint that handles capture and rebill, switched by the paymentType field.

POST /v1/payments/{paymentId} with paymentType=RF and the partial refund amount, then read the response result code to confirm success.

AI agent for merchant operations

Through Jentic, an AI agent can resolve a support ticket like 'refund order 12345' by looking up the HyperPay payment ID in the order system and calling POST /v1/payments/{paymentId} with paymentType=RF. The HyperPay bearer token sits in the Jentic vault, and the agent never sees the raw secret.

Search Jentic for 'refund a hyperpay payment', load POST /v1/payments/{paymentId}, and execute it with paymentType=RF and the payment ID from the support ticket.

Key Endpoints

5 endpoints — jentic publishes the only available openapi specification for hyperpay open payment platform api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v1/checkouts

Prepare a hosted checkout session

GET

/v1/checkouts/{checkoutId}/payment

Read the result of a checkout

POST

/v1/payments

Run a server-to-server payment

GET

/v1/payments/{paymentId}

Get the status of a payment

POST

/v1/payments/{paymentId}

Run capture, reversal, refund, or rebill on an existing payment

POST

/v1/checkouts

Prepare a hosted checkout session

GET

/v1/checkouts/{checkoutId}/payment

Read the result of a checkout

POST

/v1/payments

Run a server-to-server payment

GET

/v1/payments/{paymentId}

Get the status of a payment

POST

/v1/payments/{paymentId}

Run capture, reversal, refund, or rebill on an existing payment

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The HyperPay bearer token is stored encrypted in the Jentic vault per merchant. Agents receive a scoped execution context — the token is added to Authorization at request time and never appears in agent prompts, logs, or model context.

Intent-based discovery

Agents search Jentic with intents like 'prepare a hyperpay checkout' or 'refund a hyperpay payment' and Jentic returns the matching operation under /v1/checkouts or /v1/payments with its full input schema.

Time to first call

Direct integration: 2-3 days to read HyperPay docs, configure test merchant, handle result codes, and wire 3D Secure. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe

Globally available payment processor with broad SDK and method coverage

Choose Stripe when the merchant needs global coverage and a deeper SDK ecosystem rather than HyperPay's regional alternative payment methods.

Alternative

Adyen Checkout

Enterprise checkout API with worldwide coverage and unified reporting

Choose Adyen when the merchant operates at enterprise scale and needs unified settlement across many regions.

Alternative

Braintree

PayPal-owned payment gateway with strong subscription tooling

Choose Braintree when PayPal acceptance is a requirement and the merchant prefers PayPal's gateway tooling.

Complementary

Mollie

European-focused PSP with strong local payment method coverage

Use alongside HyperPay for European local methods such as iDEAL or Bancontact when HyperPay's regional mix does not cover the customer base.

FAQs

Specific to using HyperPay Open Payment Platform API API through Jentic.

Why is there no official OpenAPI spec for HyperPay Open Payment Platform API?

HyperPay does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call HyperPay Open Payment Platform API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the HyperPay OPP API use?

Each request is authorised with an HTTP bearer access token issued by the HyperPay merchant backend. Through Jentic the token is stored encrypted in the vault and added to the Authorization header at execution, so the agent never receives the secret.

Can I issue a refund through this API?

Yes. Refunds are issued by POST /v1/payments/{paymentId} with paymentType=RF. The same endpoint handles capture (CP), reversal (RV), and rebill (DB) — the operation is selected by the paymentType field rather than separate URLs.

What are the rate limits for the HyperPay OPP API?

HyperPay does not document rate limits in this spec; they are governed by the merchant's contract and the test or production environment in use. The spec exposes both eu-test.oppwa.com and eu-prod.oppwa.com servers, and limits are stricter on the test environment.

How do I prepare a checkout through Jentic?

Search Jentic for 'prepare a hyperpay checkout', load POST /v1/checkouts, and execute it with amount, currency, and paymentType. The response includes a checkoutId you pass to the HyperPay widget on the front end.

Does this API handle 3D Secure?

3D Secure is enabled at the HyperPay account level and is signalled in the result codes returned by GET /v1/payments/{paymentId} and the checkout result endpoint. The agent inspects the result code to determine whether the payment succeeded, was rejected, or requires further action.