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

Everything you need to tokenize payment cards

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

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

This API exposes 4 operations across 4 paths, and defines 1 schema. 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.

4 operations 4 paths 1 schemas 1 DELETE1 GET2 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 tokenization 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 4

Across 4 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

tokenization 4

Everything you need to tokenize payment cards

POST
/create
Performs credit or debit card tokenization
createToken 7 params → 201400401403
GET
/{token}
Gets the details of a credit card that you have previously tokenized
lookupToken 2 params → 200400401403404
DELETE
/
Delete a previously created token
deleteToken 1 param → 204400401403404
POST
/update
Updates the details of a previsouly tokenized credit or debit card
updateToken 6 params → 200400401403404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Token (15 properties). Each schema is shown below with its type and property counts.

Token
object
15 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-tokenization-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