production
development
https://sandbox.sibspayments.com
Paths
/{id}/mbway-id/purchase
post /{id}/mbway-id/purchase
clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
id
Required in path
string
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
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/payments/{id}/mbway-id/purchase
Try this operation
Definitions
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"example": "THREEDS_METHOD",
"enum": [
"THREEDS_METHOD",
"THREEDS_CHALLENGE"
]
},
"executed": {
"type": "boolean"
}
},
"additionalProperties": false
}
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"data": {
"$ref": "#/definitions/Data"
}
},
"additionalProperties": false
}
{
"properties": {
"url": {
"type": "string"
},
"params": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
}
},
"additionalProperties": false
}
Object that defines the customer device information.
{
"properties": {
"browserAcceptHeader": {
"type": "string",
"description": "Browser Accept Header"
},
"browserJavaEnabled": {
"type": "string",
"description": "Browser Java Enabled"
},
"browserLanguage": {
"type": "string",
"description": "Browser Language"
},
"browserColorDepth": {
"type": "string",
"description": "Browser Color Depth"
},
"browserScreenHeight": {
"type": "string",
"description": "Browser Screen Height"
},
"browserScreenWidth": {
"type": "string",
"description": "Browser Screen Width"
},
"browserTZ": {
"type": "string",
"description": "Browser Time Zone"
},
"browserUserAgent": {
"type": "string",
"description": "Browser User Agent"
},
"systemFamily": {
"type": "string",
"description": "System Family"
},
"systemVersion": {
"type": "string",
"description": "System Version"
},
"systemArchitecture": {
"type": "string",
"description": "System Architecture"
},
"deviceManufacturer": {
"type": "string",
"description": "Device Manufacturer"
},
"deviceModel": {
"type": "string",
"description": "Device Model"
},
"deviceID": {
"type": "string",
"description": "Device Unique Identification"
},
"applicationName": {
"type": "string",
"description": "Application Name"
},
"applicationVersion": {
"type": "string",
"description": "Application Version"
},
"geoLocalization": {
"type": "string",
"description": "Geolocation"
},
"ipAddress": {
"type": "string",
"description": "IP Address"
},
"browserJavascriptEnabled": {
"type": "string",
"description": "Browser Javascript Enabled"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Property Key"
},
"value": {
"type": "string",
"description": "Property Value"
}
},
"additionalProperties": false
}
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."
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "integer",
"example": "21451",
"description": "Merchant terminal id.",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Merchant channel.",
"example": "web"
},
"merchantTransactionId": {
"type": "string",
"maxLength": 35,
"description": "Id of the transaction in merchant store.",
"example": "863b730df285443f9a60ca404e0085fd1234"
},
"mbwayRedirectURL": {
"type": "string",
"description": "MB WAY URL for redirect purposes to MB WAY App. \\n Can include the MerchantURL, if inserted by the merchant, for redirect purposes to Merchant App",
"maxLength": 2048
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
},
"additionalProperties": false
}
Object that defines the payment operation request fields
{
"properties": {
"customerPhone": {
"type": "string",
"description": "Customer's phone number. Mandatory for MB WAY Purchase. Not present for MB WAY Mandate Purchase.",
"pattern": "^\\d{1,5}#\\d{4,11}$",
"example": "351#900000000"
},
"info": {
"$ref": "#/definitions/Info",
"description": "Object that defines the aditional info provided by the merchant. Check the Info definition."
},
"actionProcessed": {
"description": "Action to be processed",
"$ref": "#/definitions/ActionProcessed"
},
"mandate": {
"description": "Object that defines a MBWAY Mandate. Only present in transactions where a MB WAY Mandate is applicable.",
"required": [
"mandateCreation",
"useMBWAYMandate"
],
"properties": {
"mandateCreation": {
"type": "boolean",
"description": "Indicates if customer requests the mandate creation."
},
"useMBWAYMandate": {
"type": "boolean",
"description": "Indicates if a MB WAY Mandate Purchase is requested."
}
}
},
"inApp": {
"type": "boolean",
"description": "Indicates, if the operation is an In-App Operation. \\n This field must only be used in case of App-to-App communication and must be stored in SPG Backend (Upstream)."
}
},
"additionalProperties": false
}
Object that defines the payment operation return fields
{
"properties": {
"returnStatus": {
"description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "Unique identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"merchant": {
"description": "Object that defines the Merchant. Check the Merchant definition.",
"$ref": "#/definitions/Merchant"
},
"paymentType": {
"type": "string",
"description": "Payment type used",
"enum": [
"AUTH",
"PURS",
"CAPT",
"CAUT",
"RFND",
"RCON",
"RVSL",
"STIQ",
"PREF",
"CPRF",
"CMBW",
"MAND",
"MAUT",
"MPUR"
],
"default": "AUTH"
},
"actionResponse": {
"description": "Action to perform",
"$ref": "#/definitions/ActionReponse"
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment.",
"enum": [
"Success",
"Partial",
"Declined",
"InProcessing",
"Pending",
"Timeout",
"Error"
],
"default": "Success"
},
"hmac": {
"type": "string",
"maxLength": 128,
"description": "For now, the type of HMAC used will be SHA2 (SHA512)."
}
},
"additionalProperties": false
}
Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself)
{
"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
}
Object that encapsulates technical execution information.
{
"required": [
"startTime",
"endTime"
],
"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
}