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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

HiPay

HiPay user-account API

Manage your HiPay account

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 5 operations across 3 paths. 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.

5 operations 3 paths 0 schemas 1 GET1 PATCH3 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 user-account 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 5

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

user-account 5

Manage your HiPay account

GET
/user-account.{_format}
Get general information about a HiPay account
get_user-account 3 params → 200400401
PATCH
/user-account.{_format}
Update a Hipay account
patch_User-account 20 params → 200400401
POST
/user-account.{_format}
Create a HiPay account
post_user-account 49 params → 201400401
POST
/user-account/sub-account.{_format}
Create a HiPay account
post_user-account_sub-account 26 params → 200201400401
POST
/user-account/is-available.{_format}
Verify if an email address is available to create a new HiPay account
post_user-account_is-available 5 params → 200400401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hipay-user-account-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
#user-account
← Back to H APIs
API Details
ID
hipay:hipay-user-account-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