Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HiPay Order API

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

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.0.0, at version 1.6.1.

Requests are made against 2 base URLs: https://stage-api-gateway.hipay.com, https://api-gateway.hipay.com.

2 operations 2 paths 43 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.6.1
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.

Address
object
8 properties
Status2
integer
BasketItem
object
Representation of one product line in a customer basket
11 properties 7 required
Operation2
object
14 properties 8 required
Currency
string
Customer
object
6 properties 2 required
Acquirer2
object
1 property
TerminalInformation
object
13 properties
Order_2
object
Object containing all the basic information of a given transaction.
9 properties 2 required
OrderResponse
object
7 properties
ReasonCode2
object
2 properties
PaymentProduct2
object
3 properties 2 required
ThreeDSAuthenticationLiability2
string
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
Cvc2
string
TechnicalInformation
object
Object that contains technical parameters that are required to process the order.
4 properties 1 required
ThreeDSAuthenticationMethod2
string
Status5
string
Error
object
4 properties 2 required
ComputedAuthenticationStatus2
string
ShippingAddress
object
8 properties
Card2
object
7 properties
PaymentMethod2
object
2 properties 2 required
Device2
object
2 properties 1 required
OperationStatus2
string
RootOrder
object
Definition of the order's api call body
4 properties 2 required
Authentication5
string
Address_2
object
Address format
7 properties
ErrorResponse
object
1 property
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
CardEntryMode
string
DebitAgreement2
object
4 properties 2 required
AcquirerTraContext2
object
Result2
string
TransactionState2
string
FraudResult2
object
3 properties 3 required
Order
object
15 properties 12 required
Preference2
integer
Review2
string
OperationType2
string
Issuer2
object
3 properties
Transaction2
object
33 properties 22 required
Authentication2
object
10 properties 1 required

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
HiPay bank-info API
HiPay captcha-generation API
HiPay Connector API
HiPay constants API
HiPay identification API
HiPay invoice API
HiPay maintenance API
HiPay merchant-group API
HiPay payments API
HiPay Routing API
HiPay Sessions API