Magento 2 Enterprise

STORES > CONFIGURATION > SALES > PAYMENT METHODS

You can customize the styling of the API Only integration by using the following field: 

Capture

Sale Mode 

When making a purchase with the “Sale” mode, the capture is automatically requested right after authorization.

If the payment fails, the customer is redirected to an error page and the status is defined as “CANCELED”.

If the payment is successful, the customer is redirected to the success page and the status is defined as “CAPTURE REQUESTED”.

“Authorization” mode  

When making a purchase with the “Authorization” mode, the transaction status will be “AUTHORIZED” until you ask for the capture.

Customers are not charged directly: you have 7 days to “capture” the order and charge the customer. Otherwise, the order is cancelled.

If the authorization fails, the customer is redirected to an error page and the status is defined as “CANCELED”.

If the authorization is successful, the customer is redirected to the success page and the status is defined as “AUTHORIZED”.

To capture a transaction in your Magento Admin Panel, select “Sales” -> “Orders” -> “View” to see the details of the order and choose to submit an “invoice”.
On the “New Invoice” page, select “Capture online” and save your invoice.
Please note: If you select a custom item quantity, you can do a partial capture.

You can also do the “capture” directly in your HiPay Enterprise back office. The order will then be automatically updated in your Magento Admin Panel.
Please note: It only works for total captures (not partial).

Refund

Some HiPay Enterprise payment methods allow for a refund. To do so, in your Magento Admin Panel, select “Sales” -> “Orders” -> “View” to see the details of the order, then choose an invoice to refund and click on “Credit Memos”.

On the “Credit Memos” page, select “Refund” and save your credit memo.

Please note: If you select a custom item quantity, you can do a partial refund.

You can also do the “refund” directly in your HiPay Enterprise back office. The order will then be automatically updated in your Magento Admin Panel.
Please note: It only works for total refunds (not partial).

Additional Features

3-D Secure

You can choose between 5 options:

1. 1. 1. Disabled (to bypass 3-D Secure authentication)
      2. Try to enable for all transactions
      3. Try to enable for configured 3ds rules
      4. Force for configured 3ds rules
      5. Force for all transactions

Rules configuration follows the same process as Magento 2 price rules.

One-click 

If the One-click option is enabled, your system will create an “alias” for the credit card. Customers will thus be able to use a saved credit card for their second transaction and won’t need to fill in all the payment data again.

Customers can delete their saved credit cards from their account.

Split payments

When an order is created with a HiPay Enterprise split payment method, x installments are created (x depending on the selected payment profile).

A split order is validated when the payment is captured. Upon payment capture, x installments are generated for this order. The order is fully invoiced (but not fully captured in the HiPay Enterprise platform) and you can get ready for shipment.

The first installment is always debited on the payment date in Capture mode or when you capture manually in Authorization mode.

Then, with a Cron task, each installment is debited on its respective payment date.

Split payment methods  

The HiPay Enterprise module for Magento 2 includes two payment methods for split payments:

• • • HiPay Enterprise Hosted Page Split Payment,
    • HiPay Enterprise Credit Card Split Payment,

based on the HOSTED or API mode.

Before using them, you need to create payment profiles.

Payment profiles  

A payment profile defines how the payment is split.

In your Magento Admin Panel, select HiPay Enterprise > Payment Profiles.

Click on “Create New Payment Profile”.

Then fill in the form.

• • • Name: Public name for your payment profile
    • Period Unit: Unit for billing during the subscription period
    • Period Frequency: Number of billing periods that make up one billing cycle
    • Period Max Cycles: Number of billing cycles for the payment period

Here is an example if you want to split the amount in 3 installments with 1 billing per month.

• • • Period Unit: month
    • Period Frequency: 1
    • Period Max Cycles: 3

Split payment method configuration  

Once you have at least one payment profile, you can configure a split payment method.

Specific configuration:

Split payment overview  

A split payment overview is available in your Magento Admin Panel in HiPay Enterprise > Split Payment.

For each installation, you can edit, delete or pay it immediately.
You can also change the payment date or the amount to pay.

Be careful: If you are not sure what to do, please submit a request (https://support.hipay.com/hc/en-us/requests/new) to our Support team.

Custom data 

It is possible to send additional information in the transaction that can then be viewed in the HiPay back office. To do so, you can use the functionality of Magento 2 which relies on the notion of plugin.

Please refer to the Magento PHP Developer Guide.

To add custom information to transactions, you need to create a plugin in your custom module. This plugin must observe HiPay\FullserviceMagento\Model\Request\Order and extend the method getCustomData with afterGetCustomData.

In your di.xml, define the plugin with: