You can add Multibanco to your existing integration. The following instructions show only what you must add to your integration specifically for Multibanco.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. This page includes only instructions to add Multibanco to your existing integration. |
|
| Action handling | Make sure that your existing integration is set up to handle the additional action. action.type: voucher. |
|
| Setup steps | Before you begin, add Multibanco in your Customer Area. |
Get Multibanco as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that Multibanco is included in the response.
| Parameter | Values |
|---|---|
| countryCode | PT |
| amount.currency | EUR |
Build your payment form for Multibanco
We provide the logo for Multibanco that you can download.
Include Multibanco in the list of available payment methods.
You do not need to collect any information from the shopper in your payment form.
Add additional parameters to your /payments request
You do not need to add any parameters when you make a payment, but note the following:
amount.value: The amount of the transaction, in minor units.
The maximum transaction amount for Multibanco is EUR 2500.
Handle the additional action
You must handle the additional action for Multibanco.
The action.type is voucher.
Test and go live
Before you can test Multibanco payments, you need to submit a request for Multibanco in your test Customer Area.
In the test environment, you can simulate a Multibanco payment by promoting the pending payment to a sale.
- Log in to your test Customer Area.
- Go to Transactions > Offers.
- Select the PSP reference of the pending Multibanco payment.
- Select Promote offer to sale button.
Multibanco payments that have been paid (including test offers that you manually promoted to sale) are under Transactions > Payments.
Test the reconciliation process by promoting test payments from offer to sale in your test Customer Area.
Before you can accept live Multibanco payments, you need to submit a request for Multibanco in your live Customer Area.