MB WAY
Beta

Last updated: July 10, 2024

Accept payments with MB WAY, a popular digital wallet in Portugal.

Information

To enable MB WAY payments on your account, contact your Account Manager or [email protected].

An MB WAY payment typically follows this payment flow:

You request a payment.
The customer performs authentication in the MB WAY app using their MB WAY PIN or Touch ID.
You receive a payment_captured webhook when the payment is completed successfully. Alternatively, you can confirm the status of the payment by retrieving the payment details via the API.

Model	Collecting
Payment flow	Direct
Payment method type	Digital wallet
One-step payment
Authorization
Capture
Refund
Partial refund
Chargeback
Recurring payment

For the full API specification, see the API reference.

post

https://api.checkout.com/payments


1{
2  "amount": 1000,
3  "currency": "EUR",
4  "source": {
5    "type": "mbway"
6  },
7  "reference": "ORD-5023-4E89",
8  "customer": {
9    "phone": {
10      "country_code": "372",
11      "number": "12345678"
12    }
13  }
14}

If you receive a 202 Accepted response with a status field set to Pending, your request was successful.


1{
2  "id": "pay_7ehiotldrlvujfpiyeo42i2roe",
3  "status": "Pending",
4  "reference": "ORD-5023-4E89",
5  "customer": {
6    "id": "cus_urx7wggzcpzufjjynbn7t6l5mq",
7    "email": "[email protected]",
8    "phone": {
9      "country_code": "372",
10      "number": "12345678"
11    }
12  },
13  "_links": {
14    "self": {
15      "href": "https://api.checkout.com/payments/pay_7ehiotldrlvujfpiyeo42i2roe"
16    }
17  }
18}

You can retrieve details about an existing MB WAY payment with the following endpoint.

For the full API specification, see the API reference.

get

https://api.checkout.com/payments/{id}


1{
2  "id": "pay_7ehiotldrlvujfpiyeo42i2roe",
3  "requested_on": "2023-08-17T07:58:32.0749106Z",
4  "source": {
5    "type": "mbway"
6  },
7  "amount": 1000,
8  "currency": "EUR",
9  "reference": "ORD-5023-4E89",
10  "status": "Pending",
11  "customer": {
12      "id": "cus_urx7wggzcpzufjjynbn7t6l5mq",
13      "email": "[email protected]",
14      "phone": {
15          "country_code": "372",
16          "number": "12345678"
17      }
18  },
19  "_links": {
20      "self": {
21          "href": "https://api.checkout.com/payments/pay_7ehiotldrlvujfpiyeo42i2roe"
22      },
23      "actions": {
24          "href": "https://api.checkout.com/payments/pay_7ehiotldrlvujfpiyeo42i2roe/actions"
25      }
26  }
27}

MB WAY supports full, partial, and multiple partial refunds.

You can refund a payment through the Dashboard or using the Refund API.

post

https://api.checkout.com/payments/{id}/refunds


1{
2  "amount": 100
3}


1{
2  "action_id": "act_jf7fv3vgiu7ezjfgzvvsqobxru",
3  "_links": {
4    "payment": {
5      "href": "https://api.checkout.com/payments/pay_fsud3hyoqkxencjvb5cfv6yqoe"
6    }
7  }
8}

When you process payments with MB WAY, we'll send the following webhooks throughout the payment lifecycle:

Webhook	Description
`payment_pending`	An asynchronous payment request was successfully initiated.
`payment_capture_pending`	The customer has approved the payment on the banking page.
`payment_captured`	The payment was successfully captured.
`payment_capture_declined`	The payment capture attempt was declined.
`payment_refunded`	A full or partial refund was successfully processed.
`payment_refund_declined`	The refund attempt was declined.
`payment_declined`	Occurs when a payment authorization request times out, or if there is a rejection during authorization. For example, due to insufficient funds, the issuer blocking the card, or a Do Not Honor instruction.
`payment_expired`	The payment was not captured within the required time and has expired.

Note

To start testing, contact your Account Manager or [email protected] to enable MB WAY payments in the sandbox environment.

To test MB WAY, request a payment using:

the customer.phone.country_code field set to 777
the customer.phone.number field set to a value from the following table, depending on which outcome you want to simulate

Response Code	Description	Phone Number
`10000`	Payment approved.	`12345678`
`20000`	The request was declined, though subsequent attempts may be successful.	`12345001`
`20017`	Customer cancellation.	`12345002`
`20003`	Invalid merchant or service provider.	`12345003`
`20120`	Invalid customer/user.	`12345004`
`20019`	Transaction has expired.	`12345005`

post

https://api.sandbox.checkout.com/payments


1{
2  "amount": 100,
3  "currency": "EUR",
4  "source": {
5    "type": "mbway"
6  },
7  "reference": "ORD-5023-4E89",
8  "customer": {
9    "phone": {
10      "country_code": "777",
11      "number": "12345678"
12    }
13  }
14}


1{
2  "amount": 100,
3  "currency": "EUR",
4  "source": {
5      "type": "mbway"
6  },
7  "reference": "ORD-5023-4E89",
8  "customer": {
9      "email": "[email protected]",
10      "phone": {
11          "country_code": "777",
12          "number": "10008888"
13      }
14  },
15  "_links": {
16      "self": {
17          "href": "https://api.checkout.com/payments/pay_7ehiotldrlvujfpiyeo42i2roe"
18      }
19  }
20}

MB WAY
Beta

Information

Request a payment

Request example

Response example

Get details about a payment

Response example

Refund a payment

Request example

Response example

Webhooks

Perform a test payment

Note

Request example