Skip to main content
Français Italiano Português

HiPay Marketplace – Cash-out – Sending bank document and bank information

You will find hereafter the necessary technical information to send sellers’ bank information.

Stage environment

In Stage environment, you can choose whether the document will be refused or accepted. 

  • File name beginning with 01_: the document will be refused because it will not be recognized.
  • File name beginning with 02_: the document will be refused because it has been falsified.
  • File name beginning with 03_: the document will be refused because it is unreadable.
  • File name beginning with 06_: the document will be refused because it is incomplete.
  • File name beginning with 07_: the document will be refused because it has expired.
  • Any other name: the document will be automatically accepted.

 

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/bank-info.json
Production https://merchant.hipaywallet.com/api/user-account/bank-info.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

The following information can be sent in the header.

Field Format Req. Description
 php-auth-subaccount-id AN M ID of the HiPay seller account
 php-auth-subaccount-login AN   Email address of the seller account
Authorization   M Credentials of the HiPay technical account encoded in base 64

 

Form parameters

Field Format Req. Description
file   M Bank account identification document (RIB/IBAN) to be uploaded, which must match with the bank details manually input and sent by API
bank_country A M Country of the bank. E.g.: 'FR'
bank_name A M Name of the bank. E.g.: "BNP"
bank_address AN M Address of the bank
bank_zip_code AN M Postal code of the bank. E.g.: "75001"
bank_city A   City of the bank
iban AN M IBAN matching with the bank account identification document provided in the file
swift AN M SWIFT code

 

Request example

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

files = {'file': open('rib.png','rb')}

headers = {
 "php-auth-subaccount-id":"760667",
 "php-auth-subaccount-login":"johndoe@mail.com",
 "Authorization": "Basic YWE5YmVhODg5ZThkxxxxxxxWVmZTJhY2UyM2UwYjE="
}

params = {
"bank_country":"FR",
"bank_name":"BNP",
"bank_address":"10 rue du test",
"bank_zip_code":"75001",
"bank_city":"Paris",
"iban":"FR1420041xxxxxxxx2606",
"swift":"PSSTFRPPXXX"
}

API response example

{
"code":0,
"message":"Setting bank info succeeded",
"status_code":2,
"status":"Validation in progress",
"bank_country":"FR",
"bank_name":"BNP",
"bank_address":"10 rue du test",
"bank_zip_code":"75001",
"bank_city":"Paris",
"iban":"FR1420041xxxxxxxx2606",
"swift":"PSSTFRPPXXX"
}

Please note: The fact that HiPay has received the bank information does not mean that it has been validated.

To make sure that it has been validated, please refer to the notifications.

 

Related articles