v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Consumers

Create Wallet Consumer

This API method allows the calling application to create a new Wallet Consumer for a Wallet, identified by a Wallet ID. Please note there could be only one ACTIVE Wallet Consumer per Wallet.

post/wallet/{walletId}/consumer

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

friendlyNamestring required

The friendly name of the Wallet Consumer to be created

typestring required

The type of the Wallet Consumer to be created. These types are managed on a per-retailer basis.

statusstring required

The status of the Wallet Consumer to be created. Can be set to ACTIVE or DELETED

statestring

The state of the Wallet Consumer to be created.

Response

Created

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