MB WAY Mandate 2.0.0

0
No votes yet

The Create MB WAY Mandate, allows the Merchant to request MB WAY Mandate creation, associated with the mobile phone number sent within the request and the mandate type. The response indicates the MB WAY Mandate Identification.

production
development
https://sandbox.sibspayments.com

Paths

/mbway-mandates/creation

post /mbway-mandates/creation
MB WAY Mandate Merchant List

MB WAY Mandate Merchant List

Performs a Merchant request to obtain a list of MB WAY Mandates.

clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
CreateMBWAYMandateRequest
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

CreateMBWAYMandateResponse
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/creation
Try this operation
https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/creation
content-type
accept
authorization
Signature

/mbway-mandates/{id}/creation

post /mbway-mandates/{id}/creation
MB WAY Mandate Merchant List

MB WAY Mandate Merchant List

Performs a Merchant request to obtain a list of MB WAY Mandates.

clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
CreateMBWAYMandateRequest
authorization
Required in header
string
id
Required in path
string

Transaction Id. Applicable when a previous checkout is performed.

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

CreateMBWAYMandateResponse
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/{id}/creation
Try this operation
https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/{id}/creation
content-type
accept
authorization
Signature
id

/mbway-mandates/{original-tx-id}/cancel

post /mbway-mandates/{original-tx-id}/cancel
Cancel MB WAY Mandate

Cancel MB WAY Mandate

Performs a Merchant request to cancel a specific MB WAY Mandate data.

clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
CancelMBWAYMandateRequest
authorization
Required in header
string
original-tx-id
Required in path
string

Original Transaction Id

Mbway-ID
Optional in header
string

Used to query a MB WAY Mandate by Alias MB WAY (phone number).

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

CancelMBWAYMandateResponse
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/{original-tx-id}/cancel
Try this operation
https://sandbox.sibspayments.com/sibs/spg/v2/mbway-mandates/{original-tx-id}/cancel
content-type
accept
authorization
Mbway-ID
Signature
original-tx-id

Definitions

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"
        },
        "systemManufacturer": {
            "type": "string",
            "description": "System Manufacturer"
        },
        "deviceModel": {
            "type": "string",
            "description": "Device Model"
        },
        "deviceID": {
            "type": "string",
            "description": "Device Unique Identification"
        },
        "deviceFingerprint": {
            "type": "string",
            "description": "Fingerprint of the device used in the request"
        },
        "applicationName": {
            "type": "string",
            "description": "Application Name"
        },
        "applicationVersion": {
            "type": "string",
            "description": "Application Name"
        },
        "geoLocation": {
            "type": "string",
            "description": "Geolocation",
            "pattern": "^GEO:[-?+?(\\d){1,3}.(\\d){6}]{8,11};[-?+?(\\d){1,3}.(\\d){6}]{8,11}$",
            "default": "GEO:1.111111;-1.111111"
        },
        "ipAddress": {
            "type": "string",
            "description": "Browser Accept Header"
        },
        "browserJavascriptEnabled": {
            "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."
        }
    },
    "additionalProperties": false
}

Object that defines a MB WAY Mandate.

{
    "required": [
        "mandateType",
        "customerName",
        "aliasMBWAY"
    ],
    "properties": {
        "mandateType": {
            "type": "string",
            "description": "Mandate Type. \\n Possible values are (\"ONECLIK\", \"SUBSCRIPTION\").",
            "enum": [
                "ONECLICK",
                "SUBSCRIPTION"
            ],
            "default": "ONECLICK"
        },
        "customerName": {
            "type": "string",
            "maxLength": 45,
            "description": "Customer name related to MB WAY Mandate."
        },
        "aliasMBWAY": {
            "type": "string",
            "maxLength": 256,
            "description": "Customer Alias MB WAY (customer phone number)."
        }
    },
    "additionalProperties": false
}
              
{
    "required": [
        "terminalId",
        "merchantTransactionId"
    ],
    "properties": {
        "terminalId": {
            "type": "integer",
            "example": "47215",
            "description": "Merchant Terminal Identification.",
            "format": "int32",
            "maxLength": 10
        },
        "channel": {
            "type": "string",
            "description": "Merchant channel.",
            "example": "web"
        },
        "merchantTransactionId": {
            "type": "string",
            "description": "Unique Id used by the Merchant.",
            "example": "863b730df285443f9a60ca404e0085fd1234",
            "maxLength": 35
        },
        "transactionDescription": {
            "type": "string",
            "description": "Merchant Transaction Short Description."
        }
    },
    "additionalProperties": false
}

Create MB WAY Mandates

{
    "required": [
        "merchant",
        "mandate"
    ],
    "properties": {
        "info": {
            "allOf": [
                {
                    "$ref": "#/definitions/Info"
                },
                {
                    "type": "object",
                    "properties": {
                        "customerInfo": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/ExtendedInfo"
                            },
                            "description": "Key Value tuple array."
                        }
                    }
                }
            ],
            "description": "Object that defines the transaction additional information."
        },
        "merchant": {
            "description": "Object that defines a Merchant.",
            "$ref": "#/definitions/Merchant"
        },
        "mandate": {
            "description": "Object that defines a MB WAY Mandate.",
            "$ref": "#/definitions/MandateInput"
        }
    },
    "additionalProperties": false
}

Object that defines a MB WAY Mandate

{
    "required": [
        "returnStatus",
        "execution"
    ],
    "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"
        },
        "transactionSignature": {
            "type": "string",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "mandate": {
            "description": "Object that defines a MB WAY Mandate. Present when MB WAY Mandate is found.",
            "type": "object",
            "required": [
                "mandateId"
            ],
            "properties": {
                "mandateId": {
                    "type": "string",
                    "description": "MB WAY Mandate Identification.",
                    "pattern": "^[a-zA-Z0-9]+",
                    "default": "9999999999999999999999999999999999999999999999999999999999999999",
                    "maxLength": 64
                }
            }
        },
        "execution": {
            "description": "Object that encapsulates technical execution information.",
            "$ref": "#/definitions/Execution"
        }
    },
    "additionalProperties": false
}

Object that defines a Cancel MB WAY Mandate

{
    "required": [
        "merchant"
    ],
    "properties": {
        "info": {
            "allOf": [
                {
                    "$ref": "#/definitions/Info"
                },
                {
                    "type": "object",
                    "properties": {
                        "customerInfo": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/ExtendedInfo"
                            },
                            "description": "Key Value tuple array."
                        }
                    }
                }
            ],
            "description": "Object that defines the transaction additional information."
        },
        "merchant": {
            "description": "Object that defines a Merchant.",
            "$ref": "#/definitions/Merchant"
        }
    },
    "additionalProperties": false
}

Object that defines a Cancel MB WAY Mandate

{
    "required": [
        "returnStatus",
        "execution"
    ],
    "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"
        },
        "transactionSignature": {
            "type": "string",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "hmac": {
            "type": "string",
            "maxLength": 128,
            "description": "For now, the type of HMAC used will be SHA2 (SHA512)."
        },
        "execution": {
            "description": "Object that defines an Execution. See the Execution definition.",
            "$ref": "#/definitions/Execution"
        }
    },
    "additionalProperties": false
}

Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself)

{
    "required": [
        "statusCode",
        "statusMsg",
        "statusDescription"
    ],
    "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
}