How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HiPay

HiPay payments API

Everything you need to create orders and transactions

Documentation Provider Profile APIs.io OpenAPI GitHub

HiPay payments API is one of 20 APIs that HiPay 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 and API documentation.

This API exposes 2 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 4 base URLs: https://stage-secure-gateway.hipay-tpp.com/rest, https://secure-gateway.hipay-tpp.com/rest, https://stage-api.hipay.com, https://stage-secure-gateway.hipay-tpp.com/rest/.

2 operations 2 paths 14 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api-gateway.hipay.com
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

HiPay payments API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-Api-Key (apiKey).

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.

payments 2

Everything you need to create orders and transactions

POST
/v1/order
Creates an order and a transaction based on payment details
requestNewOrder body → 200400401403
POST
/v1/hpayment
Creates a secure payment page which you can redirect your customer to, in order to proceed checkout
generatePage body → 200400401403

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Order (52 properties), Common (39 properties), Transaction (31 properties), OrderResponse (13 properties). Each schema is shown below with its type and property counts.

InputOrder
object
InputOrder model
6 required
ThreeDSecure
object
ThreeDSecure model
7 properties
debitAgreement
object
Debit Agreement model
2 properties
Common
object
Common model
39 properties
paymentMethod
object
Payment model
8 properties
Order
object
Order model
52 properties
fraud
object
Fraud screening model
3 properties
Transaction
object
Transaction model
31 properties
Error
object
Error model
3 properties
OrderResponse
object
Order Response model
13 properties
reason
object
Reason model
2 properties
HostedPage_OrderResponse
object
Order Response model
11 properties
HostedPage_Forward
object
Forward
4 properties
HostedPage_Error
object
Error model
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-payments-api-openapi.yml Raw ↑

Other APIs HiPay publishes across the network.

HiPay balance API
AE Profile APIs.io
HiPay bank-info API
AE Profile APIs.io
HiPay captcha-generation API
AE Profile APIs.io
HiPay Connector API
AE Profile APIs.io
HiPay constants API
AE Profile APIs.io
HiPay identification API
AE Profile APIs.io
HiPay invoice API
AE Profile APIs.io
HiPay maintenance API
AE Profile APIs.io
HiPay merchant-group API
AE Profile APIs.io
HiPay Order API
AE Profile APIs.io
HiPay Routing API
AE Profile APIs.io
HiPay Sessions API
AE Profile APIs.io
#Payments
← Back to H APIs
API Details
ID
hipay:hipay-payments-api
Base URL
https://api-gateway.hipay.com
Docs
https://developer.hipay.com/api-explorer/api-gateway
Provider
HiPay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=hipay-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hipay-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of HiPay payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.