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-bank-info-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 Bank Info API
description: The implementation of HiPay Marketplace involves establishing connections between your marketplace platform and HiPay based on a simple integration through a set of APIs.
servers:
- url: https://test-professional.hipay.com/api
tags:
- name: Bank Info
description: Manage bank informations of a HiPay account
paths:
/user-account/bank-info.{_format}:
post:
description: '### Information
Register new bank-details on an HiPay account.
Must be called with the bank identity document and bank info together
__In test environment__
You can choose if the document will be accepted or not by changing the 3 first characters of the uploaded file name.
- Filename starts with `01_`: document will be refused because unrecognized
- Filename starts with `02_`: document will be refused because falsified
- Filename starts with `03_`: document will be refused because unreadable
- Filename starts with `06_`: document will be refused because inconsistent
- Filename starts with `07_`: document will be refused because expired
- Any other name : document will be automatically accepted'
operationId: post_user-account_bank-info
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. 0 => Successful response 2 => Missing parameter 3 => Invalid parameter 7 => Not found 13 => An error occurred, please try again 400 => Bad request
format: int32
type: integer
message:
description: Description of the answer.
type: string
status_code:
description: Bank details status code (1=>No bank information, 2=>Validation in progress, 3=>Validated).
format: int32
type: integer
status:
description: Bank details status.
type: string
bank_country:
description: Country of the bank.
type: string
bank_name:
description: Name of the bank.
type: string
bank_address:
description: Address of the bank.
type: string
bank_zip_code:
description: Zip code of the bank.
type: string
bank_city:
description: City of the bank.
type: string
iban:
description: 'IBAN eg: GR9608100010000001234567890.'
type: string
swift:
description: 'SWIFT/BIC eg: AGRIFRPP836.'
type: string
aba_num:
description: ABA number.
type: string
bsb_num:
description: BSB number.
type: string
bank_num:
description: Bank number.
type: string
acct_num:
description: Account number.
type: string
transit_num:
description: Transit number.
type: string
'400':
description: Validation failed.
'401':
description: Authentication failed.
summary: Register new bank details on a HiPay account
tags:
- Bank Info
security:
- basicAuth: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: Bank details file to upload (`jpg`, `gif`, `png`, `pdf`). Must match bank details to be validated.
bank_country:
type: string
default: FR
description: Country of the bank.
bank_name:
type: string
default: BNP
description: Name of the bank (50 characters max.).
bank_address:
type: string
default: 1 Avenue des Champs-Élysées
description: Address of the bank.
bank_zip_code:
type: string
default: '75001'
description: Zip code of the bank.
bank_city:
type: string
default: Paris
description: City of the bank (50 characters max.).
iban:
type: string
default: FR1420041010050500013M02606
description: IBAN.
swift:
type: string
default: PSSTFRPPXXX
description: SWIFT / BIC.
aba_num:
type: string
description: ABA number.
bsb_num:
type: string
description: BSB number.
bank_num:
type: string
description: Bank number.
acct_num:
type: string
description: Account number.
transit_num:
type: string
description: Transit number.
required:
- file
- bank_country
/user-account/bank-info/{locale}.{_format}:
get:
description: '### Information
Get bank details of a HiPay account.'
operationId: get_user-account_bank-info_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:
description: /merchant-group/Status code of the answer. 0 => Successful response 2 => Missing parameter 3 => Invalid parameter 7 => Not found 13 => An error occurred, please try again 400 => Bad request
format: int32
type: integer
message:
description: Description of the answer.
type: string
status_code:
description: Bank details status code (1=>No bank information, 2=>Validation in progress, 3=>Validated).
format: int32
type: integer
status:
description: Bank details status.
type: string
bank_country:
description: Country of the bank.
type: string
bank_name:
description: Name of the bank.
type: string
bank_address:
description: Address of the bank.
type: string
bank_zip_code:
description: Zip code of the bank.
type: string
bank_city:
description: City of the bank.
type: string
iban:
description: 'IBAN eg: GR9608100010000001234567890.'
type: string
swift:
description: 'SWIFT/BIC eg: AGRIFRPP836.'
type: string
aba_num:
description: ABA number.
type: string
bsb_num:
description: BSB number.
type: string
bank_num:
description: Bank number.
type: string
acct_num:
description: Account number.
type: string
transit_num:
description: Transit number.
type: string
'400':
description: Validation failed.
'401':
description: Authentication failed.
summary: Get bank details registered on a HiPay account
tags:
- Bank Info
security:
- basicAuth: []
components:
securitySchemes:
basicAuth:
type: http
scheme: basic