alt

Important information

The API reference is now available here.
The deprecated API reference is available here.

Unzer

Manage transactions

Manage transactions for your Shopware 5 CD-Edition plugin.

Once you have configured the plugin and set up payment methods, you can start accepting payments. You can manage the payment workflows as described here.

To review and manage order details, go to the Heidelpay tab. Alternatively, you can also review them in Unzer Insights.

Capture after reservation (Charge after Authorization)

  1. Sign in to the shop back end, go to Customers > Orders, and select the Pencil icon for the order that you want to charge.

  2. Select Heidelpay, to view the options that are available for this specific transaction. Order detail view

  3. Select Capture, enter the Amount that you want to charge.

  4. Select Action to charge.

After every transaction, the payment state of the order is updated and a new entry is available in the payment history table.

Order detail view heidelpay

Refund (reversal) the invoice amount

  1. Sign in to the shop back end, go to Customers > Orders, and select the Pencil icon for the order that you want to charge.
  2. Select Heidelpay, to view the action buttons that are available for this specific transaction. You can only refund up to the paid amount. Unpaid or reserved amounts have to be cancelled via a reversal transaction

Order detail view 3. Select the Refund or Reversal, enter the Amount that you want to cancel.

After every transaction, the payment state of the order is updated and a new entry is available in the payment history table.

Order detail view heidelpay

Send notifications for shipment (activate insurance)

For some payment methods, a shipping or finalize message to Unzer is required to activate the insurance. A shipping message can only be reported to the Unzer system if there is also a unique invoice number for the order in the appropriate Shopware database table. These payment methods are:

  • Heidelpay CD-Edition gesicherter Rechnungskauf / Heidelpay CD-Edition Invoice secured (internal name in code: hgw_papg)
  • Heidelpay CD-Edition gesicherter B2B Rechnungskauf / Heidelpay CD-Edition Invoice secured B2B (internal name in code: hgw_ivb2b)
  • Rechnungskauf von Santander (internal name in code: hgw_ivb2b)
  • Payolution Rechnungskauf (internal name in code: hgw_ivpd)
  • Heidelpay CD-Edition ratenkauf by easyCredit (internal name in code: hgw_hpr)
  • Ratenkauf von Santander (internal name in code: hgw_hps)

Automatic shipping message

Because of varied requirements for each specific business, there’s no automatic shipment message available in the Unzer plugin for activating the insurance for the transaction. If you want to implement it by yourself for your ERP system, contact support@unzer.com.

Shipping notification via order details

Sign in to the shop back end, go to Customers > Orders, and select the Pencil icon. In the Documents tab you can see if there’s an invoice document or number available.

Order overview

Once an invoice is generated for the order via the back end or the invoice number is set to default according to Shopware’s invoice workflow. The Finalize button is available in Order Details > Heidelpay view.

Order detail view

  1. Select Finalize, enter the Amount you want to insure.
  2. Select Action to do the finalize transaction.

After every transaction, the payment state of the order is updated and a new entry is available in the payment history table.

Currently, you only can send one shipment message per transaction.

Transaction handling: special cases

Refer to the following section to learn how to handle specific payment methods

Activating shipment or insurance

For the payment methods Invoice (guaranteed / factoring / B2B / Santander / Payolution), Ratenkauf by easyCredit, Santander Ratenkauf a Shipment / Shipping messages must be generated in order to activate the payment insurance. To set up the notifications, see Send notifications for shipment.

Display of account data for bank transfer

For all invoice and prepayment payment methods payment data for payment must be displayed to the customer.

On the Checkout-Finish page

The plugin modifies the checkout-finish page and the invoice information for a merchant shop is displayed as shown in the following example.

Checkout success page

For more information on how to modify this payment info texts, see Edit Checkout finish payment data texts.

On Customer-Account-Order page

The plugin modifies the customer’s account-order-page by having an additional section for Our comment.

Account orders page

You can modify the text displayed on customer’s account order overview in Order details > Communication tab. For more information on how to customize, see Customize the Plugin.

Sending additional email with your payment data

After placing the order, a confirmation e-mail is sent to the customer by the shop automatically. The plugin doesn’t modify this standard e-mail, because most merchants customize the standard confirmation-e-mail-template. If you want to send an additional text-email with payment data, you can activate it as described in Configure your plugin environment > Send payment information email for….

To more information on modifying the email data, see Edit additional email data.

On the invoice document

If an invoice document is generated within the shop back end, the information for the money transfer is automatically added to the invoice PDF.

For more information on updating the invoice text data, see Modify payment data on the invoice document.

The plugin does not modify the footer area of invoice or other documents

Review transaction details in Unzer Insights

Within the order overview, you can find the Transaction column which contains an ID which you can map to the field Order number in your Unzer Insights account.

Orders overview in Shopware

You can also find the Short-ID in Heidelpay > payment details of the order, which can also be used to find a specific order or transaction in Unzer Insights.

Unzer Insights order overview

See also