Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Wallets

Suspend Wallet

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

patch/wallet/{walletId}/suspend

Path parameters

walletIdstring string required

EES AIR Wallet ID

Request body

EmptyPatchPayload required

Response

OK

walletIdstring required

Wallet ID

friendlyNamestring required

Friendly Name of the Wallet

status'ACTIVE' | 'SUSPENDED' | 'INACTIVE' required

Status of the Wallet.

typestring required

TYPE of that particular wallet. Could be defined per AIR Tenant as part of the Client Onboarding process and then used, if this list is not defined only NULL values are available.

statestring required

STATE of that particular wallet. Could be defined per AIR Tenant as part of the Client Onboarding process and then used, if this list is not defined only NULL values are available.

dateCreatedstring date-time required

Wallet creation date time

lastUpdatedstring date-time required

Wallet last updated date time

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