Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Refresh Wallet Account

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.

patch/wallet/{walletId}/account/{accountId}/refresh

Path parameters

walletIdstring string required

EES AIR Wallet ID

accountIdstring string required

EES AIR Wallet Account ID

Request body

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

Account Status

statestring

Account state for new entitlements that will be created as a part of refresh. For existing entitlements state will not be updated. If not provided default wallet account state configuration is used.

Response

Updated

accountIdstring required

EES AIR Wallet Account ID

walletIdstring required

EES AIR Wallet ID

campaignIdstring required

The campaignId (Campaign or Programme) this account belongs to.

type'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC' required

EES AIR Account Type.

clientTypestring required

Account client type.

status'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' 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 date-time required

Date this Account was created

lastUpdatedstring date-time required

Date this Account was last updated