Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Create Subscription Account

This API method allows the calling application to create a Subscription Account with Entitlement Accounts (arisen from supplied Plan definition) and place them into the corresponding Wallet.

post/wallet/{walletId}/plan/{planId}/account

Path parameters

walletIdstring string required

EES AIR Wallet ID

planIdstring string required

EES AIR Plan ID

Request body

status'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' | 'SUSPENDED'

Account Status

statestring

Account state

currencystring

Example request

{
  "details": {
    "details": {
      "key1": "Value1",
      "key2": "AnotherValue"
    }
  }
}

Response

Created

accountIdstring required

EES AIR Wallet Account ID

walletIdstring required

EES AIR Wallet ID

campaignIdstring required

The campaignId (Campaign or Programme) this account belongs to.

type'ECOUPON' | 'VOUCHER' | 'PAPER' | 'DEBIT' | 'PLASTIC' required

EES AIR Account Type.

clientTypestring required

Account client type.

status'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' required

Account status

statestring required

Account state, managed per retailer base, list of possible enum values could be set-up as part of the Onboarding process.

dateCreatedstring date-time required

Date this Account was created

lastUpdatedstring date-time required

Date this Account was last updated