Your settlement reporting needs are evolving. Our settlement services, too!

To keep on offering you more possibilities, HiPay has developed enhanced functionalities.

Please note:

Settlements are only available on the Production account.
To test, you need to make a test purchase in Production of at least €1.

If you want to add additional information to your settlement field, you can just use our "custom_data" API parameter to send up to 5 new columns when you create a transaction.

To do so, you must use this format:


'custom_data' = '{
  "_reporting_data_1":"my custom data 1",
  "_reporting_data_2":"my custom data 2",
  "_reporting_data_3":"my custom data 3",
  "_reporting_data_4":"my custom data 4",
  "_reporting_data_5":"my custom data 5"
}';

To be informed of each settlement, activate email notifications from the Finance tab of your HiPay Enterprise back office (formerly HiPay Fullservice). It’s simple: just click on the “Enable notification” button.

An email notification will be sent every time a settlement is made, with the corresponding file (the same information is also displayed in the “Settlement overview” in your back office).

When your server needs to retrieve a settlement file, call our API: you will receive all the file details!

For further information, please refer to the technical documentation on our Developer Portal.

Does your server have to be informed every time a settlement file is created?

If so, from your HiPay Enterprise back office, just activate financial feedback notifications under “Integration → Notifications → Financial Feedback”.

Settlement file fields

The following table lists and describes all the fields included in each settlement file.

Some of these features involve additional fees: do not hesitate to communicate with your HiPay sales representative for pricing information.

For technical assistance, please submit a request to our Support team.

Retrieving my settlement reporting

Settlement file fields