Home
Guides
Start typing to search…

Object Types & Statuses

Many of the objects within the AIR platform are defined in this guide, along with information about which can be configured as part of your onboarding. Each object type has its types, client types, statuses and states defined. This guide also denotes which can be configurable as part of onboarding.

Types
The types listed are the common object types. The types are platform specific and not configurable.

Client Types
Client Types are configurable and can be setup as required during onboarding. The guide highlights the values included in the standard configuration within AIR.

Statuses
The statuses listed for each object are predefined within AIR and cannot be configured by the client.

States
The states listed are example values that are client-driven and will be configured by the client via Wallet config when onboarding.

Please speak to your Account Manager for further details on this.

Wallets

Types

There are no wallet types defined by the system.

Client Types

Wallet Client Types are configurable, but the standard configuration includes:

  • CONSUMER

Statuses

  • ACTIVE
  • INACTIVE
  • SUSPENDED
  • DELETED - Irreversible status and hidden from API responses and dashboard view
  • MERGED – irreversible status
  • TERMINATED – Irreversible status - Makes it read-only

States

Wallet states are configurable, but the standard configuration includes:

  • DEFAULT

Identities

Types

There are no identity types defined by the system.

Client Types

Identity client types are configurable, but the standard configuration includes:

  • CUSTOMER_ID

Statuses

  • ACTIVE
  • INACTIVE
  • LOST
  • SUSPENDED
  • DELETED - Irreversible status and hidden from API responses and dashboard views
  • STOLEN - Irreversible status
  • TERMINATED – Irreversible status - Makes it read-only

States

Identity states are configurable, but the standard configuraiton includes:

  • DEFAULT

Account

Types

Account types are as listed below. Different account types have different behaviours linked to them:

  • COUPON
  • ECOUPON
  • PAPER
  • CONTINUITY
  • STAMP_CARD
  • STORED_VALUE
  • DEBIT
  • PLASTIC
  • VOUCHER
  • LOYALTY
  • POINTS
  • STAMP_CARD
  • SUBSCRIPTION
  • STANDARD_SUBSCRIPTION

Client Types

Account Client Types are configurable, but the standard configuration includes:

  • RETAILPOINTS (Used for points accounts)
  • OFFER (Used for any targeted or open offer based accounts)

Statuses

  • ACTIVE
  • BLOCKED
  • CANCELLED
  • DELETED
  • EXPIRED
  • INACTIVE
  • INVALIDATED
  • LOCKED
  • STOLEN
  • USED

States

Account states are configurable, but the standard configuration includes:

  • LOADED (The account will be used in adjudication during the next transaction)
  • UNLOADED (The account will be excluded from adjudication)
  • EARNONLY (A points account that can only earn points but not spend them - often used to encourage acceptance of T&Cs)
  • EARNBURN (A points account that can both earn and spend points)
  • HIDDEN (An account that will be included in adjudication but should not be surfaced to the customer in any digital channels)

Consumer

Types

There are no consumer types defined by the system.

Client Types

Consumer client types are configurable, but the stadnard configuration includes:

  • INDIVIDUAL

Statuses

  • ACTIVE
  • DELETED

States

Consumer states are configurable, but the standard configuraiton includes:

  • DEFAULT

Wallet Transactions

Types

There are no transaction types defined by the system.

Client Types

Wallet Transaction types are configurable, but the standard configuration includes:

  • ADJUSTMENT
  • BEHAVIOURAL_ACTION
  • CHALLENGE_REWARD
  • CREDIT
  • DEBIT
  • DONATION
  • EXCHANGE
  • EXPIRY
  • FULFIL
  • GIFT
  • GOODWILL
  • REDEEM_CREDIT
  • SETTLE
  • SPEND
  • SUBSCRIPTION_CANCELLED
  • SUBSCRIPTION_CREATED
  • SUBSCRIPTION_RENEWED
  • UNREDEEM
  • VOID

Statuses

  • ACTIVE
  • DELETED
  • CANCELLED
  • EXPIRED
  • SETTLED
  • PURGED
  • VOIDED
  • EMPTIED
  • FULFILLED
  • FULFILLING

States

Wallet Transaction states are configurable, but the standard configuration includes:

  • ORIGINAL
  • MODIFIED

Fund

Types

Fund types are not configurable.

  • POINTS
  • STORED_VALUE
  • DISCOUNT

Client Types

Fund client types are configurable. The standard configuration does not define any client types.

Statuses

  • ACTIVE
  • INACTIVE
  • DELETED
  • LOCKED

Fund Transactions

Types

Fund Transaction types are not configurable.

  • CREDIT
  • DEBIT
  • LOAD
  • UNLOAD
  • RESET

Client Types

Fund Transaction client types are configurable. The standard configuration does not define any client types.

Invite

Types

There are no invite types defined by the system.

Client Types

Client types are configurable, but the standard configuration defines:

  • INVITE

Statuses

  • ACTIVE
  • EXPIRED
  • CANCELLED
  • ACCEPTED
  • REJECTED

States

Invite states are configurable, but the standard configuration defines:

  • INVITE

Unit

Types

Unit types are not configurable.

  • COMPANY
  • OUTLET
  • SUPPLIER

The below types exist but are deprecated in the platform.

  • GROUP
  • DEPARTMENT

Statuses

  • ACTIVE
  • INACTIVE
  • DELETED

Campaign

Statuses

  • ACTIVE
  • INACTIVE
  • DELETED
  • EXPIRED
  • REJECTED
  • PENDING
  • DRAFT
  • READY
  • STOPPED
  • SUSPENDED

Updated about 4 hours ago