Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Create Wallets and Identities

This API method allows the calling application to create a Wallet with one or more Identities within single API call.

post/services/wallet

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",
  "identities": [
    {
      "type": "CARD",
      "status": "ACTIVE",
      "value": "12344567890"
    },
    {
      "type": "FOB",
      "status": "ACTIVE",
      "value": 987654321
    }
  ],
  "relationships": {
    "child": [
      {
        "type": "PARENT_WALLET",
        "status": "ACTIVE"
      }
    ],
    "parent": [
      {
        "type": "CHILD_WALLET",
        "status": "ACTIVE"
      }
    ],
    "associate": [
      {
        "type": "ASSOCIATE_WALLET",
        "status": "ACTIVE"
      }
    ]
  },
  "meta": {
    "key2": "Value2"
  }
}

Response

Created

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