Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Accounts

Create Coupon Account

This API method allows the calling application to create a coupon account and place into the corresponding wallet.

post/wallet/{walletId}/campaign/{campaignId}/account

Path parameters

walletIdstring string required

EES AIR Wallet ID

campaignIdstring string required

EES AIR Campaign ID

Query parameters

relatedAccountsboolean

Show all related accounts created with that account

tokensboolean

Show up to 100 active Tokens associated with the account.

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