Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hipay-constants-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: '0.3'
title: HiPay Marketplace Constants API
description: "\nThe implementation of HiPay Marketplace involves establishing connections between your marketplace platform and HiPay based on a simple integration through a set of APIs.\n\n## Account creation:\n\n 1) The agent checks the e-mail availability with the [Is-available API](#/user-account/post_user-account_is-available).\n\n 2) The agent creates a HiPay account for merchants using the [User-account API](#/user-account/post_user-account).\n\n 3) The agent sends us the account number and the identification/KYC information using the [Identification API](#/identification/post_Identification). HiPay validates the identification/KYC information within three days and sends the agent a notification confirming that the merchant is fully operational.\n\n## Bank account information submission:\n\nPlease note that it is possible to submit bank account information any time between account creation and withdrawal requests.\nTo register a HiPay account bank information, use the [Bank-info API.](#/bank-info/post_user-account)\n\n## Fund allocation:\n\nFund allocation is only possible if the merchant's account is validated by HiPay.\n\nAll the funds are held in escrow before being deposited on the technical account.\n\nThe [Transfer API](#/transfer/post_transfer]) is then used to allocate funds from the technical account to the merchant's account.\nThe [Transfer API](#/transfer/post_transfer]) allows transfer requests to be made on the agent’s behalf or on the behalf of a third party.\n\nThe technical account is therefore a monitoring tool that provides a clear view of fund allocation (fund remittance, refunds, chargebacks).\n\n## Withdrawal requests:\n\nWithdrawal is only possible if the merchant's account AND banking informations are validated by HiPay.\n\nOnce funds are allocated, there are two withdrawal possibilities:\n\n - Whenever a transaction is made – please note that this option is not recommended by HiPay,\n - Whenever a withdrawal request is made by the merchant – for example, every ten days, depending on the agent.\n\nWhen agents want to do a withdrawal, they need to check the merchant’s account balance with the [Balance API.](#/balance/get_user-account)\n\n - In case of a zero balance, funds must be allocated with the [Transfer API](#/transfer/post_transfer]).\n - If the balance equals the amount of the allocated funds, a fund withdrawal request can be made with the [Withdrawal API](#/withdrawal/post_withdrawal). (The Withdrawal API allows for a withdrawal request to transfer money to the merchant’s bank account and also to the partner’s bank account.)\n - There must be a zero balance in the end.\n\n## Marketplace live testing:\n\nThis documentation describes the Marketplace API parameters and response fields and allows you to test the platform in real time.\n\n## Marketplace API base URLs:\n\n| Environment | Base URL |\n| --- | --- |\n| Test | https://test-professional.hipay.com/api/ |\n| Production | https://professional.hipay.com/api/ |\n\n## Authentication:\n\nAll requests to the HiPay Marketplace API require you to authenticate yourself using the HTTP *Basic Authentication* to convey your identity. Your API credentials can be found in [your Test HiPay Professional back office](https://test-merchant.hipaywallet.com/login). Most HTTP clients (including web browsers) have built-in support for HTTP Basic Authentication. If not, the following header must be included in all HTTP requests.\n\n`Authorization: Basic base64(\"<API login>:<API password>\")`\n"
servers:
- url: https://test-professional.hipay.com/api
tags:
- name: constants
description: Manage your account with our API tools
paths:
/tools/bank-info-fields/{country}/{locale}.{_format}:
get:
summary: Get bank details required for a HiPay account depending on its country
description: '
### Information
Get bank details required for a HiPay account depending on its country.'
parameters:
- in: path
name: country
required: true
description: 'Enter country code [using ISO_3166-1 convention.](https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements)
Examples of values: `FR`, `AL`, `AU`, `PT`, `US`...'
schema:
type: string
default: FR
- in: path
name: locale
required: true
description: 'Enter locale code [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes)
Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
schema:
type: string
default: fr_FR
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
description: Status code of the answer.
format: int32
type: integer
message:
description: Description of the answer.
type: string
country:
description: Country to get bank info fields.
type: string
fields:
description: Required bank fields.
items:
description: Required bank fields.
properties:
code:
description: string
type: string
label:
description: string
type: string
type: array
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/business-lines/{locale}.{_format}:
get:
summary: Return business lines
description: '
### Information
Return business lines.'
parameters:
- in: path
name: locale
required: true
description: 'Enter locale code [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes)
Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
schema:
type: string
default: fr_FR
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
business_lines:
type: array
items:
description: array of objects (BusinessLineEntity)
properties:
id:
type: integer
format: int32
description: integer
label:
type: string
description: string
description: array of objects (BusinessLineEntity)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/locale/codes.{_format}:
get:
summary: Return locales codes and names
description: '
### Information
Return locales codes and names.'
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
locales:
type: array
items:
description: Required bank fields.
properties:
code:
description: string
type: string
label:
description: string
type: string
description: array of objects (CodeLabelResponse)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/locale/countries/{locale}.{_format}:
get:
summary: Return locales codes and names
description: '
### Information
Return countries codes and labels by locale.'
parameters:
- in: path
name: locale
required: true
description: 'Enter locale code [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes)
Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
schema:
type: string
default: fr_FR
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
countries:
type: array
items:
description: Required bank fields.
properties:
code:
description: string
type: string
label:
description: string
type: string
description: array of objects (CodeLabelResponse)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/locale/currencies/{locale}.{_format}:
get:
summary: Return currencies codes and labels by locale
description: '
### Information
Return currencies codes and labels by locale.'
parameters:
- in: path
name: locale
required: true
description: 'Enter locale code [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes)
Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
schema:
type: string
default: fr_FR
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
currencies:
type: array
items:
description: Required bank fields.
properties:
code:
description: string
type: string
label:
description: string
type: string
description: array of objects (CodeLabelResponse)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/locale/timezones.{_format}:
get:
summary: Return timezones
description: '
### Information
Return timezones.'
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
timezones:
type: array
items:
description: Required bank fields.
properties:
code:
description: string
type: string
label:
description: string
type: string
description: array of objects (CodeLabelResponse)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
/tools/website-topics/{business_line_id}/{locale}.{_format}:
get:
summary: Return website topics
description: '
### Information
Return website topics.'
parameters:
- in: path
name: locale
required: true
description: 'Enter locale code [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes)
Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
schema:
type: string
default: fr_FR
- in: path
name: business_line_id
required: true
schema:
type: string
default: '2'
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
responses:
'200':
description: Success response.
content:
application/json:
schema:
properties:
code:
type: integer
format: int32
description: Status code of the answer.
message:
type: string
description: Description of the answer.
business_line_id:
type: integer
format: int32
description: integer
website_topics:
type: array
items:
description: array of objects (TopicEntity)
properties:
id:
type: integer
format: int32
description: integer
label:
type: string
description: string
description: array of objects (TopicEntity)
'400':
description: Validation failed.
'401':
description: Authentication failed.
tags:
- constants
components:
securitySchemes:
basicAuth:
type: http
scheme: basic