A capture is used to request a debit to previously authorized transaction. 

A capture request is performed using a previous payment authorization (AUTH) payment by referring its transactionID and sending a POST request over HTTPS to the /payments/{transactionID}/capture endpoint. 

Capture can occur in different ways:

• Full: capture the full amount authorized and finish the purchase.
• Partial: split the capture over one or several capture requests, up to the total amount authorized.

POST /api/v1/payments/{transactionID}/capture 

Request URL

https://spg.qly.site1.sibs.pt/api/v1/payments/{transactionID}/capture 

Request headers

Authorization: Bearer 0276b80f950fb446c6addaccd121abfbbb.eyJlIjoiMTk4N (...)
X-IBM-Client-Id: 8247e05b-e64d-4948-843d-6e8b30224e39
Content-Type: application/json 

Request body

{ 
"transactionID": "s2CB2CH3U91PdGDHsacJ", 
    "execution": { 
        "startTime": "2023-11-09T16:19:11.924Z", 
        "endTime": "2023-11-09T16:19:12.052Z" 
    }, 
    "paymentStatus": "Timeout", 
    "returnStatus": { 
        "statusCode": "000", 
        "statusMsg": "Success", 
        "statusDescription": "Success" 
    }    
    "maxAmount": {
        "value": 5.5, 
         "currency": "EUR" 
    }, 
     "minAmount": { 
         "value": 5.5, 
         "currency": "EUR" 
    }, 
     "entity": "24000"  
}

Consists in an authorization for a future payment.

Various transaction types available to meet your payment needs. 

In this documentation webpage, you will find how to use our APIs and Webhooks in order to control your QR Code Express.

Our QR Code Express APIs and Webhooks enable you to:

• Trigger notifications
• Check details from QR Code Express purchases
• Manage and edit QR Code Express prices and stock

Get purchase information

Webhook notifications

You can use Webhooks to proactively receive, in real-time, the payment status of QR Code Express purchases and its associated information (e.g. client data).

For more information on how to configure Webhooks for QR Code Express, click here.

Request purchase details via API

Use this API to request the payment status of QR Code Express purchases and its associated information (e.g. client data). Information is provided transaction by transaction.

If you don’t have access to this API yet, please register at SIBS Payment Gateway.

Follow the instructions below to configure the API.

Step 1: Configure the endpoint

Step 2: Define the header

Step 3: Get the response

Step 1: Configure the endpoint

Step 2: Define the header

Header parameters

Step 3: Get the response

{
    "merchant": {
    "terminalId": "{{terminalId}}"
    },

    "transactionID": "{{transactionID}}",
    "amount": {
    "currency": "EUR",
    "value": "1.23"
    },

    "paymentType": "PURS",
    "paymentStatus": "Success",
    "token": {
    "tokenType": "MobilePhone",
    "value": "351#911111111"
    },

    "execution": {
    "endTime": "2024-02-22T10:27:25.371Z",
    "startTime": "2024-02-22T10:27:25.258Z"
    },

    "returnStatus": {
    "statusCode": "000",
    "statusMsg": "Success",
    "statusDescription": "Success"
    }
}

Manage Stock

You can use the QR Code Express stock API to perform the following actions:

• Add stock units
• Remove stock units
• Define stock units
• View stock units

Add Stock Units

This action is used to add stock units to an existing QR Code Express. The available request fields are the following:

The response fields are the following:

Remove Stock Units

This action is used to remove stock units from an existing QR Code Express.

The available request fields are the following:

The response fields are the following:

Define Stock Units

This action is used to define the stock units of an existing QR Code Express. The available request fields are the following:

The response fields are the following:

Obtain Stock Units info

This action is used to obtain the current stock units info of an existing QR Code Express.

The available request fields are the following:

The response fields are the following:

Error Codes

When performing API call, the following errors can appear:

Update QR Code Express

To edit a QR Code Express:

Update QR Codes in bulk

To update QR Codes Express in bulk:

QR Code – Type 1

QR Code – Type 2

Deactivate QR Code

To deactivate a QR Code Express:

Deactivate QR Code Express in bulk

To deactivate more than one QR Code Express at once:

As soon as a QR Code Express is deactivated, it is no longer possible to proceed with a payment.

Check Transactions

To check transactions made with QR Code Express:

The platform will redirect you to the menu “Payment Operations” in which you will be able to check the transactions of the QR Code Express selected.

As an alternative you can go directly to the menu “Payments” > “Payment Operations” and follow the steps mentioned on the following section (link).

Filter transactions

To check transactions made with QR Code Express:

It is also possible to filter a search by using the “Payment Type” filter, available on the “Other Filters” field, in which you can filter by “QR Code Express T1” (type 1) or “QR Code Express T2” (type 2).

Refund purchases

To refund a purchase made with QR Code Express:

Activate the QR Code Express functionality

After having access to SIBS Backoffice, you can request access to the QR Code Express functionality through your financial institution.

If you don’t have access to SIBS Backoffice yet, you can activate your account here.

Create a QR Code Express

To create a new QR Code Express on SIBS Backoffice:

Before distributing your QR Code Express, please consider testing it using your MB WAY app, to confirm that everything is correct.

Create QR Codes in bulk

On SIBS Backoffice you can also import QR Codes in bulk through a CSV file.

To create QR Codes In bulk:

Code Type 1

Code Type 2

Download a QR Code Express

To download a QR Codes Express:

Download QR Codes in bulk

To download more than one QR Code Express at once:

Before distributing your QR Code Express, please consider testing it using your MB WAY app, to confirm that everything is correct.

The management of QR Code Express is done on SIBS Backoffice, where you can control the life cycle of your QR Code Express in an effortless way.

If you don’t have access to SIBS Backoffice yet, you can activate your account here.

On SIBS Backoffice, merchants can:

 

• Create and download QR Codes;
• Edit and manage the QR Codes created (e.g. add stock, change prices or expiration date);
• Check QR Code Express transactions in real-time;
• Monitor QR Code Express usage;
• Issue full or partial refunds on purchases made using QR Code Express;
• Configure real-time notifications of QR Code Express transactions (by e-mail or webhook).

QR Code Express is available in two different types:

Type 1: Used for purchases with instant consumption or delivery

• Mandatory fields: collects “TIN”
• Optional fields: collects “Billing address”, “Billing e-mail”, “Quantity” and “Order Identifier”

Type 2: Used for purchases with digital or physical delivery

• Mandatory fields: collects “TIN”, “E-mail” and “Billing e-mail”
• Optional fields: collects “Delivery address”, “Billing address”, “Name”, “Phone number” and “Quantity”

QR Code Express is a payment type that allows individuals to make purchases by scanning static QR Codes with MB WAY App.

A single QR Code Express can be scanned by multiple users and several times by the same user. Each QR Code is created and managed by the Merchant, who must define which information is associated to the QR Code, i.e. which data the user should fill in during checkout: billing data, delivery data and contact information.

By using this solution, Merchants can make payment codes available everywhere, from traditional media to physical devices, in which customers can use MB WAY to read and pay within a few clicks. This type of QR Code can be used to make purchases of physical or digital goods with instant delivery or home delivery.

How it works  

The SIBS processing system automatically detects whether a card is eligible for DCC and converts the purchase amount (EUR) into the card’s home currency. The DCC option is displayed on the payment screen, allowing the customer to choose which currency they want the transaction to be carried out in. 

Types of cards that can be used 

DCC payments are only available for Visa and Mastercard, credit and debit cards (including some prepaid cards).

Commissions involved in a transaction

In a DCC payment, the amount is converted from EUROS into the card’s home currency using an up-to-date exchange rate that includes the mark-up displayed on the terminal screen.

Available currencies

The DCC is available in more than 40 major world currencies, including the currencies of the countries that account for the largest share of tourism in Portugal. 

MIT (Merchant Initiated Transactions) are payment transactions that are not initiated by the Cardholder, but by the Merchant, after agreement between them. There are several types of MITs, including UCOF and Recurring, which are already marketed. 

Allows the Merchant to initiate the payment, without fixed recurrence. 

Enables payments of fixed or variable amount, without the end customer having to  authenticate after initial authorisation. 

Benefits

Initiate payment

Allows the Merchant to initiate the payment, without fixed recurrence.

Enable payments

Enables payments of fixed or variable amount, without the end customer having to  authenticate after initial authorisation. 

Business model

Transactional commissions/items for authorisation and purchase apply. The 3DS authentication item is only applied in the initial transaction

Integration methods

UCOF will be available on SIBS gateway 2.0 for payments using VISA and Mastercard scheme cards, for: 

• Server-to-Server; 
• Form. 

UCOF (Unscheduled Credential on File) 

An UCOF (Unscheduled Credential on File) transaction does not occur on a fixed or recurring date and may have a variable value. Each MIT can be of a lower, equal or higher amount than the initial transaction made by the customer – the CIT (Cardholder Initiated Transaction). 

Recurring 

Transactions processed at fixed, regular intervals not to exceed one year between Transactions, representing an agreement between a Cardholder and a Merchant to purchase goods or services provided over a period of time.