production
development
https://sandbox.sibspayments.com
Paths
/{id}/token/purchase
post /{id}/token/purchase
input
Required in body
object
id
Required in path
string
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://sandbox.sibspayments.com/sibs/spg/v1/payments/{id}/token/purchase
Try this operation
Definitions
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"example": "THREEDS_METHOD",
"enum": [
"THREEDS_METHOD",
"THREEDS_CHALLENGE"
]
},
"executed": {
"type": "boolean"
}
},
"additionalProperties": false
}
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"data": {
"$ref": "#/definitions/Data"
}
},
"additionalProperties": false
}
{
"properties": {
"url": {
"type": "string"
},
"params": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
}
},
"additionalProperties": false
}
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"
}
},
"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
}
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
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"tokenType": {
"type": "string"
},
"value": {
"type": "string"
},
"secureCode": {
"type": "string"
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"tokenName": {
"type": "string"
},
"tokenType": {
"type": "string"
},
"value": {
"type": "string"
},
"maskedPAN": {
"type": "string"
},
"expireDate": {
"type": "string"
}
},
"additionalProperties": false
}
Object that defines the payment operation request fields
{
"properties": {
"info": {
"$ref": "#/definitions/Info",
"description": "Object that defines the aditional info provided by the merchant. Check the Info definition."
},
"actionProcessed": {
"description": "Action to be processed",
"$ref": "#/definitions/ActionProcessed"
},
"tokenInfo": {
"$ref": "#/definitions/TokenInfo"
}
},
"additionalProperties": false
}
{
"properties": {
"returnStatus": {
"description": "Object that defines the Status of the transaction. Check the ReturnStatus definition.",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "Backend unique identify of the transaction.",
"example": "42f59038f3f14e618d091da8bf3b717e9999"
},
"merchant": {
"description": "Object that defines the Merchant. Check the Merchant definition.",
"$ref": "#/definitions/Merchant"
},
"paymentType": {
"type": "string",
"description": "Payment type used"
},
"actionResponse": {
"description": "Action to perform",
"$ref": "#/definitions/ActionReponse"
},
"tokenResponse": {
"$ref": "#/definitions/TokenResponse"
},
"recurringTransaction": {
"description": "Object that defines a Recurring Transaction. Check the Recurring Transaction definition.",
"$ref": "#/definitions/RecurringTransactionOutput"
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment."
}
},
"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."
}
},
"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
}
{
"properties": {
"status": {
"type": "string",
"description": "Recurring Transaction outcome.",
"example": "Success"
}
},
"additionalProperties": false
}