# Eagle Eye Documentation > Eagle Eye's API documentation provides up to date information for the AIR platform. ## Guides: Eagle Eye AIR OVERVIEW - [AIR Concepts](https://developer.eagleeye.com/eagleeye-developer/docs/air-concepts.md) - [AIR Data Lifecycle Policy](https://developer.eagleeye.com/eagleeye-developer/docs/data-lifecycle-policy.md) - [Account Data Structures](https://developer.eagleeye.com/eagleeye-developer/docs/account-data-structures.md) - [Wallets](https://developer.eagleeye.com/eagleeye-developer/docs/wallets-1.md) - [Wallet Householding](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-householding.md) - [Wallet Data Entities: Wallets](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-data-entities-wallets.md) - [Wallet Data Entities: Wallet Identities](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-data-entities-identities.md) - [Wallet Data Entities: Wallet Transactions](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-data-entities-wallet-transactions.md) - [Wallet Data Entities: Consumer Record](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-data-entities-consumer-record.md) - [Campaigns](https://developer.eagleeye.com/eagleeye-developer/docs/campaigns.md) - [Schemes](https://developer.eagleeye.com/eagleeye-developer/docs/schemes.md) - [Programmes](https://developer.eagleeye.com/eagleeye-developer/docs/programmes.md) - [Tokens](https://developer.eagleeye.com/eagleeye-developer/docs/tokens.md) - [Tags](https://developer.eagleeye.com/eagleeye-developer/docs/tags.md) - [Glossary of Terms](https://developer.eagleeye.com/eagleeye-developer/docs/glossary-of-terms.md) ## Guides: Core Products - [Real Time Loyalty](https://developer.eagleeye.com/eagleeye-developer/docs/real-time-loyalty.md) - [Customer Wallet](https://developer.eagleeye.com/eagleeye-developer/docs/customer-wallet.md) - [Loyalty Ledger & Tiers](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-ledger.md) - [Loyalty Earn](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-earn.md) - [Loyalty Burn](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-burn.md) - [Customer Care](https://developer.eagleeye.com/eagleeye-developer/docs/customer-care.md) - [Real-Time Loyalty Reporting](https://developer.eagleeye.com/eagleeye-developer/docs/real-time-loyalty-reporting.md) - [Customer Care](https://developer.eagleeye.com/eagleeye-developer/docs/customer-care-for-promotions.md) - [Real-time Promotions Reporting](https://developer.eagleeye.com/eagleeye-developer/docs/real-time-promotions-reporting.md) - [Smart Rewards](https://developer.eagleeye.com/eagleeye-developer/docs/cloud-based-adjudication.md) - [POS Integration](https://developer.eagleeye.com/eagleeye-developer/docs/pos-integration.md) - [Ordering and Stacking Rules](https://developer.eagleeye.com/eagleeye-developer/docs/ordering-and-stacking-rules.md) - [Multi Banner Redemption](https://developer.eagleeye.com/eagleeye-developer/docs/multi-banner-redemption.md) - [Events and Reporting](https://developer.eagleeye.com/eagleeye-developer/docs/events-and-reporting.md) ## Guides: Best Practices - [Campaign Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-best-practices.md) - [Campaign Features](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-features.md) - [Points Campaigns Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/points-campaigns.md) - [Discounts Campaigns Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/discounts-campaigns.md) - [Alternative Campaigns Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/alternative-campaigns.md) - [Spend Rate Modifier Campaigns](https://developer.eagleeye.com/eagleeye-developer/docs/spend-rate-modifier-campaigns.md) - [Which Campaign Should I Choose - Types & Offers](https://developer.eagleeye.com/eagleeye-developer/docs/which-campaign.md) - [Campaigns via API](https://developer.eagleeye.com/eagleeye-developer/docs/campaigns-api.md) - [Creating Campaigns via API - Types & Offers](https://developer.eagleeye.com/eagleeye-developer/docs/campaigns-create-via-api.md) - [Campaigns API - The Rest of the Payload](https://developer.eagleeye.com/eagleeye-developer/docs/campaigns-api-the-rest.md) - [Using PATCH and PUT /campaigns](https://developer.eagleeye.com/eagleeye-developer/docs/using-patch-and-put-campaigns.md) - [Loyalty Tiers Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-tiers-best-practices.md) - [POS Connect Best Practices](https://developer.eagleeye.com/eagleeye-developer/docs/pos-connect-best-practices.md) - [POS Connect Best Practices: Adjudication](https://developer.eagleeye.com/eagleeye-developer/docs/pos-connect-best-practices-adjudication.md) - [POS Connect Best Practices: Settle](https://developer.eagleeye.com/eagleeye-developer/docs/pos-connect-best-practices-settle.md) - [POS Connect Best Practices: Spend](https://developer.eagleeye.com/eagleeye-developer/docs/pos-connect-best-practices-spend.md) - [POS Connect Best Practices: Refund](https://developer.eagleeye.com/eagleeye-developer/docs/pos-connect-best-practices-refund.md) - [Scheme Features](https://developer.eagleeye.com/eagleeye-developer/docs/scheme-features.md) - [Scheme Details](https://developer.eagleeye.com/eagleeye-developer/docs/scheme-details.md) - [Scheme Services](https://developer.eagleeye.com/eagleeye-developer/docs/scheme-services.md) - [Scheme Rates](https://developer.eagleeye.com/eagleeye-developer/docs/scheme-rates.md) - [Standard Configurations](https://developer.eagleeye.com/eagleeye-developer/docs/standard-configurations.md) - [SFTP Folders: Standard Configurations](https://developer.eagleeye.com/eagleeye-developer/docs/sftp-folders-standard-configurations.md) - [Tracking Coupon Accounts using UTM](https://developer.eagleeye.com/eagleeye-developer/docs/tracking-coupon-accounts.md) ## Guides: Technical Specifications - [Open API Specifications](https://developer.eagleeye.com/eagleeye-developer/docs/air-specifications.md) - [Postman Collections](https://developer.eagleeye.com/eagleeye-developer/docs/postman-collections.md) - [Authentication and Connectivity](https://developer.eagleeye.com/eagleeye-developer/docs/authentication.md) - [API Authentication](https://developer.eagleeye.com/eagleeye-developer/docs/api-authentication.md) - [Dashboard Authentication](https://developer.eagleeye.com/eagleeye-developer/docs/air-dashboard-authentication.md) - [Backend Points](https://developer.eagleeye.com/eagleeye-developer/docs/backend-points.md) - [Offer Allocation Ingestion](https://developer.eagleeye.com/eagleeye-developer/docs/offer-allocation-ingestion.md) - [Product and Groups Ingestion](https://developer.eagleeye.com/eagleeye-developer/docs/product-and-groups-ingestion.md) - [Recommendation Ingestion](https://developer.eagleeye.com/eagleeye-developer/docs/recommendation-ingestion.md) - [Store Ingestion](https://developer.eagleeye.com/eagleeye-developer/docs/store-ingestion.md) - [Third Party Codes Ingestion](https://developer.eagleeye.com/eagleeye-developer/docs/third-party-codes-ingestion.md) - [Events/Notifications and Webhooks](https://developer.eagleeye.com/eagleeye-developer/docs/notifications-and-webhooks.md) - [Event Use Cases](https://developer.eagleeye.com/eagleeye-developer/docs/events-use-cases.md) - [Account Transaction Events](https://developer.eagleeye.com/eagleeye-developer/docs/notifications-events.md) - [Account Transaction Events Delivery Methods](https://developer.eagleeye.com/eagleeye-developer/docs/account-transaction-events-delivery-methods.md) - [Atomic Operation Events](https://developer.eagleeye.com/eagleeye-developer/docs/atomic-operation-events.md) - [Event Data Structures](https://developer.eagleeye.com/eagleeye-developer/docs/event-data-structures.md) - [Using Atomic Operations](https://developer.eagleeye.com/eagleeye-developer/docs/using-atomic-operations.md) - [Event Definitions](https://developer.eagleeye.com/eagleeye-developer/docs/event-definitions.md) - [Atomic Operation Event Delivery Methods](https://developer.eagleeye.com/eagleeye-developer/docs/atomic-operation-event-delivery-methods.md) - [Platform Overview](https://developer.eagleeye.com/eagleeye-developer/docs/air-technical-overview.md) - [Hosting & Infrastructure](https://developer.eagleeye.com/eagleeye-developer/docs/hosting-infrastructure.md) - [IP Address Ranges](https://developer.eagleeye.com/eagleeye-developer/docs/ip-address-ranges.md) - [Security](https://developer.eagleeye.com/eagleeye-developer/docs/security.md) - [Resilience & Availability](https://developer.eagleeye.com/eagleeye-developer/docs/resilience-availability.md) - [Scalability & Performance](https://developer.eagleeye.com/eagleeye-developer/docs/scalability-performance.md) - [Platform Fair Usage Guidelines](https://developer.eagleeye.com/eagleeye-developer/docs/platform-fair-usage-guidelines.md) ## Guides: Integrations - [Data Analytics Integration](https://developer.eagleeye.com/eagleeye-developer/docs/data-analytics-partner-integration.md) - [CDP and CRM Integrations](https://developer.eagleeye.com/eagleeye-developer/docs/cdp-integrations.md) ## Guides: Eagle Eye Connectors - [Connectors](https://developer.eagleeye.com/eagleeye-developer/docs/eagle-eye-connectors-overview.md) - [Plugins](https://developer.eagleeye.com/eagleeye-developer/docs/connectors-plugins.md) - [Commerce Tools](https://developer.eagleeye.com/eagleeye-developer/docs/commerce-tools.md) - [Ecrebo](https://developer.eagleeye.com/eagleeye-developer/docs/ecrebo.md) - [Odicci Gamification Platform](https://developer.eagleeye.com/eagleeye-developer/docs/odicci-gamification-platform.md) - [Eagle Eye Connect](https://developer.eagleeye.com/eagleeye-developer/docs/ee-connect.md) - [CDP and MAP Connectors](https://developer.eagleeye.com/eagleeye-developer/docs/eagle-eye-connect-cdp-map.md) - [Braze](https://developer.eagleeye.com/eagleeye-developer/docs/braze.md) - [mParticle](https://developer.eagleeye.com/eagleeye-developer/docs/mparticle.md) - [Segment](https://developer.eagleeye.com/eagleeye-developer/docs/segment.md) - [POS and eCommerce Platforms](https://developer.eagleeye.com/eagleeye-developer/docs/pos-ecommerce-platforms.md) - [Oracle Simphony POS](https://developer.eagleeye.com/eagleeye-developer/docs/oracle-simphony-pos.md) - [Zonal](https://developer.eagleeye.com/eagleeye-developer/docs/zonal.md) ## Guides: RECIPES - [Introduction to Technical Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/intro-technical-recipes.md) - [Exchange Points for Rewards Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/exchange-points-for-rewards-recipe.md) - [Gamification](https://developer.eagleeye.com/eagleeye-developer/docs/gamification-recipe.md) - [Real-Time Tender Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/real-time-tender-recipe.md) - [Real-Time Tender with Tiers Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/real-time-tender-tiers-recipe.md) - [Ingredients](https://developer.eagleeye.com/eagleeye-developer/docs/ingredients.md) - [Company, Banner & Store Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/company-banner-store-recipes.md) - [Identity Type Auto Generated Value Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/identity-type-auto-generated-value-recipe.md) - [Identity Type Create Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/identity-type-create-recipe.md) - [Wallet Type Create Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-type-create-recipe.md) - [Campaign Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-recipes.md) - [Campaign Create Recipe - Continuity](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-continuity-receipe.md) - [Campaign Create Recipe - Continuity with a Coupon Reward](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-continuity-with-coupon-reward.md) - [Campaign Create Recipe - Behavioral Action Coupon Reward](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-behavioral-action-coupon-reward.md) - [Campaign Create Recipe - Behavioral Action Points Reward](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-behavioral-action-points-reward.md) - [Campaign Create Recipe - Discount Basket](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-discount-basket-recipe.md) - [Campaign Create Recipe - Discount Products](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-discount-products.md) - [Campaign Create Recipe - Manual](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-manual.md) - [Campaign Create Recipe - Points Fixed](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-points-fixed-recipe.md) - [Campaign Create Recipe - Product Points Multiplier](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-product-points-multiplier-recipe.md) - [Campaign Create Recipe - Quest](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-quest.md) - [Campaign Create Recipe - Stamp Card](https://developer.eagleeye.com/eagleeye-developer/docs/campaign-create-recipe-stamp-card.md) - [Loyalty Points Rules Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-recipes.md) - [Loyalty Points Rules Recipe - Earn & Burn with Points Expiry](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-earn-burn-expiry-recipe.md) - [Loyalty Points Rules Recipe - Earn Only with Points Expiry](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-earn-only-points-expiry-recipe.md) - [Loyalty Points Rules Recipe - Earn Only with Points Expiry & Tiers Enabled](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-earn-only-with-points-expiry-tiers-recipe.md) - [Loyalty Points Rules Recipe - Pending Points](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-recipe-pending-points.md) - [Loyalty Points Rules Recipe - Points Expiry Only](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-points-rules-points-expiry-only-recipe.md) - [Programmes Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/programmes-recipes.md) - [Programme Create Recipe - Multi Use Voucher](https://developer.eagleeye.com/eagleeye-developer/docs/programme-create-recipe-multi-use-voucher.md) - [Programme Create Recipe - Single Use Voucher](https://developer.eagleeye.com/eagleeye-developer/docs/programme-create-recipe-single-use-voucher.md) - [Token Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/token-recipes.md) - [Token Format Create Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/token-format-create-recipe.md) - [Rewards Bank](https://developer.eagleeye.com/eagleeye-developer/docs/rewards-bank.md) - [Personal Reward Bank Create](https://developer.eagleeye.com/eagleeye-developer/docs/personal-reward-bank-create-recipe.md) - [Public Reward Bank Create](https://developer.eagleeye.com/eagleeye-developer/docs/public-reward-bank-create-recipe.md) - [Tier Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/tier-recipes.md) - [Loyalty Tiers Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-tiers-recipe.md) - [Wallet Recipes](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-recipes.md) - [Public Reward Bank Exchange](https://developer.eagleeye.com/eagleeye-developer/docs/public-reward-bank-exchange-recipe.md) - [Personal Reward Bank Link & Exchange](https://developer.eagleeye.com/eagleeye-developer/docs/personal-reward-bank-link-exchange-recipe.md) - [ Behavioral Action Trigger](https://developer.eagleeye.com/eagleeye-developer/docs/behavioral-action-trigger.md) - [Wallet & Coupon Create Recipe](https://developer.eagleeye.com/eagleeye-developer/docs/wallet-coupon-create-recipe.md) - [Loyalty Account Create & Credit](https://developer.eagleeye.com/eagleeye-developer/docs/loyalty-account-create-credit-recipe.md) ## API Reference: Wallet API - Wallets - [Get Wallet by Identity](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletbyidentityvalue.md): This API method allows the calling application to retrieve a Wallet's details for a specific identity. - [Create Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/createwallet.md): This method allows the calling application to create a Wallet within the Eagle Eye Platform. - [Get Wallet by Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletbywalletid.md): This API method allows the calling application to retrieve a Wallet's details by Id. - [Update Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletmainproperties.md): This API method allows the calling application to amend wallet properties. - [Delete Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/deletewallet.md): This API method allows the calling application to delete a Wallet (soft deletion) - [Get Wallet Statistics](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletstats.md): This API method allows the calling application to retrieve a Wallet's stats. Please note set of Statistics should be agreed during Client's onboarding and documented elsewhere. - [Activate Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/activatewallet.md): This API method allows the calling application to activate a wallet. - [Suspend Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/suspendwallet.md): This API method allows the calling application to suspend a wallet. - [Terminate Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/terminatewallet.md): This API method allows the calling application to Terminate a wallet. - [Update Wallet State](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletstate.md): This API method allows the calling application to change a state of a Wallet. - Identities - [Get Wallet Identity by Value](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletidentitybyidentityvalue.md): This API method allows the calling application to retrieve Wallet Identity details by Identity Value - [Get Wallet Identities by Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletidentitiesbywalletid.md): This API method allows the calling application to retrieve Identities for a specific wallet. - [Create Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletidentity.md): This API method allows the calling application to create new Wallet Identity for a specific wallet. - [Get Wallet Identity by Identity Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletidentitybyidentityid.md): This API method allows the calling application to retrieve Wallet Identity details for a specific wallet. - [Update Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentity.md): This API method allows the calling application to update Wallet Identity properties for a specific wallet. - [Delete Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/deletewalletidentity.md): This API method allows the calling application to delete a Wallet Identity for a specific wallet. Please note: this operation can't be undone. - [Suspend Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystatussuspended.md): This API method allows the calling application to mark a Wallet Identity as SUSPENDED (by setting Wallet Identity status equal to SUSPENDED). That change would block this Wallet Identity from being… - [Activate Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystatusactive.md): This API method allows the calling application to mark a Wallet Identity as ACTIVE (by setting Wallet Identity status equal to ACTIVE). That change would allow this Wallet Identity to be used to… - [Update Wallet Identity to Lost](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystatuslost.md): This API method allows the calling application to mark a Wallet Identity as LOST (by setting Wallet Identity status equal to LOST). That change would block this Wallet Identity from being used so it… - [Update Wallet Identity to Stolen](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystatusstolen.md): This API method allows the calling application to mark a Wallet Identity as STOLEN (by setting Wallet Identity status equal to STOLEN) This would block this Wallet Identity from being used so it… - [Change Wallet Identity State](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystate.md): This API method allows the calling application to change a `state` of a Wallet Identity. - [Terminate Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletidentitystateterminate.md): This API method allows the calling application to Terminate a Wallet Identity. TERMINATED is a final state and once set this value can not be re-used or recovered. - [Move Wallet Identity](https://developer.eagleeye.com/eagleeye-developer/reference/movewalletidentity.md): This API method allows the calling application to move a Wallet Identity from the Source Wallet Id to the Destination Wallet Id in the payload. - Accounts - [Create Coupon Account](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletcampaignaccount.md): This API method allows the calling application to create a coupon account and place into the corresponding wallet. - [Create Multiple Coupon Accounts](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletcampaignsaccounts.md): This API method allows the calling application to create one or many coupon accounts and place into the corresponding wallet. This API is considered a bulk action API so the user should consider… - [Create Programme Account](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletprogrameaccount.md): This API method allows the calling application to create a programme stored value account and place into the corresponding wallet. - [Create Loyalty Points Account](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletschemeaccount.md): This API method allows the calling application to create a loyalty scheme points account and place into the corresponding wallet. - [Create Subscription Account](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletplanaccount.md): This API method allows the calling application to create a Subscription Account with Entitlement Accounts (arisen from supplied Plan definition) and place them into the corresponding Wallet. - [Create Entitlement Coupon](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletentitlementcouponaccount.md): This API method allows the calling application to create a new Entitlement Account (of type COUPON) and link it to existing Subscription Account, identified by `parentAccountId` - [Get Wallet Accounts by Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccountsbywalletid.md): This API method allows the calling application to retrieve a list of Wallet Accounts for a Wallet, identified by Wallet Id. - [Get Wallet Accounts by Identity Value](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccountsbyidentityvalue.md): This API method allows the calling application to retrieve a list of Wallet Accounts, for a Wallet identified by Wallet Identity Value. - [Get Single Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccount.md): This API method allows the calling application to retrieve details for a Wallet Account. - [Update Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletaccount.md): This API method allows the calling application to modify a Wallet Account. - [Credit Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/creditwalletaccount.md): This API method allows the calling application to credit a Wallet Account. Currently available for POINTS and CONTINUITY accounts, along with all Stored Value accounts. - [Earn Loyalty Points](https://developer.eagleeye.com/eagleeye-developer/reference/earnpoints.md): This API method allows the calling application to credit Points into Wallet Account and create a Wallet Account Transaction (with `event=EARN`) within EES AIR. Currently available for POINTS accounts… - [Debit Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/debitwalletaccount.md): This API method allows the calling application to debit a Wallet Account and create appropriate Account Transaction. Currently available for POINTS and CONTINUITY accounts, along with all Stored… - [Load Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/loadwalletaccount.md): This API method allows the calling application to load a Wallet Account. Currently available for Stored Value account types. If the account is INACTIVE, the load will activate it by default. - [Redeem Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/redeemwalletaccount.md): This API method allows the calling application to redeem a Coupon using a Wallet Account. Currently available for ECOUPON and CONTINUITY accounts. - [Void Wallet Account Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/voidwalletaccounttransaction.md): This API method allows the calling application to void the specified Wallet Account Transaction. Currently only applicable for CONTINUITY and POINTS accounts, along with all stored value accounts. - [Inactivate Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/inactivatewalletaccount.md): This API method allows the calling application to inactivate the specified Wallet Account. Currently available for CONTINUITY accounts. - [Activate Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/activatewalletaccount.md): This API method allows the calling application to activate a specified Wallet Account. Currently available for COUPON, CONTINUITY, POINTS and STANDARD_SUBSCRIPTION accounts. Please note this… - [Cancel Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/cancelwalletaccount.md): This API method allows the calling application to cancel a specified account. Currently available for ECOUPON, CONTINUITY and STANDARD_SUBSCRIPTION. Please note a) this operation will cancel… - [Block Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/blockwalletaccount.md): This API method allows the calling application to block a specified Wallet Account. Currently available for STANDARD_SUBSCRIPTION, ECOUPON, VOUCHER, DEBIT and PLASTIC accounts. Please note: a) this… - [Unblock Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/unblockwalletaccount.md): This API method allows the calling application to unblock an Account. Currently available for STANDARD_SUBSCRIPTION, ECOUPON, VOUCHER, DEBIT and PLASTIC Accounts. Please note: a) this operation will… - [Retrieve Available Loyalty Points](https://developer.eagleeye.com/eagleeye-developer/reference/walletaccountpointsavailable.md): This API method allows calling applications to retrieve detailed information about how a customers points will expire. This end point is only applicable to schemes where Points Expiry is enabled. The… - [Calculate Points to be Earned](https://developer.eagleeye.com/eagleeye-developer/reference/calculatepointstobeearned.md): This API method allows the calling application to request an amount of points calculation (how much points should be credited for that `potential transaction`). EES AIR will use Scheme Earn… - [Refresh Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/refreshwalletaccount.md): This API method allows the calling application to bring a Subscription Account Entitlement Accounts within a particular wallet up to date with current setup of plan and campaigns. - [Move Account into a Wallet](https://developer.eagleeye.com/eagleeye-developer/reference/moveaccounttowallet.md): This API method allows the calling application to move an Account into a requested Wallet. Please note: currently this endpoint supports an `ACTIVE` Account move of type `COUPON` and initially… - [Get Household Points Balances](https://developer.eagleeye.com/eagleeye-developer/reference/getwallethouseholdbalances.md): This API method allows the calling application to retrieve the household balances from points accounts across a household of Wallets. If enabled, and set to HOUSEHOLD mode, the Tier Membership and… - [Top-up Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/topupwalletaccount.md): This API method allows the calling application to top-up a Stored Value Wallet Account. A request to top-up an INACTIVE account will fail. A request to top-up with a value of zero will be accepted.… - [Unredeem Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/unredeemwalletaccount.md): This API method allows the calling application to unredeem a Wallet Account. Currently available for ECOUPON and CONTINUITY accounts. - [Refund Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/refundwalletaccount.md): This API method allows the calling application to refund a Wallet Account. Currently available for Stored Value. - [Verify Wallet Account](https://developer.eagleeye.com/eagleeye-developer/reference/verifywalletaccount.md): This API method allows the calling application to verify a transaction against the specified Wallet Account. - [Spend Loyalty Points](https://developer.eagleeye.com/eagleeye-developer/reference/spendloyaltypoints.md): This API method allows the calling application to spend accumulated points. Please note a) this endpoint could be used only for Point Accounts b) this endpoint also allows to adjust other than… - [Change Wallet Account State](https://developer.eagleeye.com/eagleeye-developer/reference/changewalletaccountstate.md): This API method allows the calling application to modify a Wallet Account state. - [Change State of Multiple Accounts](https://developer.eagleeye.com/eagleeye-developer/reference/changestateofmultipleaccounts.md): This API method allows the calling application to modify the State of multiple Accounts in a Wallet - [Get Wallet Account Stats](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccountstats.md): Get statistics for wallet account - [Credit Goodwill Points](https://developer.eagleeye.com/eagleeye-developer/reference/creditgoodwillpoints.md): This API method allows the calling application to Credit a Goodwill Points to a points Wallet Account. Please note Goodwill rules has to be defined for a Scheme. - Account Transactions - [Get Account Transactions](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccounttransactions.md): This API method allows the calling application to retrieve a paginated list of Wallet Account Transactions for a specific Wallet Account. - [Get Account Transactions By Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaccounttransactionsbyid.md): This API method allows the calling application to retrieve a specific Account Transaction for a Wallet Account. - Consumers - [Create Wallet Consumer](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletconsumer.md): This API method allows the calling application to create a new Wallet Consumer for a Wallet, identified by a Wallet ID. Please note there could be only one ACTIVE Wallet Consumer per Wallet. - [Get Wallet Consumer by Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletconsumer.md): This API method allows the calling application to retrieve Wallet Consumer details for a specific Wallet - [Get Wallet Consumer by Wallet and Consumer Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletconsumerbyconsumerid.md): This API method allows the calling application to get the Wallet Consumer details for a Wallet. Please note Wallet Consumer Data structure could be defined within AIR per Client. If this structure is… - [Update Wallet Consumer](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletconsumer.md): This API method allows the calling application to update the Wallet Consumer details for a Wallet. Please note Wallet Consumer Data structure could be defined within AIR per Client. If this structure… - [Delete Wallet Consumer](https://developer.eagleeye.com/eagleeye-developer/reference/deletewalletconsumer.md): This API method allows the calling application to delete a Wallet Consumer - [Update Wallet Consumer Data](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletconsumerdataoperation.md): This API method allows the calling application to update the Wallet Consumer Data details for a Wallet using approach described in RFC 6902. Please note: #1 only consumer data sub-structure could be… - [Update Wallet Consumer State](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletconsumerstate.md): This API method allows the calling application to change the State of a Wallet Consumer - Relationships - [Create Child Wallet Relationship](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletchildrelation.md): This API method allows the calling application to set up a child relationship between the wallets, Wallet {walletId} will become a child of the Wallet {relationshipWalletId} - [Create Associate Wallet Relationship](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletassociaterelation.md): This API method allows the calling application to set up an associate relationship between the wallets, Wallet {walletId} will become an associate of of the Wallet {relationshipWalletId} - [Create Donor Wallet Relationship](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletdonorrelation.md): This API method allows the calling application to set up a donor relationship between two wallets, Wallet identified by the {walletId} will become a donor for a Wallet identified by… - [Remove Wallet Relationship](https://developer.eagleeye.com/eagleeye-developer/reference/splitwalletrelation.md): This API method allows the calling application to remove any relationship between two wallets. Please note that only child, associate and donor relations could be removed, if you want to remove… - [Move Wallet Relationship](https://developer.eagleeye.com/eagleeye-developer/reference/movewalletrelations.md): This API method allows the calling application to move any relationship(s) from a Wallet, identified by {oldRelationshipWalletId} into another Wallet, identified by {newRelationshipWalletId}. Please… - Transactions - [Get Wallet Transactions](https://developer.eagleeye.com/eagleeye-developer/reference/getwallettransactions.md): This API method allows the calling application to retrieve a paginated list of Transactions for a specific wallet. - [Get Wallet Transaction By Reference](https://developer.eagleeye.com/eagleeye-developer/reference/getwallettransactionbyreference.md): This API endpoint allows the calling application to retrieve Wallet Transaction details by unique Reference (provided during Wallet Transaction creation). - [Get Wallet Transaction by Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwallettransactionbyid.md): This API method allows the calling application to get a Wallet Transaction details by a Wallet Transaction Id - [Update Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransaction.md): This API method allows the calling application to update existing Wallet Transaction details, identified by a Wallet Transaction Id and Wallet Id. - [Delete Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/deletewallettransaction.md): This API method allows the calling application to delete a Wallet Transaction - [Get Wallet Transaction History](https://developer.eagleeye.com/eagleeye-developer/reference/getwallettransactionhistory.md): This API method allows the calling application to get the history of a Wallet Transaction. - [Update Wallet Transaction State](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransactionstate.md): This API method allows the calling application to update existing Wallet Transaction state. - [Settle Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransactionsettle.md): This API method allows the calling application to settle a Wallet Transaction, identified by a Wallet Transaction Id and Wallet Id. - [Cancel Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/cancelwallettransaction.md): This API method allows the calling application to cancel a Wallet Transaction, identified by a Transaction Id and Wallet Id. - [Expire Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransactionexpire.md): This API method allows the calling application to expire a Wallet Transaction, identified by a Transaction Id and Wallet Id. - [Release Pending Points](https://developer.eagleeye.com/eagleeye-developer/reference/pendingpointsrelease.md): This API method allows the calling application to release all pending points credited against a Wallet Transaction, identified by a Wallet Transaction Id and Wallet Id. Any non-pending point account… - [Reject Pending Points](https://developer.eagleeye.com/eagleeye-developer/reference/pendingpointsreject.md): This API method allows the calling application to reject all pending points credited against a Wallet Transaction, identified by a Wallet Transaction Id and Wallet Id. Any non-pending point account… - [Create Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/createwallettransaction.md): This API method allows the calling application to create a transaction against a specific wallet. - Invites - [Get Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletinvite.md): This API method allows the calling application to retrieve the Wallet Invite details by the Wallet Invitation GUID. - [Get Wallet Invite by Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletinvitesbywalletid.md): This API method allows the calling application to retrieve the list of Invites for a specific wallet. - [List Wallet Invites](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletinvites.md): This API method allows the calling application to retrieve all invites using either the GUID or reference (or both). - [Create Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletinvite.md): This API method allows the calling application to create new Wallet Invite for a specific wallet. - [Get Wallet Invite by Invite Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletidbyinviteid.md): This API method allows the calling application to retrieve specific Wallet Invite for a specific Wallet. - [Update Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletinvite.md): This API method allows the calling application to update a Wallet Invite for a specific Wallet. - [Verify Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/verifywalletinvite.md): This API method allows the calling application to verify an existing Wallet Invite identified by the Wallet Invitation GUID. - [Accept Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/acceptwalletinvite.md): This API method allows the calling application to accept a Wallet Invite. - [Cancel Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/cancelwalletinvite.md): This API method allows the calling application to cancel a wallet invite. - [Reject Wallet Invite](https://developer.eagleeye.com/eagleeye-developer/reference/rejectwalletinvite.md): This API method allows the calling application to reject a Wallet Invite. - [Change Wallet Invite State](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletinvitestate.md): This API method allows the calling application to change the state of a Wallet Invite. - Recommendations - [Get Recommendations by Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletrecommendationsbywalletid.md): This API method allows the calling application to retrieve a list of Wallet's Recommendations. - [Get Recommendations by Identity Value](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletrecommendationsbyidentityvalue.md): This API method allows the calling application to retrieve of recommendations linked to the identity value given in the request. The validity of the identity value is not checked in this request. - [Change Recommendation Status to Active](https://developer.eagleeye.com/eagleeye-developer/reference/changerecommendationstatustoactive.md): This API method allows the calling application to change a status of a Recommendation to `ACTIVE`. - [Change Recommendation Status to Accepted](https://developer.eagleeye.com/eagleeye-developer/reference/changerecommendationstatustoaccepted.md): This API method allows the calling application to change a status of a Recommendation to `ACCEPTED`. Please note: This endpoint only changes a Recommendation status to `ACCEPTED`, but without an… - [Change Recommendation Status to Rejected](https://developer.eagleeye.com/eagleeye-developer/reference/changerecommendationstatustorejected.md): This API method allows the calling application to change a status of a Recommendation to `REJECTED`. - [Change Recommendation Status to Deleted](https://developer.eagleeye.com/eagleeye-developer/reference/changerecommendationstatustodeleted.md): This API method allows the calling application to change a status of a Recommendation to `DELETED`. Please note: Status `DELETE` is a terminal status and a Recommendation with this status cannot… - [Accept Recommendation](https://developer.eagleeye.com/eagleeye-developer/reference/acceptrecommendation.md): This API method allows the calling application to request a Recommendation Acceptance. Accepting a Recommendation would result in an issuance of recommended entities and changing a Recommendation… - [Create and Fetch Wallet Accounts](https://developer.eagleeye.com/eagleeye-developer/reference/createandfetchwalletaccounts.md): This endpoint allows you to fetch recommendations and campaigns based on the provided identity-value or walletId and mark them as accepted. Campaigns are fetched based on tags, and accounts are… - [Accept All Recommendations](https://developer.eagleeye.com/eagleeye-developer/reference/acceptrecommendations.md): This API allows you to accept all recommendations associated with a customer's identity-value or walletId, automatically creating accounts for each recommendation offer and linking them to the… - [Bulk Delete Wallets Recommendations](https://developer.eagleeye.com/eagleeye-developer/reference/bulkdeletewalletsrecommendations.md): This API allows the calling application to delete, in bulk, the `ACTIVE` recommendations for many walletId/campaignId pairs in a single request. For each pair, every `ACTIVE` recommendation of the… - Links - [Get Reward Bank Links](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletbankrewardlinks.md): 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 Banks (of type Points Reward). Optionally this… - [Get Active Reward Bank Links](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletbankrewardlinksavailable.md): 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… - [Create Reward Bank Link](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletbankrewardlink.md): 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). - [Delete Reward Bank Link](https://developer.eagleeye.com/eagleeye-developer/reference/deletewalletbankrewardlink.md): This API method allows the calling application to remove a link between a requested Wallet, identified by a Wallet ID, and a requested `PRIVATE` Reward Bank (of type Points Reward). - [Update Reward Bank Link](https://developer.eagleeye.com/eagleeye-developer/reference/amendwalletbankrewardlink.md): 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). - [Delete Reward Bank Link by Linked Wallet Id](https://developer.eagleeye.com/eagleeye-developer/reference/deletewalletbankrewardlink2.md): This API method allows the calling application to remove a link between a requested Wallet, identified by a Wallet ID, and a `PRIVATE` Reward Bank (of type Points Reward). - Services - [Social Behavioral Action Trigger](https://developer.eagleeye.com/eagleeye-developer/reference/socialbehavioralactioncampaign.md): This API method allows the calling application to trigger the creation, redemption and issuing of a reward for a Behavioural Action Campaign based on an Action Reference. For e.g. Submit a… - [Update Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransactionservicebyid.md): This API method allows the calling application to update a transaction against a specific wallet if it has already been released, and at the same time will lock the specified accounts in preparation… - [Create Wallets and Identities](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletandwalletidentities.md): This API method allows the calling application to create a Wallet with one or more Identities within single API call. - [Delete Wallet and Related Objects](https://developer.eagleeye.com/eagleeye-developer/reference/deleteserviceswallet.md): This API method allows the calling application to delete a Wallet and its contents. Wallet Consumer and Identities are deleted and Wallet accounts are cancelled. This API provides the ability for all… - [Create a Wallet, Identities, Coupon/Scheme Accounts and Consumer Object](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletaccountservice.md): We have the ability in AIR to create a wallet, one or more identities, one or more coupon accounts, one or more scheme accounts and a consumer object in a single API call. If the first identity… - [Get Active Child and Parent Wallet Accounts by a Child Identity Value](https://developer.eagleeye.com/eagleeye-developer/reference/getchildandparentaccountswalletaccountsbychildidentityvalue.md): This API method allows the calling application to retrieve up to 100 active wallet accounts by wallet identity Value. If that wallet has a parent (household) then up to 100 active parent wallet… - [Update a Wallet Transaction by Transaction Reference](https://developer.eagleeye.com/eagleeye-developer/reference/updatewallettransactionservicebyreference.md): This API method allows the calling application to update a transaction using the transaction reference if it has already been released, and at the same time will lock the specified accounts in… - [Create a Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/createwallettransactionservice.md): This API method allows the calling application to create a transaction against a specific wallet, and at the same time will lock the specified accounts in preparation for the given account… - [Settle a Wallet Transaction using a WalletId and a TransactionId](https://developer.eagleeye.com/eagleeye-developer/reference/settlewallettransactionservicebytransactionid.md): This API method allows the calling application to settle a wallet transaction using a specific walletId and transactionId, processing the accounts attached to the transaction and performing the… - [Settle a Wallet Transaction using a Transaction Reference](https://developer.eagleeye.com/eagleeye-developer/reference/settlewallettransactionservicebytransactionreference.md): This API method allows the calling application to settle a transaction using a transaction reference, processing the accounts attached to the transaction and performing the necessary actions to… - [Release a Wallet Transaction using a WalletId and a TransactionId](https://developer.eagleeye.com/eagleeye-developer/reference/releasewallettransactionservicebytransactionid.md): This API method allows the calling application to release a wallet transaction using a specific walletId and transactionId, processing the accounts attached to the transaction and removing them from… - [Release a Wallet Transaction using a Transaction Reference](https://developer.eagleeye.com/eagleeye-developer/reference/releasewallettransactionservicebytransactionreference.md): This API method allows the calling application to release a transaction using a transaction reference, processing the accounts attached to the transaction and removing them from the transaction so… - [Cancel a Wallet Transaction using a WalletId and a TransactionId](https://developer.eagleeye.com/eagleeye-developer/reference/cancelwallettransactionservicebytransactionid.md): This API method allows the calling application to cancel a wallet transaction using a specific walletId and transactionId, processing the accounts attached to the transaction and removing them from… - [Cancel a Wallet Transaction using a Transaction Reference](https://developer.eagleeye.com/eagleeye-developer/reference/cancelwallettransactionservicebytransactionreference.md): This API method allows the calling application to cancel a transaction using a transaction reference, processing the accounts attached to the transaction and removing them from the transaction so… - [Exchange Points for Reward](https://developer.eagleeye.com/eagleeye-developer/reference/exchange.md): This API method allows the calling application to perform a Reward Bank exchange. Exchange means a Consumer will receive a specific reward as per Rewards Bank definition. For example: receive a… - [Donate Points](https://developer.eagleeye.com/eagleeye-developer/reference/donate.md): This API method allows the calling application to perform a Donate operation. A Donation means a requested amount from an EES AIR Donor Account will be used to credit (transferred-in) into… - [Gift Points](https://developer.eagleeye.com/eagleeye-developer/reference/gift.md): This API method allows the calling application to perform a Gift operation. A Gift means a specified amount of points from a giver's points account will be used to credit a receiver’s points account.… - [Credit Loyalty Points and Create Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/createcreditwallettransactionservice.md): This API method allows the calling application to Credit an EES AIR Account, Create an Account Transaction and create a CREDIT Wallet Transaction - [Spend Loyalty Points and Create Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/createspendwallettransactionservice.md): This API method allows the calling application to Spend from an EES AIR Account, Create an Account Transaction and create a SPEND Wallet Transaction - [Redeem Account and Credit Loyalty Points](https://developer.eagleeye.com/eagleeye-developer/reference/createredeemcreditwallettransactionservice.md): This API method allows the calling application to Redeem a Coupon Account and in turn Credit an existing Points Account within an individual consumer's wallet. It also creates an Account Transaction… - [Create Goodwill Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/creategoodwillwallettransactionservice.md): This API method allows the calling application to perform a Goodwill transaction for an EES AIR Account, Create an Account Transaction and create a GOODWILL Wallet Transaction - [Debit Loyalty Points and Create Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/createdebitwallettransactionservice.md): This API method allows the calling application to Debit an EES AIR Account, Create an Account Transaction and create a DEBIT Wallet Transaction. Please note: by default for Loyalty Points… - [Unredeem Wallet Account and Create Wallet Transaction](https://developer.eagleeye.com/eagleeye-developer/reference/unredeemwallettransactionservice.md): This API method allows the calling application to Unredeem previously redeemed EES AIR Account, Create an Account Transaction (of type UNREDEEM) and create a UNREDEEM Wallet Transaction - [Merge Wallets](https://developer.eagleeye.com/eagleeye-developer/reference/mergetwowallets.md): This API method allows the calling application to Merge two existing Wallets of the same type. All Identities except DELETED from the Victim Wallet will be moved to the Survivor Wallet. All Accounts… - [Create Campaign Accounts by Identity or WalletId](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletcampaignsaccountsbyidentityorwalletid.md): This API method allows the calling application to create one or many coupon accounts and place them into the wallet by identity value or wallet id. Either identity-value or walletId must be provided… - [Create Entitlement Coupons by Identity or WalletId](https://developer.eagleeye.com/eagleeye-developer/reference/createwalletentitlementcouponaccountsbyidentityorwalletid.md): This API method allows the calling application to create one or many Entitlement Account (of type COUPON) and link it to existing Subscription Account by identity value or wallet id. Either… - [Backend Points Redeem](https://developer.eagleeye.com/eagleeye-developer/reference/adjustpointbalanceredeem.md): This API method allows the calling application to redeem a coupon account and adjust a points account balance of a specified wallet. The points balance will be increased or decreased based on the… - [Backend Points Refund](https://developer.eagleeye.com/eagleeye-developer/reference/backendpointsrefund.md): This API method allows the calling application to refund into a points account of a specified wallet. The points balance will be increased based on the value specified in the PointsValue column. - [Backend Points](https://developer.eagleeye.com/eagleeye-developer/reference/adjustpointbalance.md): This API method allows the calling application to adjust a points account balance of a specified wallet. The points balance will be increased or decreased based on the value specified in the… - [Create or Update a Wallet Consumer](https://developer.eagleeye.com/eagleeye-developer/reference/updatewalletconsumerbyidentity.md): This API method allows the calling application to create or update a wallet consumer for a wallet specified by the identity-value. The consumer will be created if it does not exist, otherwise the… - [Void Points Exchange](https://developer.eagleeye.com/eagleeye-developer/reference/voidexchange.md): This API method allows the calling application to Void a Reward Bank exchange transaction using the original Wallet Transaction Reference. This operation will reverse the original exchange… - Audiences - [Add Wallets to an Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/addwalletstoaudience.md): This API method allows the calling application to add wallets to a specified audience within the Eagle Eye Platform. This endpoint will not validate if the walletIds exist and it will only process… - [Delete Wallets from Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deletewalletsfromaudience.md): This API method allows the calling application to remove wallets from a specified audience within the Eagle Eye Platform. This endpoint will not validate if the walletIds exist and it will only… - [Get Audiences For A Wallet (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getwalletaudiences.md): This API method allows the calling application to retrieve all the audiences associated with a specified Wallet ID within the Eagle Eye Platform. ## API Reference: POS-Connect API - Wallet - [Open](https://developer.eagleeye.com/eagleeye-developer/reference/openwallet.md): This API endpoint allows the calling application to open an AIR Wallet by providing an Identity Value (if no identity is passed then the end point can be configured to operate in unidentified… - [OpenSettle](https://developer.eagleeye.com/eagleeye-developer/reference/opensettletransaction.md): This API endpoint allows the calling application to record in AIR a Consumer Transaction, by recording all Account's operations (like Coupon Redemption, Stored Value Credit/Debit amount, Loyalty… - [Settle](https://developer.eagleeye.com/eagleeye-developer/reference/settletransaction.md): This API endpoint allows the calling application to record in AIR a Consumer Transaction, by recording all Account's operations (like Coupon Redemption, Stored Value Credit/Debit amount, Loyalty… - [Product Exchange](https://developer.eagleeye.com/eagleeye-developer/reference/productexchangewallettransaction.md): This API endpoint allows the exchange of one or more products for another set of products. The basket request attribute includes both the product(s) being returned salesKey=REFUND and the new… - [Refund](https://developer.eagleeye.com/eagleeye-developer/reference/refundwallettransaction.md): This API endpoint allows the calling application to record within AIR a refund (return) transaction. Request attribute `basket` should contain only a list of returned items (please note each returned… - [Fulfil](https://developer.eagleeye.com/eagleeye-developer/reference/fulfilwallettransaction.md): This API endpoint allows the calling application to record within AIR a fulfil (Partial Settle) transaction. Request attribute `basket` should contain list of items to be fulfilled with attribute… - [Replay](https://developer.eagleeye.com/eagleeye-developer/reference/replaywallettransactions.md): This API endpoint involves reviewing wallet transactions made by a customer over the past seven days and adjudicating any offers that were requested in the payload. - [Unlock](https://developer.eagleeye.com/eagleeye-developer/reference/unlockwallet.md): This API endpoint allows the calling application to unlock all previously locked Accounts (by calling Open Wallet) - [Calculate](https://developer.eagleeye.com/eagleeye-developer/reference/spendcalculate.md): This API endpoint allows the calling application to work out the financial value of points based on the rules configured against the points scheme. These points are converted using the floor,… - [Spend](https://developer.eagleeye.com/eagleeye-developer/reference/spend.md): This API applies the calculated operations from the spend-calculate API to a wallet and spends points from a customer's points account. This creates an active Wallet Transaction in the wallet found… - [Void](https://developer.eagleeye.com/eagleeye-developer/reference/spendvoid.md): Void an ACTIVE spend transaction against the given wallet and undo the spending of points. This call is used in the case of a cancelled transaction where a customer has spent points but does not wish… - [Activate](https://developer.eagleeye.com/eagleeye-developer/reference/activatewallet-1.md): This API endpoint allows the calling application to activate an AIR Wallet and/or Identity by providing its Identity Value. AIR will check the status of the identity, wallet and household wallet (if… - Account - [Create](https://developer.eagleeye.com/eagleeye-developer/reference/createaccount.md): This API endpoint allows the calling application to create a new AIR Account - [Verify](https://developer.eagleeye.com/eagleeye-developer/reference/verifyaccount.md): This API endpoint allows the calling application to verify an Account. Please note this endpoint should be used only in real-time mode - [Activate](https://developer.eagleeye.com/eagleeye-developer/reference/activateaccount.md): This API endpoint allows the calling application to activate an Account. Please note only `INACTIVE` Accounts could be Activated. - [Load](https://developer.eagleeye.com/eagleeye-developer/reference/loadaccount.md): This API endpoint allows the calling application to perform an initial Account Load and perform an optional Account `ACTIVATION` on successful load. - [Unlock](https://developer.eagleeye.com/eagleeye-developer/reference/unlockaccount.md): This API endpoint allows the calling application to UNLOCK (`Release a Lock`) from `LOCKED` Wallet Account. Please note : * This endpoint should be called in real-time only * Only the same unit… - [Lock](https://developer.eagleeye.com/eagleeye-developer/reference/lockaccount.md): This API endpoint allows the calling application to explicitly request specified Account to be `locked`. Please note : * this endpoint should be used in real-time only * Locked Wallet Accounts… - [Redeem](https://developer.eagleeye.com/eagleeye-developer/reference/redeemaccount.md): This API endpoint allows the calling application to Redeem an Individual AIR Account. Please note this endpoint is applicable for `COUPON` Type Accounts - [Debit](https://developer.eagleeye.com/eagleeye-developer/reference/debitaccount.md): This API endpoint allows the calling application to Debit a Requested Account. Please note this endpoint is applicable for `STORED VALUE` or Loyalty `POINTS` Account Types - [Credit](https://developer.eagleeye.com/eagleeye-developer/reference/creditaccount.md): This API endpoint allows the calling application to Credit a Requested Account. Please note this endpoint is applicable for `STORED VALUE` or Loyalty `POINTS` Account Types, and it will create an… - [Earn](https://developer.eagleeye.com/eagleeye-developer/reference/earnpoints-1.md): This API endpoint allows the calling application to Earn Points for a Requested Account of Type Loyalty Points - [Spend](https://developer.eagleeye.com/eagleeye-developer/reference/spendpoints.md): This API endpoint allows the calling application to Spend Points from a Requested Account of Type (Loyalty) Points - [Stamp](https://developer.eagleeye.com/eagleeye-developer/reference/stampaccount.md): This API endpoint allows the calling application to Stamp a Requested Account of Type (Loyalty) `STAMP CARD` - [Unredeem](https://developer.eagleeye.com/eagleeye-developer/reference/unredeemaccounttransaction.md): This API endpoint allows the calling application to `unredeem` previously Redeemed Offer for Account type `COUPON`. - [Refund](https://developer.eagleeye.com/eagleeye-developer/reference/refundaccounttransaction.md): This API endpoint allows the calling application to perform a partial or full refund for a previously Debited Account of type `STORED VALUE`. - [Void](https://developer.eagleeye.com/eagleeye-developer/reference/voidaccounttransaction.md): This API endpoint allows the calling application to `void` a previously Transacted Account. Please note: a) not every AIR Transaction could be voided (i.e. creating an Account could not be… - [Block](https://developer.eagleeye.com/eagleeye-developer/reference/blockaccount.md): This API endpoint allows the calling application to explicitly request a specified Token or Account to be `blocked`. - [Unblock](https://developer.eagleeye.com/eagleeye-developer/reference/unblockaccount.md): This API endpoint allows the calling application to `unblock` a Token or Account that was previously `blocked` within the AIR platform. - [Cancel](https://developer.eagleeye.com/eagleeye-developer/reference/cancelaccount.md): This API endpoint allows the calling application to `cancel` a Token or Account within the AIR platform. Please note this operation cannot be undone. - [Update PIN](https://developer.eagleeye.com/eagleeye-developer/reference/pinupdateaccount.md): This API endpoint allows the calling application to change a Token or Account's PIN within the AIR platform. Please note this operation applies to Coupon or Stored Value accounts where a PIN has been… - [Update Dates](https://developer.eagleeye.com/eagleeye-developer/reference/datesupdateaccount.md): This API endpoint allows the calling application to amend Token or Account Dates (Valid-From and/or Valid-To) within the AIR platform. Please note a `location` cannot be included in the payload of… - [Unexpire](https://developer.eagleeye.com/eagleeye-developer/reference/unexpireaccount.md): This API endpoint allows the calling application to `unexpire` a Token or Account and set a new expiry date within the AIR platform. - [Balance Check](https://developer.eagleeye.com/eagleeye-developer/reference/balancecheckaccount.md): This API endpoint allows the calling application to check a Token or Account Balance. Please note: | - Checking balance will leave auditable trace in AIR in a form of an Account Transaction. - This… - [Resend](https://developer.eagleeye.com/eagleeye-developer/reference/resendaccount.md): This API endpoint allows the calling application to `resend` requested Token (maintaining existing AIR Account without the need for previous Token being deactivated and issuing new one). Please note… - [Reissue](https://developer.eagleeye.com/eagleeye-developer/reference/reissueaccount.md): This API endpoint allows the calling application to request reissuing a Token (Invalidate Requested Token and Create a new one instead). Please note: | - The AIR Account ID will remain the same. -… - Wallet Transaction - [Get by Reference](https://developer.eagleeye.com/eagleeye-developer/reference/getwallettransaction.md): This API endpoint allows the calling application to retrieve an existing Wallet Transaction for the calling Unit. ## API Reference: Tiers API - Tier Membership - [Retrieve a Customer's Current Tier Membership](https://developer.eagleeye.com/eagleeye-developer/reference/gettiermembership.md): This API allows a calling application to retrieve the current Tier Membership details for a customer. - [Add a Customer into a Tier](https://developer.eagleeye.com/eagleeye-developer/reference/addtiermembership.md): This API allows a customer's Loyalty Account to be given a Tier Membership. - [Add a Customer into a Tier](https://developer.eagleeye.com/eagleeye-developer/reference/addtiermembershipwithwalletid.md): This API allows a customer's Loyalty Account to be given a Tier Membership. - [Update a Customer's Tier Membership](https://developer.eagleeye.com/eagleeye-developer/reference/updatetiermembership.md): This API allows a customer's Loyalty Account Tier Membership to be updated. - Tier Membership Transaction - [Move a Customer into a different Tier](https://developer.eagleeye.com/eagleeye-developer/reference/movetiermembership.md): This API allows a calling application to move a customer into a new Tier. - [Credit a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/credittiermembershipbalances.md): This API allows a calling application to increase the balances of a customer tier. This API enforces a positive movement of the balances. Only positive integers can be passed in the balances object… - [Debit a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/debittiermembershipbalances.md): This API allows a calling application to decrease the Tier Membership Balances for a customer. This API completes a negative movement of balances only. The values passed in the balances of the… - [Adjust a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/adjusttiermembershipbalances.md): This API allows a calling application to adjust the balances of a customer's Tier Membership. This API can change balances in both a positive and negative direction. The values passed in the… - [Move a Customer into a different Tier](https://developer.eagleeye.com/eagleeye-developer/reference/movetiermembershipwithwalletid.md): This API allows a calling application to move a customer into a new Tier. - [Credit a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/credittiermembershipbalanceswithwalletid.md): This API allows a calling application to increase the balances of a customer tier. This API enforces a positive movement of the balances. Only positive integers can be passed in the balances object… - [Debit a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/debittiermembershipbalanceswithwalletid.md): This API allows a calling application to decrease the Tier Membership Balances for a customer. This API completes a negative movement of balances only. The values passed in the balances of the… - [Adjust a Customer's Tier Membership Balances](https://developer.eagleeye.com/eagleeye-developer/reference/adjusttiermembershipbalanceswithwalletid.md): This API allows a calling application to adjust the balances of a customer's Tier Membership. This API can change balances in both a positive and negative direction. The values passed in the… ## API Reference: Smart Messaging API - Smart Messaging - [Create](https://developer.eagleeye.com/eagleeye-developer/reference/retrievemessagesattill.md): This API endpoint allows the calling application to request a set of additional information from EES AIR. These Messages could then be displayed on a Till screen, printed on a Consumer receipt, etc.… - [Report Status](https://developer.eagleeye.com/eagleeye-developer/reference/reportmessagesattill.md): This API allows the calling application to report back on the print status of requested Messages. AIR needs to update the Message record based on the print status e.g whether a Message has printed… ## API Reference: Resource API - Audiences - [Search for Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getaudiences.md): This method allows the calling application to search for Audiences on the AIR platform. - [Create Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/createaudiences.md): This method allows the calling application to create an Audience on the AIR platform. - [Replace Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putaudiences.md): This method allows the calling application to replace the contents of an Audience by Id. - [Delete Audience (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteaudience.md): This method allows the calling application to delete an Audience by Id. - Campaigns - [Search for Campaigns](https://developer.eagleeye.com/eagleeye-developer/reference/getcampaigns.md): This method allows the calling application to retrieve Campaigns. - [Create Campaign](https://developer.eagleeye.com/eagleeye-developer/reference/postcampaigns.md): This method allows the calling application to create a Campaign. - [Get Campaign](https://developer.eagleeye.com/eagleeye-developer/reference/getcampaign.md): This method allows the calling application to retrieve a Campaign by Campaign Id. - [Replace Campaign](https://developer.eagleeye.com/eagleeye-developer/reference/putcampaign.md): This method allows the calling application to update a Campaign by Campaign Id. - [Update Campaign](https://developer.eagleeye.com/eagleeye-developer/reference/patchcampaign.md): This method allows the calling application to partial update a Campaign by Campaign Id. If you are updating an array it is recommended to use the PUT /campaigns endpoint instead. - [Delete Campaign](https://developer.eagleeye.com/eagleeye-developer/reference/deletecampaign.md): This method allows the calling application to delete a Campaign. - [Ingest Third Party Tokens](https://developer.eagleeye.com/eagleeye-developer/reference/postthirdpartytokens.md): This method allows the calling application to submit a list of Tokens that will be issued against a particular Campaign. - Schemes - [Search for Points Schemes](https://developer.eagleeye.com/eagleeye-developer/reference/getschemes.md): This method allows the calling application to retrieve all Schemes. - [Get Points Scheme](https://developer.eagleeye.com/eagleeye-developer/reference/getschemebyid.md): This method allows the calling application to retrieve a Scheme by Id. - [Create Points Scheme](https://developer.eagleeye.com/eagleeye-developer/reference/postschemes.md): This method allows the calling application to create a Scheme. - [Get Points Scheme](https://developer.eagleeye.com/eagleeye-developer/reference/z-getschemebyid.md): This endpoint is deprecated - See GET By Id - GET /schemes/points/{schemeId} This method allows the calling application to retrieve a Scheme by Id. - [Get Points Scheme by Reference](https://developer.eagleeye.com/eagleeye-developer/reference/z-getschemebyreference.md): This endpoint is deprecated - Please use Get By Id - GET /schemes/points?reference={reference} This method allows the calling application to retrieve a Scheme by Reference. - [Replace Points Scheme](https://developer.eagleeye.com/eagleeye-developer/reference/putschemebyid.md): This method allows the calling application to update a Scheme by Scheme Id. - Reward Bank - [Search for Reward Banks](https://developer.eagleeye.com/eagleeye-developer/reference/getpointsexchangebanks.md): This API endpoint allows the calling application to retrieve a set of Points Exchange Banks details fulfilling an optional filtering criteria - [Create a Reward Bank with Rewards](https://developer.eagleeye.com/eagleeye-developer/reference/postpointsexchangebanks.md): This API endpoint allows the calling application to create a Reward Bank with Rewards - [Get Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/getpointsrewardbankbyid.md): This API endpoint allows the calling application to retrieve a Points Exchange Bank details by Bank ID - [Update Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/patchpointsrewardbankbyid.md): This API endpoint allows the calling application to update a Points Exchange Bank details by Bank ID. - [Delete Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/deletepointsrewardbankbyid.md): This method allows the calling application to delete a Reward Bank. Any associated Rewards will also be deleted. - [Search for Rewards From a Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/getpointsexchangebankrewards.md): This API endpoint allows the calling application to retrieve a Points Exchange Bank Reward details by Bank ID and optionally by other filtering criteria - [Add Reward to Existing Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/postpointsexchangebankrewards.md): This API endpoint allows the calling application to create one or more Rewards for an existing Points Exchange Bank - [Get a Reward from a Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/getbankreward.md): This API endpoint allows the calling application to retrieve a Reward details by Bank ID and Reward ID - [Update a Reward in a Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/patchbankreward.md): This API endpoint allows the calling application to update a Reward's details by Bank ID and Reward ID. - [Delete Reward from a Reward Bank](https://developer.eagleeye.com/eagleeye-developer/reference/deletebankreward.md): This method allows the calling application to delete a Reward Bank Reward. - Inventory List - [Search for Inventory Lists](https://developer.eagleeye.com/eagleeye-developer/reference/getallinventorylists.md): This API endpoint allows the calling application to retrieve all Inventory List products that includes optional criteria filtering. - [Create Inventory List](https://developer.eagleeye.com/eagleeye-developer/reference/postinventorylist.md): This API endpoint allows the calling application to create a new Inventory List. - [Get Inventory List](https://developer.eagleeye.com/eagleeye-developer/reference/getinventorylistbyid.md): This API endpoint allows the calling application to retrieve details for an Inventory List's products by Inventory List Id. - [Replace Inventory List](https://developer.eagleeye.com/eagleeye-developer/reference/putinventorylist.md): This API endpoint allows the calling application to update an existing Inventory List. - [Delete Inventory List](https://developer.eagleeye.com/eagleeye-developer/reference/deleteinventorylist.md): This API endpoint allows the calling application to delete an Inventory List's products by Inventory List Id. - Product Inventory - [Search the Product Inventory](https://developer.eagleeye.com/eagleeye-developer/reference/getproductinventory.md): This API endpoint allows the calling application to retrieve a list of Products based on a number of parameters. Below is a list of the 5 combinations of parameters that can be be passed in to… - [Create an Inventory Product (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postinventoryproduct.md): This API endpoint allows the calling unit to create a new inventory product for their child unit as specified by its `incomingIdentifier`. - [Get an Inventory Product (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getinventoryproduct.md): This API endpoint allows the calling unit to retrieve a single inventory product by ID from their child unit as specified by its `incomingIdentifier`. - [Update an Inventory Product (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putinventoryproduct.md): This API endpoint allows the calling unit to update an existing inventory product by ID for a child unit as specified by its `incomingIdentifier`. - [Delete an Inventory Product (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteinventoryproduct.md): This API endpoint allows the calling unit to delete an inventory product by ID from their child unit as specified by its `incomingIdentifier`. - [Create an Inventory Group (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postinventorygroup.md): This API endpoint allows the calling unit to create a new inventory group for their child unit as specified by its `incomingIdentifier`. - [Get an Inventory Group (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getinventorygroup.md): This API endpoint allows the calling unit to retrieve a single inventory group by ID from their child unit as specified by its `incomingIdentifier`. - [Delete an Inventory Group (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteinventorygroup.md): This API endpoint allows the calling unit to delete an inventory group by ID from their child unit as specified by its `incomingIdentifier`. - [Search Inventory Groups (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/searchinventorygroups.md): This API endpoint allows the calling unit to search inventory groups for their child unit as specified by its `incomingIdentifier`. - [Search Inventory Products (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/searchinventoryproducts.md): This API endpoint allows the calling unit to search inventory products for their child unit as specified by its `incomingIdentifier`. Results are always returned ordered by `productId` ascending. The… - [Bulk Delete Inventory Products (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postinventoryproductsbulkdelete.md): This API endpoint allows the calling unit to delete multiple inventory products for their child unit as specified by its `incomingIdentifier`. The request body must be a non-empty array of up to 100… - [Bulk create Inventory Products (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postinventoryproductsbulk.md): This API endpoint allows the calling unit to create multiple inventory products in one request for their child unit as specified by its `incomingIdentifier`. - [Bulk Update Inventory Products (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putinventoryproductsbulkupdate.md): This API endpoint allows the calling unit to update multiple inventory products for their child unit as specified by its `incomingIdentifier`. The request body must be a non-empty array of up to 100… - Token Formats - [Search for Token Formats](https://developer.eagleeye.com/eagleeye-developer/reference/gettokenformats.md): This method allows the calling application to search token formats using query parameters. - [Get a Token Format](https://developer.eagleeye.com/eagleeye-developer/reference/gettokenformatsbyid.md): This method allows the calling application to fetch a Token Format by ID. - [Create Token Format](https://developer.eagleeye.com/eagleeye-developer/reference/posttokenformats.md): This method allows the calling application to create a Token Format and attach it to the calling unit. - [Get a Token Format](https://developer.eagleeye.com/eagleeye-developer/reference/z-gettokenformatsbyid.md): This endpoint is deprecated - please see /tokenFormats/{id} This method allows the calling application to fetch a Token Format by ID. - Units - [Search for Units](https://developer.eagleeye.com/eagleeye-developer/reference/getunits.md): This method allows the calling application to search units using query parameters. - [Create Unit](https://developer.eagleeye.com/eagleeye-developer/reference/postunits.md): This method allows the calling application to create a Banner or a Store/Outlet unit. - [Get Unit](https://developer.eagleeye.com/eagleeye-developer/reference/getunitbyid.md): This method allows the calling application to retrieve a unit by id. - [Update Unit](https://developer.eagleeye.com/eagleeye-developer/reference/patchunitbyid.md): This method allows the calling application to update a unit. - [Create and Configure Tenant (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postservicesunits.md): This method allows the calling application to create a new tenant unit with wallet config, POS Connect config and unit credentials. __Warning:__ This API can cause issues if used from within an… - [Create Identity Type (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postidentitytypes.md): This method allows calling application to create an identity type for the calling unit. - [Replace Identity Type (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putidentitytypes.md): This method allows calling application to update an identity type for the calling unit. - [Create Wallet Type (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postwallettypes.md): This method allows calling application to create a wallet type for the calling unit. - [Replace Wallet Type (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putwallettypes.md): This method allows calling application to update a wallet type for the calling unit. - [Get Unit File Transfer Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getunitfiletransferconfigbyid.md): This method allows the calling application to retrieve a unit's file transfer configuration. - [Create Unit File Transfer Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postunitfiletransferconfigbyid.md): This method allows the calling application to create a unit file transfer configuration. - [Update Unit File Transfer Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/patchunitfiletransferconfigbyid.md): This method allows the calling application to update the key associated with the file transfer configuration - [Delete Unit File Transfer Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteunitfiletransferconfigbyid.md): This method allows the calling application to permanently delete the file transfer configuration associated with the specified unit. Once deleted, all settings related to file transfers for this unit… - [Create Unit Ingestion (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postingestion.md): This method allows the calling application to create an ingestion configuration for a unit. - [Search Unit Ingestions (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getingestions.md): This method allows the calling application to retrieve the ingestion configurations for a unit. - [Get Unit Ingestion (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getingestionbyid.md): This method allows the calling application to retrieve an ingestion configuration by id. - [Replace Unit Ingestion (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/putingestionbyid.md): This method allows the calling application to update an ingestion configuration for a unit. - [Delete Unit Ingestion (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteingestionbyid.md): This method allows the calling application to delete an ingestion configuration for a unit. - [Get Unit Event Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/getunitevents.md): This method allows the calling application to retrieve the Unit Event configuration. Please note that the unitId *must* be that of the calling unit. - [Create Unit Event Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postunitevents.md): This method allows the calling application to create Unit Event configuration. This endpoint can only be called once to create the configuration. Please note that the unitId *must* be that of the… - [Update Unit Event Recipient Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/patchuniteventsrecipient.md): This method allows the calling application to update the configuration of a Unit Event Recipient. Please note that the unitId *must* be that of the calling unit. - [Delete Unit Event Recipient (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/deleteuniteventsrecipient.md): This method allows the calling application to delete the configuration of a Unit Event Recipient. Please note that the unitId *must* be that of the calling unit. - [Create Unit Event Recipient Configuration (BETA)](https://developer.eagleeye.com/eagleeye-developer/reference/postuniteventsrecipient.md): This method allows the calling application to create configuration for a new Unit Event Recipient. Unit Events must already be configured for the Unit to add an additional Recipient. Please note that… - Tiers - [Search for Tiers](https://developer.eagleeye.com/eagleeye-developer/reference/gettiers.md): This method allows the calling application to search Loyalty Tiers using query parameters. - [Create Tier](https://developer.eagleeye.com/eagleeye-developer/reference/posttiers.md): This method allows the calling application to create a Loyalty Tier. - [Create Tier](https://developer.eagleeye.com/eagleeye-developer/reference/z-posttiers.md): This endpoint is deprecated - See /tiers This method allows the calling application to create a Loyalty Tier. - [Get Tier](https://developer.eagleeye.com/eagleeye-developer/reference/gettiersbyid.md): This method allows the calling application to retrieve a Loyalty Tier by id. - [Get Tier](https://developer.eagleeye.com/eagleeye-developer/reference/z-gettiersbyid.md): This endpoint is deprecated - See /tiers/{id} This method allows the calling application to retrieve a Loyalty Tier by id. - [Replace Tier](https://developer.eagleeye.com/eagleeye-developer/reference/puttiersbyid.md): This method allows the calling application to update a Loyalty Tier. - [Replace Tier](https://developer.eagleeye.com/eagleeye-developer/reference/z-puttiersbyid.md): This endpoint is deprecated - See /tiers/{id} This method allows the calling application to update a Loyalty Tier. - [Delete Tier](https://developer.eagleeye.com/eagleeye-developer/reference/deletetiersbyid.md): This method allows the calling application to delete a Loyalty Tier. It is not possible to delete a Loyalty Tier if it is set as the default for a Scheme. - [Delete Tier](https://developer.eagleeye.com/eagleeye-developer/reference/z-deletetiers.md): This endpoint is deprecated - See /tiers/{id} This method allows the calling application to delete a Loyalty Tier. It is not possible to delete a Loyalty Tier if it is set as the default for a Scheme. - Programmes - [Search for Programmes](https://developer.eagleeye.com/eagleeye-developer/reference/getprogrammes.md): This method allows the calling application to retrieve all Programmes. - [Create Programme](https://developer.eagleeye.com/eagleeye-developer/reference/postprogrammes.md): This method allows the calling application to create a Programme. - [Get Programme](https://developer.eagleeye.com/eagleeye-developer/reference/getprogrammebyid.md): This method allows the calling application to retrieve a Programme by id. - [Update Programme](https://developer.eagleeye.com/eagleeye-developer/reference/putprogrammebyid.md): This method allows the calling application to update a Programme. - [Delete Programme](https://developer.eagleeye.com/eagleeye-developer/reference/deleteprogrammebyid.md): This method allows the calling application to delete a Programme by id. ## API Reference: Token API - Token - [Create](https://developer.eagleeye.com/eagleeye-developer/reference/createtoken.md): This method allows the calling application to create a new Token within AIR platform. - [Redeem](https://developer.eagleeye.com/eagleeye-developer/reference/redeemtoken.md): This method allows the calling application to Redeem a Token. This API is replaced by the POS Connect account APIs. - [Unredeem](https://developer.eagleeye.com/eagleeye-developer/reference/unredeemtoken.md): This method allows the calling application to Unredeem a Token. This API is replaced by the POS Connect account APIs. - [Verify](https://developer.eagleeye.com/eagleeye-developer/reference/verifytoken.md): This API method allows the calling application to verify a Token or Account that has been presented by a consumer. These checks can be used for a variety of use cases in order to: * Check it is… - [Unlock](https://developer.eagleeye.com/eagleeye-developer/reference/unlocktoken.md): This method allows the calling application to unlock previously locked Token. This API is replaced by the POS Connect account APIs. - [Credit](https://developer.eagleeye.com/eagleeye-developer/reference/credittoken.md): This method allows the calling application to Credit an Account identified by a Account ID or a Token. Applicable to Stored Value Account types. - [Debit](https://developer.eagleeye.com/eagleeye-developer/reference/debittoken.md): This method allows the calling application to Debit an Account identified by Account Id or Token. Applicable to Stored Value Account types. This API is replaced by the POS Connect account APIs. - [Load](https://developer.eagleeye.com/eagleeye-developer/reference/loadtoken.md): This method allows the calling application to Load a Token (Account). Please note - only INACTIVE Accounts should be loaded and this operation should be performed once (later down the line credit… - [Activate](https://developer.eagleeye.com/eagleeye-developer/reference/activatetoken.md): This method allows the calling application to Activate a Token within the AIR platform (Change status of a Token to ACTIVE). Please note only INACTIVE Tokens could be Activated. - [Cancel](https://developer.eagleeye.com/eagleeye-developer/reference/canceltoken.md): This method allows the calling application to Cancel a Token within the AIR platform. Please note this operation can not be undone. - [Update PIN](https://developer.eagleeye.com/eagleeye-developer/reference/updatetokenpin.md): This method allows the calling application to change a Token's (Account's) PIN within the AIR platform. Please note - Campaign (or Programme) settings controls if a PIN is enabled or not - [Update Dates](https://developer.eagleeye.com/eagleeye-developer/reference/updatetokendates.md): This endpoint allows the calling application to Amend Token Dates (Valid-From and/or Valid-To) within the AIR platform. - [Unexpire a token and set a new expiry date](https://developer.eagleeye.com/eagleeye-developer/reference/unexpiretoken.md): This endpoint allows the calling application to Unexpire a token and set a new expiry date within the AIR platform. - [Balance Check](https://developer.eagleeye.com/eagleeye-developer/reference/checkbalance.md): This endpoint allows the calling application to check an Account (Token) Balance. Please note: * Checking balance would leave auditable trace in AIR in a form of an Account Transaction, * this… - [Refund](https://developer.eagleeye.com/eagleeye-developer/reference/refund.md): This endpoint allows the calling application to perform a refund for an Account (Token). This API is replaced by the POS Connect account APIs. - [Resend](https://developer.eagleeye.com/eagleeye-developer/reference/resendtoken.md): This method allows the calling application to resend requested Token (maintaining existing AIR Account without the need for previous Token being deactivated and issuing new one). Please note that the… - [Reissue](https://developer.eagleeye.com/eagleeye-developer/reference/reissuetoken.md): This method allows the calling application to request reissuing a Token (Invalidate Requested Token and Create a new one instead). Please note AIR Account ID will remain the same. - [Void](https://developer.eagleeye.com/eagleeye-developer/reference/voidtoken.md): This method allows the calling application to Void a Token within the AIR platform. Please note this operation can not be undone. ## API Reference: Consumer API - Consumer - [Create](https://developer.eagleeye.com/eagleeye-developer/reference/createconsumer.md): This method allows the calling application to create a Consumer within AIR Platform. - [Get](https://developer.eagleeye.com/eagleeye-developer/reference/getconsumer.md): This method allows the calling application to retrieve Consumer details by Consumer ID. - [Update](https://developer.eagleeye.com/eagleeye-developer/reference/updateconsumer.md): This method allows the calling application to update Consumer details, identified by Consumer ID - [Update](https://developer.eagleeye.com/eagleeye-developer/reference/updateconsumerput.md): This method allows the calling application to update Consumer details, identified by Consumer ID - [Delete](https://developer.eagleeye.com/eagleeye-developer/reference/purgeconsumer.md): Purge a consumer's details, along with all associated accounts which are ACTIVE, INACTIVE or BLOCKED. This operation can not be undone. ## API Reference: Orders API - Order - [Bulk Order](https://developer.eagleeye.com/eagleeye-developer/reference/tokenbulkorder.md): This method allows the calling application to create a Bulk Order of Token based accounts created outside of a wallet. Please note received Bulk Order Request will be processed by AIR after a HTTP… - [Retail Order](https://developer.eagleeye.com/eagleeye-developer/reference/tokenordercrete.md): This method allows the calling application to create Gift Voucher or plastic card Order - [Fulfil Order](https://developer.eagleeye.com/eagleeye-developer/reference/tokenorderfulfil.md): This method allows the calling application to fulfil an existing Order - [Cancel Order](https://developer.eagleeye.com/eagleeye-developer/reference/tokenordercancel.md): This method allows the calling application to cancel an existing Order that is awaiting fulfilment. Only plastic card (or mixed) orders that have not already been fulfilled can be cancelled.