MB WAY is the leading e-wallet in Portugal, with over 3.5 million users as of May 2021. The user base continues to grow steadily each quarter, and now 50% of Portuguese bank customers are using MB WAY. Learn more.

Payment Method Properties


Markets	`PT`
Processing currencies	`EUR`
Consumer currencies	`EUR`
Settlement currencies	`EUR`
Minimum payment amount	0.01 EUR
Maximum payment amount	5,000.00 EUR
Recurring payments	To be checked
Separate captures	To be checked
Refund	Full - Partial - Multiple
Refund validity	120 days
Chargeback	Yes
Sandbox availability	PPRO provided

Make an MB WAY payment

To make an MB Way payment, you'll need to provide the following data when calling our /v1/payment-charges API:

Data Field	Required	Description
paymentMethod	Y	`MBWAY`
amount.value	Y	The amount to be paid in the smallest units of the currency used.
amount.currency	Y	`EUR`
consumer.name	Y	Full name of the consumer.
consumer.country	Y	The country where the consumer is shopping
authenticationSettings: REDIRECT settings.returnUrl	Y	Specify the URL to which the consumer should be redirected after completing the payment.

Request

POST /v1/payment-charges

{
    "paymentMethod": "MBWAY",
    "amount": {
        "value": 1000,
        "currency": "EUR"
    },
    "consumer": {
        "name": "John Smith",
        "country": "PT"
    },
    "authenticationSettings": [
        {
            "type": "REDIRECT",
            "settings": {
                "returnUrl": "https://www.your-merchant-success-page.com/"
            }
        }
    ]
}

Response

You'll receive one of our standard payment charge responses (see potential responses in the API Reference)

{
    "merchantPaymentChargeReference": "{{$randomPassword}}",
    "paymentMethod": "MBWAY",
    "amount": {
        "value": 1,
        "currency": "EUR"
    },
    "paymentDescriptor": "Payment Descriptor",
    "consumer": {
        "name": "John Smith",
        "country": "PT",
        "email": "[email protected]",
        "billingAddress": {
            "firstName": "John",
            "lastName": "Smith",
            "phoneNumber": "01522113356",
            "street": "Hellersbergstraße 14",
            "postalCode": "41460",
            "city": "Berlin",
            "region": "Berlin",
            "country": "DE"
        }
    },
    "order": {
        "orderItems": [
            {
                "name": "Product Name 1",
                "quantity": 1,
                "amount": 100
            }
        ]
    },
    "authenticationSettings": [
        {
            "type": "REDIRECT",
            "settings": {
                "returnUrl": "https://www.ppro.com/"
            }
        }
    ]
}

Consumer Authentication

MB WAY requires authentication by the consumer, which they do via their bank's online environment. You will need to redirect their browser to MB WAY's payment page using the link provided in the requestUrl field of the REDIRECT authentication method response. On MBWay's payment page to choose their bank

The payment charge will remain in the AUTHENTICATION_PENDING state until the consumer logs into their bank and approves the payment. After this, the charge will transition to the CAPTURED state.

Handling the Payment Result

The consumer will be redirected to the authenticationMethods.settings.returnUrl provided in the initial payment charge creation request, depending on whether the authorization is a success, a failure, or if the user cancelled/aborted the flow.

If the consumer fails to authenticate the payment within the timeout window, the charge will transition to the DISCARDED state.

You can receive webhooks for all changes to the payment charge state and use these to build business logic such as delivering the goods when the charge is CAPTURED.