Your settlement reporting needs are evolving. Our settlement services, too!
To keep on offering you more possibilities, HiPay has developed enhanced functionalities.
Settlement custom data
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"
}';Settlement e-mail
To be informed of each settlement, activate e-mail 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 e-mail 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).
Settlement exports via SFTP
If you need your settlement files to be dropped on a secure SFTP server, it is now possible with HiPay!
For further information, please refer to the technical documentation.
Settlement notification
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 API
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.
Settlement file fields
The following table lists and describes all the fields included in each settlement file.
| Field name | Description |
|---|---|
| Account | HiPay’s account number |
| Account name | HiPay’s account name |
| Date | Date of collection |
| Date value | Acquirers' value date |
| Invoice reference | HiPay’s invoice reference |
| Settlement ID | Settlement ID |
| Transaction ID | HiPay’s transaction ID |
| Order | Unique identifier of the order as provided by the merchant |
| Product name | Payment method |
| Invoiced | Invoiced transaction (0/1) |
| Settled | Settled transaction (0/1) |
| Original amount | Original amount of the operation |
| Original currency | Original currency of the operation |
| Amount (Excl. Tax) | Amount of the operation excluding taxes |
| Tax amount | Tax amount of the operation |
| Amount (Incl. Tax) | Amount of the operation including taxes |
| Currency | Invoice currency |
| Operation | Operation type |
| Settled amount | Settled amount |
| Settlement currency | Settlement currency |
| Original settlement ID | Original settlement ID (if applicable) |
| Customer ID | Unique identifier of the customer as provided by the merchant |
| Merchant operation ID | Operation ID sent in maintenance operation |
| Reporting data 1 | Settlement custom data 1 |
| Reporting data 2 | Settlement custom data 2 |
| Reporting data 3 | Settlement custom data 3 |
| Reporting data 4 | Settlement custom data 4 |
| Reporting data 5 | Settlement custom data 5 |
| Collect Mode | Transaction collect mode |
| Transfer | Settlement transfer date |
| Operation date | Date of operation request |
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.
Comments
0 comments
Article is closed for comments.