---
title: "Cancel Wallet Transaction"
method: PATCH
path: "/wallet/{walletId}/transaction/{transactionId}/cancel"
tags: ["Transactions"]
---

# Cancel Wallet Transaction

`PATCH /wallet/{walletId}/transaction/{transactionId}/cancel`

This API method allows the calling application to cancel a Wallet Transaction, identified by a Transaction Id and Wallet Id.

## Path parameters

- `walletId` string, string, required
- `transactionId` string, string, required

## Request body

- EmptyPatchPayload

## Response `200`

OK

- WalletTransactionEntity
  - `walletTransactionId` string, required — Wallet Transaction ID
  - `parentWalletTransactionId` string, nullable, required — Parent Wallet Transaction ID
  - `walletId` string, nullable, required — Wallet ID
  - `reference` string, nullable, required — Calling party's reference to this transaction
  - `identityId` string, nullable, required — The Identity ID responsible for this transaction.
  - `identity` WalletIdentityEntity
    - `identityId` string, required — EES AIR Wallet Identity ID
    - `walletId` string, required — EES AIR Wallet ID
    - `type` string, required — Type of the Identity, list of possible enum values could be defined per Client as part of the Onboarding process.
    - `friendlyName` string, required — Wallet Identity friendly name
    - `value` string, required — Wallet Identity value
    - `safeValue` string, required — Identity Safe Value (e.g. "original value salted and hashed") - safeValue could be than used in external systems like analytics, referencing original identity, provide uniqueness within a retailer, but without exposing sensitive information like card number.
    - `secret` string, required — Wallet Identity secret
    - `dates` DatesEntity, required
      - `start` string, date-time
      - `end` string, date-time
    - `meta` MetaEntity, required
      - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
      - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
    - `state` string, required — Wallet Identity state, list of possible values could be defined and set-up per Client during Onboarding process.
    - `status` 'ACTIVE' | 'DELETED' | 'SUSPENDED' | 'LOST' | 'STOLEN' | 'INACTIVE', required — Identity status
    - `dateCreated` string, date-time, required — Date this identity was created
    - `lastUpdated` string, date-time, required — Date this identity was last updated
    - `mobileWallet` string, required — A url that can be used to add this identity to a mobile wallet (like Apple Wallet and Google Pay)
  - `type` string, nullable, required — Transaction Type, defined per retailer
  - `status` 'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED' | 'FULFILLING' | 'FULFILLED', required — Transaction status
  - `meta` MetaEntity, required
    - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
    - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
  - `state` string, nullable, required — Transaction state
  - `transactionDateTime` string, date-time, required — Transaction date-time in ATOM format.
  - `transactionDateTimeOffset` string, string — The offset of the date-time from UTC in format "+00:00".
  - `expiryDate` string, date-time, nullable, required — Transaction Expiry Timestamp (date-time in ATOM format), when transaction should expiry and automatically be settled.
  - `accounts` object[], required
    - `accountId` string, required — Account ID
    - `accountTransactionId` string, required — Account Transaction ID
  - `basket` union, required
    - StandardBasketEntity
      - `type` 'STANDARD', required
      - `summary` object
        - `totalItems` integer, required — Basket Items count
        - `totalBasketValue` integer, required — Total Basket monetary Value after discounts, denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`)
        - `totalDiscountAmount` object
          - `promotions` integer, nullable — Promotions Discount Amount. If basket adjustment adds to discounts, this amount will be added to
          - `staff` integer, nullable — Staff Discount Amount
          - `general` integer, nullable — General Discount Amount
        - `totalQualifyingAmount` object, nullable
          - `points` integer — Basket Monetary Value for Loyalty Points calculations
          - `baseEarn` integer — Basket Monetary Value used for calculating base earn, overriding totalBasketValue. Adheres to basket discounts
          - `promotions` integer — Basket Monetary Value for Promotion Offer selections
          - `discount` integer — Basket Monetary Value for Discount calculations
          - `staff` integer — Basket Monetary Value for Staff Discount or Promotions
        - `totalTaxAmount` integer — Total Tax Amount denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`)
        - `adjustmentRules` AdjustmentRulesEntity
          - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
          - `externalAdjustmentReason` string — The reason for externalAdjustment
          - `ignore` boolean — Ignore object as if not sent
        - `redemptionChannel` string, string — The redemption channel used for this request
      - `contents` object[], nullable
        - `sku` string, string — Item SKU
        - `upc` string, string — Item SKU
        - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag
        - `description` string, string — Product Name
        - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit
        - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH' — The metric in which the item is measure (nullable)
        - `itemUnitCount` number — Item Quantity
        - `itemUnitDiscount` integer — Discount per Item
        - `totalUnitCost` integer — Total cost for this item
        - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts)
        - `taxRate` number, float — Tax Rate (Percentage)
        - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit
        - `qualifies` object, nullable
          - `discount` boolean, required — Determines if the item is eligible for basket level discounting. If false this item will not qualify for basket level discounts but still qualify for product level discounts. However this is possible to override based on the ‘ignorePreviousExcludes’ key on a campaign.
          - `points` boolean, required — Determines if the item is eligible for Base Earn points. If false this item will not qualify for Base Earn points but still qualify for basket and product level discounts.
        - `meta` MetaEntity
          - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
          - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
        - `adjustmentRules` AdjustmentRulesEntity
          - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
          - `externalAdjustmentReason` string — The reason for externalAdjustment
          - `ignore` boolean — Ignore object as if not sent
        - `relatedContents` object[] — Recursive list of contents related to the parent item with the same schema as this object.
          - `sku` string, string — Item SKU
          - `upc` string, string — Item SKU
          - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag
          - `description` string, string — Product Name
          - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit
          - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' — The metric in which the item is measure (nullable)
          - `itemUnitCount` number — Item Quantity
          - `itemUnitDiscount` integer — Discount per Item
          - `totalUnitCost` integer — Total cost for this item
          - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts)
          - `taxRate` number, float — Tax Rate (Percentage)
          - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit
          - `qualifies` object, nullable
            - `discount` boolean, required — Determines if the item is eligible for basket level discounting. If false this item will not qualify for basket level discounts but still qualify for product level discounts. However this is possible to override based on the ‘ignorePreviousExcludes’ key on a campaign.
            - `points` boolean, required — Determines if the item is eligible for Base Earn points. If false this item will not qualify for Base Earn points but still qualify for basket and product level discounts.
          - `meta` MetaEntity
            - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
            - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
          - `adjustmentRules` AdjustmentRulesEntity
            - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
            - `externalAdjustmentReason` string — The reason for externalAdjustment
            - `ignore` boolean — Ignore object as if not sent
          - `relatedContents` unknown
      - `payment` object[], nullable
        - `tenderType` string, string, required — Tender type - predefined by Eagle Eye
        - `amount` integer, required — Monetary amount of payment in lowest unit of currency
        - `bin` string, string — The bin for the tender
        - `identifier` string, string — An identifying value of what was scanned, could be a token, barcode, gift-card
    - EnrichedBasketEntity
      - `type` 'ENRICHED', required
      - `summary` object, required
        - `totalItems` integer, required — Basket Items count
        - `totalBasketValue` integer, required — Total Basket monetary Value after discounts, denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`)
        - `totalQualifyingAmount` object, nullable
          - `points` integer, nullable — Basket Monetary Value for Loyalty Points calculations
          - `baseEarn` integer — Basket Monetary Value used for calculating base earn, overriding totalBasketValue. Adheres to basket discounts
          - `promotions` integer, nullable — Basket Monetary Value for Promotion Offer selections
          - `discount` integer, nullable — Basket Monetary Value for Discount calculations
          - `staff` integer, nullable — Basket Monetary Value for Staff Discount or Promotions
        - `totalTaxAmount` integer, nullable — Total Tax Amount denominated to a smallest currency unit (e.g. for `USD` this value should be provided in `cents`)
        - `totalDiscountAmount` object
          - `promotions` integer, nullable — Promotions Discount Amount. If basket adjustment adds to discounts, this amount will be added to
          - `staff` integer, nullable — Staff Discount Amount
          - `general` integer, nullable — General Discount Amount
        - `fulfilledBaseEarn` object[] — Records the base earn points rewarded to customer during mid fulfil requests.
          - `targetedAccountId` string, string — EES AIR Account ID.
          - `points` integer — Total value of base earn points rewarded.
        - `adjustmentRules` AdjustmentRulesEntity
          - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
          - `externalAdjustmentReason` string — The reason for externalAdjustment
          - `ignore` boolean — Ignore object as if not sent
        - `tenderResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'createRedeem' — Operation Type
          - `value` integer — Operation Amount
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccountIds` string[]
          - `targetedAccountId` string, string — EES AIR Account ID
          - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
          - `multiItem` string[]
          - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency
        - `adjustmentResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'createRedeem' — Operation Type
          - `value` integer — Operation Amount
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccountIds` string[]
          - `targetedAccountId` string, string — EES AIR Account ID
          - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
          - `multiItem` string[]
          - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency
          - `totalMatchingUnits` integer — The number of products the adjustment was applied to
          - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account
        - `bounceBackResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Campaign Id
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem'
          - `value` integer — Value of transaction
          - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
            - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero.
            - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero.
            - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0.
            - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0.
            - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
            - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
          - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccounts` string[]
          - `targetAccountId` string, string — EES AIR Account ID
        - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it
          - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification
          - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification
          - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate
        - `adjudicationResults` object[]
          - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type
          - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive)
          - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
            - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero.
            - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero.
            - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0.
            - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0.
            - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
            - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
          - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccounts` string[]
          - `targetedAccountId` string, string — EES AIR Account ID
          - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer
        - `results` EnrichedBasketSummaryResultsEntity
          - `points` object
            - `spend` integer — Total value of points spent during transaction
            - `debit` integer — Total value of points debited during transaction
            - `refund` integer — Total value of points clawed-back during refund transaction
            - `totalPointsTaken` integer — Sum of all negative balance actions (spend + debit + refund)
            - `earn` integer — Total value of points earned during transaction
            - `credit` integer — Total value of points credited during transaction
            - `totalPointsGiven` integer — Sum of all positive balance actions (earn + credit)
            - `totalMonetaryValue` integer — Monetary value of points using Scheme rules
            - `redemptionChannel` string, string — The redemption channel used for this request
        - `redemptionChannel` string, string — The redemption channel used for this request
      - `contents` object[], nullable
        - `sku` string, string — Item SKU
        - `upc` string, string — Item SKU
        - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag
        - `description` string, string — Product Name
        - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit
        - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' | 'EACH' — The metric in which the item is measure (nullable)
        - `itemUnitCount` number — Item Quantity
        - `itemFulfilmentCount` number, nullable — Number Of Items Fulfilled
        - `itemUnitDiscount` integer — Discount per Item
        - `totalUnitCost` integer — Total cost for this item
        - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts)
        - `taxRate` number, float — The rate of tax being applied to this item (percentage)
        - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit
        - `qualifies` object, nullable
          - `discount` boolean, required — Determines if the item is eligible for discounting
          - `points` boolean, required — Determines if the item is eligible for points
        - `meta` MetaEntity
          - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
          - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
        - `adjustmentRules` AdjustmentRulesEntity
          - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
          - `externalAdjustmentReason` string — The reason for externalAdjustment
          - `ignore` boolean — Ignore object as if not sent
        - `adjustmentResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'createRedeem' — Operation Type
          - `value` integer — Operation Amount
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccountIds` string[]
          - `targetedAccountId` string, string — EES AIR Account ID
          - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
          - `multiItem` string[]
          - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency
          - `totalMatchingUnits` integer — The number of products the adjustment was applied to
          - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account
        - `tenderResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'createRedeem' — Operation Type
          - `value` integer — Operation Amount
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccountIds` string[]
          - `targetedAccountId` string, string — EES AIR Account ID
          - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
          - `multiItem` string[]
          - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency
        - `bounceBackResults` object[]
          - `resourceType` 'CAMPAIGN' — EES Resource Type
          - `resourceId` string, string — EES AIR Campaign Id
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem'
          - `value` integer — Value of transaction
          - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
            - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero.
            - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero.
            - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0.
            - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0.
            - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
            - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
          - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccounts` string[]
          - `targetAccountId` string, string — EES AIR Account ID
        - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it
          - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification
          - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification
          - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate
        - `contributionResults` object[], nullable — If an offer was spend £30 get £5 off, this entity would be against each of the products contributing to the £5 off, with their combined `value`s adding up to the £5.
          - `value` integer — The proportional contribution to the discount/points given
          - `instanceId` string, string — The reference back to the offer which these items contributed
        - `adjudicationResults` object[]
          - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type
          - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
          - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
          - `success` boolean, nullable
          - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type
          - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive)
          - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
            - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero.
            - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero.
            - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0.
            - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0.
            - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
            - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0.
            - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0.
          - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
          - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
          - `relatedAccounts` string[]
          - `targetAccountId` string, string — EES AIR Account ID
          - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer
        - `relatedContents` object[] — Recursive list of contents related to the parent item with the same schema as this object.
          - `sku` string, string — Item SKU
          - `upc` string, string — Item SKU
          - `salesKey` 'SALE' | 'REFUND' | 'FULFIL' — `SALE`/`REFUND`/`FULFIL` Flag
          - `description` string, string — Product Name
          - `itemUnitCost` integer — Item Price per unit, denominated to a smaller currency unit
          - `itemUnitMetric` 'LITRES' | 'GRAMS' | 'MILLILITERS' | 'KILOGRAMS' | 'POUNDS' | 'OUNCES' | 'PIECE' — The metric in which the item is measure (nullable)
          - `itemUnitCount` number — Item Quantity
          - `itemFulfilmentCount` number, nullable — Number Of Items Fulfilled
          - `itemUnitDiscount` integer — Discount per Item
          - `totalUnitCost` integer — Total cost for this item
          - `totalUnitCostAfterDiscount` integer — Total cost for this item after discount (please note this does not take into account whole basket discounts)
          - `taxRate` number, float — The rate of tax being applied to this item (percentage)
          - `taxAmount` integer — Tax Amount for that item, denominated to a smallest currency unit
          - `qualifies` object, nullable
            - `discount` boolean, required — Determines if the item is eligible for discounting
            - `points` boolean, required — Determines if the item is eligible for points
          - `meta` MetaEntity
            - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value
            - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value
          - `adjustmentRules` AdjustmentRulesEntity
            - `externalAdjustment` boolean — If the object (summary/basket item) has been modified by the POS at all with information we don't know about
            - `externalAdjustmentReason` string — The reason for externalAdjustment
            - `ignore` boolean — Ignore object as if not sent
          - `adjustmentResults` object[]
            - `resourceType` 'CAMPAIGN' — EES Resource Type
            - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
            - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
            - `success` boolean, nullable
            - `type` 'redeem' | 'createRedeem' — Operation Type
            - `value` integer — Operation Amount
            - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
            - `relatedAccountIds` string[]
            - `targetedAccountId` string, string — EES AIR Account ID
            - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
            - `multiItem` string[]
            - `totalDiscountAmount` integer — The monetary effect of the discount in the lowest unit of currency
            - `totalMatchingUnits` integer — The number of products the adjustment was applied to
            - `instanceId` string, string — A mechanism to distinguish each individual reward that has been given for any account
          - `tenderResults` object[]
            - `resourceType` 'CAMPAIGN' — EES Resource Type
            - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
            - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
            - `success` boolean, nullable
            - `type` 'redeem' | 'createRedeem' — Operation Type
            - `value` integer — Operation Amount
            - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
            - `relatedAccountIds` string[]
            - `targetedAccountId` string, string — EES AIR Account ID
            - `targetedWalletId` string, string, nullable — EES AIR Wallet ID. Nullable
            - `multiItem` string[]
            - `totalTenderAmount` integer — The amount of tender value in the lowest unit of currency
          - `bounceBackResults` object[]
            - `resourceType` 'CAMPAIGN' — EES Resource Type
            - `resourceId` string, string — EES AIR Campaign Id
            - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
            - `success` boolean, nullable
            - `type` 'redeem'
            - `value` integer — Value of transaction
            - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
              - …
            - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
            - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
            - `relatedAccounts` string[]
            - `targetAccountId` string, string — EES AIR Account ID
          - `qualifiesResults` object[] — If an offer was buy a pizza and get a free garlic bread, the pizza would have this entity against it
            - `totalMatchingUnits` integer — The number of products forming part of the offer's qualification
            - `totalMatchingSpend` integer — The monetary value this product contributes towards the offer's qualification
            - `instanceId` string, string — The reference back to the offer reward which these qualifiers relate
          - `adjudicationResults` object[]
            - `resourceType` 'CAMPAIGN' | 'PROGRAMME' | 'SCHEME' — EES Resource Type
            - `resourceId` string, string — EES AIR Resource ID (Campaign ID, Programme ID, Scheme ID)
            - `playOrderPosition` integer, nullable — The exact position the offer was triggered during analysis
            - `success` boolean, nullable
            - `type` 'redeem' | 'credit' | 'debit' | 'earn' | 'spend' — Operation Type
            - `value` integer — Operation Amount (please note: value and balances attributes are mutually exclusive)
            - `balances` AccountBalancesEntity — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.
              - …
            - `isRefundable` boolean — Boolean Flag indicating if this offer should be refundable
            - `isUnredeemable` boolean — Boolean Flag indicating if this offer should be Unredeemable
            - `relatedAccounts` string[]
            - `targetAccountId` string, string — EES AIR Account ID
            - `totalMatchingUnits` integer, nullable — The minimum number of products required to trigger offer
          - `relatedContents` unknown
      - `payment` object[], nullable — Similar to standardPaymentEntity, except that any _tender_ offers used during adjustment, have an entry injected here, stipulating the tender amount to take off basket
        - `tenderType` string, string, required — Tender type - predefined by Eagle Eye, including a further type of _tenderCoupon_
        - `amount` integer, required — Monetary amount of payment/tender in lowest unit of currency
        - `bin` string, string — The bin for the tender
        - `identifier` string, string — An identifying value of what was scanned, could be a token, barcode, gift-card
        - `accountId` string, string — The EE AIR Account ID (only populated when tender is owned by EE)
      - `analysedDateTime` string, ees-date-time — Basket Analysis Date-Time in ATOM format
  - `channel` string, required — Channel used for Transaction creation or update
  - `location` LocationResponseEntity, required
    - `storeId` string, string — The Incoming Identifier of the Outlet.
    - `storeParentId` string, string — The Incoming Identifier of the Outlet's Parent Unit.
  - `dateCreated` string, date-time, required — Date this Wallet Transaction was created
  - `lastUpdated` string, date-time, required — Date this Wallet Transaction was last updated

## Other responses

- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not Found.
- `409` — Conflict
- `415` — Unsupported Media Type
- `423` — Locked
- `429` — Too Many Requests
- `500` — Server Error

---

[API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/revisions/90a122bb14cc/schema)