Multibanco

Overview

Multibanco is a payment method that allows customers to perform purchases by bank transferring. Purchases through this method are available by using Payment Page and Gate.

General information

Payment method type	bank payments
Payment instruments	bank accounts
Countries and regions	PT
Payment currencies	EUR
Currency conversion	–
Purchases	+
Payouts	–
Stored credentials payments	–
Full refunds	–
Partial refunds	–
Chargebacks	–
Notes	–
Onboarding and access fee	Refer to your key account manager ecommpay

Interaction diagram

Payment processing by using the Multibanco payment method requires merchant's web service, one of ecommpay interfaces, and the ecommpay payment platform, as well as Multibanco technical facilities that provides interaction with banking services.

Operations support

	Interfaces				Amounts, EUR		Times *
	Payment Page	CMS Plug-ins	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases	+	–	+	–	–	99,999.99	–	7 days

* The basic and threshold times are defined as follows:

The basic 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 initiator. The basic 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 customer is required). Use the basic time to estimate when to react to the absence of payment result notifications or when to check payment status.
The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the initiator receives the callback with the payment result. A payment is automatically declined, if its waiting time exceeds the threshold time. For individual setting of the threshold time limit, contact ecommpay technical support.

Processing scenarios

In the Multibanco method, customers perform a purchase operation by using the payment instructions.

Figure: Purchase by using Payment Page procedure

Figure: Purchase by using Gate procedure

The sections that follow provide detailed information about what you need to perform payments and how you can analyse the information on payments and operations.

Purchase by using Payment Page

General information

In the Multibanco method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ecommpay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Multibanco method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.

Figure: Purchase sequence in the Payment Page method:

A customer initiates a purchase on the merchant's web service.
The web service sends the request for Payment Page opening to the specified ecommpay URL.
The request for opening is redirected to the payment platform.
The payment platform performs the initial request processing that involves validation of the required parameters and signature.
Requested Payment Page is generated into the ecommpay payment platform as specified in the project settings and the request parameters.
Payment Page is displayed to the customer.
The customer selects the Multibanco payment method.
The payment platform receives the purchase request for payment processing from Payment Page.
The payment platform performs the internal purchase request processing and generates the payment instruction data.
The data is passed to Payment Page to display to the customer.
The payment form with the instructions to complete the payment is displayed to the customer.
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.
The payment platform performs the internal purchase request processing and sends it to the Multibanco service.
The payment is processed on the Multibanco service side.
The Multibanco service sends the result notification to the payment platform.
The payment platform sends a callback with the payment result to the web service.
The payment platform sends the result to Payment Page.
A page with the payment result information is displayed to the customer on Payment Page.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Multibanco payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Multibanco method:

You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
- project_id—the project ID obtained from ecommpay
- payment_id—payment ID unique within the project
- payment_currency—payment currency in ISO-4217 alpha-3 format
- payment_amount—payment amount in minor units
- customer_id—customer ID unique within the project
The currency of payment can only be EUR.
There are more mandatory parameters customer_first_name, customer_last_name, customer_email—first and last names, email of the customer within the project.
If you need to have payment form displayed with the Multibanco method selected, set the force_payment_method parameter to multibanco.
If required, you can also add any other additional parameters Payment Page supports.
After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Thus, a correct payment request in the Multibanco method must include project, customer, and payment IDs, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { project_id: 0, 
      payment_id: 'X03936',
      payment_amount: 1000, 
      payment_currency: 'EUR',   
      customer_id: 'customer1',
      customer_first_name: 'John',
      customer_last_name: 'Johnson',
      customer_email: 'John@mail.com',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1YtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Multibanco method, see Parameters for opening payment form.

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 an information about successful 10.00 EUR purchase made by the customer in the 238 project.

Figure: Example of a successful purchase callback

{
{
        "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": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
{
        "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": "RUB"
            },
            "sum_converted": {
                "amount": 1,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+rDsDhKC2JvPwQKkDNO940esLz/88b/uRrI04ggf2ALg=="
    }
}

Purchase by using Gate

General information

In the Multibanco methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

Send a request with all the required parameters and signature to the ecommpay URL.
Get the callback with the payment data and pass it to the customer as a payment instructions.
Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.

Figure: Purchase by using Gate

A customer initiates a purchase through Multibanco on the merchant's web service side.
The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
The payment platform receives the request for processing the purchase from Gate.
The payment platform performs the initial request processing that includes validation of the required parameters and signature.
The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
The payment platform performs the internal payment request processing and redirects the request to the Multibanco service.
The request is processed on the Multibanco side.
The Multibanco service sends the payment data to perform a bank transfer to the payment platform.
The payment platform sends the callback with the instruction data in the provider_extra_fields object.
The customer receives the bank transfer instructions and independently redirects to the bank website.
The customer completes all the payment steps required by using the instructions. A payment can be performed within 30 days.
The payment is processed on the Multibanco side.
The result is displayed to the customer.
The customer is redirected to the merchant's web service.
The Multibanco service sends the payment result notification to the payment platform.
The payment platform sends a callback to the web service.
The customer receives the payment result on the web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Multibanco payment method and provide the information on the format of callbacks with purchase results.

Request format

There are several things you must consider when using purchase requests in the Multibanco method:

You send purchase requests by sending the /v2/payment/bank-transfer/multibanco/sale request by using HTTP method POST. This request refers to the bank transferring requests group: /v2/payment/bank-transfer/{payment_method}/sale.
The following objects and parameters must be specified in any request:
- Object general—general purchase information:
  - project_id—project identifier
  - payment_id—unique purchase identifier
  - signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
- Object customer—customer information:
  - id—unique ID within the merchant project
  - first_name—first name
  - last_name—last name
  - email—email address
  - ip_address—customer IP address
- Object payment—purchase information:
  - amount—purchase amount
  - currency—payout currency in the ISO-4217 alpha-3 format.
- return_url—URL for customer returning from the bank site:
  - return—site URL for returning
The currency of purchase can only be EUR.
If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Multibanco method must include project and payment IDs, customer data, currency and amount of the purchase, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 2990,
        "payment_id": "payment_id",
        "signature": "PJkV8ej\/UG0Di8NN5e7cV+VHq3LwY3T\/pOMeSaRfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
      "ip_address": "1.1.1.1",
      "email": "Johnson@mail.com",
      "first_name": "John",
      "last_name": "Johnson",
      "id": "customer1"
    },
    "payment": {
      "amount": 1000,
      "currency": "EUR"
    },
    "return_url": {
      "return": "http://merchantsite.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: Callback fragment containing the instructions data

{
"provider_extra_fields": {
            "service_suppler_id": "11854",
            "payment_reference": "646511672",
            "merchant_site_url": "https://merchant.com/"
        }
}

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 an information about successful 10.00 EUR purchase made by the customer in the 238 project.

Figure: Example of a successful purchase callback

{
{
        "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": "V0zYWk7OzwfcMBAJJxArOuQoQfNv92z0wBJeQIHwj75hpkuXFNqHjYGMdfhycMw=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of a declined purchase callback

{
{
        "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": "RUB"
            },
            "sum_converted": {
                "amount": 1,
                "currency": "EUR"
            },
            "provider": {
                "id": 1208,
                "payment_id": ""
            },
            "code": "603",
            "message": "Auto decline"
        },
        "signature": "KDgghuSnXgvc9V9smeF+rDsDhKC2JvPwQKkDNO940esLz/88b/uRrI04ggf2ALg=="
    }
}

Analysis of payments results

As with other payment methods ecommpay offers, when using the Multibanco method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

Dashboard allows you to download reports in CSV and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by using the /operations/get queries.

If you have any further questions regarding payment data analysis, contact ecommpay technical support.

Multibanco

Overview

General information

Interaction diagram

Operations support

Processing scenarios

Purchase by using Payment Page

General information

Request format

Callback format

Related topics

Purchase by using Gate

General information

Request format

Format of the customer redirection data

Callback format

Related topics

Analysis of payments results