Wallets

Create Wallet

Changed on Nov 3, 2026

This method allows the calling application to create a Wallet within the Eagle Eye Platform.

post/wallet

Request

Base URL
https://wallet.uk.eagleeye.com/2.0
URL
https://wallet.uk.eagleeye.com/2.0/wallet
Auth
API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Request body

typestring required

Type of the Wallet to be created; e.g. CONSUMER

status'ACTIVE' | 'DELETED' | 'INACTIVE' | 'SUSPENDED' | 'TERMINATED' required

Wallet status

statestring

Wallet state

friendlyNamestring

The friendly name of the wallet

Example request

{
  "type": "CONSUMER",
  "status": "ACTIVE",
  "state": "EARNBURN",
  "friendlyName": "Susan's Wallet",
  "meta": {
    "key2": "Value2"
  }
}

Response

Created

walletIdstring

Wallet ID

friendlyNamestring

Friendly Name of the Wallet

Status of the EE Wallet.

typestring

Wallet flag informing what is the type of that particular wallet. Could be defined per Client as part of the Onboarding process.

statestring

Additional flag, list of possible enum values could be defined per Client, as part of the Onboarding process.

dateCreatedstring

Date-time (ATOM) this Wallet was created

lastUpdatedstring

Date-time (ATOM) this wallet was last updated

Example response

{
  "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"
}

Changes

Nov 3, 20267bc73e06813c Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  the response's property format changed from date-time to no format for status
- breaking
  the response's property format changed from date-time to no format for status
- breaking
  the // response's property format changed from string to no format for status
- breaking
  the // response's property format changed from string to no format for status
- breaking
  the // response's property format changed from string to no format for status
- breaking
  the // response's property format changed from string to no format for status
- warning
  added the new AALR enum value to the //// response property for the response status
- warning
  added the new AALR enum value to the //// response property for the response status
- warning
  added the new AALR enum value to the //// response property for the response status
- warning
  added the new AALR enum value to the //// response property for the response status
- warning
  added the new CILR enum value to the //// response property for the response status
- warning
  added the new CILR enum value to the //// response property for the response status
- warning
  added the new CILR enum value to the //// response property for the response status
- warning
  added the new CILR enum value to the //// response property for the response status
- warning
  added the new CLPPR enum value to the //// response property for the response status
- warning
  added the new CLPPR enum value to the //// response property for the response status
- warning
  added the new CLPPR enum value to the //// response property for the response status
- warning
  added the new CLPPR enum value to the //// response property for the response status
- warning
  added the new DELETED enum value to the response property for the response status
- warning
  added the new ELE enum value to the //// response property for the response status
- warning
  added the new ELE enum value to the //// response property for the response status
- warning
  added the new ELE enum value to the //// response property for the response status
- warning
  added the new ELE enum value to the //// response property for the response status
- warning
  added the new MERGED enum value to the response property for the response status
- warning
  added the new RF enum value to the //// response property for the response status
- warning
  added the new RF enum value to the //// response property for the response status
- warning
  added the new RF enum value to the //// response property for the response status
- warning
  added the new RF enum value to the //// response property for the response status
- warning
  added the new RFL enum value to the //// response property for the response status
- warning
  added the new RFL enum value to the //// response property for the response status
- warning
  added the new RFL enum value to the //// response property for the response status
- warning
  added the new RFL enum value to the //// response property for the response status
- warning
  added the new TBR enum value to the //// response property for the response status
- warning
  added the new TBR enum value to the //// response property for the response status
- warning
  added the new TBR enum value to the //// response property for the response status
- warning
  added the new TBR enum value to the //// response property for the response status
- warning
  added the new TBS enum value to the //// response property for the response status
- warning
  added the new TBS enum value to the //// response property for the response status
- warning
  added the new TBS enum value to the //// response property for the response status
- warning
  added the new TBS enum value to the //// response property for the response status
- warning
  added the new TERMINATED enum value to the response property for the response status
- warning
  added the new WLNF enum value to the //// response property for the response status
- warning
  added the new WLNF enum value to the //// response property for the response status
- warning
  added the new WLNF enum value to the //// response property for the response status
- warning
  added the new WLNF enum value to the //// response property for the response status
- warning
  added the new WTF enum value to the //// response property for the response status
- warning
  added the new WTF enum value to the //// response property for the response status
- warning
  added the new WTF enum value to the //// response property for the response status
- warning
  added the new WTF enum value to the //// response property for the response status
- warning
  added the new WTNF enum value to the //// response property for the response status
- warning
  added the new WTNF enum value to the //// response property for the response status
- warning
  added the new WTNF enum value to the //// response property for the response status
- warning
  added the new WTNF enum value to the //// response property for the response status
- info
  added to the response body allOf list for the response status
- info
  removed from the response body allOf list for the response status
- info
  removed from the response body allOf list for the response status
- info
  removed from the response body allOf list for the response status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response property //// became required for the status
- info
  the response's property 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/ was added for the status
- info
  the response's property 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/ was added for the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
This list may be incomplete.

Operation history