production
development
https://sandbox.sibspayments.com
Paths
/payments
post /payments
clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
Authorization
Required in header
string
Signature
Optional in header
string
For now, the type of HMAC used will be SHA2 (SHA512). base64
{
"maxLength": 128
}Content-Type
Optional in header
string
application/json
text/plain
text/plain
Accept
Optional in header
string
application/json
text/plain
text/plain
200
201
Created
204
No Content
206
Partial Content
400
Bad Request.
401
Unauthorized.
403
Forbidden.
404
Not Found.
405
Method Not Allowed.
406
Not Acceptable.
408
Request Timeout.
415
Unsupported Media Type.
429
Too Many Requests.
500
Internal Server Error.
503
Service Unavailable.
504
Gatewaty Timeout.
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/payments
Try this operation
/payments/status
get /payments/status
clientid
X-IBM-Client-Id
(apiKey located in header)
Authorization
Required in header
string
merchantTransactionId
Optional in query
string
{
"maxLength": 35
}Signature
Optional in header
string
For now, the type of HMAC used will be SHA2 (SHA512). base64
{
"maxLength": 128
}Accept
Optional in header
string
application/json
text/plain
text/plain
200
204
No Content
206
Partial Content
400
Bad Request.
401
Unauthorized.
403
Forbidden.
404
Not Found.
405
Method Not Allowed.
406
Not Acceptable.
408
Request Timeout.
415
Unsupported Media Type.
429
Too Many Requests.
500
Internal Server Error.
503
Service Unavailable.
504
Gatewaty Timeout.
Example Request
Example Response
GET https://sandbox.sibspayments.com/sibs/spg/v2/payments/status
Try this operation
/payments/{id}/status
get /payments/{id}/status
clientid
X-IBM-Client-Id
(apiKey located in header)
Authorization
Required in header
string
id
Required in path
string
Signature
Optional in header
string
For now, the type of HMAC used will be SHA2 (SHA512). base64
{
"maxLength": 128
}Accept
Optional in header
string
application/json
text/plain
text/plain
200
204
No Content
206
Partial Content
400
Bad Request.
401
Unauthorized.
403
Forbidden.
404
Not Found.
405
Method Not Allowed.
406
Not Acceptable.
408
Request Timeout.
415
Unsupported Media Type.
429
Too Many Requests.
500
Internal Server Error.
503
Service Unavailable.
504
Gatewaty Timeout.
Example Request
Example Response
GET https://sandbox.sibspayments.com/sibs/spg/v2/payments/{id}/status
Try this operation
Definitions
Parameter with the value and currency of the transaction.
{
"properties": {
"value": {
"type": "number",
"format": "double",
"example": 5
},
"currency": {
"type": "string",
"description": "Currency used in the transaction.",
"example": "EUR"
}
},
"additionalProperties": false,
"required": [
"value",
"currency"
]
}
Object that defines a customer.
{
"properties": {
"customerInfo": {
"description": "Object that defines the customer predefined information (name, age, etc). Check the CustomerInfo definition.",
"$ref": "#/definitions/CustomerInfo"
},
"extendedInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false
}
Object that defines the predefined customer information.
{
"properties": {
"customerName": {
"type": "string",
"description": "Name of the customer. Maximum length is 45.",
"maxLength": 45,
"example": "John"
},
"customerEmail": {
"type": "string",
"description": "Customer e-mail",
"example": "john@mail.com"
},
"shippingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
},
"billingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
}
},
"additionalProperties": false
}
Object that defines the customer device information.
{
"properties": {
"browserAcceptHeader": {
"type": "string"
},
"browserJavaEnabled": {
"type": "string"
},
"browserLanguage": {
"type": "string"
},
"browserColorDepth": {
"type": "string"
},
"browserScreenHeight": {
"type": "string"
},
"browserScreenWidth": {
"type": "string"
},
"browserTZ": {
"type": "string"
},
"browserUserAgent": {
"type": "string"
},
"systemFamily": {
"type": "string"
},
"systemVersion": {
"type": "string"
},
"systemArchitecture": {
"type": "string"
},
"deviceManufacturer": {
"type": "string"
},
"deviceModel": {
"type": "string"
},
"deviceID": {
"type": "string"
},
"applicationName": {
"type": "string"
},
"applicationVersion": {
"type": "string"
},
"geoLocalization": {
"type": "string"
},
"ipAddress": {
"type": "string"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
Object that defines the transaction additional information
{
"properties": {
"deviceInfo": {
"$ref": "#/definitions/Deviceinfo",
"description": "Object that defines the customers device predefined information. Check the DeviceInfo definition."
},
"customerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
},
"channelInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false
}
{
"properties": {
"id": {
"type": "string"
},
"datetime": {
"type": "string"
},
"recipientId": {
"type": "string",
"description": "Original Transaction ID"
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "integer",
"example": "47215",
"description": "Merchant terminal id.",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Merchant channel.",
"example": "web"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique id used by the merchant.",
"example": "5351136",
"maxLength": 35
}
},
"additionalProperties": false
}
Object that defines the checkout operation request fields
{
"properties": {
"merchant": {
"description": "Object that defines a Merchant. Check the Merchant definition.",
"$ref": "#/definitions/Merchant"
},
"customer": {
"description": "Object that defines a Customer. Check the Customer definition.",
"$ref": "#/definitions/Customer"
},
"transaction": {
"description": "Object that defines a Transaction. Check the Transaction definition.",
"$ref": "#/definitions/Transaction"
},
"info": {
"$ref": "#/definitions/Info",
"description": "Object that defines the aditional info provided by the merchant. Check the Info definition."
},
"originalTransaction": {
"$ref": "#/definitions/OriginalTransaction",
"description": "Original transaction of a Backoffice transaction."
},
"tokenisation": {
"$ref": "#/definitions/Tokenisation",
"description": "Field with tokenisation details (see tokenisation Request and paymentTokens)."
},
"merchantInitiatedTransaction": {
"$ref": "#/definitions/MerchantInitiatedTransactionInput",
"description": "Provided field to create a recurring transaction. validity Date is the date until is possible to perform recurring transactions over the specified transaction."
},
"mandate": {
"$ref": "#/definitions/Mandate",
"description": "Object that defines a MBWAY Mandate."
}
},
"additionalProperties": false
}
Provided field on Checkout request to perform card tokenisation.
{
"properties": {
"tokeniseCard": {
"type": "boolean"
}
}
}
Token value tuple.
{
"type": "object",
"properties": {
"tokenType": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
Customer payment tokens. This tokens are provided at the end of a successful.
{
"properties": {
"tokenisationRequest": {
"$ref": "#/definitions/TokenisationRequest"
},
"paymentTokens": {
"type": "array",
"items": {
"$ref": "#/definitions/PaymentTokenItem"
}
}
},
"additionalProperties": false
}
Object that defines the inquiry operation return fields
{
"properties": {
"returnStatus": {
"description": "Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself).",
"$ref": "#/definitions/ReturnStatus"
},
"paymentStatus": {
"type": "string"
},
"transactionStatusCode": {
"type": "string",
"maxLength": 5,
"description": "External Transaction Status Code (ex: EXXXX)"
},
"transactionStatusDescription": {
"type": "string",
"maxLength": 256,
"description": "Description of External Transaction Status Code"
},
"paymentMethod": {
"type": "string"
},
"transactionID": {
"type": "string"
},
"amount": {
"description": "Object that defines the amount. Check the Amount definition",
"$ref": "#/definitions/Amount"
},
"merchant": {
"$ref": "#/definitions/Merchant",
"description": "Object that defines a Merchant. Check the Merchant definition."
},
"paymentType": {
"type": "string",
"description": "Transaction payment type. Purchase or Authorisation."
},
"paymentReference": {
"$ref": "#/definitions/PaymentInquiryReference"
},
"token": {
"$ref": "#/definitions/TokenInquiry"
},
"merchantInitiatedTransaction": {
"description": "Object that defines a Recurring Transaction. Check the Recurring Transaction definition.",
"$ref": "#/definitions/MerchantInitiatedTransactionStatusResponse"
},
"threeDSecure": {
"$ref": "#/definitions/ThreeDSecureInquiry"
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
}
},
"additionalProperties": false
}
Object that defines the checkout operation return fields
{
"properties": {
"returnStatus": {
"description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
"example": "",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "Unique identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"transactionSignature": {
"type": "string",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"amount": {
"description": "Object that defines the amount. Check the Amount definition",
"$ref": "#/definitions/Amount"
},
"merchant": {
"description": "Object that defines a Merchant. Check the Merchant definition.",
"$ref": "#/definitions/Merchant"
},
"paymentMethodList": {
"type": "array",
"description": "List of payment methods.",
"$ref": "#/definitions/PaymentMethodList"
},
"tokenList": {
"type": "array",
"description": "Payment tokens.",
"items": {
"$ref": "#/definitions/Token"
}
},
"formContext": {
"type": "string",
"description": "String given by Checkout Response, to be passed to the spg-form (see SIBS Payment Gateway Integration Guide)."
},
"merchantInitiatedTransaction": {
"description": "Object that defines a Merchant Initiated transaction.",
"$ref": "#/definitions/MerchantInitiatedTransactionOutput"
},
"mandate": {
"description": "Object that defines a MBWAY Mandate.",
"properties": {
"mandateAvailable": {
"type": "boolean",
"description": "MB WAY Mandate Available for use. Is set to true if current Client has an active mandate for current Merchant."
},
"termsAndConditions": {
"type": "string",
"description": "Merchant URI with Authorized Payment Terms & Conditions."
}
}
},
"expiry": {
"type": "string",
"format": "date-time",
"description": "Expiration datetime."
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
}
},
"additionalProperties": false
}
Object that defines the status of the processed transaction.
{
"properties": {
"statusCode": {
"type": "string",
"description": "Identifier code of the processed transaction status.",
"example": "000"
},
"statusMsg": {
"type": "string",
"description": "Message of the processed transaction status.",
"example": "Success"
},
"statusDescription": {
"type": "string",
"description": "Description of the processed transaction status."
}
},
"additionalProperties": false,
"required": [
"statusCode",
"statusDescription"
]
}
Object that defines a transaction.
{
"properties": {
"transactionTimestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the transaction.",
"example": "2020-12-10T15:41:56.971Z"
},
"description": {
"type": "string",
"description": "Transaction description.",
"example": "Transaction short description"
},
"moto": {
"type": "boolean",
"description": "Mail Order / Telephone Order",
"example": false
},
"paymentType": {
"type": "string",
"enum": [
"AUTH",
"PURS",
"CAPT",
"CAUT",
"RFND",
"RCON",
"RVSL",
"STIQ",
"PREF",
"CPRF",
"CMBW"
],
"default": "AUTH",
"description": "Type of payment used by the client."
},
"paymentMethod": {
"description": "Method of payment used by the client.",
"example": "",
"$ref": "#/definitions/PaymentMethodList"
},
"amount": {
"example": "",
"description": "Object that defines the amount. Check the Amount definition.",
"$ref": "#/definitions/Amount"
},
"paymentReference": {
"description": "Payment reference details in case of customer select payment reference (Multibanco) payment method.",
"$ref": "#/definitions/PaymentReference"
},
"threeDSecureOptions": {
"description": "3D Secure Requested Options",
"$ref": "#/definitions/ThreeDSecureOptions"
},
"subMerchant": {
"description": "This complex type has the submerchant info. \\n This attributes will be mandatory in case the Merchant is a Payment Facilitator.",
"$ref": "#/definitions/SubMerchantRequest"
}
},
"additionalProperties": false
}
{
"properties": {
"authenticationExemption": {
"type": "string",
"description": "Requested Authentication Exemption Type. Possible values are { \"WHITELIST_PROMPT\" - Whitelist Exemption Cardholder Prompt, \"WHITELIST\" - Whitelist Exemption, \"LOW_VALUE\" - Low Value Amount Exemption, \"LOW_RISK\"-Low Risk Exemption, \"NONE\"- None}.",
"enum": [
"LOW_VALUE",
"LOW_RISK",
"NONE",
"WHITELIST_PROMPT",
"WHITELIST"
]
}
},
"required": [
"authenticationExemption"
]
}
{
"properties": {
"street1": {
"type": "string",
"description": "Address Street. Maximum length is 50.",
"example": "First street"
},
"street2": {
"type": "string",
"description": "Address Additional Street. Maximum length is 19."
},
"city": {
"type": "string",
"description": "Address city or town. Maximum length is 35.",
"example": "Lisbon"
},
"postcode": {
"type": "string",
"description": "Address Postal Code. Maximum length is 16.",
"example": "1700-123"
},
"country": {
"type": "string",
"description": "Country Code. Alpha2",
"example": "PT"
},
"countrySubDivision": {
"type": "string",
"description": "Address Country Sub Division. Maximum length is 35.",
"maxLength": 35
}
},
"additionalProperties": true
}
{
"properties": {
"mandateId": {
"type": "string",
"description": "MBWAY Mandate Identifier. Not applicable in creation. Mandatory in further usage.",
"pattern": "^[a-zA-Z0-9]+",
"default": "9999999999999999999999999999999999999999999999999999999999999999"
},
"mandateType": {
"type": "string",
"description": "Mandate Type. \\n Possible values are (\"ONECLIK\", \"SUBSCRIPTION\"). Mandatory in creation. Not applicable in further usage.",
"enum": [
"ONECLICK",
"SUBSCRIPTION"
],
"default": "ONECLICK"
},
"mandateCreationOnly": {
"type": "boolean",
"description": "Possible values are (\"True\"- Only Creates Mandate, \"False\" - Creates Mandate and requests payment). Mandatory in creation. Not applicable in further usage. (Reserved for Future Use)"
},
"disableMandateMBWAYFallback": {
"type": "boolean",
"description": "Possible Values: \\n \"false\" - If mandate limits are exceeded and do not allow mandate usage, an MBWAY Purchase is performed. \\n \"true\" - If mandate limits are exceeded and do not allow mandate usage, payment ends without success. \\n Not applicable in creation. Optional for Payment with MB WAY Mandate. In this last case, if not present the \"false\" value is assumed."
}
},
"additionalProperties": true
}
{
"properties": {
"entity": {
"type": "string",
"description": "Entity used in Payment Reference",
"example": "25100"
},
"minAmount": {
"description": "Minimum amount of the transaction.",
"$ref": "#/definitions/Amount"
},
"maxAmount": {
"description": "Maximum amount of the transaction.",
"$ref": "#/definitions/Amount"
},
"initialDatetime": {
"type": "string",
"format": "date-time",
"example": "2020-05-20T15:41:56.971Z",
"description": "Date from when the payment reference is valid (if generated)."
},
"finalDatetime": {
"type": "string",
"format": "date-time",
"example": "2020-12-31T15:41:56.971Z",
"description": "Payment reference expiring date (if generated)."
},
"paymentEntityDescription": {
"type": "string",
"minLength": 1,
"maxLength": 40,
"description": "Payment Entity Reference Description."
}
},
"additionalProperties": false
}
{
"properties": {
"reference": {
"type": "string",
"description": "Payment Reference"
},
"entity": {
"type": "string",
"description": "Entity used in Payment Reference"
},
"paymentEntity": {
"type": "string",
"description": "Payment Reference Entity"
},
"amount": {
"description": "Object that defines the amount. Check the Amount definition.",
"$ref": "#/definitions/Amount"
},
"status": {
"type": "string",
"description": "Payment Reference Status",
"enum": [
"UNPAID",
"PAID",
"PARTPAIDCLS",
"PARTPAIDOPN",
"CANC",
"UNKN"
],
"default": "PAID"
},
"expireDate": {
"type": "string",
"description": "Expiration Date of the Reference",
"format": "date-time"
}
},
"additionalProperties": false
}
{
"properties": {
"tin": {
"type": "string",
"pattern": "^\\d{1,20}$",
"minLength": 1,
"maxLength": 20,
"description": "SubMerchant Tax Identification Numeric"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "SubMerchant Name"
},
"mcc": {
"type": "number",
"minimum": 0,
"maximum": 9999,
"description": "Merchant Category Code"
},
"sic": {
"type": "number",
"minimum": 0,
"maximum": 99999,
"description": "Standard Industrial Classification (SIC) / Código de Atividade Económica (CAE)"
}
},
"additionalProperties": false
}
{
"properties": {
"tokenName": {
"type": "string"
},
"tokenType": {
"type": "string",
"enum": [
"Email",
"MobilePhone",
"QRCodeMBWAY1",
"Card"
],
"default": "Card"
},
"value": {
"type": "string"
},
"maskedPAN": {
"type": "string"
},
"expireDate": {
"type": "string",
"example": "PT"
}
},
"additionalProperties": false
}
{
"properties": {
"tokenName": {
"type": "string"
},
"tokenType": {
"type": "string",
"enum": [
"Email",
"MobilePhone",
"QRCodeMBWAY1",
"Card"
],
"default": "Card"
},
"value": {
"type": "string"
},
"maskedPAN": {
"type": "string"
},
"expireDate": {
"type": "string",
"example": "PT"
}
},
"additionalProperties": false
}
{
"properties": {
"whitelistStatus": {
"description": "Possible values are: \\n • Y = 3DS Requestor is whitelisted by cardholder \\n • N = 3DS Requestor is not whitelisted by cardholder \\n • E = Not eligible as determined by issuer \\n • P = Pending confirmation by cardholder \\n • R = Cardholder rejected \\n • U = Whitelist status unknown, unavailable, or does not apply.",
"type": "string",
"enum": [
"Y",
"N",
"E",
"P",
"R",
"U"
]
}
},
"required": [
"whitelistStatus"
]
}
Object that encapsulates technical execution information.
{
"properties": {
"startTime": {
"type": "string",
"description": "Time of the acceptance of the request by the API.",
"format": "date-time",
"example": "2020-07-15T12:10:49.131+01:00"
},
"endTime": {
"type": "string",
"description": "Time of the response to the request by the API.",
"format": "date-time",
"example": "2020-07-15T12:10:49.131+01:00"
}
},
"additionalProperties": false,
"required": [
"startTime",
"endTime"
]
}
{
"properties": {
"termsAndConditions": {
"type": "string",
"description": "Merchant URI with Merchant Initiated Transactions Terms & Conditions."
}
},
"additionalProperties": false,
"required": [
"termsAndConditions"
]
}
{
"properties": {
"status": {
"type": "string",
"description": "Recurring Transaction Outcome. \\n Possible values are \"Success\", \"Decline\", \"Error\"."
}
},
"additionalProperties": false
}
Object that defines a Merchant Initiated transaction request.
{
"properties": {
"type": {
"type": "string",
"description": "Merchant Initiated Transaction Type. \\n Possible values are \"UCOF\"-\"Unscheduled Credential on File\" and \"RCRR\"-\"Recurring\".",
"enum": [
"UCOF",
"RCRR"
],
"default": "RCRR"
},
"validityDate": {
"type": "string",
"description": "Expiration Date of Merchant Initiated Transaction.",
"format": "date-time",
"example": "2020-07-15T12:10:49.131+01:00"
},
"amountQualifier": {
"type": "string",
"description": "Qualifies the amount associated with the Merchant Initiated Transaction. Possible values are \"ACTUAL\"-\"Actual amount\", \"ESTIMATED\"-\"Estimated amount (the final amount could be above or below)\" and \"DEFAULT\"-\"Default amount\". If not present, the \"DEFAULT\" value is assumed. If merchantInitiatedTransaction has MITType \"UCOF\", the amountQualifier must be set to \"ESTIMATED\".",
"enum": [
"DEFAULT",
"ESTIMATED",
"ACTUAL"
],
"default": "ESTIMATED"
},
"description": {
"type": "string",
"description": "Description of the Merchant Initiated Transaction.",
"example": "Merchant Initiated Transaction"
},
"schedule": {
"$ref": "#/definitions/Schedule",
"description": "Merchant Initiated Transaction Schedule"
},
"active": {
"type": "boolean",
"description": "Merchant Initiated Transaction Status."
}
},
"additionalProperties": false,
"required": [
"type"
]
}
{
"properties": {
"initialDate": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T12:10:49.131+01:00"
},
"finalDate": {
"type": "string",
"format": "date-time",
"example": "2020-07-15T12:10:49.131+01:00"
},
"interval": {
"type": "string",
"enum": [
"DAILY",
"WEEKLY",
"BIWEEKLY",
"MONTHLY",
"QUARTERLY",
"SEMIANNUAL",
"ANNUAL"
],
"default": "DAILY"
}
},
"additionalProperties": false
}
Method of payment used by the client.
{
"type": "array",
"items": {
"type": "string",
"enum": [
"CARD",
"MBWAY",
"QRCODE",
"REFERENCE",
"TOKEN",
"MANDATE",
"XPAY"
]
}
}