production
development
https://sandbox.sibspayments.com
Paths
/{id}/service-reference/generate
post /{id}/service-reference/generate
clientid
X-IBM-Client-Id
(apiKey located in header)
authorization
Required in header
string
Signature
Optional in header
string
For now, the type of HMAC used will be SHA2 (SHA512). base64
{
"maxLength": 128
}id
Required in path
string
input
Optional 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.sibspayments.com/sibs/spg/v2/payments/{id}/service-reference/generate
Try this operation
Definitions
{
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "Possible values are (\"TREEDS_METHOD\", \"THREEDS_CHALLENGE\", \"DCC\").",
"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
}
Parameter with the value and currency of the transaction.
{
"properties": {
"value": {
"type": "number",
"description": "Amount of the transaction.",
"example": 5,
"format": "double"
},
"currency": {
"type": "string",
"description": "Currency used in the transaction.",
"example": "EUR"
}
},
"additionalProperties": false,
"required": [
"value",
"currency"
]
}
{
"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"
},
"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"
},
"browserJavascriptEnabled": {
"type": "string",
"description": "Browser Javascript Enabled"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
{
"properties": {
"reference": {
"type": "string",
"description": "Payment Reference"
},
"entity": {
"type": "string",
"description": "Payment Reference Entity"
},
"paymentEntity": {
"type": "string",
"description": "Generate Type Used"
},
"amount": {
"$ref": "#/definitions/Amount",
"description": "Generate Type Used"
},
"expireDate": {
"type": "string",
"format": "date-time",
"description": "Reference Expiration Date."
},
"status": {
"type": "string",
"description": "Payment Reference Status.",
"enum": [
"UNPAID",
"PAID",
"PARTPAIDCLS",
"PARTPAIDOPN",
"CANC",
"UNKN"
],
"default": "PAID"
}
},
"additionalProperties": false
}
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": "Merchant terminal id.",
"format": "int32"
},
"channel": {
"type": "string",
"description": "Merchant channel.",
"example": "web"
},
"merchantTransactionId": {
"type": "string",
"description": "Id of the transaction in merchant store.",
"example": "863b730df285443f9a60ca404e0085fd1234",
"maxLength": 35
}
},
"additionalProperties": false
}
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
},
"additionalProperties": false
}
Object that defines the payment operation request fields
{
"properties": {
"info": {
"description": "Object that defines the aditional info provided by the merchant. Check the Info definition.",
"$ref": "#/definitions/Info"
},
"actionProcessed": {
"description": "Action to be processed",
"$ref": "#/definitions/ActionProcessed"
}
},
"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": "Generate type used"
},
"paymentReference": {
"$ref": "#/definitions/PaymentReference",
"description": "Payment reference details in case of customer select payment reference (Multibanco) payment method."
},
"actionResponse": {
"description": "Action to perform",
"$ref": "#/definitions/ActionReponse"
},
"execution": {
"description": "Object that defines an Execution. See the Execution definition.",
"example": "",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment.",
"enum": [
"Success",
"Partial",
"Declined",
"InProcessing",
"Pending",
"Timeout",
"Error"
],
"default": "Success"
},
"hmac": {
"type": "string",
"maxLength": 128,
"description": "For now, the type of HMAC used will be SHA2 (SHA512)."
}
},
"additionalProperties": false
}
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.",
"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"
]
}