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.
Parameters
Headers
The following information can be sent in the header.
Form parameters
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.