Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Links

Get Active Reward Bank Links

This API method allows the calling application to retrieve a list of links between a requested Wallet, identified by a Wallet ID, and a PRIVATE Reward Bank (of type Points Reward). The links returned will be filtered with a status of either ACTIVE or EXPIRED

get/wallet/{walletId}/bank/pointsreward/links/available

Path parameters

walletIdstring string required

EES AIR Wallet ID

Query parameters

statestring string

[Optional] Filter by Link STATE

orderBy[]string string

[Optional] Query string for controlling Paginated Results Sorting Order. Please note this query string needs to be constructed from field name + comma sign and sorting order (ASC/DESC). Currently AIR supports sorting by keys: walletId,pointsRewardBankId, pointsRewardBankRewardId,state

Headers

x-client-transaction-timestring string

Client Transaction Time Override

Response

OK

offsetinteger required

Pagination Offset

limitinteger required

Pagination Limit

totalinteger required

Result set count

Example response

{
  "offset": 0,
  "limit": 100,
  "orderBy": [
    {
      "name": "pointsRewardBankWalletLinkId",
      "order": "ASC"
    }
  ],
  "total": 2,
  "results": [
    {
      "pointsRewardBankWalletLinkId": "116",
      "walletId": "155345",
      "pointsRewardBankId": "6855",
      "pointsRewardBankRewardId": "5077",
      "status": "ACTIVE",
      "state": "BASIC",
      "type": "DEFAULT_LINK_TYPE",
      "validFrom": "2020-03-19T00:00:00+00:00",
      "validTo": "2020-04-19T00:00:00+01:00",
      "dateCreated": "2020-03-30T14:23:25+01:00",
      "lastUpdated": "2020-03-30T14:23:25+01:00"
    },
    {
      "pointsRewardBankWalletLinkId": "117",
      "walletId": "155345",
      "pointsRewardBankId": "6855",
      "pointsRewardBankRewardId": "5077",
      "status": "ACTIVE",
      "state": "BASIC",
      "type": "DEFAULT_LINK_TYPE",
      "validFrom": "2020-03-19T00:00:00+00:00",
      "validTo": "2020-04-19T00:00:00+01:00",
      "dateCreated": "2020-03-30T14:29:26+01:00",
      "lastUpdated": "2020-03-30T14:29:26+01:00"
    }
  ]
}