production
development
https://site3.sibsapimarket.com/sibs-qly/sibslabs
production
development
https://api.qly.sibspayments.com:11501/sibs-qly/sibslabs
production
development
https://site4.sibsapimarket.com/sibs-qly/sibslabs
Paths
/payments/{id}/pbl/payment-link
post /payments/{id}/pbl/payment-link
Perform the transaction and redirect user to Payment Host.
input
Required in body
object
id
Required in path
string
authorization
Required in header
string
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
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://site3.sibsapimarket.com/sibs-qly/sibslabs/sibs/spg/v1/payments/{id}/pbl/payment-link
Try this operation
Definitions
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"
},
"browserJavascriptEnabled": {
"type": "string"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
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
}
Merchant
{
"type": "object",
"properties": {
"merchantURL": {
"type": "string",
"description": "Merchant Shop URL for redirect."
}
}
}
Object that defines the payment operation request fields
{
"properties": {
"userAcceptanceIndicator": {
"type": "boolean",
"example": "",
"description": "Indicates if the user has accepted the Terms and Conditions, in order to continue with the payment."
},
"gatewayId": {
"type": "string",
"example": "",
"description": "Payment Channel identifier for the channel the Customer is going to use for their payment."
},
"info": {
"$ref": "#/definitions/Info"
},
"merchant": {
"$ref": "#/definitions/Merchant"
}
},
"additionalProperties": false
}
{
"properties": {
"transactionID": {
"type": "string",
"description": "Backend unique identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
},
"redirectURL": {
"type": "string",
"description": "An address to continue the transaction started by the pre-transaction message."
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment."
},
"returnStatus": {
"description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
"$ref": "#/definitions/ReturnStatus"
}
}
}
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
}
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
}