CGI Transaction

CGI Transaction sends a structured JSON transaction request to the terminal using a structured CGI contract. TPN and Authkey are provided in the request body (Authkey may be omitted when SpinAccessToken is supplied). Additional fields can be added via CustomFields. All the responses have GeneralResponse section that informs about successful result or error. See Error Codes and Messages.

Request Body

application/json

Tpn*string

Terminal profile number.

Length10 <= length <= 12

Authkey?string

Merchant's authorization password. Required if no SpinAccessToken.

Length10 <= length <= 10

SPInProxyTimeout?|

Timeout for processing transaction with SPIn proxy. If null, the default timeout will be used.

Formatint32

Range1 <= value <= 720

CustomFields?

A collection of custom fields in key-value format.

RequestGuid?string

Unique request identifier for end-to-end request tracking. If not provided, it will be generated by SPInAPI.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/v2/CGI/Transaction" \  -H "Content-Type: application/json" \  -d '{    "Tpn": "",    "Authkey": "",    "SPInProxyTimeout": null,    "CustomFields": {},    "RequestGuid": "00000000-0000-0000-0000-000000000000"  }'

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

{
  "GeneralResponse": {
    "ResultCode": "0",
    "StatusCode": "0000",
    "Message": "",
    "DetailedMessage": "",
    "DelayBeforeNextRequest": null
  }
}

CGI Transaction

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`