Datatrans is a leading Swiss payment service provider, offering a secure and flexible ecommerce payment solution trusted by merchants worldwide. With Datatrans, businesses  can provide their customers with a seamless checkout experience that supports a wide variety of national and international payment methods—including credit cards, debit cards, digital wallets, and alternative payment options. 
Designed for scalability and flexibility, Datatrans integrates smoothly with online shops of  all sizes and industries. The solution ensures high levels of security and compliance,  including PCI DSS certification and support for 3-D Secure, protecting sensitive customer  data and minimizing fraud risk. 
Through its modular setup, Datatrans empowers merchants to tailor their payment  processes, optimize transaction handling, and leverage features such as alias management  (securely saving cards for future use), multiple payment brand support, and customizable  authorization flows. Whether operating a small online store or a large-scale e-commerce  platform, Datatrans delivers a reliable, future-ready payment infrastructure built to meet  the needs of modern digital commerce. 
This guide is designed to help merchants install, configure, and manage the Datatrans  Payment Module in their Magento 2 store. 
Using the Datatrans plugin, merchants can: 

• Offer a wide range of secure payment methods to their customers 
• Ensure smooth integration between backend configuration and frontend checkout experience 
• Customize payment behavior through flexible settings tailored to business needs 

This manual will walk you through:

• System requirements and installation steps 
• Configuration of key module settings and their impact on the customer experience 
• Functional details of payment methods and how each setting affects order  handling and transaction flow 

• Datatrans Credit/Debit Cards 
  Brands 
  • MasterCard 
  •  Visa 
  • American Express 
  • China Union Pay 
  • Diners Club 
  • Discover 
  • JCB 
  • Maestro 
  • Dankort 
• Datatrans GooglePay 
• Datatrans PostFinancePay 
• Datatrans Sepa Elv 
• Datatrans Samsung Pay 

This chapter explains how to install the Datatrans Payment Module for Magento 2. 
System Requirements: 
Please ensure the following requirements are met before installing the plugin: 

• Magento Version: Magento 2.4.5 – 2.4.8-p2 (tested and supported) 
• PHP Version: 8.1 – 8.4 
• Composer: Composer 2 

Note: Datatrans requires a secure HTTPS environment to function correctly.

The Datatrans module configuration in Magento 2 includes two sections: 

• General Configuration 
• Payment Method-Specific Configuration 

All configuration options are available in the Magento Admin panel under: 
Magento Admin Panel → Stores → Configuration → Pits Configuration → Datatrans. These settings control both the backend logic and the frontend checkout experience. Each field directly affects how payments are processed, displayed to customers, and logged for transaction tracking. 

Type: Yes/No (Select) 

• Description: Turns the Datatrans payment module on or off. 
• Frontend Impact: If set to “No”, none of the Datatrans payment methods will be visible during checkout. 

Type: Select (Test Mode/ Live Mode) 

• Description: Defines which environment to use for transaction processing. 
  • Test Mode– For development and sandbox testing with test credentials. 
  • Live Mode– For production payments with real customer transactions. 
• Impact: Controls which API credentials and endpoints are used. Must be set to Live before going live. 

Type: Text 

• Description: Merchant identifier provided by Datatrans for your live/test account. 
• Where to find it: Available in the Datatrans Backoffice. Please login to the Datatrans Backoffice, and from the landing page choose the ‘Change Merchant’ option to web. Please see Figure 2.
• Once Merchant is changed, choose UPP Administration option and select the Security option to see the Merchant ID. 
• Impact: Used to authenticate transactions in the live environment. 

Type: Text 

• Description: API password associated with your live/test Merchant ID. 
• Where to find it: Available in the Datatrans Backoffice. Please login to the Datatrans Backoffice, and from the landing page choose the ‘Change Merchant’ option to web. Please see Figure 2. 
• Once Merchant is changed, choose UPP Administration option and select the Security option to generate the password. 

Type: Yes/No (Select) 

• Description: Allows customers to securely save their card details (tokenized as an alias) for future purchases. 
• Frontend Impact:
  • A Saved Cards section appears in the customer’s “My Account” area. 
  • During checkout, customers can select from saved cards or add a new one. 
• Security: Card details are never stored in Magento; they are securely handled by Datatrans.

Type: Yes/No (Select) 

• Description: Defines whether the unique Datatrans transaction ID should be displayed to the customer. 
• Frontend Impact: 
  • If enabled, the transaction ID is shown on the Order Success Page, My Accounts-Sales Order View page and included in the Order Confirmation email. 
• Benefit: Provides transparency for customers and simplifies transaction tracking for support teams. 

Type: Yes/No (Select) 

• Description: Enables or disables logging of all API errors encountered during communication with Datatrans. 
• Impact: 
  • Yes – All failed API calls, invalid responses, and error messages are recorded. 
  • No – Errors will not be logged. 
• Recommendation: Keep this enabled in both Test and Live environments to simplify issue tracking.

Type: Button (Admin Action) 

• Description: Provides a direct link in the Magento Admin to view the API error log file. 
• Impact: 
  • Opens a list of logged errors, including timestamp, request details, and error message.
  • Helps merchants quickly identify and resolve issues without accessing the server directly. 
• File Location: Errors are stored in var/log/datatrans_error.log.

Type: Yes/No (Select) 

• Description: Enables or disables detailed logging of API communication with Datatrans (including request and response payloads). 
• Impact: 
  • Yes – All the request/response API calls are logged in detail. 
  • No – No debug-level logs are written. Recommended for production to avoid large log files. 

Type: Button (Admin Action) 

• Description: Provides a direct link in the Magento Admin to view the debug log file. 
• Impact: 
  • Shows full API request/response data for troubleshooting. 
  • Useful for verifying whether data is being sent correctly to Datatrans. 
• File Location: Debug logs are stored in var/log/datatrans_debug.log.

Type: Yes/No (Select) 

• Description: Activates or deactivates the payment method. 
• Frontend Impact: If set to No, the method will not appear during checkout.

Type: Text 

• Description: Defines the label shown to customers at checkout (e.g., “Google Pay”). 
• Frontend Impact: Displayed on the payment method selection screen. 

Type: Textarea 

• Description: Custom description shown below the title at checkout.
•  Frontend Impact: Helps customers understand the payment method (e.g., “Pay quickly using your Credit/Debit card”).

Type: Select (All Allowed Countries / Specific Countries) 

• Description: Controls whether this method is available worldwide or restricted to specific countries. 

Type: Multi-select (Country List)

• Description: If “Specific Countries” is selected above, choose which countries are allowed. 

Type: Multi-select 

• Description: Defines which currencies are supported for this payment method. 
• Note: Ensure that your Datatrans terminal supports these currencies. 

Type: Select 

• Options: 
  • Redirect – Customer is redirected to a secure Datatrans-hosted payment page. 
  • Lightbox – Payment form is shown directly within Magento checkout. 
• Frontend Impact: Defines how the customer experiences the payment flow. 

Type: Select 

• Options: Auto Capture / Delayed Capture 

Auto Capture – Funds are captured immediately after authorization. The payment is finalized, and an invoice can be automatically generated. 

• Backend Impact: Magento creates and marks the invoice as paid automatically. 

Delayed Capture – The payment is only authorized (amount reserved on the customer’s card). The merchant must manually capture funds later from the Magento Admin. 

• Frontend Impact: Customer sees the order as placed, but funds are only reserved. 
• Backend Impact: Merchant must trigger the “Capture” action in the Magento Admin to finalize payment and generate the invoice.

Type: Yes/No (Select) 

• Description: Automatically sends the Magento invoice email after auto-capture. 
• Dependency: Visible only if Capture Type = Auto.

Type: Manual/Automatic (Select) 

• Description: Automatically generate invoice after order placement. 
• Dependency: Visible only if Capture Type = Delayed. 

Type: Select 

• Options: No/Billing Address /Shipping Address /Both Billing and Shipping 
• Description: Controls what address details are sent to Datatrans for transaction records

Type: Yes/No (Select) 

• Description: Displays the Credit/Debit card logo/icon next to the payment option at checkout. 

Type: Numeric 

• Description: Restrict availability of the payment method based on order total. 
• Frontend Impact: Payment method is hidden if the order total is outside the defined range. 

Type: Numeric 

• Description: Determines the position of this payment method in the checkout list (lower numbers appear first). 

Initialized 

• When? Right after the customer clicks the Place Order button and is being redirected to the payment page. 
• Details: A transaction entry is created, but the payment has not yet been completed. This may happen if the customer abandons the payment or an error occurs. 
• Magento Internal Status: Pending Payment 

Authorized 

• When? The payment has been approved by the customer’s bank, but funds are not yet transferred. 
• Details: Requires manual or automatic capture based on the capture and liability settings. 
• Magento Internal Status: Processing 

Settled 

• When? The funds have been confirmed for transfer from the customer’s account  
• Details: Transaction has been successfully captured after authorization. 
• Magento Internal Status: Processing 

Settled - Transmitted

• When? Datatrans has transmitted the settlement (capture) request to the acquirer for processing
• Details: This combined status means the transaction has been settled and the settlement data has been transmitted to the acquirer or payment processor for final processing. 
• Magento Internal Status: Processing 

Credited 

• When? The transaction has been successfully refunded.
• Details: The customer has received their money back. 
• Magento Internal Status: Closed 

Credited - Transmitted 

• When? When a refund (credit) has been initiated and Datatrans has transmitted the refund request to the acquirer
•  Details: This status refers to a refund (credit) that has been successfully processed and transmitted to the acquirer. It confirms that the refund request has been 
  accepted and forwarded for execution.
•  Magento Internal Status: Closed

Settled - Credited 

• When? After the transaction has been fully processed and Datatrans has confirmed that the amount has been credited back to the customer 
•  Details: This indicates that the original transaction was settled, and a refund (credit) has subsequently been issued. It reflects both the initial capture and the transfer of funds back. 
• Magento Internal Status: Closed 

Transmitted 

• This status alone typically means that the transaction data has been sent to the acquirer but may not yet be confirmed as settled or credited. It’s part of the finalization process

Automatic Capture 

• When the Capture Type is set to Automatic, funds are captured immediately after the payment is authorized. 
• If invoice generation is also set to automatic, Magento will create a paid invoice for the order once the capture is completed. 
• No manual action is required in the Magento backend. 

Delayed Capture 

• When the Capture Type is Delayed, the transaction remains authorized but funds are not yet collected. 
• To capture the payment: 
  • Manual Invoice Generation
    • If invoice generation is configured as manual, the merchant must create the invoice manually from the Magento Admin. Please see Figure 5
    • Creating the invoice triggers an online capture of the authorized amount through Datatrans. 
  • Automatic Invoice Generation 
    • If invoice generation is automatic but the capture type is configured as manual (delayed), Magento will still generate the invoice automatically; however, the invoice will remain in a Pending state.
    • In this scenario, the merchant must manually click Capture Payment under the Order Invoice window to finalize the capture process. Please see Figure 6.  

Note on Multi-Capture: 

• Datatrans supports multi-capture feature only for Cards 
• Multi-capture allows merchants to capture funds separately for different items or partial quantities within a single order. Please see Fig 7 
• Each capture action will generate a corresponding invoice (manual or automatic) in Magento, reflecting the captured amount. 

Key Points: 

• The Magento invoice status is directly linked to the capture action: a captured payment generates a paid invoice. 
• After capture, the payment status is updated in both Magento and the Datatrans Backoffice. 

Full or Partial Refund

•  Refunds can be processed fully (entire order amount) or partially (specific products or amounts). 
• The refund is performed online through Datatrans and reflected in Magento.

Handling Multiple Paid Invoices 

• If an order has multiple paid invoices (e.g., due to multi-capture or split shipments), each invoice can be refunded separately. 
• Partial refunds can be applied to one or more invoices, and the refunded amount will be updated for each invoice. 
• The Magento order status will reflect the cumulative refund: 
  • Fully refunded: All invoices for the order are refunded. 
  • Partially refunded: Some invoices or amounts have been refunded, while others remain paid. 

Key Points: 

• Refunds are only possible for captured transactions. 
• Ensure that the refund amount matches the intended invoice(s) to avoid discrepancies. 
• Each refund action generates a corresponding entry in the Datatrans Backoffice for audit and tracking. 

Void Payment (Authorized, Not Captured) 

• When? The transaction is authorized, but the payment has not yet been captured. 
• Details: 
  • The authorization is canceled in Datatrans. 
  • No funds are collected from the customer. 
  • The Magento order status is updated to Canceled. 

Cancel Payment (Before Capture) 

• When? The customer or merchant cancels the order before the capture is performed. Please see Figure 6. 
• Details:
  •  The transaction is canceled in Datatrans. 
  • Magento updates the order status to Canceled automatically. 

Key Points: 

• Voids can only be performed on authorized but uncaptured transactions. 
• Once a transaction has been captured, a refund must be used instead of a void. 
• Voids ensure that no invoice is marked as paid in Magento, keeping financial records consistent. 
• The Datatrans Backoffice reflects all void actions for auditing purposes. 

Magento Core Patch Recommendation

If you encounter issues when capturing or cancelling an invoice (for example, a 404 error when clicking Capture or Cancel in the Magento Admin), it may be due to known Magento core bugs. 
These issues are addressed in the following patches:

Below the transaction summary, Magento displays a Transaction History Log that records all payment-related events for the order. Please see Figure 11. This log provides a timestamped sequence of actions performed through Datatrans — including initialization, authorization, capture (settlement), refund, and cancellation events. 
Each entry includes: 

• Timestamp: The exact date and time when the event occurred. 
• Event Type: Indicates the payment stage, such as initialized, authorize, settle, refund, or cancel.
• Transaction Reference: The Datatrans transaction ID related to the event. 
• Details/Comments: A brief message describing the result or amount processed for the event. 

The registration interface includes: 

• A dropdown listing available tokenizable payment methods (e.g., Visa, Mastercard, American Express). 
• An “Add Card” button, which becomes active once a valid payment method is selected. 

When the user initiates the registration: 

• The Datatrans SDK loads dynamically depending on the configured environment (Test or Live). 
• The selected payment method is processed securely via Datatrans. 
• Upon successful registration, an alias (token) is created and stored for the customer in Magento. 

The alias represents the card reference (e.g., a masked card number like 411111xxxxxx1111) that can be used for future transactions.

Note: 

• The alias is linked to the customer’s Magento account and can be used only by that customer. 
• Tokenization methods available depend on your Datatrans contract and configuration. 

The Saved Cards table displays all registered cards for the logged-in customer. 
Each entry shows the following details: 

• Card Number: Masked card number (e.g., 411111xxxxxx1111).
• Payment Method: Type of payment method used (e.g., Visa, Mastercard, Google Pay). 
• Valid Until: Expiry date of the alias as returned by Datatrans. 
• Action: A Delete button to remove the saved card. 

Customers can delete any stored alias at any time by clicking the Delete button. Please see Figure 12.  This action triggers an API call to Datatrans to remove the corresponding alias from their system, ensuring it cannot be used in future payments. If no saved cards exist, the system displays a message: “You have no Saved Cards.” 

• The saved card registration form utilizes the Datatrans Tokenization SDK loaded via the registerAlias JavaScript module. 
• The process is fully PCI-DSS compliant, as card data is transmitted directly to Datatrans without passing through Magento servers. 
• Saved card details in Magento are stored only as reference tokens, along with masked display information and expiry metadata. 
• Supported payment methods for alias registration depend on Datatrans configuration — for example, credit/debit cards support alias creation. 

Debug logs record the full sequence of actions and data exchanged between Magento and Datatrans, including: 

• API request and response parameters 
• Callback and redirect handling results 
• Payment state transitions (e.g., initialize, authorize, capture, refund) 
• System context (order ID, transaction ID, environment) 

This helps developers verify that the integration is functioning correctly and that expected parameters (like transactionId, refno, or status) are received.