Core objects and initial setup
This topic describes the Pismo platform's object structure and explains how the initial setup process works.
Core objects
The Pismo platform has a built-in hierarchy of objects, as shown in the following image.
The following table describes these elements and their basic relationships.
Core object | Description |
|---|---|
Org (Organization) | This is the top-level object in the structure. It contains one or more programs. |
Program | Defines a set of parameters for a group of accounts. (The specific parameters depend on the use case.) In Visa® and Mastercard® issuing scenarios, the program coincides with a product that is defined by a BIN range. |
Account | Contains balances and credit limits as attributes. Each account belongs to a single program and is always tied to a single customer. Whenever an attribute is not defined for an account, it is inherited from its program. Accounts can contain an unlimited number of customers, but only one customer can have the |
Customer | Each account contains at least one customer. The customer object defines an individual (person or company) associated with an account. For example, a person, John Doe, may have a work telephone number associated with a corporate credit card and another phone number associated with a wallet. No parameters are set at the customer level, but several account parameters use the |
Card (or Token) | A customer makes transactions against an account using an issued card. A customer object can have multiple cards. For security, a token is an encrypted string used in place of actual card information when making an API request. |
Entity | Entities include transactions, timeline events, addresses, phone numbers, and banking details. |
Setup process
The first step of your journey integrating with the Pismo platform is to set up your organization and your first program.
API access
No API access is possible until your org and program are created. To ensure a smooth setup experience, the Pismo Implementation team guides you through the steps of your setup process.
Org setup
To set up your org, you must provide the following initial attribute values to the Implementation team:
- oficial_name
- org_name
- document_number
- address
- number
- complementary_address
- neighborhood
- zipcode
- city
- state
- country
- legal_proxy_name
- legal_proxy_document
- category
- currency_numeric_code
- timezone
Program setup
After your org setup is complete, you use the Pismo Console to create the first program associated with your org. Program attributes depend on the type of program. Program types are:
- Credit
- Debit
- Combo (a mix of credit and debit). To do so, you must already have a
creditand adebitprogram associated with your org. - Prepaid
- Credit zero-balance
- Pre-paid zero-balance
- Merchant
- Seller management
The initial attributes needed to create any type of program are:
- Name
- Type
- Brand
- Initial_Card_Status
- BIN
- Value
- Start_Range
- End_Range
- Channels
- Name
- Type
- Program_ID
- Due_Dates
- Day
Initial_Card_Status property
This property defines default settings for newly created cards. For example, you can set new cards to be active when created.
Program_ID and Channels properties
Both of parameters identify the type of program you are creating. (You can use one or the other.)
Due_Dates property
If you skip this property, its default value is set to 1. Even debit programs require this parameter, as a way of grouping transactions.
Cloud storage
Pismo creates a cloud storage container for migrating your data.
Keys
Pismo also generates a server key and a secret key that provides you with access to Pismo's APIs.
Next steps
After the initial setup is completed, Pismo sends an email to the main account holder (Pismo's primary contact at your company) with helpful instructions for accessing our interfaces and account management applications.
Updated 5 months ago