Links

Update Reward Bank Link

Changed on

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

patch/wallet/{walletId}/bank/pointsreward/link/{pointsRewardBankWalletLinkId}

Request

  • Base URL
    https://wallet.uk.eagleeye.com/2.0
  • URL
    https://wallet.uk.eagleeye.com/2.0/wallet/{walletId}/bank/pointsreward/link/{pointsRewardBankWalletLinkId}
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Path parameters

walletIdstring string required

EES AIR Wallet ID

pointsRewardBankWalletLinkIdstring string required

EES AIR Bank Reward Link 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

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

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

Response

OK

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"
}

Changes

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    This list may be incomplete.