production
development
https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
production
development
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
Paths
/generate
post /generate
api-key
X-IBM-Client-Id
(apiKey located in header)
Unique key generated for each client app.
input
Required in body
object
Content-Type
Optional in header
string
application/json
text/plain
text/plain
Accept
Optional in header
string
application/json
text/plain
text/plain
200
200 OK
Example Request
Example Response
POST https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/qrcode/generate
Try this operation
/inquiry
post /inquiry
api-key
X-IBM-Client-Id
(apiKey located in header)
Unique key generated for each client app.
input
Required in body
object
Content-Type
Optional in header
string
application/json
text/plain
text/plain
Accept
Optional in header
string
application/json
text/plain
text/plain
200
200 OK
Example Request
Example Response
POST https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/qrcode/inquiry
Try this operation
/payment
post /payment
api-key
X-IBM-Client-Id
(apiKey located in header)
Unique key generated for each client app.
input
Required in body
object
Content-Type
Optional in header
string
application/json
text/plain
text/plain
Accept
Optional in header
string
application/json
text/plain
text/plain
200
200 OK
Example Request
Example Response
POST https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb/spgbusiness/v1/qrcode/payment
Try this operation
Definitions
Object that defines an amount.
{
"properties": {
"value": {
"type": "number",
"description": "Amount of the transaction.",
"example": 23.45,
"format": "double"
},
"currency": {
"type": "string",
"description": "Currency used in the transaction.",
"example": "EUR"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "PhoneBrand"
},
"value": {
"type": "string",
"example": "IPhone"
}
}
}
Object that defines the transaction additional information
{
"properties": {
"extendedInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false
}
{
"properties": {
"requestGenerate": {
"$ref": "#/definitions/RequestGenerate",
"description": "Object that defines the QR Code generate request parameters. Check the RequestGenerate definition."
}
},
"additionalProperties": false
}
{
"properties": {
"requestInquiry": {
"description": "Object that defines the QR Code inquiry request parameters. Check the RequestInquiry definition.",
"$ref": "#/definitions/RequestInquiry"
}
},
"additionalProperties": false
}
{
"properties": {
"requestPayment": {
"description": "Object that defines the QR Code payment request parameters. Check the RequestPayment definition.",
"$ref": "#/definitions/RequestPayment"
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "integer",
"example": "21451",
"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": {
"responseGenerate": {
"description": "Object that defines the QR Code generate response parameters. Check the ResponseGenerate definition.",
"$ref": "#/definitions/ResponseGenerate"
}
},
"additionalProperties": false
}
{
"properties": {
"responseInquiry": {
"description": "Object that defines the QR Code inquiry response parameters. Check the ResponseInquiry definition.",
"$ref": "#/definitions/ResponseInquiry"
}
},
"additionalProperties": false
}
{
"properties": {
"responsePayment": {
"description": "Object that defines the QR Code payment response parameters. Check the ResponsePayment definition.",
"$ref": "#/definitions/ResponsePayment"
}
},
"additionalProperties": false
}
Object that defines the generate operation request fields
{
"properties": {
"transactionToken": {
"type": "string",
"description": "Unique id identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"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 payment operation request fields
{
"properties": {
"transactionToken": {
"type": "string",
"description": "Unique id identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
}
},
"additionalProperties": false
}
Object that defines the generate operation return fields
{
"properties": {
"returnStatus": {
"description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
"$ref": "#/definitions/ReturnStatus"
},
"transactionToken": {
"type": "string",
"description": "Unique id identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"qrcodeImage": {
"type": "string",
"description": "QR Code image in Base64 string",
"example": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAALg0lEQVR4Xu2dUXbjMAwD0/sfOnuBjSbPCB5la/aXSxIECVF22ubv/X6/X/6TARn4LwN/CsTJkIHPDCgQp0MGFgwoEMdDBhSIMyAD1xhwg1zjTa9DGFAghzTaMq8xoECu8abXIQwokEMabZnXGFAg13jT6xAGFMghjbbMawwokGu86XUIAwrkkEZb5jUGFMg13vQ6hAEFckijLfMaAwrkGm96HcJALJC/v79HU7X7r8sQ/4Sf/O/eXKqf6lMgwFBKMDUgtdOAE37yT/FN+1P9hE+BKBCakVvbFUi5fSnBZXgv2gCEn/zb+NvxqX7K7wZxg9CM3NquQMrtSwkuw3ODlA84N0iZYAXSZmAdPz3gFIgCmZ3gcvbtBZICLPMXX1FSfPSQTPxN+6f1p/5p/ZS/vkGowQSwbW8TTPjT/NP+VF/bntZP+BQI/CRAW+Bpg6f9acDa9rR+wqdAFMhyRtoHBA0o2RUIMRTa2wQTvDT/tD/V17an9RM+N4gbxA2yYECBKBAFokA+M9Be0bjCQ4Gm+FN/qq9tb+Mf3yBUYEowPWRSfvJP8VH+ND7hp/yp/+74CZ8CCU9wIpjsNKDkT/Z0wFN/wkf2ND/5U34FokCiZ5C7C1yBwDfMUYPTEwgbUP6VZcKf1k/+VD/Z2/gpvxvEDeIG2fkt1tNPIDyh3CBVgdIGwv6kX+JJA04AyZ8KIHuan/wpP9nvXv/d8WN/FMj6zxYpkPW3hCsQkBgRRANG/qRwsqf59VcgawYUyJIBEvjpAqMDjOxt/ii/b7HCt1gKpPuXNRXIw9/itBu8u0DphCZ7mz/K7wZxg1Rfs9IAkl2BuEGqA9oeMNpgJACyt/FTfjeIG6QqUBpAsisQN0h1QNsD5gbxNW/0mjc9IcmfBlSBRJ9ivLxila9YNOA0wOSvQLo/CaFAFEj1ikcCJzsdIOkBQfkViAJRIAsGFIgCUSAK5DMD6Yomf1rhdIUgf8pP8dv+hJ/sbfyU3w3iBnGDuEHcIJ8YcIOsd8j4BqEV17anA0L40vipfxsfxW/b6/xM/0Zhm0CKXye4fIWjO/p0/ZQ/tdf7p0DKHzQpkFQDS38FUqX3Vf8KtrSBqT/R145P+VN7G7/PIOEJTw1OG5j6t/FR/La9zo9XLK9YqyFOn3EUSPkEvj3BIT/1EzLE1+4Pxa/z4wZxg7hBFp+TtQVCJ8DudrpipCfY7v6794fwUf/Iv/6QTgB2txPBuw94in/3/hA+qp/8FQgwRAQrEBqxWTv1j9ApEAVCM3JruwIpt48IdoOUGxCGp/5ReDeIG4Rm5NZ2BVJuHxHsBik3IAxP/aPwbhA3CM3Ire3jArk1e4KXAWAg3iAyLANPZkCBPLm71hYzoEBiCg3wZAYUyJO7a20xAwokptAAT2ZAgTy5u9YWM6BAYgoN8GQGYoHQJ8lEXvpBDsVP8VH8afzt/FR/yu80fqxv+hem2gSlDSQCp/G381P9Kb/T+LE+BUIUre3tBtMAtvMTO4SP/KfxEz6vWMQQ2NsNpgFs5yd6CB/5T+MnfAqEGFIgSwYUCAzI7gSl+Eg/7ROQ8LfzU/2Ej/yn8RM+Nwgx5AZxgyQzsvsJkuIjbtonIOFv56f6CR/5T+MnfPUNQgQQwW1/Iii1U31p/NQ/5ZfyT8cnfGRXIMRQaFcg71tf0RRIKAByVyAKZDkj6Ypt+9OAp3YFokAUyIIBBaJAFIgC+chAegOgDU7xyZ/sPoMQQ6HdDeIGcYO4Qdwg4UF62Z1O4HTFUnwCTvkpPvlT/jQ++VP+Nv52foofX7EoQWqnBu7eoGn8xA/ho/5RfPKfzo/40t8HoQSpnQjcvUHT+Ikfwkf9o/jkP50f8SmQ9XcUEoE0IDQA5E/50/jkT/nb+Nv5Kb5XLPiWVyKQBoQGkPwpfxqf/Cl/G387P8VXIAqEZiR6S0nBpwWK+LxiecWiIVnZ3SAJez/wpRNm9wZN4yd+CB+1kOKT/3R+xJduECqQCGz7EwGEj/xTO9Wfxm/7E3/T9RE+4id+BiECCGDbnwggfOSf2qn+NH7bn/ibro/wET8K5L3+WSEiMLVPD1CKnwZwuj7CR/UrEAVCMxK9xVIg8JqUFEwEpv7UfYpP/qmd6k/jt/2Jv+n6CB/x4wZxg9CMuEEShuiEIAW3/ak2wkf+qZ3qT+O3/Ym/6foIH/HjBnGD0Iy4QSKGwLl9gtAJkea/e/xmb38Re5pfqiHeIJgg/Fknij9N8O4CJP6m7dP9o/oVCDA03cBUgDQA0/Zpfql+BaJAaEaqdgXiFevWD7lVdbxeLwWiQBTIggEFokAUiAL5zED7IXP6BErra+NvX5HS+O36KT7hrz+kE4C720kg1KBp/zb/VF87P/FP+RUIMRR+EEoNogFq+4flozvVhwHC/0D8UXgFQgwpkIghBRLRd39nGgA6wab92x2g+tr5iX/K7wYhhtwgEUMKJKLv/s40AHSCTfu3O0D1tfMT/5TfDUIMuUEihhRIRN/9nWkA6ASb9m93gOpr5yf+KX+8QaYJoAJTOxFM9ZM/4Uvjp/4pPvInftr4CZ8CAYamG5gOSOqPAxT+KNE0v1hf+y8rEoDd7dMNTAc89af+UHzyn+aX8LlB3CA0I0u7Agnf4kTsb+A8fcLRAO6Oj1o4jZ/wuUHcIDQjbpCEITrhktg7+E6fcMTv7vioh9P4CZ8bxA1CM+IGSRhKT7gk9y98U/zkn2KkEzaNT/in81N9dXzt17ztAohAsqcDQv6Un+xt/gj/dP5xfhTI+jsKaUBowKjBZKf85E92wj+dn/DX8SkQBbIawvoAlj+JJ4GRvf6Q3iaYCiR7eoKSP+Une5s/wj+df5wfN4gbxA3ymQE3SPkbsugEJPv0CT6df5wfN4gbxA2y8QahOzCdIGSnE5Dykz/lp/jkT3bCR/nJn/Kn8VN/wpfax69YRFBaIA0A5Sd/wkfxyZ/shI/ykz/lT+On/oQvtSuQ8BmEGkADQP5kpwGn/ORP+dP4qT/hS+0KRIFEM5QOeOofgf/CWYEokC/GZPEQG/KnQOBbZImgqHs/+IKW9hXk6fURf9R/8k/5I383SHgCIsHhj1JQfBqg9gCm8VN/4ie1KxAFEs1QOuCpfwT+C2cFMiyQdAN80ePqf0nxk38V/BfBFYgC+WJMPv8XGvDdNwQVr0AUCM3I0q5AgL70hCD/qHs3eIuVDljKT+qf4if/FF/q7wZxg0QzRANOByD5R+B+4KxAFEg0RjTgCiQcMCIw6p5XrJQ+9FcgPoPgkKz+Ax0A6YBF4H7gnOIn/x9AjEJ4xQo3YMT+6/UiAaXxyZ8GtI2vnZ/iEz8KRIEsZ0SBhBIjAik8+ZPCyZ7mJ3/KT/Z2/ZSf6mvja+en+MSPG8QN4gZZMKBAFIgCUSCfGaArRLqicYWXfxye8lN9xA/FJ3s7P8UnfG4QN4gbxA3iBvnEAJ2wbhBiqPxBIa24tp0GgOgh/zb+6fgpP+Q/Xd/4FWucgPCKpUDe0RVNgcAfbVAg0wxk+WnA6QAh/wxd7u0GcYNEU0QDrkDCAYu68wPntIHk/wOIW4dQID6kR3fsraf7B+AUiAJRIAsGFIgCUSAK5PquffodfPcTkvgn/NT56fiEL62P4tffYhGA3e3UgPYAET/t/NPxqX7qD/mTXYEAQ9SA9gBhA8tvEdv1UXyqn/pD/mRXIAokesZKB1SBkEQ3t9MAUIPJPy2/nX86PvFT57f9LbdU4O52akB7gIifdv7p+FQ/9Yf8ye4VyyuWV6wFAwpEgSiQpkBoRWmXgTszEG+QOxcvdhkgBhQIMaT9aAYUyNHtt3hiQIEQQ9qPZkCBHN1+iycGFAgxpP1oBhTI0e23eGJAgRBD2o9mQIEc3X6LJwYUCDGk/WgGFMjR7bd4YkCBEEPaj2ZAgRzdfosnBhQIMaT9aAYUyNHtt3hi4B+oR7ZsMCjNYAAAAABJRU5ErkJggg=="
},
"qrcodeData": {
"type": "string",
"description": "QR Code data",
"example": "CPMBV20000349370000001906121739210000100897829314200A8E1FCFA4"
}
},
"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"
},
"transactionToken": {
"type": "string",
"description": "Unique id identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
}
},
"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"
}
},
"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."
},
"paymentType": {
"type": "string",
"example": "QRCODE",
"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
}