TOKEN API (Sandbox)

TOKEN API (Sandbox) 1.0.0

0
No votes yet

The Token API requests the payment using a card token previously generated. Allows the merchant to request Card Token generation during Card Payment transactions and store them associated with his customer.

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

/{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
Accept
Optional in header
string
application/json
text/plain
200

200 OK

ResponsePayment
400

Bad Request.

ResponsePayment
401

Unauthorized.

ResponsePayment
403

Forbidden.

ResponsePayment
404

Not Found.

ResponsePayment
405

Method Not Allowed.

ResponsePayment
406

Not Acceptable.

ResponsePayment
408

Request Timeout.

ResponsePayment
415

Unsupported Media Type.

ResponsePayment
429

Too Many Requests.

ResponsePayment
500

Internal Server Error.

ResponsePayment
503

Service Unavailable.

ResponsePayment
504

Gatewaty Timeout.

ResponsePayment
Example Request
Example Response
POST https://site3.sibsapimarket.com/sibs-qly/sibslabs/sibs/spg/v1/payments/{id}/token/purchase
Try this operation
https://site3.sibsapimarket.com/sibs-qly/sibslabs/sibs/spg/v1/payments/{id}/token/purchase
content-type
accept
id

Definitions 

{
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string",
            "example": "THREEDS_METHOD",
            "enum": [
                "THREEDS_METHOD",
                "THREEDS_CHALLENGE",
                "DCC"
            ]
        },
        "executed": {
            "type": "boolean"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "id": {
            "type": "string"
        },
        "type": {
            "type": "string",
            "example": "THREEDS_METHOD",
            "enum": [
                "THREEDS_METHOD",
                "THREEDS_CHALLENGE",
                "DCC"
            ]
        },
        "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"
        },
        "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
}

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"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "data": {
            "type": "string"
        }
    },
    "additionalProperties": false
}
              
{
    "type": "object",
    "properties": {
        "oneClickApplication": {
            "type": "boolean",
            "description": "For use of already created One Click. Indicates if a One Click Payment is requested to be applied. The absence indicates the value 'false'."
        }
    },
    "required": [
        "oneClickApplication"
    ]
}
              
{
    "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"
        },
        "oneClick": {
            "description": "Object that defines a One Click Payment.",
            "$ref": "#/definitions/OneClick"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "returnStatus": {
            "description": "Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself).",
            "$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": "Provided field to create a recurring transaction. validity Date is the date until is possible to perform recurring transactions over the specified transaction.",
            "$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
}

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
}

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
}