v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Links

Create Reward Bank Link

This API method allows the calling application to create a link between a requested Wallet, identified by a Wallet ID, and a requested PRIVATE Reward Bank (of type Points Reward).

post/wallet/{walletId}/link/bank/pointsreward/{pointsRewardBankId}

Path parameters

walletIdstring string required

EES AIR Wallet ID

pointsRewardBankIdstring string required

EES AIR Bank Reward ID

Request body

pointsRewardBankRewardIdstring string

[Optional] This optional request attribute allows to create more granular links, allowing to link a wallet to a Reward Bank and to a specific Reward from that Bank

typestring string required

Link Type - please refer to your Wallet Config document as available for each Client enum values for this field, and their meaning should be documented there

status'ACTIVE' | 'USED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' required

Link Status

statestring string required

Link state - - please refer to your Wallet Config document as available for each Client enum values for this field, and their meaning should be documented there

validFromstring ees-date-time required

Link Validity-From a Date-time (ATOM format)

validTostring ees-date-time required

Link Validity-To a Date-time (ATOM format)

Example request

{
  "type": "BASIC_LINK_TYPE",
  "status": "ACTIVE",
  "state": "BASIC",
  "validFrom": "2020-01-12T01:00:01+01:00",
  "validTo": "2021-01-12T01:00:01+01:00"
}

Response

Created

pointsRewardBankWalletLinkIdstring string required

EES AIR Link ID

walletIdstring string required

EES AIR Wallet ID

pointsRewardBankIdstring string required

EES AIR Reward Bank ID

pointsRewardBankRewardIdstring string required

Reward ID

typestring string required

Link Type - please refer to your Wallet Config document as available for each Client enum values for this field, and their meaning should be documented there

status'ACTIVE' | 'USED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' required

Link Status

statestring string required

Link state - - please refer to your Wallet Config document as available for each Client enum values for this field, and their meaning should be documented there

validFromstring ees-date-time required

Link Validity-From a Date-time (ATOM format)

validTostring ees-date-time required

Link Validity-To a Date-time (ATOM format)

dateCreatedstring ees-date-time required

Link Creation Date-time (ATOM format)

lastUpdatedstring ees-date-time required

Link last update Date-time (ATOM format)

Example response

{
  "pointsRewardBankWalletLinkId": "76",
  "pointsRewardBankId": "6855",
  "pointsRewardBankRewardId": "5077",
  "type": "DEFAULT_LINK_TYPE",
  "status": "ACTIVE",
  "state": "BASIC",
  "validFrom": "2020-03-19T00:00:00+00:00",
  "validTo": "2020-04-19T00:00:00+01:00",
  "dateCreated": "2020-03-23T08:35:22+00:00",
  "lastUpdated": "2020-03-23T08:35:22+00:00"
}