Inputs and Outputs (Cards)

Checkout

Inputs & Outputs, CheckOut

Input		Ouput
merchant		returnStatus
–	terminalId	–	statusCode
–	channel	–	statusMsg
–	merchantTransactionId	–	statusDescription
customer		paymentStatus
–	customerInfo	transactionID
–	customerName	amount
–	shippingAddress	–	value
–	billingAddress	–	currency
–	extendedInfo	merchant	terminalId
Transaction		merchant	channel
–	transactionTimestamp	merchant	merchantTransactionId
–	description	PaymentType
–	paymentType	paymentMethod
–	paymentMethod	amount
–	amount	–	value
–	value	–	currency
–	currency	Status
deviceInfo* (see dedicated table – Table – Synchronous & asynchronous notifications)		tokenList
customerInfo		–	tokenType
–	key	–	value
–	value	–	maskedPAN
originalTransaction		–	expireDate
–	id	formContext
–	datetime	expiry	string (date-time)
–	recipientId	execution
tokenisation		–	startTime
–	tokenisationRequest	–	endTime
–	tokeniseCard
–	paymentTokens
–	tokenType
–	value
mandate
–	mandateId
–	mandateType
–	mandateCreationOnly

Payment method card: Card

Inputs & Outputs, CARD

Input		Output
cardInfo		actionProcessed
–	PAN	–	id
–	secureCode	–	ty
–	validationDate	–	executed
–	cardholderName	tokenResponse
–	createToken	–	tokenType
		–	Value
		–	tokenName
		–	maskedPAN
		–	expireDate
instalmentPlan
–	id

Transaction status

It is possible to receive the transaction statuses below:

IN PROCESSING – meaning that the transaction initiated is now in processing.
PARTIAL – it is pending to receive information.
SUCCESS – informing transaction OK, the transaction was executed with success.
DECLINED – indicating that the transaction was declined by an operation intervenient.
TIMEOUT – informing a potential communication error.
ERROR – indicating that the transaction was declined by external system.

After the transaction is in processing, it will only retrieve the “partial” status if some action is pending to be taken. After that it will send the transaction status.

Notifications (Merchant notifications)

The Merchant can receive notifications by email or endpoint (notification assembling to the status inquiry – Checkout Status), however, only a notification will be sent for each transaction.
Notifications are sent by endpoint straight to the URL provided by the Merchant. The parameterization of this endpoint needs to be done on the SIBS Gateway Backoffice.
For email notifications, only one notification will be sent per transaction.
For URL notifications not accomplished, retries will be attempted. Each time SIBS Gateway receives a transaction, a notification will be sent with the transaction status in real time.
Every day SIBS Gateway sends a summarized email with the newest failed notifications (email needs to be registered on the Backoffice).
There is no guarantee on message order, especially if the time difference between the notifications is smaller than the time it takes to process them or by any communication or systems issues. Once the issues are sort out, new notifications will arrive in real time and old notifications will be resent. In case no notification is received, the option “Checkout Status” should be used before rejecting any transaction.

There are two types of notifications, the Synchronous and the Asynchronous:

Asynchronous

Make request – Need action – Get response;

Synchronous

Make request – Get response→CARD

Complex types

MerchantNotificationRequest

MerchantNotificationResponse

statusCode

string (Maximum 11 Text) (ex: 000)

Mandatory

statusMsg

String (Maximum 256 Text) (ex: Success)

Mandatory

Possible values are {“Success”, “Partial”, “Declined”, “InProcessing“, “Pending”, “Timeout”, “Error”}.

notificationID

PaymentNotificationId (UUID – Exact36Text)

Mandatory

Examples

On this subchapter, it is possible to find examples of webhook notifications sent by SIBS Gateway and the answer that the customer application should give. Answering this message is very important to avoid more unnecessary notifications sent by SIBS Gateway.

Request example

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

    "paymentStatus": "Success",
    "paymentMethod": "MBWAY",
    "transactionID": "DaBzrs8ayhQpi1EeenHe",
    "transactionDateTime": "2022-11-12T16:18:53.127Z",

    "amount": {
        "currency": "EUR",
        "value": 1.0
    },

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

    "paymentType": "AUTH",
    "notificationID": "2533e456-5e36-42c8-9eea-7961902f185e"
}

Response example

{
    "statusCode": "200",
    "statusMsg": "Success",
    "notificationID": "2533e456-5e36-42c8-9eea-7961902f185e" 
}

Cardholder Initiated Transaction with Type Recurring Example:

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

    "paymentStatus": "Success",
    "paymentMethod": "CARD",
    "transactionID": "s24nZiFtu15SCiW9vpDm",
    "transactionDateTime": "2022-12-27T16:05:27.585Z",

    "amount": {
        "currency": "EUR",
        "value": 11.2
    },

    "merchant": {
        "transactionId": "6637262",
        "terminalId": 45546,
        "merchantName": "COMERCIANTE DO LEGACY"
    },

    "paymentType": "PURS",
    "notificationID": "a433453e-6e40-4f53-a80d-4985cffa36f6",

    "merchantInitiatedTransaction": {
        "type": "RCRR",
        "validityDate": "2023-06-30T01:00:00+01:00",
        "amountQualifier": "ACTUAL",
        "schedule": {
            "initialDate": "2022-12-27T00:00:00Z",
            "finalDate": "2023-01-06T00:00:00Z",
            "interval": "DAILY"
        }
    }
}

Merchant Initiated Transaction with Type Recurring Example:

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

    "paymentStatus": "Success",
    "paymentMethod": "CARD",
    "transactionID": "s2K9YuqPQuC9NkdCvDA4",
    "transactionDateTime": "2023-01-06T00:00:03.378Z",

    "amount": {
        "currency": "EUR",
        "value": 11.2
    },

    "merchant": {
        "terminalId": 45546,
        "merchantName": "COMERCIANTE DO LEGACY" 
    },

    "paymentType": "MITR",
    "notificationID": "3a9d8777-292d-48fb-971c-6e6558de0fd5",

    "merchantInitiatedTransaction": {
        "type": "RCRR",
        "amountQualifier": "ACTUAL"
    }
}

Cardholder Initiated Transaction with Type UCOF Example:

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

    "paymentStatus": "Success",
    "paymentMethod": "CARD",
    "transactionID": "s2bDX8mjiFZU5ZwfvSvR",
    "transactionDateTime": "2023-01-06T16:57:11.2Z",

    "amount": {
        "currency": "EUR",
        "value": 102.38
    },

    "merchant": {
        "transactionId": "3064371",
        "terminalId": 45546,
        "merchantName": "GOMERCIANTE DO LEGACY"
    },

    "paymentType": "AUTH",
    "notificationID": "45d108d3-2cef-41a6-90af-a3bdb4af244a",

    "merchantInitiatedTransaction": {
        "type": "UCOF",
        "validityDate": "2023-01-31T00:00:00Z",
        "amountQualifier": "ESTIMATED"
    }

}

Merchant Initiated Transaction with Type UCOF Example:

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

    "paymentStatus": "Success",
    "paymentMethod": "CARD",
    "transactionID": "s2nYaNUC3hFpqd0HGq4Z",
    "transactionDateTime": "2022-12-23T10:48:39.153Z",

    "amount": {
        "currency": "EUR",
        "value": 5.16
    },

    "merchant": {
        "transactionId": "6540474",
        "terminalId": 45546,
        "merchantName": "GOMERCIANTE DO LEGACY"
    },

    "paymentType": "MITR",
    "notificationID": "c9786e7e-dc2a-4611-8a31-4b8197f41138",

    "merchantInitiatedTransaction": {
        "type": "UCOF",
        "amountQualifier": "ESTIMATED"
    }

}

Response example

{
    "statusCode": "200",
    "statusMsg": "Success",
    "notificationID": "2533e456-5e36-42c8-9eea-7961902f185e" 
}

Error message

Checkout Request

Error code	Message to the Merchant	Message to the Client	Owner	What to do?
12.110.1201	Wrong parameterization in the amount, expiration date, token, Merchant code or terminal code.	Please try again later.	Merchant	Checkout and payment received data for reference generation is incomplete, has to send (Amount and Expiration date).
12.110.1202	Wrong parameterization. Missing data.	Please try again later.	Merchant	Evaluate if the message is correctly formatted (Check if it is parameterizing correctly) according to the SLA.
12.110.1203	SIBS internal error. Please try again later.	Service not available. Please try later.	SIBS	Try again later.
12.110.1204	SIBS internal error. Please try again later.	Service not available. Please try later.	SIBS	Try again later.
12.110.1205	SIBS internal error. Please try again later.	Service not available. Please try later.	SIBS	Try again later.
12.110.1206	SIBS internal error. Please try again later.	Service not available. Please try later.	SIBS	Try again later.

Card

Error code	Message to the Merchant	Message to the client	Owner	What to do?
10.105.0001	Invalid payment entity	Entity not valid, please try again later.	Merchant	Please verify that the correct Merchant entity is being used.
10.103.0003	No card record	Card not valid please try again later.	SIBS	Please verify log.
10.103.0004	Not sufficient funds	Not sufficient funds, try again	Client	Please assure that the account has enough funds
10.103.0005	Invalid card number	Card number not valid try again.	Client	Please insert the correct card number
10.103.0006	Expired card	Expired card, please verify with your bank.	Client	Please note that your card has expired
10.103.0007	Card Cancelled	Your card has been Cancelled please verify with your bank.	Client	Please verify with your bank
10.103.0008	Inactive card	Inactive card, please verify with your bank.	Client	Please verify with your bank
10.103.0009	This card has been reported as stolen	Pick-up card, please verify with your bank.	Client	Please verify with your bank
10.103.0010	Blocked card	Blocked Card, please verify with your bank.	Client	Plese verify with your bank
10.103.0011	Invalid CVV	Invalid please check CVV double	Client	Please insert the correct CVV number
10.103.0012	Card limit exceeded	Card limit exceeded, please verify with your bank.	Client	Please verify with your bank
10.103.0013	Wrong expiry date	Wrong expiry date, please double check	Client	Please insert the correct card expiration date
10.105.0014	Invalid refund amount	N/A	Merchant	Please assure that the Refund is equal to the total amount or less
10.103.0015	Invalid card (Cannot process operation – fraud)	Invalid card, please verify with your bank.	Client	Please verify with your bank
10.105.0016	Invalid expiry date	Invalid expiry date, please double check	Client	Please verify with your bank or insert a valid Expiration date
10.103.0017	Wrong code	Wrong Code, please double check	Client	Please try again
10.103.0018	Wrong Code, 3 tentative exceed	Wrong Code, 3 tentative exceed, please verify with your bank.	Client	Please contact your bank
10.105.0017	Cancellation amount exceeds authorized amount	Cancellation amount exceeds authorized amount	Merchant	Please assure that the Authorisation is not finalised
10.105.0018	Authorisation is cancelled	The Authorisation was cancelled	Merchant	Please assure that the Authorisation is not finalized
10.105.0019	Authorisation is already used	N/A	Merchant	Please assure that this Authorisation belongs to this transaction.
10.105.0020	Purchase amount exceeds authorized amount	N/A	Merchant	Please assure that the purchase is Equal to the total amount or less
10.105.0021	Purchase already refunded	Purchase already refunded	Merchant	Please assure that this operation belongs to this transaction.
10.105.0022	Amount is below commission	Amount is below commission	Merchant	Please assure the minimum amount to allow the fee charge
90.000.0001	Exception	SIBS Technical Issue try again later	SIBS	Please try Again or later – Issue to be solved by SIBS
90.000.0003	Error in message format	SIBS Technical Issue try again later	SIBS	Please try Again or later – Issue to be solved by SIBS

Payment request

Error code	Message to the Merchant	Message to the Client	Owner	What to do?
12.110.1301	Wrong parameterization. Missing data.	Service not available. Please try again later.	Merchant	Please check parameterization on the checkout, its needed to invoke the form script to send the signature (Form context). Please verify if the amount, expiration date, token, Merchant code or terminal code are being sent correctly.
12.110.1302	Wrong parameterization. Missing data.	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1303	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1304	Wrong parameterization in payment type (Authorisation, Purchase, Capture, or Refund)	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1305	Wrong parameterization in payment method (Card, MB WAY, or Reference)	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1306	Wrong parameterization in payment method (Card, MB WAY, or Reference)	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1307	Wrong parameterization in amount, expiration date, token, Merchant code or terminal code.	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1308	Wrong amount.	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1309	Wrong currency.	Service not available. Please try again later.	Merchant	Evaluate if the message is correctly formatted and no data is missing (Check if it is parameterizing correctly) according to the SLA.
12.110.1310	Transaction already finalized.	Service not available. Please try again later.	Merchant	Need to input a valid transaction Id that it is not finalized.
12.110.1 311	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1312	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1313	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Payment does not fail, only tokenisation fails. No Action.
12.110.1314	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1315	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1316	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1 317	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1318	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1319	Declined.	Declined.	SIBS	Try again later.
12.110.1320	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1321	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1322	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1323	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.
12.110.1324	SIBS internal error. Please try again later.	Service not available. Please try again later.	SIBS	Try again later.

PAYMENT GATEWAY

Inputs and Outputs (Cards)

Checkout

Inputs & Outputs, CheckOut

Transaction status

Notifications (Merchant notifications)

Complex types

MerchantNotificationRequest

MerchantNotificationResponse

Examples

Request example

Response example

Cardholder Initiated Transaction with Type Recurring Example:

Merchant Initiated Transaction with Type Recurring Example:

Cardholder Initiated Transaction with Type UCOF Example:

Merchant Initiated Transaction with Type UCOF Example:

Response example

Error message

Checkout Request

Card

Payment request

On this page: