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

The Transaction API from HiPay — 6 operation(s) for transaction.

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

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

This API exposes 6 operations across 6 paths, and defines 78 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.

6 operations 6 paths 78 schemas 6 GET

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 Transaction 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 6

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

Transaction 6
GET
/v3/transaction/{transaction_reference}
get_api_transaction_consultation_public 1 param → 200401404
GET
/v3/transactions/{type}/{value}
get_api_transaction_consultations_by_type_public 2 params → 200400401404
GET
/v1/transaction/{transaction_reference}deprecated
Gets details of existing transactions based on a transaction ID
getTransactionByReference 1 param → 200400401403
GET
/v1/transactiondeprecated
Gets details of existing transactions related to a given order
getTransactionsByReference 1 param → 200400401403
GET
/transaction.{_format}
Get transactions list
8 params → 200400401
GET
/transaction/{id}.{_format}
Get transaction details
4 params → 200400401

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are Transaction3 (36 properties), Transaction (35 properties), Transaction_2 (31 properties), Operation (14 properties). Each schema is shown below with its type and property counts.

Result3
string
reason
object
Reason model
2 properties
Preference
integer
Issuer3
object
3 properties
Review3
string
Address2
object
8 properties
Authentication4
object
10 properties 1 required
ReasonCode
object
2 properties
paymentMethod
object
Payment model
8 properties
ComputedAuthenticationStatus3
string
ThreeDSAuthenticationMethod3
string
Status6
string
CardEntryMode2
string
Transaction_2
object
Transaction model
31 properties
OperationType3
string
Error_2
object
Error model
3 properties
TerminalInformation2
object
13 properties
fraud
object
Fraud screening model
3 properties
Authentication6
string
Status
integer
Cvc3
string
PaymentMethod3
object
2 properties 2 required
ThreeDSAuthenticationLiability
string
Transaction
object
35 properties 23 required
Acquirer
object
1 property
OperationStatus3
string
DebitAgreement
object
4 properties 2 required
Cvc
string
AcquirerTraContext3
object
Device3
object
2 properties 1 required
Error
object
4 properties 2 required
Transaction3
object
36 properties 24 required
FraudResult3
object
3 properties 3 required
Status4
integer
Device
object
2 properties 1 required
CardEntryMode3
string
Authentication3
string
ThreeDSAuthenticationMethod
string
Review
string
FraudResult
object
3 properties 3 required
Customer2
object
6 properties 2 required
Address3
object
8 properties
debitAgreement
object
Debit Agreement model
2 properties
TransactionState
string
OperationType
string
Card
object
7 properties
Card3
object
7 properties
StatusHistoryCollection
object
DebitAgreement3
object
4 properties 2 required
ReasonCode3
object
2 properties
PaymentMethod
object
2 properties 2 required
Order2
object
13 properties 10 required
TerminalInformation3
object
13 properties
Preference3
integer
Order3
object
13 properties 10 required
Customer3
object
6 properties 2 required
Acquirer3
object
1 property
ThreeDSecure
object
ThreeDSecure model
7 properties
OrderResponse
object
Order Response model
13 properties
OperationStatus
string
ShippingAddress3
object
8 properties
ComputedAuthenticationStatus
string
Operation3
object
14 properties 8 required
Operation
object
14 properties 8 required
Currency2
string
PaymentProduct
object
3 properties 2 required
Result
string
Authentication
object
10 properties 1 required
ThreeDSAuthenticationLiability3
string
ShippingAddress2
object
8 properties
Status3
string
PaymentProduct3
object
3 properties 2 required
Issuer
object
3 properties
AcquirerTraContext
object
TransactionCollection
object
1 property
TransactionDetail
object
Transaction detail
1 property
TransactionState3
string
Currency3
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-transaction-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 payments API
HiPay Routing API