Accept Multibanco payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.
Before you begin
These instructions explain how to add Multibanco to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.
Before starting your Multibanco integration:
- Make sure that you have set up your back end implementation.
- Add Multibanco in your test Customer Area.
Build your payment form for Multibanco
Include Multibanco in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.
We provide an Multibanco logo which you can use on your payment form. For more information, refer to Downloading logos.
amount.value: The amount of the transaction, in minor units.
The maximum transaction amount for Multibanco is EUR 2500.
The required fields are included in the object with
Make a payment
- In your /payments request, specify the following parameters:
The following code sample is a /payments request for a Multibanco payment.
You receive a response containing:
expiresAt: The expiry date of the voucher. The shopper needs to make their payment before this date and time.
entity: The corresponding entity number.
reference: The Multibanco reference that the shopper needs to make the payment.
Use the information in the
action object in the /payments response to present the voucher to the shopper.
The payment voucher should include the following information:
action.expiresAt: The expiry date of the payment voucher. The shopper needs to make the payment before this time. The default expiry is D+3 (three days later) at 11:59PM.
action.initialAmount.value: The amount the shopper needs to pay.
reference: The payment reference that the shopper needs to make the payment.
Present the payment result
resultCode that you received in response to your /payments call to present the payment voucher to your shopper.
resultCode value you can receive for Multibanco is:
|resultCode||Description||Action to take|
|PresentToShopper||Present the voucher to the shopper.||Inform the shopper that you've received their order, and are waiting for the payment to be completed.
When the shopper has completed the payment you will receive a successful AUTHORISATION webhook.
We don't know when the shopper will make the payment. Thus, we will only send the AUTHORISATION webhook once the payment has been received. Once the shopper transfers the funds, we receive the result from the bank, and the transaction status changes to Authorised. If the shopper fails to make the payment before the payment voucher expires, you will receive an OFFER_CLOSED webhook.
Test and go live
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.