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

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 1.0.

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

6 operations 6 paths 78 schemas 6 GET

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, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 4

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

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), Operation3 (14 properties). Each schema is shown below with its type and property counts.

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

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