--- title: "Void Wallet Account Transaction" method: PATCH path: "/wallet/{walletId}/account/{accountId}/transaction/{accountTransactionId}/void" tags: ["Accounts"] --- # Void Wallet Account Transaction `PATCH /wallet/{walletId}/account/{accountId}/transaction/{accountTransactionId}/void` 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. ## Path parameters - `walletId` string, string, required - `accountId` string, string, required - `accountTransactionId` string, required ## Request body - AccountLocationDetailsPatchPayload - `location` LocationEntity - `location` string, string — [Optional] Outlet incoming identifier where Transaction has happened - `details` DetailsEntity - `details` TransactionDetailsEntity — JSON Object without a fixed structure (EES AIR Meta-Data) ## Response `200` OK - WalletAccountTransactionEntity — Object representing an account transaction. - `accountTransactionId` string — The account transaction id. - `accountId` string — The account id related to this transaction. - `parentAccountTransactionId` string — The parent account transaction. - `event` 'CREATE' | 'REDEEM' | 'UNLOCK' | 'UNREDEEM' | 'VERIFY' | 'ACTIVATE' | 'INACTIVATE' | 'REACTIVATE' | 'LOAD' | 'CREDIT' | 'DEBIT' | 'BALANCE' | 'INVALIDATE' | 'BLOCK' | 'UNBLOCK' | 'RESEND' | 'STOLEN' | 'CANCEL' | 'VOID' | 'REISSUE' | 'REFUND' | 'TRANSFER' | 'TRANSFER_IN' | 'TOPUP' | 'AUTOTOPUP' | 'STAMP' | 'SPEND' — The type of transaction. - `value` integer — The value related to this account transaction. Typically, if an account transaction like credit was executed with a value, then this value will be stored here. For Continuity, however, this value should always be 0, and the same for Coupon (since there is no value for a coupon). - `source` string — The source of this transaction e.g. from a client, or automated. - `transactionDetails` object — An simple object of key value pairs representing the transaction details. For Points and Continuity, this can contain a JSON encoded object with the details of the amounts applied to each balance. - `balancesBefore` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `balancesAfter` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `properties` object — Properties related to the account transaction. - `dateCreated` string — Date this account transaction was created - `lastUpdated` string — Date this account transaction was last updated - `account` WalletAccountEntity — The account object, present only if include=accounts is passed in the query string. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - `children` WalletAccountTransactionChildEntity[] — List of Child Wallet Account Transactions - for operations on multiple and linked accounts this property will be populated. - `accountTransactionId` string — The account transaction id. - `accountId` string — The account id related to this transaction. - `parentAccountTransactionId` string — The parent account transaction. - `event` 'ACTIVATE' | 'AUTOTOPUP' | 'BALANCE' | 'BLOCK' | 'CANCEL' | 'CREATE' | 'CREDIT' | 'DEBIT' | 'INACTIVATE' | 'INVALIDATE' | 'LOAD' | 'REACTIVATE' | 'REDEEM' | 'REFUND' | 'REISSUE' | 'RESEND' | 'SPEND' | 'STAMP' | 'STOLEN' | 'TOPUP' | 'TRANSFER' | 'TRANSFER_IN' | 'UNBLOCK' | 'UNLOCK' | 'UNREDEEM' | 'VERIFY' | 'VOID' — The type of transaction. - `value` integer — The value related to this account transaction. Typically, if an account transaction like credit was executed with a value, then this value will be stored here. For Continuity, however, this value should always be 0, and the same for Coupon (since there is no value for a coupon). - `source` string — The source of this transaction e.g. from a client, or automated. - `transactionDetails` object — An simple object of key value pairs representing the transaction details. For Points and Continuity, this can contain a JSON encoded object with the details of the amounts applied to each balance. - `balancesBefore` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `balancesAfter` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `properties` object — Properties related to the account transaction. - `dateCreated` string — Date this account transaction was created - `lastUpdated` string — Date this account transaction was last updated - `account` WalletAccountEntity — The account object, present only if include=accounts is passed in the query string. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - `children` unknown - `rewardAccounts` WalletAccountEntity[], nullable — List of Reward Account Transactions or Accounts - for operations on multiple and linked accounts this property will be populated. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - `accountId` string, int64, required — Account ID - `dateCreated` string, date-time, required — Relation creation date-time - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - `rewardAccounts` union[], nullable — List of Reward Account Transactions or Accounts - for operations on multiple and linked accounts this property will be populated. - union - WalletAccountEntity — The account object, present only if include=accounts is passed in the query string. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - `accountType` WalletAccountRelationEntity - … - `ENTITLEMENT_OF` object - `accountType` WalletAccountRelationEntity - … - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - `validFrom` string, date-time — The date the token lock is valid from. - `validTo` string, date-time — The date the token lock is valid to. - WalletAccountTransactionChildEntity — Object representing an account transaction. - `accountTransactionId` string — The account transaction id. - `accountId` string — The account id related to this transaction. - `parentAccountTransactionId` string — The parent account transaction. - `event` 'ACTIVATE' | 'AUTOTOPUP' | 'BALANCE' | 'BLOCK' | 'CANCEL' | 'CREATE' | 'CREDIT' | 'DEBIT' | 'INACTIVATE' | 'INVALIDATE' | 'LOAD' | 'REACTIVATE' | 'REDEEM' | 'REFUND' | 'REISSUE' | 'RESEND' | 'SPEND' | 'STAMP' | 'STOLEN' | 'TOPUP' | 'TRANSFER' | 'TRANSFER_IN' | 'UNBLOCK' | 'UNLOCK' | 'UNREDEEM' | 'VERIFY' | 'VOID' — The type of transaction. - `value` integer — The value related to this account transaction. Typically, if an account transaction like credit was executed with a value, then this value will be stored here. For Continuity, however, this value should always be 0, and the same for Coupon (since there is no value for a coupon). - `source` string — The source of this transaction e.g. from a client, or automated. - `transactionDetails` object — An simple object of key value pairs representing the transaction details. For Points and Continuity, this can contain a JSON encoded object with the details of the amounts applied to each balance. - `balancesBefore` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `balancesAfter` AccountTransactionBalancesHistoryEntity — The object of balances to show for either before or after the account transaction. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance. - `refundable` integer — The refundable balance. This is applicable for all account types, except STAMP, ECOUPON, POINTS and CONTINUITY. - `current` integer — The current balance. Applicable only to accounts of type Points and Stamp. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type Points and Stamp. - `totalSpend` integer — The total spend balance. Applicable only to accounts of type Continuity. - `transactionCount` integer — The transaction counter. Applicable only to accounts of type Continuity. - `properties` object — Properties related to the account transaction. - `dateCreated` string — Date this account transaction was created - `lastUpdated` string — Date this account transaction was last updated - `account` WalletAccountEntity — The account object, present only if include=accounts is passed in the query string. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - … - `ENTITLEMENT_OF` object - … - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - … - `children` unknown - `rewardAccounts` WalletAccountEntity[], nullable — List of Reward Account Transactions or Accounts - for operations on multiple and linked accounts this property will be populated. - `accountId` string, required — EES AIR Wallet Account ID - `relationships` object — Wallet Accounts Relations - `ENTITLEMENT` object - … - `ENTITLEMENT_OF` object - … - `walletId` string, required — EES AIR Wallet ID - `campaignId` string, required — The campaignId (Campaign or Programme) this account belongs to. - `type` 'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC', required — EES AIR Account Type. - `clientType` string, required — Account client type. - `status` 'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED', required — Account status - `state` string, required — Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process. - `dates` DatesEntity, required - `start` string, date-time - `end` string, date-time - `meta` MetaEntity, required - `key1` string — Meta 1 property, up to 250 characters; up to 750 characters for Key 1 Value - `key2` string — Meta 2 property, up to 250 characters; up to 750 characters for Key 2 Value - `balances` AccountBalancesEntity, required — The object of balances. Some balances only apply to certain types of accounts. See notes below on balances. - `available` integer — The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero. - `refundable` integer — The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero. - `totalSpend` integer — The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0. - `transactionCount` integer — The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0. - `current` integer — The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `usable` integer — The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `locked` integer — The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0. - `lifetime` integer — The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0. - `dateCreated` string, date-time, required — Date this Account was created - `lastUpdated` string, date-time, required — Date this Account was last updated - `tokens` TokenEntity[] — Array of token entities, present only if include=tokens is passed in the query string. - `tokenId` string — The Token ID. - `accountId` string — The Account ID. - `token` string — The Token. - `validFrom` string, date-time — The date this token is valid from. - `validTo` string, date-time — The date this token is valid to. - `dateCreated` string, date-time — The date this token was created. - `lastUpdated` string, date-time — The date this token was last updated. - `status` string — The status of the Token. - `tokenLock` object — Token lock information. All values can be null if no token lock exists. - … ## Other responses - `207` — Multi-Status - `400` — Bad Request. - `401` — Unauthorized. - `403` — Forbidden. - `404` — Not Found. - `409` — Conflict - `415` — Unsupported Media Type - `423` — Locked - `429` — Too Many Requests - `500` — Server Error --- [API](https://skmtc.net/eagleeye/apis/wallet-api.md) · [All operations](https://skmtc.net/eagleeye/apis/wallet-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeye/wallet-api/versions/90a122bb14cc/schema)