Skip to main content
Français Italiano Português

HiPay Marketplace – Cash-out – Making electronic transfers

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 know 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/transfer.json
Production https://merchant.hipaywallet.com/api/user-account/transfer.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. To be specified in case the transfer must be done from an account other than the technical account.
php-auth-subaccount-login AN   Email address of the seller account. To be specified in case the transfer must be done from an account other than the technical account.
Authorization   M Credentials of the technical account encoded in base 64

Form parameters

Field Format Req. Description
recipient_account_id N M ID of the account receiving the funds
recipient_account_login AN   Login ID of the account receiving the funds
amount R M Transfer amount
public_label AN   Transfer ID, visible to the marketplace operator and the seller receiving the transfer
private_label AN   Transfer ID, only visible to the marketplace operator
merchant_unique_id AN   Unique transfer ID. Any other transfer 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 = {
 "Authorization": "Basic MWViMmI4NzNzVlMjE0NzUyZTA0N2FmYjE3MjA4Zjk6ZDI0MzNmNjQ5ZjQ5ZDZlOTZjMzA3M2Y0YWM4MmEyMTY="
}

params = {
"amount":"126.78",
"public_label":'Invoice-id_seller-id_transfer001',
"merchant_unique_id":"1234b",
"recipient_account_id":"10317734",
"recipient_account_login":"johndoe@mail.com",
}

 

API response example

{
"code":0,
"message":"Direct transfer successfully posted.",
"transaction_id":"5cb989c84fa8k22218",
"amount":126.78,
"currency":"EUR",
"recipient_username":"contact@contact.com",
"public_label":"transfer001",
"periodicity_type":"direct"
} 

Please note: The fact that HiPay has received the transfer request does not mean that it has been processed.

To make sure that the transfer has been validated, please refer to the notifications before making the withdrawal request.

Related articles