SIBS Gateway provides a collection of APIs that enables our Clients to process and manage payments.
Our APIs allow to generate MULTIBANCO references to perform payments in the Multibanco ATM network or in the home banking solutions from card issuers.
Form integration
To be a valid Merchant on SIBS Gateway V02.00 it will be necessary to have an authorisation token <AuthToken>, <terminalId>.
Simple form integration with javascript based widget, on four simple steps:
Step 1: Server-to-server request
Step 2: Create the payment form
Step 3: Get the payment status
Step 4: Merchant notification
Step 1: Server-to-server request
First, perform a server-to-server POST request to prepare the checkout with the required data, including the order type, amount and currency. The response to a successful request is a JSON with a transactionID, which is required in the second step to create the payment form.
Step 2: Create the payment form
Displays a payment form to allow customers to submit payment method data. To create the payment form you just need to add the following lines of HTML/Javascript to your page and populate the following variables:
1. The checkout transactionID that was returned in the response from step 1
Change the variable in accordance with the environment – QLY or PRD.
<script src="https://{QLY/PRD}/assets/js/widget.js?id={transactionID}"></script>
2. The {formContext} that you get in response from step 2
{formConfig};
{formStyle} (optionally);
<form class="paymentSPG" spg-context="{formContext}" spg-config="{formConfig}" spg-style="{formStyle}"><form>
Configures the Merchant redirectUrl, which is the page on your website where the customer should be redirected after the payment.
Optional parameter that allows the user to change the form style.
Step 3: Get the payment status
Gets the checkout status.
Once the payment is processed, the customer is redirect to your redirectUrl.
You can check the status of your transaction making a GET request.
Step 4: Merchant notification
Receive payment status.
SIBS Gateway will send the notification of the asynchronous payment status.
Server-to-server integration
The Server to Server integration is also known as direct integration as it enables communication between the two servers, SIBS and Merchant. Cardholders can finalise a payment without being redirected to the SIBS Gateway Form. This integration is suitable for Merchants that store the payment data before sending them to the SIBS Payment Gateway.
Financial operations
For financial operations, Server-to-Server Integration is based on the following steps:
Step 1: Prepare the checkout
Step 2: Display payment method options to customer
Step 3: Update payment method data
Step 4: Get the payment status
Step 5: Merchant Notification
Step 1: Prepare the checkout
Sends payment data, except payment method data.
First, perform a server-to-server POST request to prepare the checkout with the required data, including the order type, amount and currency. The response to a successful request is a JSON with a transactionID, which is required in the second step.
Step 2: Display payment method options to customer
The next step is to provide the payment method options and get payment data from the customer:
- Card
- MULTIBANCO
- MB WAY ID
- Authorised payment
Step 3: Update payment method data: sends payment method and its required data.
Perform a payment request, call SIBS Gateway API with the collected data accordingly with the method.
Step 4: Get the payment status: gets the payment status.
Step 5: Merchant Notification: Receive payment status.
SIBS Gateway will send the notification of the asynchronous payments to the merchant server.