Skip to content

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. 
Info

Notification MULTIBANCO – Asynchronous: Make request – Need action – Get response 

Complex Types

MerchantNotificationRequest  

Body

returnStatus
Optional
Show more
statusDescription

String (Maximum 256 Text)

Optional
Show more
statusMsg

string (Maximum 256 Text)

Optional

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

Show more
statusCode

String (Maximum 11 Text)

Optional

(ex: 000)

Show more
paymentStatus

string

Optional

(“Success”, “Partial”, “Declined”, “InProcessing”, “Pending”, “Timeout”, “Error”)

Show more
paymentMethod

string

Optional

(“MBWAY”, “CARD”, “REFERENCE”, “TOKEN”, “STATIC_QRCODE”, “MANDATE”)

Show more
transactionID

String (Maximum 35 Text)

Optional
Show more
transactionDateTime

string (date-time)

Optional
Show more
amount
Optional
Show more
currency

String (ISO 4217 Alpha-3 Code)

Optional
Show more
value

number (double)

Optional
Show more
merchant
Optional
Show more
transactionId

String (Maximum 35 Text)

Optional
Show more
terminalId

Integer (int32)

Optional
Show more
inApp

boolean

Mandatory
Show more
paymentType

string

Optional

(“AUTH”, “PURS”, “CAPT”, “CAUT”, “RFND”, “CANC”, “PREF”, “CPRF”. “CMBW”, “MAND”, “MAUT”. “MPUR”, “MITR”)

Show more
paymentReference
Optional
Show more
reference

String (Maximum 50 Text)

Optional
Show more
entity

String (Maximum 50 Text)

Optional
Show more
paymentEntity

String (Maximum 50 Text)

Optional
Show more
amount
Optional
Show more
currency

string (ISO 4217 Alpha-3 Code)

Optional
Show more
value

number (double)

Optional
Show more
status

String

Optional

(“UNPAID”, “PAID”, PARTPAIDLS”,” PARTPAIDOPN”, “CANC”,”UNKN”)

Show more
expireDate

string (date-time)

Optional
Show more
token
Optional
Show more
tokenName

String (Maximum 50 Text)

Optional
Show more
tokenType

String

Optional

(“TokenType1”. “MobilePhone”, “MobilePhone”, “Card”)

Show more
value

String (Maximum 50 Text)

Mandatory
Show more
maskedPAN

String (Maximum 35 Text)

Optional
Show more
expireDate

string (date-time)

Optional
Show more
financialOperation
Optional
Show more
product
Optional
Show more
staticQRCodeId

Max36Text

Optional
Show more
twoStepPurchase

boolean

Optional
Show more
aliasName

String (Maximum 256 Text)

Optional
Show more
merchantContactType

String (Maximum 256 Text)

Optional
Show more
productName

Max100Text

Optional
Show more
productQuantity

Max4NumericText

Optional
Show more
productAmount

Decimal8_2

Optional
Show more
expeditionAmount

Decimal8_2

Optional
Show more
contactClientIndicator

Max1NumericText

Optional
Show more
customerSupportContact

Max100Text

Optional
Show more
billingInfo
Optional
Show more
billingName

Max45Text

Optional
Show more
billingSurname

Max45Text

Optional
Show more
billingTIN

Max14Text

Optional
Show more
billingAddressCity

String (Maximum 50 Text)

Optional
Show more
billingAddressCountry

Max3Text

Optional
Show more
billingAddressLine1

String (Maximum 50 Text)

Optional
Show more
billingAddressLine2

String (Maximum 50 Text)

Optional
Show more
billingAddressLine3

String (Maximum 50 Text)

Optional
Show more
billingAddressPostalCode

Max16Text

Optional
Show more
billingHomePhone

Max15Text

Optional
Show more
billingMobilePhone

Max15Text

Optional
Show more
expeditionInfo
Optional
Show more
expeditionName

Max45Text

Optional
Show more
expeditionSurname

Max45Text

Optional
Show more
expeditionAddressCity

String (Maximum 50 Text)

Optional
Show more
expeditionAddressCountry

Max3Text

Optional
Show more
expeditionAddressLine1

String (Maximum 50 Text)

Optional
Show more
expeditionAddressLine2

String (Maximum 50 Text)

Optional
Show more
expeditionAddressLine3

String (Maximum 50 Text)

Optional
Show more
expeditionAddressPostalCode

Max16Text

Optional
Show more
expeditionHomePhone

Max15Text

Optional
Show more
expeditionMobilePhone

Max15Text

Optional
Show more
expeditionEmail

Max100Text

Optional
Show more
logkey

String (Maximum 50 Text)

Optional
Show more
serviceOperationPlayer

Max36Text

Optional
Show more
merchantOperation

Max36Text

Optional
Show more
serviceType

Max10Text

Optional
Show more
mbwayMandate
Optional
Show more
mandateIdentification

String (Maximum 64 Text)

Optional
Show more
mandateAction

Max4Text

Optional

(“CRTN” – Mandate Creation,
“SSPN” - Mandate Suspension by Client;
“RCTV” – Mandate Reactivation by Client,
“LMUP” – Mandate Limits Update by Client,
“CNCL” – Mandate Cancellation by Client)

Show more
mandateActionStatus

Max4Text

Optional

(“SCCS” – Success (applicable to all Action Codes),

“RFSD” – Refused due to validation rules (only applicable to Mandate Creation),

“RJCT” – Rejected by Client (only applicable to Mandate Creation))

Show more
mandateActionStatusReason

mandateActionStatusReason

Optional
Show more
merchantTransactionIdentification

String (Maximum 35 Text)

Optional
Show more
mandateType

Max4Text

Optional

(“ONCL” – One-Click Mandate, “SBSC” – Subscription Mandate)

Show more
mandateAmountLimit
Optional
Show more
currency

string (ISO 4217) Alpha-3 Code

Optional
Show more
value

number (double)

Optional
Show more
mandateExpirationDate

ISODate

Optional
Show more
clientName

String (Maximum 256 Text)

Optional
Show more
InstalmentPlan
Optional
Show more
PlanId

Max3NumberText

Optional
Show more
customer
Optional
Show more
customerName

String (Maximum 45 Text)

Optional
Show more
customerEmail

String (Maximum 256 Text)

Optional
Show more
customerTIN

Max14Text

Optional
Show more
merchantInitiatedTransaction
Optional
Show more
type

Max4Text

Optional

(“UCOF”-Unscheduled Credential on File, “RCRR”-Recurring)

Show more
validityDate

string (date-time)

Optional
Show more
amountQualifier

Max7Text

Optional

(“ACTUAL”-Actual amount, “ESTIMATED”-Estimated amount (the final amount could be above or below), “DEFAULT”-Default amount)

If not present, the “DEFAULT” value is assumed.

If merchantInitiatedTransaction has MITType “UCOF”, the amountQualifier must be set to “ESTIMATED”.

Show more
description

String (Maximum 50 Text)

Optional
Show more
Schedule
Optional
Show more
initialDate

string (date-time)

Optional
Show more
finalDate (optional)

string (date-time)

Optional
Show more
Interval

Max10Text

Optional

(“DAILY”, “WEEKLY”, “BIWEEKLY”, “MONTHLY”, “QUARTERLY”, “SEMIANNUAL”, “ANNUAL”)

Show more
notificationID
Optional

PaymentNotificationId (UUID – Exact36Text)

Show more

MerchantNotificationResponse

Body

statusCode

string (Maximum 11 Text) (ex: 000)

Optional
Show more
statusMsg

String (Maximum 256 Text) (ex: Success)

Optional

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

Show more
notificationID

PaymentNotificationId (UUID – Exact36Text)

Optional
Show more

Error message

Multibanco
Error codeMessage to the MerchantMessage to the ClientOwnerWhat to do?
10.107.0001 Invalid payment entity Entity not valid, Try again later. Merchant Please verify that the correct Merchant entity is being used. 
10.107.0002 Invalid reference minimum amount Invalid reference minimum, amount please try again. Merchant Please verify the parameterization in the amount  
10.107.0003 Invalid reference maximum amount Invalid reference maximum amount please try again. Merchant Please verify the parameterization in the amount  
10.107.0004 Invalid currency Invalid currency try again. Merchant Please verify the parameterization in the currency accepted 
10.107.0005 Invalid NIB Invalid NIB please try again. Client Please verify you are using the correct NIB 
10.107.0006 Invalid reference initial date time Invalid reference initial date time try again. Merchant Please verify the parameterization in time accepted  
10.107.0007 Invalid reference limit date time Invalid reference limit date time try again. Merchant Please verify the parameterization in time accepted  
10.107.0008 Invalid Email Invalid Email try again. Client Please insert the email used on the registration 
10.107.0009 Payment entity is not active Payment entity is not active, try later Merchant Please verify your entity, if it is the one in the SLA 
10.107.0010 Reference generation not allowed for the payment entity Reference generation not allowed try later. Merchant Please verify your entity, if it is the one in the SLA 
10.107.0011 Payment reference not found SIBS Internal error, Please try again later. SIBS SIBS Internal error, Please try again later. 
10.107.0012 Payment reference is cancelled Payment reference is cancelled. Merchant Please verify your reference was cancelled. 
10.107.0013 Payment reference already paid Payment reference already paid. Merchant Please verify your reference is already paid. 
10.107.0014 Invalid operation Invalid operation, try later. SIBS SIBS Internal error, Please try again later. 
90.000.0001 Exception SIBS Technical Issue try again later SIBS Please try Again or later – Issue to be solved by SIBS  
90.000.0003Error in message format SIBS Technical Issue try again later SIBS Please try Again or later – Issue to be solved by SIBS  
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.