Multibanco

Overview

Introduction

Multibanco is a payment method which allows you to process payments in euros by using bank accounts in Portugal. This method supports purchases.

This article provides information about working with the Multibanco method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type bank payments
Payment instruments bank accounts
Countries and regions PT
Payment currencies EUR
Currency conversion –
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts –
Chargebacks –
Notes –
Onboarding and access fee refer to your ecommpay key account manager; additional information is available in ecommshop

Interaction diagram

Payment processing by using the Multibanco method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the Multibanco service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the Multibanco method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

When working with the Multibanco the following properties and limitations are applicable.

Amounts, EUR Times ¹
minimum maximum basic threshold
Purchases – 99,999.99 – 7 days
Note:
  1. The base and threshold times are defined as follows:
    • The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase by using the Multibanco method, customers make purchases by using the displayed payment instructions.

Figure 1. Purchase by using Payment Page


Figure 2. Purchase by using Gate


Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the Multibanco method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 3. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the Multibanco method.
  8. The payment platform receives the request for processing the payment by using the Multibanco method.
  9. The payment platform processes the request and generates the payment instruction data.
  10. The data is sent to Payment Page for displaying to the customer.
  11. The payment form with the instructions to complete the payment is displayed to the customer.
  12. The customer selects a bank, independently redirects to the bank website or redirects from Payment Page to the Multibanco service to complete all the payment steps required by using the instructions. A payment can be performed within 30 days.
  13. The payment platform processes the request and sends it to the Multibanco service.
  14. The purchase is processed in the Multibanco service.
  15. The Multibanco service sends a notification about the result to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The payment platform sends the result information to Payment Page.
  18. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the Multibanco method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Multibanco method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. Additionally, it is recommended to specify the first, last names and email address of the customer in the parameters customer_first_name, customer_last_name and customer_email. If any of these parameters are missing, the payment form may display input fields for entering the missing values (details are available in Submission of additional payment information).
  4. The currency of payment can only be EUR.
  5. If you need to have the payment form displayed with the Multibanco method selected, set the force_payment_method parameter to multibanco.
  6. Additionally, any other parameters available for working with Payment Page can be used (details).
  7. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Multibanco method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "customer_email": "customer@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 4. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "EUR",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Johnson",
   "customer_email": "customer@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The Multibanco method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 10.00 EUR purchase made in the 238 project.

Figure 5. Example of callback data indicating that the purchase has been processed
{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "multibanco",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002914,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": "148907",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

The following is the example of a callback with information about a declined purchase.

Figure 6. Example of callback data indicating that the purchase has been declined
{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15593086938557",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "method": "multibanco",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "description": "TEST_15593086938557"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24680000002456,
            "type": "sale",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "created_date": "2019-05-31T13:20:11+0000",
            "request_id": "c4a6cb475cf610bac95feba1",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+resLz/88b/uRrI04ggf2ALg=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the Multibanco method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the Multibanco service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 7. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the Multibanco method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the Multibanco service.
  7. The request is processed on the Multibanco service side.
  8. The Multibanco service sends the data for displaying the payment instructions to the payment platform.
  9. The payment platform sends the callback with the data for displaying the payment instructions to the web service.
  10. The customer receives the bank transfer instructions and independently redirects to the bank website.
  11. The customer completes all the payment steps required by using the instructions. A payment can be performed within 30 days.
  12. The purchase is processed in the Multibanco service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The Multibanco service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the Multibanco method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Multibanco method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/bank-transfer/multibanco/sale endpoint. This endpoint belongs to the group /v2/payment/bank-transfer/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email address
    • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
      • return—URL for redirecting a customer during a purchase
  3. The currency of purchase can only be EUR.
  4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Multibanco method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URL for redirection, as well as signature.

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UGSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "Johnson@example.com",
      "first_name": "John",
      "last_name": "Johnson",
      "id": "customer123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://example.com"
    }
}
Figure 8. Example of sufficient data in a purchase request
{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UGSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "192.0.2.0",
      "email": "Johnson@example.com",
      "first_name": "John",
      "last_name": "Johnson",
      "id": "customer123"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://example.com"
    }
}

Format of the customer redirection data

To complete the payment, customers must get the payment instructions from you. To display the payment data in the form of instructions, you need to receive a callback from the payment platform with the necessary data in the provider_extra_fields object:
  • service_suppler_id—bank identifier selected by a customer
  • payment_reference—reference number to complete payment
Figure 9. provider_extra_fields example
{
"provider_extra_fields": {
            "service_suppler_id": "11854",
            "payment_reference": "646511672",
            "merchant_site_url": "https://example.com/"
        }
}

Final callback format

The Multibanco method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 10.00 EUR purchase made in the 238 project.

Figure 10. Example of callback data indicating that the purchase has been processed
{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_1560760354708",
            "type": "purchase",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "method": "multibanco",
            "sum": {
                "amount": 1000,
                "currency": "EUR"
            },
            "description": ""
        },
        "operation": {
            "id": 29891000002914,
            "type": "sale",
            "status": "success",
            "date": "2019-06-17T08:56:47+0000",
            "created_date": "2019-06-17T08:50:34+0000",
            "request_id": "0d6aabd20c7925f1719b7cb63f728b32a3450cf0",
            "sum_initial": {
                "amount": 1000,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": "148907",
                "date": "2019-06-17T08:56:46+0000",
                "auth_code": ""
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "V0zYWk7OzwfcMJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

The following is the example of a callback with information about a declined purchase.

Figure 11. Example of callback data indicating that the purchase has been declined
{
{
        "project_id": 238,
        "payment": {
            "id": "TEST_15593086938557",
            "type": "purchase",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "method": "multibanco",
            "sum": {
                "amount": 100,
                "currency": "RUB"
            },
            "description": "TEST_15593086938557"
        },
        "customer": {
            "id": "1"
        },
        "operation": {
            "id": 24680000002456,
            "type": "sale",
            "status": "decline",
            "date": "2019-05-31T13:36:03+0000",
            "created_date": "2019-05-31T13:20:11+0000",
            "request_id": "c4a6cb475cf610bac95feba1",
            "sum_initial": {
                "amount": 100,
                "currency": "EUR"
            },
            "sum_converted": {
                "amount": 100,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+resLz/88b/uRrI04ggf2ALg=="
    }
}

Useful links

The following articles can be useful when implementing purchases via Gate:

Analysis of payments results

To analyse information about payments made with the Multibanco method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.