Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Consumers

Update Wallet Consumer Data

This API method allows the calling application to update the Wallet Consumer Data details for a Wallet using approach described in RFC 6902. Please note: #1 only consumer data sub-structure could be modified using that endpoint. #2 Wallet Consumer Data structure could be defined within AIR per Client. If this structure is defined, AIR can provide validation of content using regular expressions. Only replace operation is supported.

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

consumerIdstring string required

EES AIR Wallet Consumer ID

Request body

op'replace' required

Operation instruction as described in RFC 6902.

pathstring string required

Wallet Consumer Data sub-structure path to be actioned

valuestring string

Value of newly modified item in Wallet Consumer data sub-structure. Please note it is possible other operation might be implemented and they may not require this field, however it is required for replace operation

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