POST updateTerminal
This operation is used for updating the device information of a front-end client/terminal to GB Host.
It is recommended to perform this operation in trigger/scheduled basis, e.g.:
• Upon terminal start-up
• On daily basis at specific time
• By manual trigger
This is a cut-down version of the DCC Update operation;
Update Terminal responds only the result of the operation while DCC Update includes updated parameters such as supported currencies.
Request Information
URI Parameters
None.
Body Parameters
TerminalUpdateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| deviceId |
Device ID - unique ID representing front-end device/terminal.
|
string |
None. |
| acquirerId |
Acquirer ID
|
string |
Range: inclusive between 1 and 99999999999 |
| merchantId |
Merchant ID
|
string |
String length: inclusive between 0 and 35 |
| terminalId |
Terminal ID
|
string |
String length: inclusive between 0 and 16 |
| deviceInfo |
Device Info |
DeviceInfo |
Required |
Request Formats
application/json, text/json
{
"deviceId": "sample string 1",
"acquirerId": "sample string 2",
"merchantId": "sample string 3",
"terminalId": "sample string 4",
"deviceInfo": {
"summary": "sample string 1",
"model": "sample string 2",
"software": "sample string 3",
"vendor": "sample string 4",
"additionalInfo": "sample string 5"
}
}
Response Information
Resource Description
TerminalUpdateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| result |
Possible codes: "0000", "6999", "6000", "6001", "6002", "6003" |
Result |
None. |
Response Formats
application/json, text/json
{
"result": {
"code": "sample string 1",
"description": "sample string 2"
}
}