HitPay · OpenAPI Overlay 1.0.0

API Evangelist enhancements for HitPay Payments API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-enrichedx-apievangelist-artifactsx-agentic-accessx-compliancex-apievangelist-notex-webhook-eventsx-drop-in-ui

Targets 3

$.info

$.components.securitySchemes.businessApiKey

$.paths['/payment-requests'].post

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for HitPay Payments API
  version: 1.0.0
# Provenance: generated 2026-07-17, method generated.
# Non-destructive enhancement layer over the modeled spec. The authoritative
# richer spec is openapi/hitpay-openapi-original.json (79 ops, searched from
# https://docs.hitpayapp.com/openapi.json); this overlay annotates the curated
# modeled spec that carries securitySchemes/tags.
extends: openapi/hitpay-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist-enriched: true
      x-apievangelist-artifacts:
        authoritative-spec: openapi/hitpay-openapi-original.json
        mcp: mcp/hitpay-mcp.yml
        cli: cli/hitpay-cli.yml
        skills: skills/_index.yml
        webhooks: asyncapi/hitpay-events-webhooks.yml
        sandbox: sandbox/hitpay-sandbox.yml
        conventions: conventions/hitpay-conventions.yml
        components: components/hitpay-components.yml
        data-model: data-model/hitpay-data-model.yml
        errors: errors/hitpay-problem-types.yml
        conformance: conformance/hitpay-conformance.yml
  - target: $.info
    update:
      x-agentic-access: agentic-access/hitpay-agentic-access.yml
      x-compliance:
        - PCI DSS
        - MAS Major Payment Institution (Singapore)
  - target: $.components.securitySchemes.businessApiKey
    update:
      x-apievangelist-note: >-
        Per-merchant Business API key. Sandbox uses a separate account/key against
        https://api.sandbox.hit-pay.com/v1. See authentication/hitpay-authentication.yml.
  - target: "$.paths['/payment-requests'].post"
    update:
      x-webhook-events:
        - payment_request.completed
        - payment_request.failed
        - charge.created
      x-drop-in-ui: components/hitpay-components.yml

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/hitpay-openapi-overlay"

All openapi overlays

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.