Overview
Multibanco Reference payments can be enabled through the supported SIBS Payment Gateway plugins for e-commerce platforms.
Once configured, Multibanco Reference is displayed as an available payment method during checkout, allowing customers to obtain a payment reference and complete the payment through Multibanco channels.
The plugin handles the communication with the Payment Gateway, simplifying the integration process while maintaining the standard Multibanco Reference payment flow.
Supported plugin platforms may include:
- WooCommerce
- Magento
- PrestaShop
- Shopify
For plugin installation, merchant credential configuration, environment setup, webhook configuration, and general plugin configuration, refer to the corresponding Plugin Integration chapters in B.3 – Integration Models – Plugin Integrations.
Payment Method Configuration
After completing the base plugin configuration, Multibanco Reference must be enabled within the payment methods configuration section.
The available settings may vary slightly between platforms, but typically include the following options:
| Parameter | Description |
|---|---|
| Enable Multibanco Reference | Enables Multibanco Reference as an available payment method during checkout. |
| Environment | Defines whether the plugin operates in Sandbox or Production mode. |
| Service Entity | Defines the payment service entity assigned to the merchant for Multibanco Reference payments. |
| Reference Expiration | Defines the validity period of the generated payment reference, when supported by the platform. |
| Display Configuration | Controls how Multibanco Reference is presented during checkout. |
| Order Status Mapping | Defines how payment results are mapped to order statuses within the platform. |
The exact configuration options available may vary depending on the plugin platform and version.
Configuration examples are shown below for the available plugin platforms.
WooCommerce
PrestaShop
Magento
Payment Flow
The following diagram illustrates the high-level Multibanco Reference payment flow when using a Plugin Integration.
Multibanco Reference is an asynchronous payment method. The final transaction status becomes available only after the customer completes the payment using the generated reference.
Customer Checkout Experience
When Multibanco Reference is enabled, customers can select it during checkout and obtain the payment details required to complete the transaction.
The typical payment flow is as follows:
- The customer selects Multibanco Reference during checkout
- The plugin creates the payment request
- A Multibanco payment reference is generated
- The customer is presented with the Entity, Reference and Amount required to complete the payment
- The customer completes the payment using a Multibanco channel
- The payment result is returned to the e-commerce platform
- The order status is updated accordingly
Payment Details
After a successful reference generation, the customer is presented with the payment details required to complete the transaction.
Typical payment information includes:
- Entity
- Reference
- Payment Amount
- Reference Expiration Date (when applicable)
The payment details may be displayed during checkout, included in order confirmation pages, and made available through customer notifications generated by the e-commerce platform.
Order Management
After payment completion, the plugin updates the order information within the e-commerce platform.
Depending on the platform and configuration, merchants can view payment information directly from the order details page.
Typical information includes:
- Payment Status
- Transaction Identifier
- Payment Method
- Transaction Date and Time
- Payment Amount
- Merchant Transaction Identifier
- Entity
- Reference
Transaction Status
Multibanco Reference is an asynchronous payment method.
After the payment reference is generated, the transaction remains pending until the customer completes the payment.
Merchants should rely on one or both of the following mechanisms to obtain the final transaction status:
- Merchant Notifications (Webhooks)
- Transaction Status Inquiry
The e-commerce platform order status should remain consistent with the final transaction status returned by the Payment Gateway.
For detailed information about transaction status handling, refer to:
- E. Notifications and Transaction Status
- D.1.3.2 – One-Off Payments – Multibanco Reference [Server-to-Server Integration]
Testing Payments
The SIBS Sandbox Payment Simulator can be used to validate Multibanco Reference payment flows during testing and integration activities.
Example sandbox simulator entry point
Related Documentation
- B.3 – Integration Models – Plugin Integrations
- D.1.3.1 – One-Off Payments – Multibanco Reference [Form Integration]
- D.1.3.2 – One-Off Payments – Multibanco Reference [Server-to-Server Integration]
- E. Notifications and Transaction Status
- E.1 – Webhooks (Notifications)
- E.2 – Status Inquiry / Get Status