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

Perform operations (capture, refund) on transactions

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

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

This API exposes 1 operation across 1 path, and defines 3 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.

1 operations 1 paths 3 schemas 1 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 maintenance 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 1

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

maintenance 1

Perform operations (capture, refund) on transactions

POST
/v1/maintenance/transaction/{transaction_reference}
Performs a maintenance operation on a given transaction
performMaintenanceOperation 1 param body → 200400401403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Operation (14 properties), Maintenance (7 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Operation
object
Operation model
14 properties
Maintenance
object
Maintenance model
7 properties 1 required
Error
object
Error model
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-maintenance-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 merchant-group API
HiPay Order API
HiPay payments API
HiPay Routing API
HiPay Sessions API