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-withdrawal-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 Withdrawal 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: withdrawal
description: Request a withdrawal from a HiPay account
paths:
/withdrawal.{_format}:
post:
description: '### Information
Allows you to request a withdrawal from a HiPay account and transfer the funds to the bank account linked to the account.
Once funds are allocated, there are two withdrawal possibilities.
- Whenever a transaction is made – please note that this option is not recommended by HiPay.
- Whenever a withdrawal request is made – for example, every ten days, depending on the agent.
When agents want to do a withdrawal, they need to check the merchant’s account balance with the getBalance API.
- In case of a zero balance, funds can be allocated with the Transfer API.
- If the balance equals the amount of the allocated funds, a fund withdrawal request can be made with the Withdrawal API. (The Withdrawal API allows for withdrawal requests to transfer money to the merchant’s bank account and also to the partner’s bank account.)
- There must be a zero balance in the end.
For more information, please read the HiPay Marketplace Withdrawal requests section'
operationId: post_withdrawal
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. 13 => Withdrawal not created 26 => Withdrawal in progress
format: int32
type: integer
default: 13
message:
description: Description of the answer.
type: string
default: Withdrawal not created
'201':
description: Success response
content:
application/json:
schema:
properties:
code:
description: Status code of the answer. 0 => Withdrawal successfully created
format: int32
type: integer
message:
description: Description of the answer.
type: string
transaction_public_id:
description: Unique transaction ID.
type: string
label:
description: Label of the withdrawal.
type: string
amount:
description: Amount of the withdrawal in the account currency.
format: double
type: number
currency:
description: Currency of the withdrawal.
type: string
issuer_account:
description: Issuer's account ID.
type: string
'400':
description: Validation failed.
'401':
description: Authentication failed.
40xx - Error code detail:
description: 'See standard HTTP status code reason for 400x - Error code detail :
| HTTP status code | Error code detail |
| --- | --- |
| `4002` | The userSpace is not activated. |
| `4003` | The userSpace is being switched to pro or professionals info are not valid. |
| `4004` | The user Space is not identified. |
| `4005` | Bank info are not valid. |
| `4006` | The userSpace state not normal. |
| `4007` | The account is not activated. |
| `4008` | The account is disabled. |
| `4009` | The account is deleted. |
| `4010` | The account is not main. |
| `4012` | Bank country is blacklisted. |
| `4013` | Withdrawal maximal limit reached. |
| `4014` | Balance after the withdrawal will be inferior to minimal amount. |
| `4015` | The declaration of your ultimate beneficial owners for your HiPay account has not been completed or has not been duly completed. |
'
content:
application/json:
schema:
properties:
error_code_detail:
format: int32
type: integer
summary: Request a withdrawal from a HiPay account
tags:
- withdrawal
security:
- basicAuth: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
amount:
type: number
format: float
default: '19.90'
description: Amount of the withdrawal in the account currency.
label:
type: string
default: Custom label here
description: Label of the withdrawal in the account currency.
merchant_unique_id:
type: string
default: ORDER_1973645854
description: Unique ID of the withdrawal sent by the merchant. HiPay will process only 1 withdrawal with this ID.
components:
securitySchemes:
basicAuth:
type: http
scheme: basic