Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Get Single Wallet Account

This API method allows the calling application to retrieve details for a Wallet Account.

get/wallet/{walletId}/account/{accountId}

Path parameters

walletIdstring string required

EES AIR Wallet ID

accountIdstring string required

EES AIR Wallet Account ID

Query parameters

includestring[]

A list of entities that should be included in the Account response

tokensboolean

Show up to 100 active Tokens associated with the account.

limitsboolean

Shows information on the limitations on using the account, this data varies per account type. For example, if it's a coupon account you'll see maxRedemptionsRemaining and perPeriodRedemptionsRemaining.

passphraseboolean

If passed then any tokens returned will have their passphrase included. This should be used with caution as the passphrase is designed to be secret (like a PIN number).

relatedAccountsboolean

This determines if related accounts are returned in the response. A collection of related wallet accounts, categorised by objects such as ECOUPON and CONTINUITY. It may also include relationships to other accounts, such as QUEST objects, and is used for multiple accounts.

Response

OK

accountIdstring required

EES AIR Wallet Account ID.

walletIdstring required

EES AIR Wallet ID.

campaignIdstring required

The Campaign ID this account belongs to.

type'ECOUPON' | 'VOUCHER' | 'STAMP_CARD' | 'PAPER' | 'DEBIT' | 'PLASTIC' | 'POINTS' | 'CONTINUITY' | 'STANDARD_SUBSCRIPTION' | 'QUEST' required

EES AIR Account Type.

clientTypestring required

Account client type.

status'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' | 'SUSPENDED' required

Account Status

statestring required

Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process.

dateCreatedstring required

Date this Account was created.

lastUpdatedstring required

Date this Account was last updated.

mobileWalletstring required

The URL that returns a digital platform wallet.

Example response

{
  "dateCreated": "2017-01-17T13:20:48+00:00",
  "lastUpdated": "2017-01-17T13:20:48+00:00"
}