Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Multibanco for API only

Add Multibanco to an existing API-only integration.

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 yet done this integration, refer to our API-only integration guide.

Before starting your Multibanco integration:

This page explains how to add Multibanco to your existing API-only integration. The API-only integration integration works the same way for all payment methods. If you haven't yet done this integration, refer to our API-only integration guide.

Build your payment form for Multibanco

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.

To show Multibanco in your payment form, you need to:

  1. Add Multibanco in your Customer Area.

We provide an Multibanco logo which you can use on your payment form. For more information, refer to Downloading logos.

You can also get the required fields from the /paymentMethods response as explained in our API-only integration guide. In your request, specify:

  • countryCode: PT
  • amount.currency: EUR

The required fields are included in the object with type multibanco.

Make a payment

  1. In your /payments request, specify the following parameters:
    • paymentMethod.type: multibanco
    • countryCode: PT

The following code sample is a /payments request for a Multibanco payment.

{
    "amount": {
        "currency": "EUR",
        "value": 1000
    },
    "reference": "YOUR_ORDER_NUMBER",
    "paymentMethod": {
        "type": "multibanco"
    },
    "countryCode": "PT",
    "merchantAccount": "TestMerchant"
}

Response

You receive a response containing:

  • expiresAt: The expiry date of the voucher. The shopper needs to make their payment before this date and time.
  • reference: The Multibanco reference that the shopper needs to make the payment.

{
    "resultCode": "PresentToShopper",
    "action": {
        "expiresAt": "2019-09-28T12:54:17",
        "initialAmount": {
            "currency": "EUR",
            "value": 1000
        },
        "merchantName": "YOUR_MERCHANT_NAME",
        "merchantReference": "YOUR_ORDER_NUMBER",
        "paymentMethodType": "multibanco",
        "reference": "MULTIBANCO_REFERENCE",
        "totalAmount": {
            "currency": "EUR",
            "value": 1000
        },
        "type": "voucher"
    }
}

Present voucher

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. You can set the time period for the expiry of the voucher. To do so, contact the Support Team.
  • action.initialAmount.currency: EUR
  • 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

Use the resultCode that you received in response to your /payments call to present the payment result to your shopper. You will also receive a webhook notification informing you of the status of the payment. The 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 notification.
Received Result code sent when it takes some time before the final outcome of the payment is known Inform the shopper that you've received their order, and are waiting for the payment to clear.

Present shopper email

You can change the text and customize the look of the email to suit your business needs. To do so:

  1. In Customer Area, go to Account > Skins.
  2. Select the relevant skin and go to Extra options > Edit language files.

In the list of key entries, you can find the following:

  • pmDetailEmailReminder.multibanco.from_address: do-not-reply@adyen.com
  • pmDetailEmailReminder.multibanco.subject: The subject of the email sent to the shopper.
  • pmDetailEmailReminder.multibanco.title: The title of the email sent to the shopper.
  • comprafacil.multibanco.result.instructions: The instructions the shopper needs to follow to carry out the payment.
  • comprafacil.multibanco.result.reference: The payment reference needed to make the payment.
  • comprafacil.multibanco.result.entity: The number representing the relevant acquiring bank.
  • comprafacil.multibanco.result.amount: The amount that the shopper needs to pay.
  • comprafacil.multibanco.result.deadline: The deadline by which the shopper needs to pay.

These fields correspond to different sentences of the email that the shopper receives. You can override the Adyen default for these sentences. To do so, enter your sentences in the blank Merchant default field. Make sure to save your changes.

Test and go live

To test Multibanco payments before going live, contact the Support Team.

See also