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

Everything you need to create orders and transactions

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 11 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 11 schemas 2 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 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 (ApiKeyAuth).

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 96 params → 200400401403

Schemas 11

The contract defines 11 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.

Common
object
Common model
39 properties
paymentMethod
object
Payment model
8 properties
Transaction
object
Transaction model
31 properties
Order
object
Order model
52 properties
debitAgreement
object
Debit Agreement model
2 properties
fraud
object
Fraud screening model
3 properties
InputOrder
object
InputOrder model
6 required
reason
object
Reason model
2 properties
ThreeDSecure
object
ThreeDSecure model
7 properties
OrderResponse
object
Order Response model
13 properties
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
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 Order API
HiPay Routing API
HiPay Sessions API