Checkout

Inputs & Outputs, CheckOut 

Payment method card: Card

Inputs & Outputs, CARD

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

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

Card

Payment request