EAeagleeye
Wallets

Suspend Wallet

This API method allows the calling application to suspend a wallet.

patch/wallet/{walletId}/suspend

Request

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

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

EmptyPatchPayload required

Response

OK

walletIdstring

Wallet ID

friendlyNamestring

Friendly Name of the Wallet

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

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": "10646",
  "friendlyName": "Wallet Friendly Name",
  "status": "SUSPENDED",
  "type": "CONSUMER",
  "state": "EARNBURN",
  "relationships": {
    "parent": [],
    "child": [],
    "associate": []
  },
  "meta": {
    "key3": "Value3"
  },
  "dateCreated": "2017-01-11T16:25:58+00:00",
  "lastUpdated": "2017-01-13T11:11:12+00:00"
}

Changes