Prows 2 API - MB Way Payments and Authorizations

This is an extension only available to partner merchants.

The Prows 2 MB Way API allows merchants to:

  • Create MB Way payments or authorizations without using a MEO Wallet checkout.
  • Use the same endpoints if the Prows 2 Credit Card API is already used.

Pre-requisites

Before using this API, you will need:

  • A merchant account which will receive payments or create authorizations. You can create an account here.
  • A merchant API key. You can generate one at “O Meu Negócio->Chaves de API” option in the merchant backoffice sidebar.
  • A ESB Token (will be provided by the Altice Pay team).

Authentication

The access to the API is based in a custom HTTP Basic authentication. Details here.

You must provide an extra HTTP header named “Proxy-Authorization” with a value with this prefix: ESBToken=. The value of this token will be provided as described above.

Services

Check examples below for each service. The endpoint used in these examples is from the sandbox environment.

The production endpoint is: https://services.wallet.pt

Prows 2 payment

You can pass a request_id in the payload to track this request. Check this page for details.

Request POST /prows/v2/payment
Query params none
Data params Operation
Returns Operation
Click here for an example
curl --location --request POST 'https://services.sandbox.meowallet.pt/prows/v2/payment' \
--header 'Authorization: WalletPT <merchant-wallet-API-Key>' \
--header 'Content-Type: application/json' \
--header 'Proxy-Authorization: ESB Token=<ESB-Token>' \
--data-raw '{
    "callback": "https://example.com",
    "method": "MBWAY",
    "amount":1.5,
    "mbway": {
        "phone":"960000000"
    },
    "currency": "EUR",
    "ext_invoiceid":"pista",
    "ext_customerid":"Xavi"
}'
Response example:
{
    "currency": "EUR",
    "instant": false,
    "id": "a24c727e-a1d3-11ef-b874-8933a5eb70ad",
    "ipaddress": "10.0.3.1",
    "ext_invoiceid": "pista",
    "ext_customerid": "Xavi",
    "type": "PAYMENT",
    "channel": "WEBSITE",
    "modified_date": "2024-11-13T15:26:21+0000",
    "items": [],
    "refundable": false,
    "fee": -0.06,
    "amount": 1.5,
    "amount_net": 1.44,
   "merchant": {
        "id": "600000000",
        "name": "testmerchant",
        "email": "testmerchant@telecom.pt"
    },
    "date": "2024-11-13T15:26:20+0000",
    "method": "MBWAY",
    "status": "PENDING"
}


Prows 2 authorization

You can pass a request_id in the payload to track this request. Check this page for details.

Request POST /prows/v2/authorization
Query params none
Data params Authorization
Returns Authorization
Click here for an example
curl --location --request POST 'https://services.sandbox.meowallet.pt/prows/v2/authorization' \
--header 'Authorization: WalletPT <merchant-wallet-API-Key>' \
--header 'Content-Type: application/json' \
--header 'Proxy-Authorization: ESB Token=<ESB-Token>' \
--data-raw '{
    "callback": "https://example.com",
    "method": "MBWAY",
    "amount": 2,
    "mbway": {
        "phone":"960000000"
    },
    "currency": "EUR",
    "ext_invoiceid":"pista",
    "ext_customerid":"Xavi"
}'
Response example:
{
    "currency": "EUR",
    "instant": false,
    "id": "ad034934-9d2f-11ef-8fa7-7fecc8eb70ad",
    "ipaddress": "10.0.3.1",
    "ext_invoiceid": "pista",
    "ext_customerid": "Xavi",
    "type": "AUTH",
    "modified_date": "2024-11-07T17:42:37+0000",
    "items": [],
    "refundable": false,
    "fee": 0,
    "amount": 2,
    "amount_net": 2,
    "date": "2024-11-07T17:42:36+0000",
    "method": "MBWAY",
    "status": "PENDING"
}


Address

Field Type In/Out Mandatory Description
address string IO N street address including door number
city string IO Y city, e.g: Lisbon
country string IO Y ISO 3166-1-alpha-2
postalcode string I Y Postal code (ex. 1000-100)

Operation

The table describes the mandatory and specific fields for the Prows 2 MB Way API. For a full description of the available fields, check the Structures documentation.

Field Type In/Out Mandatory Description
amount float I Y payment amount
currency string I Y amount currency in ISO 4217
merchant Merchant O Y transaction recipient
callback string IO Y valid url to receive the callback
method string IO Y payment method - MBWAY
mbway MBWayPayment IO Y MB Way data

Merchant

Field Type In/Out Mandatory Description
id string O Y internal merchant id
email string O Y merchant email
name string O N merchant comercial name
apikey string I Y merchant API Key