Sign in
Consumers

Update Wallet Consumer State

This API method allows the calling application to change the State of a Wallet Consumer

patch/wallet/{walletId}/consumer/{consumerId}/state

Path parameters

walletIdstring string required

EES AIR Wallet ID

consumerIdstring string required

EES AIR Wallet Consumer ID

Request body

statestring required

The state to set.

Example request

{
  "state": "EARNBURN"
}

Response

OK

consumerIdstring required

EES AIR Wallet Consumer ID

walletIdstring required

EES AIR Wallet ID

friendlyNamestring required

Wallet Consumer Friendly Name

typestring required

Wallet Consumer type. Types are managed per retailer base and could be set-up as part of the Onboarding process.

status'ACTIVE' | 'DELETED' required

Wallet Consumer status.

statestring required

Wallet Consumer State. States are managed per retailer base and could be set-up as part of the Onboarding process.

dateCreatedstring date-time required

Date this Wallet Consumer was created

lastUpdatedstring date-time required

Date this Wallet Consumer was last updated

Changes