HyperPay · OpenAPI Overlay 1.0.0

API Evangelist enhancements for HyperPay Payment API

4 actions 4 updates update extends openapi/hyperpay-openapi.yml

Derived by API Evangelist Built from the contracts HyperPay publishes. HyperPay did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-agentic-consequencex-agentic-human-in-the-loopx-apievangelist-providerx-apievangelist-platformx-apievangelist-paymentsx-apievangelist-regionx-apievangelist-artifactsx-result-code-field

Targets 4

$.info

$.paths['/v1/payments'].post

$.paths['/v1/payments/{id}'].post

$.components.securitySchemes.bearerAuth

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for HyperPay Payment API
  version: 1.0.0
extends: openapi/hyperpay-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: hyperpay
      x-apievangelist-platform: ACI / OPPWA Open Payment Platform
      x-apievangelist-payments: true
      x-apievangelist-region: MENA / Saudi Arabia
      x-apievangelist-artifacts:
        authentication: authentication/hyperpay-authentication.yml
        conventions: conventions/hyperpay-conventions.yml
        error_catalog: errors/hyperpay-result-codes.yml
        decline_codes: errors/hyperpay-decline-codes.yml
        webhooks: asyncapi/hyperpay-webhooks.yml
        sandbox: sandbox/hyperpay-sandbox.yml
        data_model: data-model/hyperpay-data-model.yml
        lifecycle: lifecycle/hyperpay-lifecycle.yml
        agentic_access: agentic-access/hyperpay-agentic-access.yml
  - target: $.paths['/v1/payments'].post
    update:
      x-agentic-consequence: physical
      x-agentic-human-in-the-loop: required
      x-result-code-field: result.code
  - target: $.paths['/v1/payments/{id}'].post
    update:
      x-agentic-consequence: physical
      x-agentic-human-in-the-loop: required
      x-backoffice: true
  - target: $.components.securitySchemes.bearerAuth
    update:
      x-companion-credential: entityId (channel identifier, required on every request)
      x-docs: https://hyperpay.docs.oppwa.com/reference/parameters

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/hyperpay-openapi-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.