production
development
https://sandbox.qly.sibspayments.com
production
development
https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
production
development
https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
Paths
/{id}/xpay/payment
post /{id}/xpay/payment
purchase
purchase
Requests the payment registered by the previous checkout using xpay payment details inserted by the customer.
id
Required in path
string
authorization
Required in header
string
signature
Optional in header
string
xPayPaymentRequest
Required in body
object
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.qly.sibspayments.com/sibs/spg/v2/payments/{id}/xpay/payment
Try this operation
Definitions
{
"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"
},
"browserJavascriptEnabled": {
"type": "string",
"description": "Browser Javascript 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"
}
},
"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 customer device information."
},
"customerInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false,
"required": [
"deviceInfo"
]
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Merchant terminal id",
"maxLength": 10
},
"channel": {
"type": "string",
"description": "Merchant channel."
},
"merchantTransactionId": {
"type": "string",
"description": "Unique id used by the merchant."
}
},
"additionalProperties": false,
"required": [
"terminalId",
"merchantTransactionId"
]
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"tokenName": {
"type": "string",
"description": "Token Name."
},
"tokenType": {
"type": "string",
"enum": [
"applePay",
"googlePay"
],
"description": "Token Type. Possible values are (\"applePay\", \"googlePay\")"
},
"value": {
"type": "string",
"description": "Token value."
}
},
"additionalProperties": false,
"required": [
"tokenType",
"value"
]
}
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. \"000\" for success. Values different from \"000\" refer to errors.",
"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,
"required": [
"statusCode",
"statusMsg",
"statusDescription"
]
}
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,
"required": [
"startTime",
"endTime"
]
}
Object that defines the payment operation request fields
{
"properties": {
"tokenInfo": {
"$ref": "#/definitions/TokenInfo",
"description": "Token Info."
},
"info": {
"$ref": "#/definitions/Info",
"description": "Object that defines the transaction additional information."
}
},
"additionalProperties": false,
"required": [
"tokenInfo"
]
}
{
"properties": {
"returnStatus": {
"description": "Describes the status of the request.",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "Unique identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"merchant": {
"description": "Object that defines the Merchant.",
"$ref": "#/definitions/Merchant"
},
"paymentType": {
"type": "string",
"description": "Payment type used.",
"enum": [
"AUTH",
"PURS",
"CAPT",
"CAUT",
"RFND",
"RCON",
"RVSL",
"STIQ",
"PREF",
"CPRF",
"CMBW"
],
"default": "AUTH"
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment.",
"enum": [
"Success",
"Partial",
"Declined",
"InProcessing",
"Pending",
"Timeout",
"Error"
],
"default": "Success"
},
"actionResponse": {
"$ref": "#/definitions/ActionResponse",
"description": "Action to perform."
},
"execution": {
"$ref": "#/definitions/Execution",
"description": "Object that defines an Execution. See the Execution definition."
}
},
"additionalProperties": false,
"required": [
"returnStatus"
]
}
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"example": "THREEDS_METHOD",
"enum": [
"THREEDS_METHOD",
"THREEDS_CHALLENGE",
"DCC"
]
},
"data": {
"$ref": "#/definitions/Data",
"description": "Depending on informed type related structures are specified below."
}
},
"additionalProperties": false
}