Generic operation service
The generic operation service depends on the authorizer / routing. This chapter will focus on the common characteristics of each operation. For more details on each operation, see the documentation prepared for each routing.
Call details#
- Feature:
/v1/genericoperations - HTTP method:
POST - Request format:
JSON - Response format:
JSON - Header parameters:
| Parameter | Description | Type (Size) | Mandatory |
|---|---|---|---|
merchant_id | Store code on Carat Portal. The production and certification codes will be different. | AN (≤ 15) | Yes |
merchant_key | Store authentication key on Carat Portal. The production and certification keys will be different. | AN (≤ 80) | Yes |
Content-Type | Use "application/json" value. | AN (= 15) | Yes |
Request parameter#
| Parameter | Description | Type (Size) | Mandatory |
|---|---|---|---|
operation | Identifying number of the operation to be called. | N (≤ 3) | Yes |
parameters | Set of properties that must be sent to perform the operation specified in the parameter operation. | AN (≤ 20) | Yes |
Descriptive table of parameters#
Each operation has a set of parameters. Below are the parameters with common characteristics for all operations:
| Parameter | Description | Type (Size) | Mandatory |
|---|---|---|---|
token | Authenticity token that was generated by Carat Portal (Learn more) | AN (= 66) | Conditional per operation |
authorizer_id | Authorization code on Carat Portal (Learn more) | AN (≤ 3) | Yes |
terminal_id | Numeric value that represents a logical terminal in SiTef. A logic terminal number cannot be used at the same time for two different requests. | AN (= 8) | Yes |
merchant_usn | NSU of in-store operation | N (≤ 12) | Yes |
operator_code | Operator code | N (= 2) | No |
supervisor_code | Supervisor code | N (= 5) | No |
subfunction | Subfunction of the operation. The value of this field must be consistent with the operation | N (= 2) | Yes |
Answer#
The answer depends on each operation and will be specified in the documentation of each authorizer/routing.