Sorry, you need to enable JavaScript to visit this website.
Skip to main content
developer.sibsapimarket.com/sibs-qly/apimarket-sb

developer.sibsapimarket.com/sibs-qly/apimarket-sb

  • Getting started
  • API Documentation
Register
  • Welcome
  • Sandbox

Attention!

This site isn't fully compatible with Edge and you may find some technical issues. For a better experience, we recommend using Chrome, Firefox or Safari.

  • MB Way (Sandbox) 2.0.0
  • APIs
  • Payment Checkout (Sandbox) 1.0.0
      • Operations
      • POST /checkout
      • POST /inquiry
      • Definitions
      • Amount
      • Customer
      • CustomerInfo
      • Deviceinfo
      • ExtendedInfo
      • In
      • Info
      • InInquiry
      • Merchant
      • Out
      • OutInquiry
      • RequestCheckout
      • RequestInquiry
      • ResponseInquiry
      • ReturnCheckout
      • ReturnStatus
      • Transaction
  • MB Way QRCode Purchase (Sandbox) 2.0.0
  • MB Way ID Purchase (Sandbox) 2.0.0

Payment Checkout (Sandbox) 1.0.0

0
No votes yet
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift
Subscribe
production
development
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
production
development
https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb

Paths

/checkout

post /checkout

Checkout Operation

api-key
X-IBM-Client-Id
(apiKey located in header)

Unique key generated for each client app.

input
Required in body
object
In
Content-Type
Optional in header
string
application/json
text/plain
Accept
Optional in header
string
application/json
text/plain
200

200 OK

Out
Example Request
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Example Response
POST https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/checkout
Show more open_in_new
                                          
                                        

x
Try this operation
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/checkout
Login to test this API.
Login to test this API.
content-type
accept

                        
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa. No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).

                            

/inquiry

post /inquiry

Inquiry Operation

api-key
X-IBM-Client-Id
(apiKey located in header)

Unique key generated for each client app.

input
Optional in body
object
InInquiry
Content-Type
Optional in header
string
application/json
text/plain
Accept
Optional in header
string
application/json
text/plain
200

200 OK

OutInquiry
Example Request
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Show more open_in_new

x
Example Response
POST https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/inquiry
Show more open_in_new
                                          
                                        

x
Try this operation
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/inquiry
Login to test this API.
Login to test this API.
content-type
accept

                        
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa. No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).

                            

Definitions

Object that defines an amount.

{
    "properties": {
        "value": {
            "type": "number",
            "format": "double",
            "example": 20.45,
            "description": "Amount value."
        },
        "currency": {
            "type": "string",
            "description": "Currency used in the transaction.",
            "example": "EUR"
        }
    },
    "additionalProperties": false
}
              

Object that defines a customer.

{
    "properties": {
        "customerInfo": {
            "description": "Object that defines the customer predefined information (name, age, etc). Check the CustomerInfo definition.",
            "example": "",
            "$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.",
            "example": "John"
        },
        "customerCountry": {
            "type": "string",
            "description": "Country of the customer.",
            "example": "Portugal"
        }
    },
    "additionalProperties": false
}
              

Object that defines the customer device information.

{
    "properties": {
        "serialNo": {
            "type": "string",
            "example": "99999999999999"
        },
        "clientIp": {
            "type": "string",
            "example": "192.168.148.1"
        },
        "deviceName": {
            "type": "string",
            "example": "John PC"
        },
        "deviceBrand": {
            "type": "string",
            "example": "Dell"
        },
        "deviceModel": {
            "type": "string",
            "example": "xps"
        },
        "imei": {
            "type": "string",
            "example": "9900000862471854"
        },
        "osName": {
            "type": "string",
            "example": "Windows"
        },
        "osVersion": {
            "type": "string",
            "example": "1083"
        },
        "wirelessNetwork": {
            "type": "string",
            "example": "adapter"
        },
        "flightMode": {
            "type": "string",
            "example": "false"
        },
        "fingerPrintEnabled": {
            "type": "string",
            "example": "true"
        },
        "deviceBootTime": {
            "type": "string",
            "example": "10"
        },
        "screenResolution": {
            "type": "string",
            "example": "1920x1080"
        },
        "isJailbreaked": {
            "type": "string",
            "example": "false"
        },
        "macAddress": {
            "type": "string",
            "example": "255.255.255.0"
        },
        "systemLanguage": {
            "type": "string",
            "example": "English"
        },
        "timeZone": {
            "type": "string",
            "example": "GMT"
        }
    },
    "additionalProperties": false
}
              

Key value tuple.

{
    "type": "object",
    "properties": {
        "key": {
            "type": "string",
            "example": "CustomerAddress"
        },
        "value": {
            "type": "string",
            "example": "Random Street"
        }
    }
}
              
{
    "properties": {
        "requestCheckout": {
            "$ref": "#/definitions/RequestCheckout",
            "description": "Object that defines the checkout request parameters. Check the RequestCheckout definition."
        }
    },
    "additionalProperties": false,
    "required": [
        "requestCheckout"
    ]
}
              

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."
        },
        "extendedInfo": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/ExtendedInfo"
            },
            "description": "Key Value tuple array."
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "requestInquiry": {
            "description": "Object that defines the QR Code inquiry request parameters. Check the RequestInquiry definition.",
            "$ref": "#/definitions/RequestInquiry"
        }
    },
    "additionalProperties": false
}
              

Object that defines a Merchant.

{
    "properties": {
        "terminalId": {
            "type": "integer",
            "example": "34937",
            "description": "Number of the merchant pos Id.",
            "format": "int32"
        },
        "channel": {
            "type": "string",
            "description": "Type of channel used by the merchant.",
            "example": "web"
        },
        "merchantTransactionId": {
            "type": "string",
            "description": "Unique id used by the merchant.",
            "example": "863b730df285443f9a60ca404e0085fd1234"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "returnCheckout": {
            "$ref": "#/definitions/ReturnCheckout",
            "description": "Object that defines the checkout response parameters. Check the ReturnCheckout definition."
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "responseInquiry": {
            "description": "Object that defines the QR Code inquiry response parameters. Check the ResponseInquiry definition.",
            "$ref": "#/definitions/ResponseInquiry"
        }
    },
    "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."
        }
    },
    "additionalProperties": false
}
              

Object that defines the inquiry operation request fields

{
    "properties": {
        "transactionToken": {
            "type": "string",
            "description": "Unique id identify of the transaction.",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        }
    },
    "additionalProperties": false
}
              

Object that defines the inquiry operation return fields

{
    "properties": {
        "returnStatus": {
            "description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
            "$ref": "#/definitions/ReturnStatus"
        },
        "paymentStatus": {
            "type": "string",
            "description": "Original transaction status.",
            "example": "Success"
        },
        "paymentAction": {
            "type": "string",
            "description": "Original transaction action.",
            "example": "3DSEC"
        },
        "transactionID": {
            "type": "string",
            "example": "1d5586885d00ddf5001a24a0",
            "description": "Unique Id generated by SIBS to identify this transaction."
        },
        "merchant": {
            "$ref": "#/definitions/Merchant",
            "description": "Object that defines a Merchant. Check the Merchant definition."
        },
        "paymentType": {
            "type": "string",
            "example": "MBWAY",
            "description": "Payment type used in the original transaction."
        }
    },
    "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"
        },
        "transactionToken": {
            "type": "string",
            "description": "Unique id identify of the transaction.",
            "example": "42f59038f3f14e618d091da8bf3b717e9999"
        },
        "transactionID": {
            "type": "string",
            "description": "Unique identify of the transaction.",
            "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": "Methods of payment accepted by the merchant.",
            "items": {
                "type": "string"
            },
            "example": ""
        }
    },
    "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.",
            "example": "Transaction processed with success."
        }
    },
    "additionalProperties": false
}
              

Object that defines a transaction.

{
    "properties": {
        "transactionTimestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of the transaction.",
            "example": "2019-04-07T18:13:18.572+01:00"
        },
        "description": {
            "type": "string",
            "description": "Description of the transaction.",
            "example": "Purchase using MB Way for the amount of 20.45€."
        },
        "paymentType": {
            "type": "string",
            "example": "MBWAY",
            "description": "Type of payment used by the client."
        },
        "amount": {
            "example": "",
            "description": "Object that defines the amount. Check the Amount definition",
            "$ref": "#/definitions/Amount"
        }
    },
    "additionalProperties": false
}
              
  • Share this
  • Log in or register to post comments

SANDBOX

Getting Started
API Documentation

©SIBS API Market

Login

User login

Use your developer.sibsapimarket.com/sibs-qly/apimarket-sb account ...

  • Create new account
  • Request new password