Skip to main content
Français Italiano Português

HiPay Marketplace – Cash-out – Withdrawals

Once KYC/KYB identification documents and bank information have been validated for a given seller, you will be able to proceed to funds allocation. 

Funds allocation is a two-step process.

- Funds transfer: Consists in transferring money from the technical account (escrow account) to a HiPay seller account or to the HiPay commission account.

- Funds withdrawal: Consists in transferring money from a HiPay seller account or the HiPay commission account to the seller’s bank account. 

Account balance

To check the available balance, whether for the technical account, the commission account or the seller account, please refer to the following documentation.

Service endpoints

There are two endpoints (base URLs) to which you can make your API calls:

  • Stage, if you are testing your integration,
  • and Production, when you have finished testing and want your application to go live.
Environment URL
Stage https://test-merchant.hipaywallet.com/api/user-account/withdrawal.json
Production https://merchant.hipaywallet.com/api/user-account/withdrawal.json

Parameters

Format abbreviation Description
A Alphabetic characters only (a-z, A-Z)
AN Alphanumeric characters (a-z, A-Z, 0-9)
N Numeric characters only
R Decimal number with explicit decimal point, signed

Headers

Field Format Req. Description
php-auth-subaccount-id  AN  

ID of the seller account on which the withdrawal must be done
php-auth-subaccount-login AN  

Email address of the seller account on which the withdrawal must be done
Authorization   M Credentials of the HiPay technical account encoded in base 64

Form parameters

Field Format Req. Description
amount R M

Withdrawal amount
label AN  

Withdrawal description
merchant_unique_id AN  

Unique withdrawal ID. Any other withdrawal with the same ID will not be processed.

Request example

The authorization is done with the login ID and password for the technical account.

headers = {
 "php-auth-subaccount-id":"10317734",
 "Authorization": "Basic MWViMmI4NzFkOzVlMjE0NzUyZTA0N2FmYjE3MjA4Zjk6ZDI0MzNmNjQ5ZjQ5ZDZlOTZjMzA3M2Y0YWM4MmEyMTY="
}

params = {
"amount":"126.78",
"label":'withdraw-001',
"merchant_unique_id":"1235486532"
}

API response example

{
"code":0,
"message":"Withdrawal successfully created.",
"transaction_public_id":"5cb990c3mf73f25215",
"label":"withdraw-001",
"amount":126.78,
"currency":"EUR",
"issuer_account":"10418734"
}

 

Related articles