Master Data Reference of GS2-Exchange

{
  "version": "2019-08-19",
  "rateModels": [
    {
      "name": "[string]Exchange Rate Name",
      "metadata": "[string?]metadata",
      "consumeActions": [
        {
          "action": "[string]Types of actions to be performed in the stamp task",
          "request": "[string]JSON of the obtain request"
        }
      ],
      "timingType": "[string]Type of exchange",
      "lockTime": "[int]Waiting time (minutes) from the execution of the exchange until the reward is actually received",
      "enableSkip": "[bool]Can skip?",
      "skipConsumeActions": [
        {
          "action": "[string]Types of actions to be performed in the stamp task",
          "request": "[string]JSON of the obtain request"
        }
      ],
      "acquireActions": [
        {
          "action": "[string]Types of actions to be performed in the stamp sheet",
          "request": "[string]JSON of request"
        }
      ]
    }
  ]
}
TypeRequireDefaultLimitationDescription
version2019-08-19Format version of master data
rateModelsList<RateModel>

RateModel

Exchange Rate Model

The exchange rate is an entity that defines the rate used to exchange resources for resources.

In addition to the rate at which a resource can be exchanged immediately, a rate can also be set at which a resource can be exchanged after a certain amount of time in real time has elapsed. Exchange rates that require an elapse of time in real time can further define the resources required to perform an immediate exchange.

TypeRequireDefaultLimitationDescription
rateModelIdstring~ 1024 charsExchange rate model GRN
namestring~ 128 charsExchange Rate Name
metadatastring~ 2048 charsmetadata
consumeActionsList<ConsumeAction>[]List of Consumption Action
timingTypeenum [‘immediate’, ‘await’]“immediate”~ 128 charsType of exchange
lockTimeint{timingType} == “await”~ 525600Waiting time (minutes) from the execution of the exchange until the reward is actually received
enableSkipbool{timingType} == “await”falseCan skip?
skipConsumeActionsList<ConsumeAction>{skipConsumeActions}[]List of Short Consumption Action
acquireActionsList<AcquireAction>[]List of Acquire Action

AcquireAction

TypeRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request

ConsumeAction

TypeRequireDefaultLimitationDescription
actionenum []~ 128 charsTypes of actions to be performed in the stamp task
requeststring~ 1048576 charsJSON of the obtain request