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"
}
]
}
]
}
| Type | Require | Default | Limitation | Description |
---|
version | ✓ | | 2019-08-19 | Format version of master data | |
rateModels | List<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.
| Type | Require | Default | Limitation | Description |
---|
rateModelId | string | ✓ | | ~ 1024 chars | Exchange rate model GRN |
name | string | ✓ | | ~ 128 chars | Exchange Rate Name |
metadata | string | | | ~ 2048 chars | metadata |
consumeActions | List<ConsumeAction> | | [] | | List of Consumption Action |
timingType | enum [‘immediate’, ‘await’] | ✓ | “immediate” | ~ 128 chars | Type of exchange |
lockTime | int | {timingType} == “await” | | ~ 525600 | Waiting time (minutes) from the execution of the exchange until the reward is actually received |
enableSkip | bool | {timingType} == “await” | false | | Can skip? |
skipConsumeActions | List<ConsumeAction> | {skipConsumeActions} | [] | | List of Short Consumption Action |
acquireActions | List<AcquireAction> | | [] | | List of Acquire Action |
AcquireAction
| Type | Require | Default | Limitation | Description |
---|
action | enum [] | ✓ | | ~ 128 chars | Types of actions to be performed in the stamp sheet |
request | string | ✓ | | ~ 1048576 chars | JSON of request |
ConsumeAction
| Type | Require | Default | Limitation | Description |
---|
action | enum [] | ✓ | | ~ 128 chars | Types of actions to be performed in the stamp task |
request | string | ✓ | | ~ 1048576 chars | JSON of the obtain request |