v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Get Wallet Accounts by Identity Value

This API method allows the calling application to retrieve a list of Wallet Accounts, for a Wallet identified by Wallet Identity Value.

get/wallet/accounts

Query parameters

includestring[]

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

identity-valuestring string required

Wallet Identity value

state[]string string

Query string for Result filtering by Account State(s). For single value square brackets could be omitted.

status[]string string

Query string for Result filtering by Account Status(es). For single value square brackets could be omitted.

type[]'ECOUPON' | 'VOUCHER' | 'STAMP_CARD' | 'PAPER' | 'DEBIT' | 'PLASTIC' | 'POINTS' | 'STANDARD_SUBSCRIPTION' | 'CONTINUITY'

Query string for Result filtering by Account Type(s). For single value square brackets could be omitted.

clientType[]string string

Query string for Result filtering by Account clientType(s). For single value square brackets could be omitted.

accountId[]string string

Query string for Result filtering by Wallet Account Id(s). For single value square square brackets could be omitted.

unitId[]string string

Query string for Result filtering by returning only child Accounts of supplied Unit.

issuerId[]string string

Query string for Result filtering by returning only child Accounts of supplied Issuer.

campaignIdstring string

Query string allowing to filter out returned results by Campaign Id.

validTostring date-time

Query string for Result Filtering by Account Valid To explicit date-time value or date-time range, for range named key attributes needs to be provided (validTo[to]=... and/or validTo[from]=...)

validFromstring date-time

Query string for Result Filtering by Account Valid From explicit date-time value or date-time range, for range named key attributes needs to be provided (validFrom[to]=... and/or validFrom[from]=...)

dateCreatedstring date-time

Query string for Result Filtering by Account Created explicit date-time value or date-time range, for range named key attributes needs to be provided (dateCreated[to]=... and/or dateCreated[from]=...)

lastUpdatedstring date-time

Query string for Result Filtering by Account Last Updated explicit date-time value or date-time range, for range named key attributes needs to be provided (lastUpdated[to]=... and/or lastUpdated[from]=...)

campaign-status'ACTIVE' | 'INACTIVE' | 'PENDING' | 'EXPIRED' | 'DELETED' | 'DRAFT' | 'REJECTED' | 'READY'

Query string for Result Filtering by Campaign Status. Please note enum below contains all possible Campaign statuses

tokens'true' boolean

Show up to 100 active Tokens associated with each account.

limitinteger

Query string Pagination Limit

offsetinteger

Query string Pagination Offset

orderBy[]string string

Query string for controlling Paginated Results Sorting Order. Please note this query string needs to be constructed from field name + comma sign and sorting order (ASC/DESC). Currently AIR supports sorting by keys: accountId, validFrom, validTo, dateCreated, lastUpdated

Response

OK

limitinteger

Results per page

totalinteger

Total Results

offsetinteger

Pagination Offset