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-user-account-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 User Account 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: user-account
description: Manage your HiPay account
paths:
/user-account.{_format}:
get:
description: '
### Information
Get information about a specific HiPay account.'
operationId: get_user-account
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
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
entity:
description: Account entity code.
type: string
user_account_id:
description: Account ID.
format: int32
type: integer
user_space_id:
description: User space ID.
format: int32
type: integer
currency:
description: Account currency.
type: string
activated:
description: True if the account is activated. activated = 0 => Means that the account can't access to the hipay backoffice. In fact, the password hasn't be registered or confirmed. activated = 1 => Means that the account can access to the hipay backoffice. Password registered.
format: int32
type: integer
ubo_statement_status_code:
description: 'UBO statement status code : -1: No UBO statement 0: New 1: Waiting 2: To check 3: Validated 4: Rejected 5: Updated.'
type: string
identified:
description: True if the account is identified.
format: int32
type: integer
bank_info_validated:
description: True if bank information is validated.
format: int32
type: integer
callback_url:
description: Account callback URL.
type: string
callback_salt:
description: Account callback salt.
type: string
websites:
description: If websites are declared on the account, list of websites.
items:
description: If websites are declared on the account, list of websites.
properties:
website_id:
description: ID of the website.
format: int32
type: integer
website_name:
description: Name of the website.
type: string
website_url:
description: URL of the website.
type: string
website_email:
description: Contact email address of the website.
type: string
business_line:
description: Business line ID of the website.
type: string
website_topic:
description: Topic ID of the website.
type: string
type: array
sub_accounts:
description: If sub-accounts are declared on the account, list of sub-accounts.
items:
description: If sub-accounts are declared on the account, list of sub-accounts.
properties:
user_account_id:
description: Account ID.
format: int32
type: integer
currency:
description: Currency of the account.
type: string
callback_url:
description: Account callback URL.
type: string
callback_salt:
description: Account callback salt.
type: string
websites:
description: Array of objects (GetAccountInfosWebsite).
type: array
items:
type: object
properties:
website_id:
description: ID of the website.
format: int32
type: integer
website_name:
description: Name of the website.
type: string
website_url:
description: URL of the website.
type: string
website_email:
description: Contact email address of the website.
type: string
business_line:
description: Business line ID of the website.
type: string
website_topic:
description: Topic ID of the website.
type: string
type: array
'400':
description: Validation failed.
'401':
description: Authentication failed.
summary: Get general information about a HiPay account
tags:
- user-account
security:
- basicAuth: []
patch:
description: '
### Information
Update a HiPay account.'
operationId: patch_User-account
x-disableTryItOut: true
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
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
account_id:
description: ID of updated HiPay account.
format: int32
type: integer
alias:
description: Alias of updated HiPay account.
type: string
email:
description: Email of created HiPay account.
type: string
callback_url:
description: URL where the notifications concerning this account will be sent.
type: string
callback_salt:
description: Salt used in notification signature.
type: string
entity_code:
description: The code of the entity to which the account is to be linked.
type: string
address:
description: Address
type: string
zipcode:
description: Zipcode
type: string
city:
description: City
type: string
country:
description: Country
type: string
homephone:
description: HomePhone
type: string
mobilephone:
description: MobilePhone
type: string
merchant_group_code:
description: MerchantGroupCode
type: string
'400':
description: Validation failed.
'401':
description: Authentication failed.
summary: Update a Hipay account
tags:
- user-account
security:
- basicAuth: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
email:
type: string
description: Account email.
alias:
type: string
description: Alias of created account.
vat_number:
type: string
description: VAT company number.
address[address]:
type: string
default: 2 Avenue de Paris
description: Street address.
address[zipcode]:
type: string
default: '75001'
description: Zip code.
address[city]:
type: string
default: Paris
description: City.
address[country]:
type: string
default: FR
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`...'
address[phone_number]:
type: string
default: 0123456789
description: Phone number.
address[mobile_phone_number]:
type: string
default: 0612345789
description: Mobile phone number.
address[fax_number]:
type: string
default: 0198765432
description: Fax number.
hipay_information:
type: integer
enum:
- 0
- 1
default: 0
description: '`0` or `1` if user agrees.
'
commercial_information:
type: integer
enum:
- 0
- 1
default: 0
description: '`0` or `1` if user agrees.
'
callback_url:
type: string
description: URL where the notifications concerning this account will be sent.
callback_salt:
type: string
description: salt used in notification signature.
city_of_birth:
type: string
description: City of birth.
country_of_birth:
type: string
description: The country of birth code. This two-letter country code complies with ISO 3166-1
cgu_validation:
type: integer
enum:
- 0
- 1
default: 0
description: '`0` or `1` if user agrees to validate HiPay terms (default : `0`).'
post:
description: '
### Information
Create a HiPay account
### Account creation step 2/3
The agent creates a HiPay account for merchants using this API. Next step: "Identification API".'
operationId: post_user-account
x-disableTryItOut: true
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
responses:
'201':
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
email:
description: Email address of the HiPay account created.
type: string
wslogin:
description: wsLogin of the HiPay account created.
type: string
wspassword:
description: wsPassword of the HiPay account created.
type: string
status:
description: True if the account is activated. activated = 0 => Means that the account can't access to the hipay backoffice. In fact, the password hasn't be registered or confirmed. activated = 1 => Means that the account can access to the hipay backoffice. Password registered.
format: int32
type: integer
account_id:
description: ID of the HiPay account created.
format: int32
type: integer
user_space_id:
description: ID of the HiPay user space created.
format: int32
type: integer
callback_url:
description: URL where the notifications concerning this account will be sent.
type: string
callback_salt:
description: salt used in notification signature.
type: string
'400':
description: Validation failed.
'401':
description: Authentication failed.
summary: Create a HiPay account
tags:
- user-account
security:
- basicAuth: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
email:
type: string
default: developer+user-api@hipay.com
description: New account email address.
controle_type:
type: string
enum:
- CREDENTIALS
- CAPTCHA
default: CREDENTIALS
description: For Marketplace implementation, please leave this field with default value to "credentials".
captcha[id]:
type: integer
format: int32
description: Captcha ID. Required for CAPTCHA control.
captcha[phrase]:
type: string
description: Captcha code. Required for CAPTCHA control.
credential[wslogin]:
type: string
default: 8434b91c5766a3446cb65360d9c7c3e6
description: Your API web service login.
credential[wspassword]:
type: string
default: b592ed0e625b026d0a6b76ec99750792bb
description: Your API web service password.
firstname:
type: string
default: John
description: First name of the new account owner.
lastname:
type: string
default: Doe
description: Last name of the new account owner.
currency:
type: string
default: EUR
description: 'Currency of the created account [using ISO 4217 Currency Codes convention.](http://www.xe.com/iso4217.php)
Examples of values: `EUR`, `USD`, `PLN`...'
locale:
type: string
default: fr_FR
description: '
Language and country of the new account [using this convention.](https://www.softaculous.com/docs/Scripts_Language_Codes) Examples of values: `fr_FR`, `de_DE`, `es_ES`, `uk_UA`...'
login:
type: string
default: customLogin
description: 'New account login (default : _email_ parameter).'
civility:
type: integer
enum:
- 1
- 2
- 3
default: 1
description: "Title of the account owner (default : `1`).\n\n- `1` = Mr, \n\n- `2` = Mrs, \n\n- `3` = Miss"
ip_address:
type: string
description: IP of the initial query to create the account. Ipv4 valid IP accepted.
merchant_group_id:
type: integer
format: int32
description: 'Merchant group ID to apply to the new account.
/!\ Parameter deprecated! Use _merchant_group_code_ parameter.
'
merchant_group_code:
type: string
description: Merchant group code to apply to the new account.
entity_code:
type: string
description: Entity to apply to the new account (HiPay will inform the merchant of the entity to use).
account_type:
type: integer
enum:
- 0
- 1
default: 1
description: "Select your account type (default : `1`).\n- `0` = personal account, \n- `1` = business account"
pro_type:
type: integer
enum:
- 1
- 2
- 3
default: 1
description: "Select your professional profile (default : `1`).\n- `1` = corporation, \n- `2` = person, \n- `3` = association"
alias:
type: string
default: myalias
description: Alias of the created account.
structure:
type: string
default: Startup
description: Type of company (e.g.:ltd...).
company_name:
type: string
default: Revolution Corp.
description: Name of the company.
vat_number:
type: string
default: AZERTY1234
description: VAT company number.
address[address]:
type: string
default: 2 Avenue de Paris
description: Street address.
address[zipcode]:
type: string
default: '75001'
description: Zip code.
address[city]:
type: string
default: Paris
description: City.
address[country]:
type: string
default: FR
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`...'
address[phone_number]:
type: string
default: 0123456789
description: Phone number.
address[mobile_phone_number]:
type: string
default: 0612345789
description: Mobile phone number.
address[fax_number]:
type: string
default: 0198765432
description: Fax number.
timezone:
type: string
default: Europe/Paris
description: 'Timezone (default : `Europe/Paris`).'
birthdate:
type: string
format: date
default: '1965-11-12'
description: 'Birthdate of the account owner. E.g.: `1965-11-12` for November 12, 1965.'
city_of_birth:
type: string
format: string
description: City of birth.
country_of_birth:
type: string
format: string
description: The country of birth code. This two-letter country code complies with ISO 3166-1
anti_phishing_key:
type: string
description: Antiphishing string.
hipay_information:
type: integer
enum:
- 0
- 1
default: 1
description: '1 if the user agrees with the terms (default : `0`).'
commercial_information:
type: integer
enum:
- 0
- 1
default: 1
description: '1 if the user agrees with the commercial offers (default : `0`).'
callback_url:
type: string
default: https://developer.hipay.com/callback-url
description: URL where the notifications concerning this account will be sent.
callback_salt:
type: string
description: 'salt used in the notification signature.
If this parameter is empty, a callback salt will be generated.'
cpf[cpf]:
type: integer
format: int32
description: “Cadastro de Pessoas Físicas” (for Brazilian accounts).
cpf[id]:
type: string
description: “Cadastro de Pessoas Físicas” identification number (for Brazilian accounts).
cpf[id_type]:
type: string
enum:
- RG
- RNE
default: RG
description: '“Cadastro de Pessoas Físicas” type (for Brazilian accounts).
- `RG` = “Registro Geral”,
- `RNE` = “Registro Nacional de Estrangeiros”
'
cpf[state]:
type: string
description: “Cadastro de Pessoas Físicas” state (for Brazilian accounts).
activation_type:
type: integer
enum:
- 0
- 1
default: 0
description: 'Select your activation type (default : `0`).
- `0` = Activation by link,
- `1` = Activation by code'
external_account_id:
type: string
format: string
description: Account ID in an external application.
external_type:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
description: 'Authorized values: UNKNOWN, Mirakl, Izeberg, Prestashop, Magento.
{"UNKNOWN":`0`,"Mirakl":`1`,"Izeberg":`2`,"Prestashop":`3`,"Magento":`4`}'
cgu_validation:
type: integer
enum:
- 0
- 1
default: 0
description: '`0` or `1` if user agrees to validate HiPay terms (default : `0`).'
/user-account/sub-account.{_format}:
post:
description: '
### Information
Create a HiPay Sub-Account inside an already created HiPay account.'
operationId: post_user-account_sub-account
x-disableTryItOut: true
parameters:
- in: path
name: _format
required: true
schema:
type: string
enum:
- json
- xml
default: json
- description: Account ID if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-id
schema:
type: integer
- description: Account login (email address) if operations must be made on an account other than yours (you must have specific rights on this account).
in: header
name: php-auth-subaccount-login
schema:
type: string
responses:
'200':
description: Error response
content:
application/json:
schema:
properties:
code:
description: Status code of the answer. 260 => An account with the given login already exists for the given entity 290 => Origin account is not a main account 330 => Origin account is not activated
format: int32
type: integer
default: 260
message:
description: Description of the answer.
type: string
default: An account with the given login already exists for the given entity
'201':
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
parent_account_id:
description: Id of the parent HiPay Account.
format: int32
type: integer
subaccount_id:
description: Id of the created HiPay Sub-Account.
format: int32
type: integer
entity_code:
description: Id of the created HiPay Sub-Account.
type: string
merchant_group_id:
description: Merchant group ID of the created HiPay Sub-Account. /!\ Parameter deprecated !
format: int32
type: integer
merchant_group_code:
description: Merchant group code of the created HiPay Sub-Account.
type: string
callback_url:
description: URL where the notifications concerning this account will be sent.
type: string
callback_salt:
description: salt used in notification signature.
type: string
'400'
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hipay/refs/heads/main/openapi/hipay-user-account-api-openapi.yml