POST activateDCC

This operation is for front-end DCC client to activate DCC service in GB Host. Upon successful activation, the client shall receive a unique device ID and list of DCC parameters.Subsequently, the client shall use the device ID for other operations.

Note that this operation may not be relevant for a host-to-host setup (e.g.front-end terminals connect to GB Host via gateway), as for such setup, the front-end client/terminals usually use its own message protocol to communicate with the gateway and has its own type of operations.

Request Information

URI Parameters

None.

Body Parameters

ActivationRequest

Name	Description	Type	Additional information
activationCode	Activation Code Terminal sends this activation code to GB host and get it activated for DCC.	string	None.
acquirerId	Acquirer ID This field is ignored if Activation Code is provided	string	Range: inclusive between 1 and 99999999999
merchantId	Merchant ID This field is ignored if Activation Code is provided	string	String length: inclusive between 0 and 35
terminalId	Terminal ID This field is ignored if Activation Code is provided	string	String length: inclusive between 0 and 16
deviceInfo	Device Info	DeviceInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "activationCode": "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

ActivationResponse

Name	Description	Type	Additional information
result	Possible codes: "0000", "6999", "6000", "6001", "6002", "6003", 6101, 9999	Result	None.
deviceId	Device ID This ID uniquely identify a front-end device/terminal.	string	None.
acquirerId	Acquirer ID	string	None.
merchantId	Merchant ID	string	None.
terminalId	Terminal ID	string	None.
baseCountry	Base Country	string	None.
baseCurrency	Base Currency	Currency	None.
supportedCurrencies	Array of currency codes	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": {
    "code": "sample string 1",
    "description": "sample string 2"
  },
  "deviceId": "sample string 1",
  "acquirerId": "sample string 2",
  "merchantId": "sample string 3",
  "terminalId": "sample string 4",
  "baseCountry": "sample string 5",
  "baseCurrency": {
    "code": "sample string 1",
    "numericCode": "sample string 2",
    "symbol": "sample string 3",
    "minorUnit": 4,
    "displayUnit": 5
  },
  "supportedCurrencies": [
    "sample string 1",
    "sample string 2"
  ]
}