Definitions
To support issuer processing functionality and concepts, CLOWD9 defines a number of key entities, the following provides definitions for each of these entities.
Entities
Client
A client is a grouping and categorization entity that is arranged in hierarchy.
A client is identified by client_id.
Clients are arranged in hierarchy by establishing a parent, child relationship. A parent client may have more than one child clients.
End user entities such as customer, card and account are grouped under a client.
Customer, card and account belonging to same person must be owned by same client.
Currently following types / levels of clients are supported
- Issuer
- Program Manager
- Sub Group
Diagram below illustrates the hierarchy of these client levels.
Each client type / level and their specific definition is further detailed below:
Client Level - Issuer
This represents the real world “Issuer”.
Issuer is the top level client owning other clients under them in hierarchy.
Issuer is used to group clients of level / type “Program Managers”
Issuer may be issued with API key, that gives them access to create and manage other entities such as customer, card, account for this client of type Issuer, program manager and child, child of child and child of child of … clients.
Issuer is the top level client and API key issued at this level is able to create any entities for any child clients underneath issuer.
Client Level - Program Manager
This represents the real world “Program Manager”.
Operates under Issuer.
An issuer may have one or more program managers.
Typically API Keys are issued for clients of type Program Manager, that gives them access to create and manage other entities such as customer, card, account for this client of type Issuer and child, child of child and child of child of … clients
Client Level - Sub Group
This type / level of client is used to group end user entities such as customer, card and account.
Sub Groups may have children Sub Groups and they can have children Sub Groups too.
Currently it is not possible to issue API keys to this type of clients.
Customer
A customer is a an entity used to represent an end user.
Customer is identified by customer_id.
A customer may be any of the following -
- Card Holder
- Account Holder
- Additional Card Holder
- Additional Account Holder
- A customer may own both Card and Account
Card
A card is an entity used to represent a PAN.
Card is identified by card_id.
One card_id may result in multiple plastics for the same PAN issued. All of these physical cards for the same PAN represents same card_id.
Eg. Re-issued card with same PAN and different expiry date, Renewed card with same PAN and different expiry date and original card with same PAN and original expiry date, all of these cards will have same card_id.
Account
An account is an entity used to represent an Account, that stores value of assets.
Account is identified by account_id.
An account must be owned by a customer.
More than one customer may use the same account.
Cards are also linked the accounts.
Account Profile
An account profile is a template or definition of how an account should be created.
Account profiles are owned by clients.
Though the client owns account profile, until it is toggled to be usable for a combination of client and product it cannot be used.
Currently two types of accounts are supported, SINGLE and MULTIPLE.
BIN
BIN is used to represent card Bank Identification Number.
BIN is owned by Issuer client.
Program Manager client is granted access to use BIN.
BIN Range
A BIN Range is a subset of BIN.
This is the range within cards can be issued.
Bin range is associated to one or more card products.
Card Product
A card product is a template or configuration on how a card issued and how it should function.
Card Products are owned by Issuer and Program Manager clients only.
A card product is associated with a BIN or BIN range.
Updated 2 months ago