HiPay
This page provides an overview of the payments methods provided by the HiPay adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating HiPay within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.
Payment Methods
| Payment Method | Transaction Flows | Transaction Types |
|---|---|---|
| Visa | Full-Page Redirect | Capture, Debit, Preauthorize, Refund, Void |
| Mastercard | Full-Page Redirect | Capture, Debit, Preauthorize, Refund, Void |
| Bancontact | Full-Page Redirect | Capture, Debit, Preauthorize, Refund, Void |
| Bancontact QR Code | Full-Page Redirect | Capture, Debit, Preauthorize, Refund, Void |
Mandatory parameters for Debit and Preauthorize
| Extra Data | Type | Required | Description |
|---|---|---|---|
| orderid | String | true | Unique order ID |
| description | String | true | The order short description |
| currency | String | true | Base currency for the order with three-character currency code |
| amount | Number | true | Total order amount |
Aditional parameters Debit and Preauthorize
| Extra Data | Type | Required | Description |
|---|---|---|---|
| operation | String | false | Operation can be either Sale for automatically submitting for capture or Authorization for manually capturing / void |
| payment_product_list | String | false | List of payment products to display on the payment page |
| basket | String | false | Shopping cart details |
| authentication_indicator | String | false | If the payment product is a credit or debit card, this parameter specifies whether 3-D secure authentication should be performed for this transaction. |
Mandatory parameters for capture and refund
| Data | Type | Required | Description |
|---|---|---|---|
| transaction_reference | String | true | The unique identifier of the transaction |
| operation | String | true | The operation to perform on the transaction: capture, cancel or refund |
| amount | String | true | Amount is required for partial maintenances. Do not specify amount for full captures or refunds. |
Item Parameters
If items are given with the transaction data, the following parameters can or must be given. For capture and refund only items that must be captured or refunded have to be sent.
| Name | Type | Required | Description |
|---|---|---|---|
| item.product_reference | string Alphanumeric characters (a-z, A-Z, 0-9) | true | Unique product reference |
| item.quantity | Number | true | Product quantity |
| item.name | String | true | Product description |
| item.unit_price | Decimal number with explicit decimal point | true | Price of the item |
| item.discount | string | true | Discount amount, always 0 or negative |
| item.total_amount | Number | true | Unit price X quantity – discount. . The sum of every "total_amount" must be equal to the "amount" sent in the call and it is automatically calculated |
| item.extraData.tax_rate | string | true | Tax rate in percentage |
| item.extraData.type | string Alphanumeric characters (a-z, A-Z, 0-9) | true | Type of product Possible values are good, discount or fee |
| item.extraData.european_article_numbering | string Alphanumeric characters (a-z, A-Z, 0-9) | false | European article numbering |