alt

Important information

Please be advised that there will be a scheduled downtime across our API network on November 05 and November 07, 2024. For more information, visit our platform status portal.:
- Scheduled maintenance on November 5, 2024
- Scheduled maintenance on November 7, 2024

Unzer

Manage transactions

Manage transactions for your Shopware 5 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 below. You can manage payment workflow in the Unzer Payment > Order detail view or in Unzer Insights

Capture after reservation

  1. Sign in to Shopware 5 backend and go to Customers > Orders, and select Edit(pencil icon). In the tab Unzer Payment you can see action buttons that are available for this specific transaction. Order details tab Unzer Payment
  2. In the Unzer Payment tab of the order select Authorization transaction
    1. Enter the Amount you want to bill (partial capture).
    2. Select Charge to charge the transaction.

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

Unzer payment tab payment history

Reverse or refund the invoice amount

  1. Sign in to Shopware 5 backend and go to Customers > Orders, and select Edit(pencil icon). In the tab Unzer Payment you can see action buttons that are available for this specific transaction.
icon
You can only refund a paid transaction. Unpaid or reserved transactions must be canceled using reversal.

Order details Unzer Payment tab reversal 2. In the Unzer Payment tab of the order select Charging transaction

  1. Enter the Amount you want to cancel.
  2. Select Refund to refund the transaction.

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

Send notifications for the shipment (activate insurance)

For some payment methods, you require a shipment call before you can activate the insurance.

icon warning
For secured payment methods, such as Unzer Installment Secured, Rechnung (Unzer Payment), you must send a shipping notification to the Unzer system. This is required for activating the insurance. A shipping message can only be reported to the Unzer system if there is also a corresponding invoice number for the order in the s_order_documents.docID Shopware database table.
icon

Changes within the positions tab will not be submitted to Unzer. If you want to lower the invoice amount, please refer to Reverse or refund the invoice amount.

If you want to increase invoice amount, your customer has to place a new order.

Send automatic shipping message

First you have to set Order status for shipment notification.

When the shipping state changes to the value you’ve set in the plugin base configuration Order status for shipment notification, and an invoice number is set in the default Shopware 5 database for invoice numbers, the shipping command is sent automatically for the original transaction amount.

Shipping notification through order details

Sign in to the Shopware 5 backend, go to Customers > Orders, and select Edit (pencil icon). In the Documents tab you can see if there’s an invoice document or number available.

Oder details documents tab

Once an invoice is generated for the order through the back end or the invoice number is set to default database table according to Shopware 5 invoice workflow, a Shipping notice button is available in Order Details > Unzer Payment.

Order details Unzer Payment tab shipping notice button

In the Unzer Payment tab of the order

  1. Perform your transaction by selecting Shipping notice. After every transaction, the payment state of the order is changed and a new entry is available in the Payment history table.
icon
Currently, you can only have only one shipment message for the full amount for each transaction. Partial shipments are not supported.

You can review all your transaction in Unzer Insights.

Transaction handling for shipment or insurance

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

Activating shipment or insurance

For payment methods Unzer Installment Secured and Unzer Rechnung (gesichert) a shipment or shipping messages must be generated to activate the payment guarantee. See Send notifications via order detail view

Display account data for bank transfer

For Unzer Rechnung (gesichert) and Vorkasse (Unzer Payment) payment methods, the data for the payment must be displayed to the end customer. The end customer uses this data to pay.

Display on the Checkout-Finish page

The plugin modifies the checkout-finish-page as shown in the following example:

Shopware checkout success page

Check Customize the Plugin to learn to modify this payment info texts.

Display on the Customer-Account-Order page

Currently the plugin does not display the payment data, the customer has to use to pay, in customer’s account on order’s page.

Display on the invoice document

If an invoice document is generated within the Shopware 5 backend, the data for the money transfer can be automatically added to the invoice PDF.

Check Customize the Plugin to learn how to modify these texts.

You can also modify the footer area of the invoice documents.

For more information, refer to Customize the Plugin to learn how to modify these texts. (LINK to Customize the plugin “Modify payment data on invoice document”)

Review transaction details in the merchant backend (Unzer Insights)

Within the order overview you can find “Transaction” column. This column contains the relevant IDs.

Order overview

With this ID, you can sign in to Unzer Insights and search in Orders > Order number.

Unzer Insights

You can also find the Short-ID by going to Unzer Payment > Details for the order. Order details Unzer Payment tab

You can find the short ID in Unzer Insights and going to transactions.

icon

Changes within the positions tab will not be submitted to Unzer. If you want to lower the invoice amount, please refer to Reverse or refund the invoice amount.

If you want to increase invoice amount, your customer has to place a new order.

See also