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 Order API

The Order API from HiPay — 2 operation(s) for order.

Documentation Provider Profile APIs.io OpenAPI GitHub

HiPay Order API is one of 20 APIs that HiPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 3 base URLs: https://stage-api-gateway.hipay.com, https://api-gateway.hipay.com, https://cloudrun-api-yugcnet4yq-ew.a.run.app/.

2 operations 2 paths 43 schemas 1 GET1 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 Order 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 (ApiKeyAuth).

Paths & Operations 2

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

Order 2
GET
/v3/order/{orderid}
get_api_order_consultation_public 1 param → 200401404
POST
/v1/connector/order
Wake a POS payment terminal to process an order payment.
postOrder body → 200400401403500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Transaction2 (33 properties), Order (15 properties), Operation2 (14 properties), TerminalInformation (13 properties). Each schema is shown below with its type and property counts.

Preference2
integer
OperationType2
string
Authentication2
object
10 properties 1 required
OperationStatus2
string
Authentication5
string
PaymentProduct2
object
3 properties 2 required
Address
object
8 properties
ComputedAuthenticationStatus2
string
Cvc2
string
Currency
string
Card2
object
7 properties
Order
object
15 properties 12 required
ReasonCode2
object
2 properties
Device2
object
2 properties 1 required
TransactionState2
string
Issuer2
object
3 properties
Status5
string
Status2
integer
Error
object
4 properties 2 required
PaymentMethod2
object
2 properties 2 required
Transaction2
object
33 properties 22 required
ThreeDSAuthenticationLiability2
string
Review2
string
ShippingAddress
object
8 properties
ThreeDSAuthenticationMethod2
string
AcquirerTraContext2
object
Operation2
object
14 properties 8 required
CardEntryMode
string
TerminalInformation
object
13 properties
Customer
object
6 properties 2 required
Acquirer2
object
1 property
Result2
string
FraudResult2
object
3 properties 3 required
DebitAgreement2
object
4 properties 2 required
TechnicalInformation
object
Object that contains technical parameters that are required to process the order.
4 properties 1 required
ErrorResponse
object
1 property
Shipping
object
To get additional insights and to be more efficient in fighting against fraud, it is recommended to send any relevant shipping information.
5 properties
RootOrder
object
Definition of the order's api call body
4 properties 2 required
Customer_2
object
To get additional insights and to be more efficient in fighting against fraud, it is recommended to send any relevant information about the customer.
9 properties
Order_2
object
Object containing all the basic information of a given transaction.
9 properties 2 required
BasketItem
object
Representation of one product line in a customer basket
11 properties 7 required
OrderResponse
object
7 properties
Address_2
object
Address format
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-order-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 payments API
AE Profile APIs.io
HiPay Routing API
AE Profile APIs.io
HiPay Sessions API
AE Profile APIs.io
#Order
← Back to H APIs
API Details
ID
hipay:hipay-order-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-order-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/hipay-order-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 Order 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.