---
updatedAt: 2026-05-27T08:01:17.000Z
agentTools:
  siteIndex: https://developer.eagleeye.com/llms.txt
  projectIndex: https://developer.eagleeye.com/eagleeye-developer/llms.txt
---

# Create a Wallet, Identities, Coupon/Scheme Accounts and Consumer Object

We have the ability in AIR to create a wallet, one or more identities, one or more coupon accounts, one or more scheme accounts and a consumer object in a single API call. If the first identity provided already exists, subsequent actions will be completed against the existing wallet and no further identities or wallets will be created.

# OpenAPI definition

```json
{
  "x-explorer-enabled": false,
  "openapi": "3.0.3",
  "servers": [
    {
      "url": "https://wallet.uk.eagleeye.com/2.0",
      "description": "UK Production"
    }
  ],
  "info": {
    "title": "Wallet API",
    "description": "These API's are used for the interaction with the Eagle Eye AIR platform when using Wallets. A Wallet is a data container that links multiple other data objects. Wallets are typically accessed through the walletId which is obtained by calling application by looking up from an identity. Each wallet can have one or many identities.<br/><br/>For the avoidance of doubt this specification documents error codes thrown by the application it, does not cover error codes such as 429 to many requests, 503 service unavailable or 504 Gateway timeout.<br/><br/>The API supports standard Keep Alive as passed in through the Connection header (as supported by Google Cloud) and compression through the Accept-Encoding header is supported (gzip and deflate). Other standard HTTP headers maybe supported but not explicitly documented here.<br/><br/>This API is secured by Eagle Eye's standard security mechanic which is a client-id and hash where the hash is generated during the request. All API requests require the X-EES-AUTH-CLIENT-ID and X-EES-AUTH-HASH headers to be correct and valid (for more details see the authorise section) and as such are not directly specified per API definition below. <br/><br/>There are some additional headers supported by the system which are available on all API requests so documented in the table below to keep the specification cleaner<table><th width=25%>Header</th><th>Description</th></tr><tr><td>X-EES-TRANSACTION-ID</td><td>Unique Reference for the API transaction within the calling company</td></tr><tr><td>X-CUSTOM-SUBSYSTEM-ID</td><td>Optional header provided by the calling application for EES AIR to identify what was the external Subsystem that made the request, this is passed through in the atomic events and used for clients for their own purposes</td></tr><tr><td>X-CUSTOM-KEY</td><td>Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-* and is passed through to the atomic events for clients own purposes</td></tr></table>",
    "version": "2.170.0",
    "contact": {
      "name": "Eagle Eye Solutions",
      "url": "https://www.eagleeye.com/"
    }
  },
  "tags": [
    {
      "name": "Services",
      "description": "Service end points to perform business logic and can interact with multiple data objects."
    }
  ],
  "paths": {
    "/services/wallet/accounts": {
      "post": {
        "summary": "Create a Wallet, Identities, Coupon/Scheme Accounts and Consumer Object",
        "operationId": "createWalletAccountService",
        "description": "We have the ability in AIR to create a wallet, one or more identities, one or more coupon accounts, one or more scheme accounts and a consumer object in a single API call. If the first identity provided already exists, subsequent actions will be completed against the existing wallet and no further identities or wallets will be created.",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/servicesWalletAccountsPayload"
              }
            }
          },
          "description": "JSON payload",
          "required": true
        },
        "tags": [
          "Services"
        ],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/walletAccountServicesEntity"
                    }
                  ]
                },
                "examples": {
                  "201 - Basic Example": {
                    "value": {
                      "walletId": "123",
                      "friendlyName": "Alice Wallet",
                      "status": "ACTIVE",
                      "type": "BASIC_PARENT",
                      "state": "BASIC",
                      "meta": [],
                      "dateCreated": "2023-04-28T08:20:11+00:00",
                      "lastUpdated": "2023-04-28T08:20:11+00:00",
                      "relationships": {
                        "parent": [],
                        "child": [],
                        "associate": [],
                        "donor": []
                      },
                      "identities": [
                        {
                          "identityId": "1",
                          "walletId": "123",
                          "type": "BASIC_CARD",
                          "friendlyName": "Alice Identity",
                          "value": "identityValue_858219249",
                          "safeValue": "",
                          "secret": "",
                          "dates": {
                            "start": "2023-04-28T08:20:11+00:00",
                            "end": ""
                          },
                          "meta": [],
                          "state": "BASIC",
                          "status": "ACTIVE",
                          "dateCreated": "2023-04-28T08:20:11+00:00",
                          "lastUpdated": "2023-04-28T08:20:11+00:00",
                          "mobileWallet": "https://mobile.wallet.com/passbook/identity/125/33439/6622/8c71ac88ba9d5e71c4d"
                        },
                        {
                          "identityId": "2",
                          "walletId": "123",
                          "type": "BASIC_CARD",
                          "friendlyName": "Bob Identity",
                          "value": "identityValue_1165812777",
                          "safeValue": "",
                          "secret": "",
                          "dates": {
                            "start": "2023-04-28T08:20:11+00:00",
                            "end": ""
                          },
                          "meta": [],
                          "state": "BASIC",
                          "status": "ACTIVE",
                          "dateCreated": "2023-04-28T08:20:11+00:00",
                          "lastUpdated": "2023-04-28T08:20:11+00:00",
                          "mobileWallet": "https://mobile.wallet.com/passbook/identity/125/33439/6623/a8ce06c5acf0706fc8"
                        }
                      ],
                      "accounts": {
                        "campaign": {
                          "total": 2,
                          "results": [
                            {
                              "accountId": "234",
                              "walletId": "123",
                              "campaignId": "777",
                              "type": "ECOUPON",
                              "clientType": "",
                              "status": "ACTIVE",
                              "state": "BASIC",
                              "dates": {
                                "start": "2023-04-28T08:20:12+00:00",
                                "end": "2038-01-19T03:14:07+00:00"
                              },
                              "meta": [],
                              "dateCreated": "2023-04-28T08:20:12+00:00",
                              "lastUpdated": "2023-04-28T08:20:12+00:00",
                              "overrides": [],
                              "balances": {
                                "available": 0,
                                "refundable": 0
                              },
                              "relationships": [],
                              "mobileWallet": "https://mobile.wallet.com/passbook/account/41833/0c83522dc294aa960b14858c"
                            },
                            {
                              "accountId": "200",
                              "walletId": "123",
                              "campaignId": "455",
                              "type": "ECOUPON",
                              "clientType": "",
                              "status": "ACTIVE",
                              "state": "BASIC",
                              "dates": {
                                "start": "2023-04-28T08:20:12+00:00",
                                "end": "2038-01-19T03:14:07+00:00"
                              },
                              "meta": [],
                              "dateCreated": "2023-04-28T08:20:12+00:00",
                              "lastUpdated": "2023-04-28T08:20:12+00:00",
                              "overrides": [],
                              "balances": {
                                "available": 0,
                                "refundable": 0
                              },
                              "relationships": [],
                              "mobileWallet": "https://mobile.wallet.com/passbook/account/41834/87b69039c29f587641b14932"
                            }
                          ],
                          "successful": {
                            "total": 2,
                            "results": [
                              {
                                "accountId": "234",
                                "walletId": "123",
                                "campaignId": "777",
                                "type": "ECOUPON",
                                "clientType": "",
                                "status": "ACTIVE",
                                "state": "BASIC",
                                "dates": {
                                  "start": "2023-04-28T08:20:12+00:00",
                                  "end": "2038-01-19T03:14:07+00:00"
                                },
                                "meta": [],
                                "dateCreated": "2023-04-28T08:20:12+00:00",
                                "lastUpdated": "2023-04-28T08:20:12+00:00",
                                "overrides": [],
                                "balances": {
                                  "available": 0,
                                  "refundable": 0
                                },
                                "relationships": [],
                                "mobileWallet": "https://mobile.wallet.com/passbook/account/41833/0c83522dc294aa960b1485"
                              },
                              {
                                "accountId": "200",
                                "walletId": "123",
                                "campaignId": "455",
                                "type": "ECOUPON",
                                "clientType": "",
                                "status": "ACTIVE",
                                "state": "BASIC",
                                "dates": {
                                  "start": "2023-04-28T08:20:12+00:00",
                                  "end": "2038-01-19T03:14:07+00:00"
                                },
                                "meta": [],
                                "dateCreated": "2023-04-28T08:20:12+00:00",
                                "lastUpdated": "2023-04-28T08:20:12+00:00",
                                "overrides": [],
                                "balances": {
                                  "available": 0,
                                  "refundable": 0
                                },
                                "relationships": [],
                                "mobileWallet": "https://mobile.wallet.com/passbook/account/41834/87b69039c29f587641b149"
                              }
                            ]
                          },
                          "failed": {
                            "total": 0,
                            "results": []
                          }
                        }
                      }
                    }
                  },
                  "201 - Example With Tokens": {
                    "value": {
                      "walletId": "418",
                      "friendlyName": "Gemma Wallet",
                      "status": "ACTIVE",
                      "type": "BASIC_PARENT",
                      "state": "BASIC",
                      "meta": [],
                      "dateCreated": "2023-04-28T08:20:12+00:00",
                      "lastUpdated": "2023-04-28T08:20:12+00:00",
                      "relationships": {
                        "parent": [],
                        "child": [],
                        "associate": [],
                        "donor": []
                      },
                      "identities": [
                        {
                          "identityId": "3",
                          "walletId": "418",
                          "type": "BASIC_CARD",
                          "friendlyName": "Gemma Identity",
                          "value": "identityValue_2028299736",
                          "safeValue": "",
                          "secret": "",
                          "dates": {
                            "start": "2023-04-28T08:20:12+00:00",
                            "end": ""
                          },
                          "meta": [],
                          "state": "BASIC",
                          "status": "ACTIVE",
                          "dateCreated": "2023-04-28T08:20:12+00:00",
                          "lastUpdated": "2023-04-28T08:20:12+00:00",
                          "mobileWallet": "https://mobile.wallet.com/passbook/identity/125/33440/6624/bb9bb3d3d88855676a"
                        },
                        {
                          "identityId": "4",
                          "walletId": "418",
                          "type": "BASIC_CARD",
                          "friendlyName": "Debra Identity",
                          "value": "identityValue_640537280",
                          "safeValue": "",
                          "secret": "",
                          "dates": {
                            "start": "2023-04-28T08:20:12+00:00",
                            "end": ""
                          },
                          "meta": [],
                          "state": "BASIC",
                          "status": "ACTIVE",
                          "dateCreated": "2023-04-28T08:20:12+00:00",
                          "lastUpdated": "2023-04-28T08:20:12+00:00",
                          "mobileWallet": "https://mobile.wallet.com/passbook/identity/125/33440/6625/85fa3a5bcf907c014c"
                        }
                      ],
                      "accounts": {
                        "campaign": {
                          "total": 2,
                          "results": [
                            {
                              "accountId": "380",
                              "walletId": "418",
                              "campaignId": "777",
                              "type": "ECOUPON",
                              "clientType": "",
                              "status": "ACTIVE",
                              "state": "BASIC",
                              "dates": {
                                "start": "2023-04-28T08:20:12+00:00",
                                "end": "2038-01-19T03:14:07+00:00"
                              },
                              "meta": [],
                              "dateCreated": "2023-04-28T08:20:12+00:00",
                              "lastUpdated": "2023-04-28T08:20:12+00:00",
                              "overrides": [],
                              "balances": {
                                "available": 0,
                                "refundable": 0
                              },
                              "relationships": [],
                              "mobileWallet": "https://mobile.wallet.com/passbook/account/41835/cefee66706c2364451bc9099",
                              "tokens": [
                                {
                                  "tokenId": "1",
                                  "accountId": "",
                                  "token": "LPZ635SCJ",
                                  "validFrom": "2023-04-28T08:20:12+00:00",
                                  "validTo": "2038-01-19T03:14:07+00:00",
                                  "dateCreated": "2023-04-28T08:20:12+00:00",
                                  "lastUpdated": "2023-04-28T08:20:12+00:00",
                                  "status": "ACTIVE",
                                  "tokenLock": {
                                    "validFrom": "",
                                    "validTo": ""
                                  }
                                }
                              ],
                              "stats": null,
                              "limits": null,
                              "relatedAccounts": null,
                              "createTransaction": null
                            },
                            {
                              "accountId": "525",
                              "walletId": "418",
                              "campaignId": "455",
                              "type": "ECOUPON",
                              "clientType": "",
                              "status": "ACTIVE",
                              "state": "BASIC",
                              "dates": {
                                "start": "2023-04-28T08:20:12+00:00",
                                "end": "2038-01-19T03:14:07+00:00"
                              },
                              "meta": [],
                              "dateCreated": "2023-04-28T08:20:12+00:00",
                              "lastUpdated": "2023-04-28T08:20:12+00:00",
                              "overrides": [],
                              "balances": {
                                "available": 0,
                                "refundable": 0
                              },
                              "relationships": [],
                              "mobileWallet": "https://mobile.wallet.com/passbook/account/41836/48cd3a6fab85bc86a79a5a08",
                              "tokens": [
                                {
                                  "tokenId": "2",
                                  "accountId": "",
                                  "token": "DNG390DMC",
                                  "validFrom": "2023-04-28T08:20:12+00:00",
                                  "validTo": "2038-01-19T03:14:07+00:00",
                                  "dateCreated": "2023-04-28T08:20:12+00:00",
                                  "lastUpdated": "2023-04-28T08:20:12+00:00",
                                  "status": "ACTIVE",
                                  "tokenLock": {
                                    "validFrom": "",
                                    "validTo": ""
                                  }
                                }
                              ],
                              "stats": null,
                              "limits": null,
                              "relatedAccounts": null,
                              "createTransaction": null
                            }
                          ],
                          "successful": {
                            "total": 2,
                            "results": [
                              {
                                "accountId": "380",
                                "walletId": "418",
                                "campaignId": "777",
                                "type": "ECOUPON",
                                "clientType": "",
                                "status": "ACTIVE",
                                "state": "BASIC",
                                "dates": {
                                  "start": "2023-04-28T08:20:12+00:00",
                                  "end": "2038-01-19T03:14:07+00:00"
                                },
                                "meta": [],
                                "dateCreated": "2023-04-28T08:20:12+00:00",
                                "lastUpdated": "2023-04-28T08:20:12+00:00",
                                "overrides": [],
                                "balances": {
                                  "available": 0,
                                  "refundable": 0
                                },
                                "relationships": [],
                                "mobileWallet": "https://mobile.wallet.com/passbook/account/41835/cefee66706c2364451bc90",
                                "tokens": [
                                  {
                                    "tokenId": "1",
                                    "accountId": "",
                                    "token": "LPZ635SCJ",
                                    "validFrom": "2023-04-28T08:20:12+00:00",
                                    "validTo": "2038-01-19T03:14:07+00:00",
                                    "dateCreated": "2023-04-28T08:20:12+00:00",
                                    "lastUpdated": "2023-04-28T08:20:12+00:00",
                                    "status": "ACTIVE",
                                    "tokenLock": {
                                      "validFrom": "",
                                      "validTo": ""
                                    }
                                  }
                                ],
                                "stats": null,
                                "limits": null,
                                "relatedAccounts": null,
                                "createTransaction": null
                              },
                              {
                                "accountId": "525",
                                "walletId": "418",
                                "campaignId": "455",
                                "type": "ECOUPON",
                                "clientType": "",
                                "status": "ACTIVE",
                                "state": "BASIC",
                                "dates": {
                                  "start": "2023-04-28T08:20:12+00:00",
                                  "end": "2038-01-19T03:14:07+00:00"
                                },
                                "meta": [],
                                "dateCreated": "2023-04-28T08:20:12+00:00",
                                "lastUpdated": "2023-04-28T08:20:12+00:00",
                                "overrides": [],
                                "balances": {
                                  "available": 0,
                                  "refundable": 0
                                },
                                "relationships": [],
                                "mobileWallet": "https://mobile.wallet.com/passbook/account/41836/48cd3a6fab85bc86a79a5a",
                                "tokens": [
                                  {
                                    "tokenId": "2",
                                    "accountId": "",
                                    "token": "DNG390DMC",
                                    "validFrom": "2023-04-28T08:20:12+00:00",
                                    "validTo": "2038-01-19T03:14:07+00:00",
                                    "dateCreated": "2023-04-28T08:20:12+00:00",
                                    "lastUpdated": "2023-04-28T08:20:12+00:00",
                                    "status": "ACTIVE",
                                    "tokenLock": {
                                      "validFrom": "",
                                      "validTo": ""
                                    }
                                  }
                                ],
                                "stats": null,
                                "limits": null,
                                "relatedAccounts": null,
                                "createTransaction": null
                              }
                            ]
                          },
                          "failed": {
                            "total": 0,
                            "results": []
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "207": {
            "description": "Multi-Status",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/walletAccountServicesEntity"
                    }
                  ],
                  "example": {
                    "walletId": "189066",
                    "friendlyName": "Flinn Wallet",
                    "status": "ACTIVE",
                    "type": "BASIC_PARENT",
                    "state": "BASIC",
                    "meta": [],
                    "dateCreated": "2021-10-22T11:23:35+00:00",
                    "lastUpdated": "2021-10-22T11:23:35+00:01",
                    "relationships": {
                      "parent": [],
                      "child": [],
                      "associate": [],
                      "donor": []
                    },
                    "identities": [
                      {
                        "identityId": "85300",
                        "walletId": "189066",
                        "type": "BASIC_CARD",
                        "friendlyName": "",
                        "value": "identityValue_1526762061",
                        "safeValue": "",
                        "secret": "",
                        "dates": {
                          "start": "2021-10-22T11:23:36+00:00",
                          "end": ""
                        },
                        "meta": [],
                        "state": "BASIC",
                        "status": "ACTIVE",
                        "dateCreated": "2021-10-22T11:23:36+00:00",
                        "lastUpdated": "2021-10-22T11:23:36+00:00",
                        "mobileWallet": null
                      },
                      {
                        "identityId": "85301",
                        "walletId": "189066",
                        "type": "BASIC_CARD",
                        "friendlyName": "",
                        "value": "identityValue_1978067984",
                        "safeValue": "",
                        "secret": "",
                        "dates": {
                          "start": "2021-10-22T11:23:36+00:00",
                          "end": ""
                        },
                        "meta": [],
                        "state": "BASIC",
                        "status": "ACTIVE",
                        "dateCreated": "2021-10-22T11:23:36+00:00",
                        "lastUpdated": "2021-10-22T11:23:36+00:00",
                        "mobileWallet": null
                      }
                    ],
                    "accounts": {
                      "campaign": {
                        "total": 2,
                        "results": [
                          {
                            "accountId": "162020",
                            "walletId": "189066",
                            "campaignId": "12619",
                            "type": "ECOUPON",
                            "clientType": "",
                            "status": "ACTIVE",
                            "state": "BASIC",
                            "dates": {
                              "start": "2021-10-23T00:00:00+00:00",
                              "end": "2021-11-22T00:00:00+00:00"
                            },
                            "meta": [],
                            "dateCreated": "2021-10-22T11:23:36+00:00",
                            "lastUpdated": "2021-10-22T11:23:36+00:00",
                            "overrides": [],
                            "balances": {
                              "available": 0,
                              "refundable": 0
                            },
                            "relationships": [],
                            "mobileWallet": null
                          },
                          {
                            "errorCode": "NF",
                            "errorMessage": "Campaign not found"
                          }
                        ],
                        "successful": {
                          "total": 1,
                          "results": [
                            {
                              "accountId": "162020",
                              "walletId": "189066",
                              "campaignId": "12619",
                              "type": "ECOUPON",
                              "clientType": "",
                              "status": "ACTIVE",
                              "state": "BASIC",
                              "dates": {
                                "start": "2021-10-23T00:00:00+00:00",
                                "end": "2021-11-22T00:00:00+00:00"
                              },
                              "meta": [],
                              "dateCreated": "2021-10-22T11:23:36+00:00",
                              "lastUpdated": "2021-10-22T11:23:36+00:00",
                              "overrides": [],
                              "balances": {
                                "available": 0,
                                "refundable": 0
                              },
                              "relationships": [],
                              "mobileWallet": null
                            }
                          ]
                        },
                        "failed": {
                          "total": 1,
                          "results": [
                            {
                              "errorCode": "NF",
                              "errorMessage": "Campaign not found"
                            }
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/badRequest"
          },
          "401": {
            "$ref": "#/components/responses/unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/forbidden"
          },
          "404": {
            "$ref": "#/components/responses/notFound"
          },
          "409": {
            "$ref": "#/components/responses/conflict"
          },
          "415": {
            "$ref": "#/components/responses/unsupportedMediaType"
          },
          "423": {
            "$ref": "#/components/responses/locked"
          },
          "429": {
            "$ref": "#/components/responses/tooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/serverError"
          }
        }
      }
    }
  },
  "security": [
    {
      "eesAuthenticationClientId": [],
      "eesAuthenticationHash": []
    }
  ],
  "components": {
    "responses": {
      "badRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/defaultErrorEntity"
            }
          }
        }
      },
      "unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/defaultErrorEntity"
            },
            "example": {
              "errorCode": "AF",
              "errorMessage": "Authentication Failure, Please check if required AUTH headers are present in your Request and if AUTH Hash is calculated correctly"
            }
          }
        }
      },
      "forbidden": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorCode": "P",
                "errorMessage": "You don't have appropriate Privileges to perform this operation"
              }
            }
          }
        }
      },
      "notFound": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorMessage": "Not Found",
                "errorCode": "NF"
              }
            }
          }
        }
      },
      "conflict": {
        "description": "Conflict",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorMessage": "Conflict",
                "errorCode": "C"
              }
            }
          }
        }
      },
      "unsupportedMediaType": {
        "description": "Unsupported Media Type",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorMessage": "Unsupported media type - Check the content type of your request",
                "errorCode": "MP"
              }
            }
          }
        }
      },
      "locked": {
        "description": "Locked",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorMessage": "Transaction ID {transactionId} is not unique",
                "errorCode": "ITID"
              }
            }
          }
        }
      },
      "tooManyRequests": {
        "description": "Too Many Requests",
        "headers": {
          "Retry-after": {
            "description": "The number of seconds after which to retry the request",
            "schema": {
              "type": "integer"
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "errorCode": {
                  "type": "string",
                  "description": "The error code",
                  "enum": [
                    "CE"
                  ]
                },
                "errorMessage": {
                  "type": "string",
                  "description": "The error message for this error",
                  "enum": [
                    "This request has been throttled. Please try again later."
                  ]
                }
              }
            }
          }
        }
      },
      "serverError": {
        "description": "Server Error",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              ],
              "example": {
                "errorMessage": "Internal Server Error"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "eesAuthenticationClientId": {
        "type": "apiKey",
        "in": "header",
        "description": "Client ID, This will be provided by EES and is unique to the company calling the API. Please note the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding chunked could potentially cause authentication failures.",
        "name": "X-EES-AUTH-CLIENT-ID"
      },
      "eesAuthenticationHash": {
        "type": "apiKey",
        "in": "header",
        "description": "Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret. Please note the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding chunked could potentially cause authentication failures.",
        "name": "X-EES-AUTH-HASH"
      }
    },
    "schemas": {
      "walletConsumerCreatePayload": {
        "type": "object",
        "required": [
          "friendlyName",
          "type",
          "status"
        ],
        "properties": {
          "friendlyName": {
            "type": "string",
            "description": "The friendly name of the Wallet Consumer to be created"
          },
          "type": {
            "type": "string",
            "description": "The type of the Wallet Consumer to be created. These types are managed on a per-retailer basis."
          },
          "status": {
            "type": "string",
            "description": "The status of the Wallet Consumer to be created. Can be set to ACTIVE or DELETED"
          },
          "state": {
            "type": "string",
            "description": "The state of the Wallet Consumer to be created."
          },
          "data": {
            "type": "object",
            "properties": {
              "key1": {
                "type": "string",
                "description": "Meta 1 property, up to 255 characters; up to 255 characters for Key 1 Value"
              },
              "key2": {
                "type": "string",
                "description": "Meta 2 property, up to 255 characters; up to 255 characters for Key 2 Value"
              }
            }
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "personal": {
            "type": "object",
            "description": "It contains the data about the person.",
            "required": [
              "title",
              "firstName",
              "lastName"
            ],
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the person."
              },
              "firstName": {
                "type": "string",
                "description": "First name of the person."
              },
              "lastName": {
                "type": "string",
                "description": "Last name of the person."
              },
              "preferredName": {
                "type": "string",
                "description": "If provided, the preferred name of the person."
              },
              "language": {
                "type": "string",
                "description": "If provided, the preferred language of the person."
              },
              "gender": {
                "type": "string",
                "description": "If provided, the given gender of the person."
              },
              "birthDate": {
                "type": "string",
                "description": "If provided, the given date of birth."
              }
            }
          },
          "address": {
            "type": "array",
            "description": "Any kind of address.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "line1",
                "city",
                "county",
                "postcode",
                "country"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "An identifier for this particular address."
                },
                "type": {
                  "type": "string",
                  "description": "Type of address, usually not required but may be needed for BFPO.",
                  "enum": [
                    "local",
                    "overseas",
                    "bfpo"
                  ]
                },
                "line1": {
                  "type": "string",
                  "description": "First address line."
                },
                "line2": {
                  "type": "string",
                  "description": "Second address line."
                },
                "line3": {
                  "type": "string",
                  "description": "Third address line."
                },
                "city": {
                  "type": "string",
                  "description": "City."
                },
                "state": {
                  "type": "string",
                  "description": "State/Provence, if applicable in the territory."
                },
                "county": {
                  "type": "string",
                  "description": "County."
                },
                "postcode": {
                  "type": "string",
                  "description": "Postcode."
                },
                "country": {
                  "type": "string",
                  "description": "Country."
                }
              }
            }
          },
          "contact": {
            "type": "array",
            "description": "Contact details for an entity.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "type",
                "value"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Unique per type of contact, used to differentiate contacts of the same type."
                },
                "type": {
                  "type": "string",
                  "description": "The type of contact, used to set the communication medium.",
                  "enum": [
                    "email",
                    "phone",
                    "whatsapp"
                  ]
                },
                "value": {
                  "type": "string",
                  "description": "The contact value to be used in communications."
                }
              }
            }
          },
          "communication": {
            "type": "array",
            "description": "Information relating to a marketing channel, including optin options.",
            "items": {
              "type": "object",
              "required": [
                "type"
              ],
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of channel used for communication.",
                  "enum": [
                    "default",
                    "sms",
                    "email",
                    "postal",
                    "phone"
                  ]
                },
                "optin": {
                  "type": "object",
                  "description": "Information about optin options.",
                  "required": [
                    "admin"
                  ],
                  "properties": {
                    "admin": {
                      "type": "boolean",
                      "description": "Indication of optin to administrative communications."
                    },
                    "marketing": {
                      "type": "boolean",
                      "description": "Indication of optin to marketing communications."
                    }
                  }
                }
              }
            }
          },
          "consent": {
            "type": "array",
            "description": "Types of consent that may have been agreed to.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "accepted"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "A unique name identifying the name of the consented agreement. Take care for the name to be specific enough to be identified later."
                },
                "accepted": {
                  "type": "boolean",
                  "description": "A simple boolean indicating consent has been agreed."
                },
                "datetime": {
                  "type": "string",
                  "description": "The date and time that the consent was given."
                },
                "link": {
                  "type": "string",
                  "description": "A link (if applicable) to the consent agreement."
                },
                "signature": {
                  "type": "string",
                  "description": "A digital signature link, image link, or some other proof that the consent was agreed."
                }
              }
            }
          },
          "preference": {
            "type": "object",
            "description": "Information about the store preference.",
            "properties": {
              "store": {
                "type": "array",
                "description": "Information about the store.",
                "items": {
                  "type": "object",
                  "properties": {
                    "brand": {
                      "type": "string",
                      "description": "The name of the brand."
                    },
                    "outlet": {
                      "type": "array",
                      "description": "Information about the outlet.",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "segment": {
            "type": "array",
            "description": "It holds information about a marketing segment against an entity.",
            "items": {
              "type": "object",
              "required": [
                "labels"
              ],
              "properties": {
                "labels": {
                  "type": "array",
                  "minItems": 1,
                  "description": "List of segment labels that the entity belongs to for the given segmentation entry. The list can be used to denote hierarchy, lowest indexed items are higher in hierarchy terms. At least one item is required.",
                  "items": {
                    "type": "string"
                  }
                },
                "data": {
                  "type": "object",
                  "description": "A place to store arbitrary domain-specific data against the segmentation object."
                },
                "base": {
                  "type": "string",
                  "description": "An optional base of segmentation that is being applied.",
                  "enum": [
                    "DEM"
                  ]
                },
                "weight": {
                  "type": "integer",
                  "description": "The relative importance of the segmentation entry, lower numbers are lighter and more important, higher numbers are heavier and sink lower."
                },
                "confidence": {
                  "type": "number",
                  "description": "The score of how likely the segmentation is to be correct. Valid values are floats less than or equal to 1."
                }
              }
            }
          },
          "segmentation": {
            "type": "array",
            "description": "It holds information about the result of Marketing Segmentation against a given entity.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "segments"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Customer defined name / category for the segment."
                },
                "segments": {
                  "type": "array",
                  "description": "It contains segment objects in the array.",
                  "items": {
                    "type": "object",
                    "required": [
                      "labels"
                    ],
                    "properties": {
                      "labels": {
                        "type": "array",
                        "minItems": 1,
                        "description": "List of segment labels that the entity belongs to for the given segmentation entry. The list can be used to denote hierarchy, lowest indexed items are higher in hierarchy terms. At least one item is required.",
                        "items": {
                          "type": "string"
                        }
                      },
                      "data": {
                        "type": "object",
                        "description": "A place to store arbitrary domain-specific data against the segmentation object."
                      },
                      "base": {
                        "type": "string",
                        "description": "An optional base of segmentation that is being applied.",
                        "enum": [
                          "DEM"
                        ]
                      },
                      "weight": {
                        "type": "integer",
                        "description": "The relative importance of the segmentation entry, lower numbers are lighter and more important, higher numbers are heavier and sink lower."
                      },
                      "confidence": {
                        "type": "number",
                        "description": "The score of how likely the segmentation is to be correct. Valid values are floats less than or equal to 1."
                      }
                    }
                  }
                }
              }
            }
          },
          "dimension": {
            "type": "array",
            "description": "Dimensions are a means for defining arbitrary facts against an entity. The Air system may define standard dimension names against entities.",
            "items": {
              "type": "object",
              "required": [
                "label",
                "value"
              ],
              "properties": {
                "label": {
                  "type": "string",
                  "description": "Name of a dimension, standard supported names may exist in the main entity, refer to entity documentation for details."
                },
                "value": {
                  "type": "string",
                  "description": "The value for the dimension, must be a string."
                }
              }
            }
          }
        }
      },
      "walletIdentityCreatePayload": {
        "type": "object",
        "required": [
          "type",
          "status"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the Identity"
          },
          "friendlyName": {
            "type": "string",
            "description": "Identity friendly name"
          },
          "value": {
            "type": "string",
            "description": "Identity value "
          },
          "safeValue": {
            "type": "string",
            "description": "Identity safe value (e.g. \"original value salted and hashed\") - safeValue could then be used in external systems like analytics, referencing original identity, provide uniqueness within a retailer, but without exposing sensitive information like card number."
          },
          "secret": {
            "type": "string",
            "description": "Identity secret"
          },
          "dates": {
            "$ref": "#/components/schemas/datesEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "state": {
            "type": "string",
            "description": "Identity state"
          },
          "status": {
            "type": "string",
            "description": "Identity status",
            "enum": [
              "ACTIVE",
              "DELETED",
              "INACTIVE",
              "LOST",
              "STOLEN",
              "SUSPENDED",
              "TERMINATED"
            ]
          }
        }
      },
      "servicesWalletAccountsPayload": {
        "type": "object",
        "required": [
          "type",
          "identities",
          "accounts"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the Wallet to be created; e.g. CONSUMER"
          },
          "status": {
            "type": "string",
            "description": "Wallet status",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "SUSPENDED",
              "TERMINATED"
            ]
          },
          "state": {
            "type": "string",
            "description": "Wallet state"
          },
          "friendlyName": {
            "type": "string",
            "description": "The friendly name of the wallet"
          },
          "identities": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/walletIdentityCreatePayload"
            }
          },
          "accounts": {
            "type": "object",
            "properties": {
              "campaign": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/walletCouponAccountCreationPayloadOptionalCampaignTag"
                }
              },
              "scheme": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/servicesWalletAccountsSchemePayload"
                }
              }
            }
          },
          "consumer": {
            "$ref": "#/components/schemas/walletConsumerCreatePayload"
          }
        },
        "example": {
          "type": "BASIC_PARENT",
          "status": "ACTIVE",
          "state": "BASIC",
          "friendlyName": "testWallet_854935006",
          "identities": [
            {
              "friendlyName": "",
              "type": "BASIC_CARD",
              "state": "BASIC",
              "status": "ACTIVE",
              "value": "identityValue_1526762061"
            },
            {
              "friendlyName": "",
              "type": "BASIC_CARD",
              "state": "BASIC",
              "status": "ACTIVE",
              "value": "identityValue_1978067984"
            }
          ],
          "accounts": {
            "campaign": [
              {
                "campaignId": "12619",
                "tokenCode": "20211022112335729351",
                "status": "ACTIVE",
                "state": "BASIC",
                "dates": {
                  "start": "2021-10-23T00:00:00+00:00",
                  "end": "2021-11-22T00:00:00+00:00"
                }
              },
              {
                "campaignId": "12619",
                "status": "ACTIVE",
                "state": "BASIC"
              }
            ],
            "scheme": [
              {
                "schemeId": "12653",
                "status": "ACTIVE",
                "state": "EARNONLY"
              }
            ]
          },
          "consumer": {
            "type": "INDIVIDUAL",
            "state": "DEFAULT",
            "status": "ACTIVE",
            "data": {
              "personal": {
                "firstName": "John",
                "lastName": "Doe"
              }
            }
          }
        }
      },
      "servicesWalletAccountsSchemePayload": {
        "type": "object",
        "required": [
          "schemeId"
        ],
        "properties": {
          "schemeId": {
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/accountStatusEntity"
          },
          "state": {
            "type": "string",
            "description": "Account state"
          },
          "dates": {
            "$ref": "#/components/schemas/datesEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "details": {
            "$ref": "#/components/schemas/detailsEntity"
          },
          "location": {
            "$ref": "#/components/schemas/locationEntity"
          },
          "balances": {
            "$ref": "#/components/schemas/accountBalancesCreateEntity"
          }
        }
      },
      "walletConsumerEntity": {
        "type": "object",
        "properties": {
          "consumerId": {
            "type": "string",
            "description": "EES AIR Wallet Consumer ID"
          },
          "walletId": {
            "type": "string",
            "description": "EES AIR Wallet ID"
          },
          "friendlyName": {
            "type": "string",
            "description": "Wallet Consumer Friendly Name"
          },
          "type": {
            "type": "string",
            "description": "Wallet Consumer type. Types are managed per retailer base and could be set-up as part of the Onboarding process."
          },
          "status": {
            "type": "string",
            "description": "Wallet Consumer status.",
            "enum": [
              "ACTIVE",
              "DELETED"
            ]
          },
          "state": {
            "type": "string",
            "description": "Wallet Consumer State. States are managed per retailer base and could be set-up as part of the Onboarding process."
          },
          "data": {
            "type": "object",
            "description": "Additional Wallet Consumer Data. Please note 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.",
            "properties": {
              "key1": {
                "type": "string",
                "description": "Data 1 property, up to 255 characters; up to 255 characters for Key 1 Value"
              },
              "key2": {
                "type": "string",
                "description": "Data 2 property, up to 255 characters; up to 255 characters for Key 2 Value"
              }
            }
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "personal": {
            "type": "object",
            "description": "It contains the data about the person.",
            "required": [
              "title",
              "firstName",
              "lastName"
            ],
            "properties": {
              "title": {
                "type": "string",
                "description": "The title of the person."
              },
              "firstName": {
                "type": "string",
                "description": "First name of the person."
              },
              "lastName": {
                "type": "string",
                "description": "Last name of the person."
              },
              "preferredName": {
                "type": "string",
                "description": "If provided, the preferred name of the person."
              },
              "language": {
                "type": "string",
                "description": "If provided, the preferred language of the person."
              },
              "gender": {
                "type": "string",
                "description": "If provided, the given gender of the person."
              },
              "birthDate": {
                "type": "string",
                "description": "If provided, the given date of birth."
              }
            }
          },
          "address": {
            "type": "array",
            "description": "Any kind of address.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "line1",
                "city",
                "county",
                "postcode",
                "country"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "An identifier for this particular address."
                },
                "type": {
                  "type": "string",
                  "description": "Type of address, usually not required but may be needed for BFPO.",
                  "enum": [
                    "local",
                    "overseas",
                    "bfpo"
                  ]
                },
                "line1": {
                  "type": "string",
                  "description": "First address line."
                },
                "line2": {
                  "type": "string",
                  "description": "Second address line."
                },
                "line3": {
                  "type": "string",
                  "description": "Third address line."
                },
                "city": {
                  "type": "string",
                  "description": "City."
                },
                "state": {
                  "type": "string",
                  "description": "State/Provence, if applicable in the territory."
                },
                "county": {
                  "type": "string",
                  "description": "County."
                },
                "postcode": {
                  "type": "string",
                  "description": "Postcode."
                },
                "country": {
                  "type": "string",
                  "description": "Country."
                }
              }
            }
          },
          "contact": {
            "type": "array",
            "description": "Contact details for an entity.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "type",
                "value"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Unique per type of contact, used to differentiate contacts of the same type."
                },
                "type": {
                  "type": "string",
                  "description": "The type of contact, used to set the communication medium.",
                  "enum": [
                    "email",
                    "phone",
                    "whatsapp"
                  ]
                },
                "value": {
                  "type": "string",
                  "description": "The contact value to be used in communications."
                }
              }
            }
          },
          "communication": {
            "type": "array",
            "description": "Information relating to a marketing channel, including optin options.",
            "items": {
              "type": "object",
              "required": [
                "type"
              ],
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of channel used for communication.",
                  "enum": [
                    "default",
                    "sms",
                    "email",
                    "postal",
                    "phone"
                  ]
                },
                "optin": {
                  "type": "object",
                  "description": "Information about optin options.",
                  "required": [
                    "admin"
                  ],
                  "properties": {
                    "admin": {
                      "type": "boolean",
                      "description": "Indication of optin to administrative communications."
                    },
                    "marketing": {
                      "type": "boolean",
                      "description": "Indication of optin to marketing communications."
                    }
                  }
                }
              }
            }
          },
          "consent": {
            "type": "array",
            "description": "Types of consent that may have been agreed to.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "accepted"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "A unique name identifying the name of the consented agreement. Take care for the name to be specific enough to be identified later."
                },
                "accepted": {
                  "type": "boolean",
                  "description": "A simple boolean indicating consent has been agreed."
                },
                "datetime": {
                  "type": "string",
                  "description": "The date and time that the consent was given."
                },
                "link": {
                  "type": "string",
                  "description": "A link (if applicable) to the consent agreement."
                },
                "signature": {
                  "type": "string",
                  "description": "A digital signature link, image link, or some other proof that the consent was agreed."
                }
              }
            }
          },
          "preference": {
            "type": "object",
            "description": "Information about the store preference.",
            "properties": {
              "store": {
                "type": "array",
                "description": "Information about the store.",
                "items": {
                  "type": "object",
                  "properties": {
                    "brand": {
                      "type": "string",
                      "description": "The name of the brand."
                    },
                    "outlet": {
                      "type": "array",
                      "description": "Information about the outlet.",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "segment": {
            "type": "array",
            "description": "It holds information about a marketing segment against an entity.",
            "items": {
              "type": "object",
              "required": [
                "labels"
              ],
              "properties": {
                "labels": {
                  "type": "array",
                  "minItems": 1,
                  "description": "List of segment labels that the entity belongs to for the given segmentation entry. The list can be used to denote hierarchy, lowest indexed items are higher in hierarchy terms. At least one item is required.",
                  "items": {
                    "type": "string"
                  }
                },
                "data": {
                  "type": "object",
                  "description": "A place to store arbitrary domain-specific data against the segmentation object."
                },
                "base": {
                  "type": "string",
                  "description": "An optional base of segmentation that is being applied.",
                  "enum": [
                    "DEM"
                  ]
                },
                "weight": {
                  "type": "integer",
                  "description": "The relative importance of the segmentation entry, lower numbers are lighter and more important, higher numbers are heavier and sink lower."
                },
                "confidence": {
                  "type": "number",
                  "description": "The score of how likely the segmentation is to be correct. Valid values are floats less than or equal to 1."
                }
              }
            }
          },
          "segmentation": {
            "type": "array",
            "description": "It holds information about the result of Marketing Segmentation against a given entity.",
            "items": {
              "type": "object",
              "required": [
                "name",
                "segments"
              ],
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Customer defined name / category for the segment."
                },
                "segments": {
                  "type": "array",
                  "description": "It contains segment objects in the array.",
                  "items": {
                    "type": "object",
                    "required": [
                      "labels"
                    ],
                    "properties": {
                      "labels": {
                        "type": "array",
                        "minItems": 1,
                        "description": "List of segment labels that the entity belongs to for the given segmentation entry. The list can be used to denote hierarchy, lowest indexed items are higher in hierarchy terms. At least one item is required.",
                        "items": {
                          "type": "string"
                        }
                      },
                      "data": {
                        "type": "object",
                        "description": "A place to store arbitrary domain-specific data against the segmentation object."
                      },
                      "base": {
                        "type": "string",
                        "description": "An optional base of segmentation that is being applied.",
                        "enum": [
                          "DEM"
                        ]
                      },
                      "weight": {
                        "type": "integer",
                        "description": "The relative importance of the segmentation entry, lower numbers are lighter and more important, higher numbers are heavier and sink lower."
                      },
                      "confidence": {
                        "type": "number",
                        "description": "The score of how likely the segmentation is to be correct. Valid values are floats less than or equal to 1."
                      }
                    }
                  }
                }
              }
            }
          },
          "dimension": {
            "type": "array",
            "description": "Dimensions are a means for defining arbitrary facts against an entity. The Air system may define standard dimension names against entities.",
            "items": {
              "type": "object",
              "required": [
                "label",
                "value"
              ],
              "properties": {
                "label": {
                  "type": "string",
                  "description": "Name of a dimension, standard supported names may exist in the main entity, refer to entity documentation for details."
                },
                "value": {
                  "type": "string",
                  "description": "The value for the dimension, must be a string."
                }
              }
            }
          },
          "dateCreated": {
            "description": "Date this Wallet Consumer was created",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "lastUpdated": {
            "description": "Date this Wallet Consumer was last updated",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          }
        }
      },
      "datesEntity": {
        "type": "object",
        "properties": {
          "start": {
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "end": {
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          }
        }
      },
      "walletIdentityEntity": {
        "type": "object",
        "properties": {
          "identityId": {
            "type": "string",
            "description": "EES AIR Wallet Identity ID"
          },
          "walletId": {
            "type": "string",
            "description": "EES AIR Wallet ID"
          },
          "type": {
            "type": "string",
            "description": "Type of the Identity, list of possible enum values could be defined per Client as part of the Onboarding process."
          },
          "friendlyName": {
            "type": "string",
            "description": "Wallet Identity friendly name"
          },
          "value": {
            "type": "string",
            "description": "Wallet Identity value"
          },
          "safeValue": {
            "type": "string",
            "description": "Identity Safe Value (e.g. \"original value salted and hashed\") - safeValue could be than used in external systems like analytics, referencing original identity, provide uniqueness within a retailer, but without exposing sensible information like card number."
          },
          "secret": {
            "type": "string",
            "description": "Wallet Identity secret"
          },
          "dates": {
            "$ref": "#/components/schemas/datesEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "state": {
            "type": "string",
            "description": "Wallet Identity state, list of possible values could be defined and set-up per Client during Onboarding process."
          },
          "status": {
            "type": "string",
            "description": "Identity status",
            "enum": [
              "ACTIVE",
              "DELETED",
              "INACTIVE",
              "LOST",
              "STOLEN",
              "SUSPENDED",
              "TERMINATED"
            ]
          },
          "dateCreated": {
            "description": "Date this identity was created",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "lastUpdated": {
            "description": "Date this identity was last updated",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "mobileWallet": {
            "type": "string",
            "description": "A url that can be used to add this identity to a mobile wallet (like Apple Wallet and Google Pay)"
          }
        }
      },
      "walletEntity": {
        "type": "object",
        "properties": {
          "walletId": {
            "type": "string",
            "description": "Wallet ID"
          },
          "friendlyName": {
            "type": "string",
            "description": "Friendly Name of the Wallet"
          },
          "status": {
            "type": "string",
            "description": "Status of the EE Wallet.",
            "enum": [
              "ACTIVE",
              "DELETED",
              "INACTIVE",
              "SUSPENDED",
              "TERMINATED",
              "MERGED"
            ]
          },
          "type": {
            "type": "string",
            "description": "Wallet flag informing what is the type of that particular wallet. Could be defined per Client as part of the Onboarding process."
          },
          "state": {
            "type": "string",
            "description": "Additional flag, list of possible enum values could be defined per Client, as part of the Onboarding process."
          },
          "relationships": {
            "$ref": "#/components/schemas/walletRelationshipsEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "dateCreated": {
            "description": "Date-time (ATOM) this Wallet was created",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "lastUpdated": {
            "description": "Date-time (ATOM) this wallet was last updated",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          }
        },
        "example": {
          "walletId": "10663859",
          "friendlyName": "John's Wallet",
          "status": "ACTIVE",
          "type": "CONSUMER",
          "state": "EARNBURN",
          "relationships": {
            "parent": [],
            "child": [
              "10663858"
            ],
            "associate": [],
            "donor": []
          },
          "meta": {
            "key1": "Value1",
            "foo": "bar"
          },
          "dateCreated": "2017-01-03T16:25:58+00:00",
          "lastUpdated": "2017-01-03T16:25:58+00:00"
        }
      },
      "walletRelationshipsEntity": {
        "type": "object",
        "properties": {
          "parent": {
            "type": "array",
            "description": "Array of Wallet IDs that current Wallet should be / is parent",
            "items": {
              "type": "string"
            }
          },
          "child": {
            "type": "array",
            "description": "Array of existing Wallet IDs that current Wallet should be / is child",
            "items": {
              "type": "string"
            }
          },
          "associate": {
            "type": "array",
            "description": "anArray of existing Wallet IDs that current Wallet should be / is associated to",
            "items": {
              "type": "string"
            }
          },
          "donor": {
            "type": "array",
            "description": "an Array of existing Wallet IDs for which current Wallet is donating into",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "locationEntity": {
        "type": "object",
        "properties": {
          "storeId": {
            "type": "string",
            "format": "string",
            "description": "Identifier of the store where this transaction has happened (Outlet Incoming Identifier)."
          },
          "storeParentId": {
            "type": "string",
            "format": "string",
            "description": "Identifier of the parent store where this transaction has happened (Outlet Parent Incoming Identifier). This can be used when the parent of the store is a child of the caller Unit."
          }
        }
      },
      "metaEntity": {
        "type": "object",
        "properties": {
          "key1": {
            "type": "string",
            "description": "Meta 1 property, up to 255 characters; up to 255 characters for Key 1 Value"
          },
          "key2": {
            "type": "string",
            "description": "Meta 2 property, up to 255 characters; up to 255 characters for Key 2 Value"
          }
        }
      },
      "detailsEntity": {
        "type": "object",
        "properties": {
          "key1": {
            "type": "string",
            "description": "Details 1 property, up to 255 characters; up to 255 characters for Key 1 Value"
          },
          "reasonDescription": {
            "type": "string",
            "description": "Reason Code description"
          }
        }
      },
      "walletAccountRelationEntity": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "accountId",
            "dateCreated"
          ],
          "properties": {
            "accountId": {
              "type": "string",
              "format": "int64",
              "description": "Account ID"
            },
            "dateCreated": {
              "type": "string",
              "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
              "example": "2017-01-17T13:20:48+00:00",
              "description": "Relation creation date-time"
            }
          }
        }
      },
      "walletAccountEntity": {
        "type": "object",
        "required": [
          "accountId",
          "walletId",
          "campaignId",
          "type",
          "clientType",
          "status",
          "state",
          "dates",
          "balances",
          "dateCreated",
          "lastUpdated",
          "mobileWallet"
        ],
        "description": "The account object.",
        "properties": {
          "accountId": {
            "type": "string",
            "description": "EES AIR Wallet Account ID"
          },
          "walletId": {
            "type": "string",
            "description": "EES AIR Wallet ID"
          },
          "campaignId": {
            "type": "string",
            "description": "The Campaign ID this account belongs to."
          },
          "type": {
            "type": "string",
            "description": "EES AIR Account Type.",
            "enum": [
              "ECOUPON",
              "VOUCHER",
              "STAMP_CARD",
              "PAPER",
              "DEBIT",
              "PLASTIC",
              "POINTS",
              "CONTINUITY",
              "STANDARD_SUBSCRIPTION",
              "QUEST"
            ]
          },
          "clientType": {
            "type": "string",
            "description": "Account client type."
          },
          "status": {
            "$ref": "#/components/schemas/accountStatusEntity"
          },
          "state": {
            "type": "string",
            "description": "Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process."
          },
          "dates": {
            "$ref": "#/components/schemas/datesEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "balances": {
            "$ref": "#/components/schemas/accountBalancesEntity"
          },
          "relationships": {
            "type": "object",
            "description": "Wallet Accounts Relations",
            "properties": {
              "ENTITLEMENT": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "ENTITLEMENT_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "OBJECTIVE": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "OBJECTIVE_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "PROMOTION": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "PROMOTION_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "BOUNCE_BACK_REWARD": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "BOUNCE_BACK_REWARD_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "COUPON_STAMP_REWARD": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "COUPON_STAMP_REWARD_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              },
              "LOYALTY_POINTS_REWARD_OF": {
                "type": "object",
                "properties": {
                  "accountType": {
                    "$ref": "#/components/schemas/walletAccountRelationEntity"
                  }
                }
              }
            }
          },
          "overrides": {
            "$ref": "#/components/schemas/accountOverridesEntity"
          },
          "dateCreated": {
            "description": "Date this Account was created",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "lastUpdated": {
            "description": "Date this Account was last updated",
            "type": "string",
            "pattern": "/\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T[0-2]\\d:[0-5]\\d:[0-5]\\d[+-][0-2]\\d:[0-5]\\d/",
            "example": "2017-01-17T13:20:48+00:00"
          },
          "mobileWallet": {
            "type": "string",
            "description": "The URL that returns a digital platform wallet."
          }
        }
      },
      "accountOverridesEntity": {
        "type": "object",
        "description": "The object of overrides. A campaign must allow overrides.\n",
        "properties": {
          "continuity": {
            "type": "object",
            "description": "Overrides affecting the offer\n",
            "properties": {
              "qualification": {
                "type": "object",
                "description": "Continuity qualification area of the offer\n",
                "properties": {
                  "totalTransactionUnits": {
                    "type": "integer",
                    "description": "The number of units that are needed in the transaction to qualify for the reward."
                  },
                  "totalTransactionSpend": {
                    "type": "integer",
                    "description": "The transaction spend amount needed to qualify for the reward"
                  },
                  "totalTransactionCount": {
                    "type": "integer",
                    "description": "The number of transactions needed to qualify for the reward"
                  }
                }
              }
            }
          },
          "offer": {
            "type": "object",
            "description": "Overrides affecting the offer\n",
            "properties": {
              "qualification": {
                "type": "object",
                "description": "Qualification area of the offer",
                "properties": {
                  "minimumProductSpend": {
                    "nullable": true,
                    "type": "integer",
                    "description": "The minimum amount that must be spent."
                  },
                  "minimumUnits": {
                    "nullable": true,
                    "type": "integer",
                    "description": "The minimum number of units that must be in the basket to qualify."
                  },
                  "minimumBasketSpend": {
                    "nullable": true,
                    "type": "integer",
                    "description": "The minimum amount that must be spent in the basket."
                  }
                }
              },
              "reward": {
                "type": "object",
                "description": "Reward area of the offer\n",
                "properties": {
                  "creditAmount": {
                    "type": "integer",
                    "description": "The amount of points this account should earn when redeemed\n"
                  },
                  "step": {
                    "type": "integer",
                    "description": "The value of the interval when the discount amount should be stepped up."
                  },
                  "floor": {
                    "type": "integer",
                    "description": "The interval value where the credit amount should start increasing from."
                  },
                  "ceiling": {
                    "type": "integer",
                    "nullable": true,
                    "description": "The interval value where the credit amount should stop increasing."
                  },
                  "multiplierValue": {
                    "type": "integer",
                    "description": "The multiplication value to apply to the base issuance of points that would normally be awarded for the transaction."
                  }
                }
              }
            }
          },
          "campaign": {
            "type": "object",
            "description": "Overrides affecting the offer\n",
            "properties": {
              "rules": {
                "type": "object",
                "description": "The campaigns rules\n",
                "properties": {
                  "couponLimit": {
                    "type": "integer",
                    "description": "The amount of times a coupon can be redeemed, 0 is unlimited, 1 is default. If this is not set it will revert to what the campaigns couponLimit is set to\n"
                  }
                }
              }
            }
          },
          "reward": {
            "type": "object",
            "description": "Overrides affecting the reward\n",
            "properties": {
              "discountAmount": {
                "type": "integer",
                "minimum": 1,
                "description": "The discount amount to apply to the basket total.\n"
              },
              "finalAmount": {
                "type": "integer",
                "minimum": 1,
                "description": "The final amount to set the basket total to.\n"
              },
              "percentageAmount": {
                "type": "number",
                "minimum": 1,
                "description": "A percentage amount to be discounted. This must be an integer unless `allowDecimal` is enabled in the Unit.\n"
              },
              "discountValue": {
                "type": "integer",
                "minimum": 1,
                "description": "The discount value to increase with every interval.\n"
              }
            }
          }
        }
      },
      "accountBalancesEntity": {
        "type": "object",
        "description": "The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.",
        "properties": {
          "available": {
            "type": "integer",
            "description": "The available balance. This is applicable for all account types, except POINTS and CONTINUITY, which uses its own balance keys. For ECOUPON account type this property will be returned and will be equal to zero."
          },
          "refundable": {
            "type": "integer",
            "description": "The refundable balance. This is applicable for all account types except POINTS and CONTINUITY, but is not used during account creation. For an Account Entity, the amount displayed here is the total refundable balance available. Please note for ECOUPON account type this property will be returned and equal to zero."
          },
          "totalSpend": {
            "type": "integer",
            "description": "The total spend balance. Applicable only to CONTINUITY type Accounts. If totalSpend is not provided on creation, this will be set to 0."
          },
          "totalUnits": {
            "type": "integer",
            "description": "The total units balance. Applicable only to CONTINUITY type Accounts. If totalUnits is not provided on creation, this will be set to 0."
          },
          "transactionCount": {
            "type": "integer",
            "description": "The transaction counter. Applicable only to CONTINUITY type Accounts. If transactionCount is not provided on creation, this will be set to 0."
          },
          "current": {
            "type": "integer",
            "description": "The current balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0."
          },
          "usable": {
            "type": "integer",
            "description": "The usable balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0."
          },
          "locked": {
            "type": "integer",
            "description": "The locked balance. Applicable only to accounts of type POINTS. If not provided on creation, this will be set to 0."
          },
          "lifetime": {
            "type": "integer",
            "description": "The lifetime balance. Applicable only to accounts of type POINTS and STAMP. If not provided on creation, this will be set to 0."
          },
          "objectivesMet": {
            "type": "integer",
            "description": "The number of completed objectives. Applicable to only accounts of type QUEST."
          }
        }
      },
      "accountStatusEntity": {
        "type": "string",
        "description": "Account Status",
        "default": "ACTIVE",
        "enum": [
          "ACTIVE",
          "BLOCKED",
          "CANCELLED",
          "DELETED",
          "EXPIRED",
          "INACTIVE",
          "INVALIDATED",
          "LOCKED",
          "STOLEN",
          "USED",
          "SUSPENDED"
        ]
      },
      "walletAccountBaseCreationPayload": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/accountStatusEntity"
          },
          "state": {
            "type": "string",
            "description": "Account state"
          },
          "currency": {
            "type": "string"
          },
          "dates": {
            "$ref": "#/components/schemas/datesEntity"
          },
          "meta": {
            "$ref": "#/components/schemas/metaEntity"
          },
          "details": {
            "$ref": "#/components/schemas/detailsEntity"
          },
          "location": {
            "$ref": "#/components/schemas/locationEntity"
          },
          "balances": {
            "$ref": "#/components/schemas/accountBalancesCreateEntity"
          },
          "overrides": {
            "$ref": "#/components/schemas/accountOverridesEntity"
          }
        }
      },
      "walletCouponAccountCreationPayload": {
        "allOf": [
          {
            "$ref": "#/components/schemas/walletAccountBaseCreationPayload"
          }
        ],
        "type": "object"
      },
      "walletCouponAccountCreationPayloadOptionalCampaignTag": {
        "allOf": [
          {
            "$ref": "#/components/schemas/walletCouponAccountCreationPayload"
          }
        ],
        "type": "object",
        "properties": {
          "campaignId": {
            "type": "string",
            "format": "string",
            "description": "Campaign ID"
          },
          "campaignTag": {
            "type": "string",
            "format": "string",
            "description": "Campaign Tag"
          },
          "tokenCode": {
            "type": "string",
            "format": "string",
            "description": "Token Code (please note that this will not work if a value is provided for campaignTag, only campaignId)"
          }
        }
      },
      "accountBalancesCreateEntity": {
        "type": "object",
        "description": "The object of balances. Some balances only apply to certain types of accounts. See notes below on balances.",
        "properties": {
          "available": {
            "type": "integer",
            "description": "The available balance. This is applicable for all account types, except STAMP, POINTS and CONTINUITY, which uses its own balance keys, and ECOUPON, which has no concept of a balance."
          },
          "totalSpend": {
            "type": "integer",
            "description": "The total spend balance. Applicable only to accounts of type Continuity. If totalSpend is not provided on creation, this will be set to 0."
          },
          "transactionCount": {
            "type": "integer",
            "description": "The transaction counter. Applicable only to accounts of type Continuity. If transactionCount is not provided on creation, this will be set to 0."
          },
          "current": {
            "type": "integer",
            "description": "The current balance. Applicable only to accounts of type Points and Stamp. If current is not provided on creation, this will be set to 0."
          },
          "usable": {
            "type": "integer",
            "description": "The usable balance. Applicable only to accounts of type Points. If usable is not provided on creation, this will be set to 0."
          },
          "locked": {
            "type": "integer",
            "description": "The locked balance. Applicable only to accounts of type Points. If locked is not provided on creation, this will be set to 0."
          },
          "lifetime": {
            "type": "integer",
            "description": "The lifetime balance. Applicable only to accounts of type Points and Stamp. If lifetime is not provided on creation, this will be set to 0."
          },
          "objectivesMet": {
            "type": "integer",
            "description": "The number of completed objectives. Applicable to only accounts of type QUEST."
          }
        }
      },
      "walletAccountServicesEntity": {
        "allOf": [
          {
            "$ref": "#/components/schemas/walletEntity"
          },
          {
            "type": "object",
            "properties": {
              "identities": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/walletIdentityEntity"
                }
              },
              "accounts": {
                "type": "object",
                "properties": {
                  "campaign": {
                    "$ref": "#/components/schemas/multiStatus207AccountEntity"
                  },
                  "scheme": {
                    "$ref": "#/components/schemas/multiStatus207AccountEntity"
                  }
                }
              },
              "consumer": {
                "$ref": "#/components/schemas/walletConsumerEntity"
              }
            }
          }
        ]
      },
      "defaultErrorEntity": {
        "type": "object",
        "required": [
          "errorCode",
          "errorMessage"
        ],
        "properties": {
          "errorCode": {
            "type": "string",
            "description": "Internal Error Code",
            "enum": [
              "AA",
              "AF",
              "ALR",
              "AALR",
              "AT",
              "CE",
              "CI",
              "CLPPR",
              "CILR",
              "CORQ",
              "CP",
              "CR",
              "CTNR",
              "CU",
              "CX",
              "DSN",
              "ELE",
              "FES",
              "IFU",
              "IH",
              "ILA",
              "IOC",
              "IP",
              "IPR",
              "IR",
              "ITID",
              "IW",
              "LIR",
              "LNA",
              "LPR",
              "MAC",
              "MAR",
              "MLV",
              "MNA",
              "MPA",
              "MTLE",
              "NF",
              "OC",
              "P",
              "RF",
              "RFL",
              "RW",
              "RWI",
              "TBR",
              "TBS",
              "TEXP",
              "TULR",
              "U",
              "UAS",
              "UV",
              "VA",
              "VC",
              "VI",
              "VL",
              "VNL",
              "VPUF",
              "VSM",
              "VU",
              "VUA",
              "VURC",
              "VURI",
              "VXP",
              "WLNF",
              "WTF",
              "WTNF"
            ]
          },
          "errorMessage": {
            "type": "string",
            "description": "Human Friendly Error Message"
          }
        },
        "x-enum": [
          {
            "errorCode": "AA",
            "errorMessage": "Invalid Access to API Method"
          },
          {
            "errorCode": "AF",
            "errorMessage": "Authorisation Failed"
          },
          {
            "errorCode": "ALR",
            "errorMessage": "Account Limit Reached"
          },
          {
            "errorCode": "AT",
            "errorMessage": "Account Type"
          },
          {
            "errorCode": "CE",
            "errorMessage": "Configuration Error"
          },
          {
            "errorCode": "CI",
            "errorMessage": "Campaign Inactive"
          },
          {
            "errorCode": "CILR",
            "errorMessage": "Campaign Issuance Limit Reached"
          },
          {
            "errorCode": "CLPPR",
            "errorMessage": "Campaign Limit Per Period Reached"
          },
          {
            "errorCode": "CORQ",
            "errorMessage": "Consumer Required"
          },
          {
            "errorCode": "CP",
            "errorMessage": "Campaign Pending"
          },
          {
            "errorCode": "CR",
            "errorMessage": "Campaign Removed"
          },
          {
            "errorCode": "CTNR",
            "errorMessage": "Consumer Type Not Recognized"
          },
          {
            "errorCode": "CU",
            "errorMessage": "Campaign Unknown"
          },
          {
            "errorCode": "CX",
            "errorMessage": "Campaign Expired"
          },
          {
            "errorCode": "DSN",
            "errorMessage": "Duplicated Serial Number"
          },
          {
            "errorCode": "ELE",
            "errorMessage": "Exchange Limit Exceeded"
          },
          {
            "errorCode": "FES",
            "errorMessage": "Scheduling Format Incorrect"
          },
          {
            "errorCode": "IFU",
            "errorMessage": "Insufficient Funds"
          },
          {
            "errorCode": "IH",
            "errorMessage": "Invalid Header set"
          },
          {
            "errorCode": "ILA",
            "errorMessage": "Invalid Load Amount"
          },
          {
            "errorCode": "IOC",
            "errorMessage": "Improper Offer Configuration"
          },
          {
            "errorCode": "IP",
            "errorMessage": "Invalid Parameter"
          },
          {
            "errorCode": "IPR",
            "errorMessage": "IP Address Rejected"
          },
          {
            "errorCode": "IR",
            "errorMessage": "Invalid Request"
          },
          {
            "errorCode": "ITID",
            "errorMessage": "Invalid Transaction ID"
          },
          {
            "errorCode": "IW",
            "errorMessage": "Voucher Can Not Be Created"
          },
          {
            "errorCode": "LIR",
            "errorMessage": "Outlet Identifier Required"
          },
          {
            "errorCode": "LNA",
            "errorMessage": "Outlet Not Allowed"
          },
          {
            "errorCode": "LPR",
            "errorMessage": "Outlet Prohibited by Campaign Settings"
          },
          {
            "errorCode": "MAC",
            "errorMessage": "Maximum Number of Code Variations"
          },
          {
            "errorCode": "MAR",
            "errorMessage": "Minimum Amount Required"
          },
          {
            "errorCode": "MLV",
            "errorMessage": "Maximum Voucher Value Exceeded"
          },
          {
            "errorCode": "MNA",
            "errorMessage": "Method Not Allowed"
          },
          {
            "errorCode": "MPA",
            "errorMessage": "Missing Parameter"
          },
          {
            "errorCode": "MTLE",
            "errorMessage": "Max Active Tokens Limit Exceeded"
          },
          {
            "errorCode": "NF",
            "errorMessage": "Not Found"
          },
          {
            "errorCode": "NPP",
            "errorMessage": "No Points Pending"
          },
          {
            "errorCode": "OC",
            "errorMessage": "Campaign has no Offer"
          },
          {
            "errorCode": "P",
            "errorMessage": "Privileges"
          },
          {
            "errorCode": "RF",
            "errorMessage": "Rollback Failure"
          },
          {
            "errorCode": "RFL",
            "errorMessage": "Redemption failed: Max redemption limit ... per period ... has been exceeded"
          },
          {
            "errorCode": "RW",
            "errorMessage": "Voucher Can Not Be Redeemed"
          },
          {
            "errorCode": "RWI",
            "errorMessage": "Token can not be Redeemed at this time. Blocked by redemption windows."
          },
          {
            "errorCode": "TBR",
            "errorMessage": "Minimum time since last redemption has not passed"
          },
          {
            "errorCode": "TBS",
            "errorMessage": "Minimum time since last stamp has not passed"
          },
          {
            "errorCode": "TEXP",
            "errorMessage": "Token Expired"
          },
          {
            "errorCode": "TULR",
            "errorMessage": "Token Usage Limit Reached"
          },
          {
            "errorCode": "U",
            "errorMessage": "Unknown Error"
          },
          {
            "errorCode": "UAS",
            "errorMessage": "Transaction Not Allowed by current account status"
          },
          {
            "errorCode": "UV",
            "errorMessage": "Voucher Unknown"
          },
          {
            "errorCode": "VA",
            "errorMessage": "Voucher already been sent"
          },
          {
            "errorCode": "VC",
            "errorMessage": "Voucher Cancelled"
          },
          {
            "errorCode": "VI",
            "errorMessage": "Voucher Invalid"
          },
          {
            "errorCode": "VL",
            "errorMessage": "Voucher Locked"
          },
          {
            "errorCode": "VNL",
            "errorMessage": "Voucher Not Locked"
          },
          {
            "errorCode": "VPUF",
            "errorMessage": "Voucher You don't have privileges to unlock this token"
          },
          {
            "errorCode": "VSM",
            "errorMessage": "Voucher Serial Mismatch"
          },
          {
            "errorCode": "VU",
            "errorMessage": "Voucher already redeemed"
          },
          {
            "errorCode": "VUA",
            "errorMessage": "No vouchers available for this campaign"
          },
          {
            "errorCode": "VURC",
            "errorMessage": "No Voucher Available to Redeem for Campaign"
          },
          {
            "errorCode": "VURI",
            "errorMessage": "No Voucher Available to Redeem for this Identity"
          },
          {
            "errorCode": "VXP",
            "errorMessage": "Voucher Expired"
          },
          {
            "errorCode": "WLNF",
            "errorMessage": "Wallet Link Not Found"
          },
          {
            "errorCode": "WTF",
            "errorMessage": "Wallet Transaction Failure"
          },
          {
            "errorCode": "WTNF",
            "errorMessage": "Wallet Transaction Not Found"
          }
        ]
      },
      "multiStatus207AccountEntity": {
        "type": "object",
        "description": "EES AIR was able to process partially this Request, due to some errors. ",
        "properties": {
          "successful": {
            "type": "object",
            "required": [
              "total",
              "results"
            ],
            "description": "Successfully process accounts",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32",
                "description": "Successfully processed Entities count"
              },
              "results": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/walletAccountEntity"
                }
              }
            }
          },
          "failed": {
            "type": "object",
            "description": "List of failures",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32",
                "description": "Failures item count"
              },
              "results": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/defaultErrorEntity"
                }
              }
            }
          },
          "results": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32",
                "description": "Combined `successful` and `failed` sections with operation order preserved"
              },
              "results": {
                "type": "array",
                "items": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  }
}
```