v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

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.

post/services/wallet/accounts

Request body

typestring required

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

status'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'TERMINATED'

Wallet status

statestring

Wallet state

friendlyNamestring

The friendly name of the wallet

Example request

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

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