Core objects
This guide describes the core objects that are configured during your onboarding process. Many endpoint calls address and interact with these core objects.
The following diagram shows a high-level overview of an organization, programs, and the mapping of account customers to entities.
Basic component structure
The Pismo platform has a built-in object hierarchy. The following table describes the platform's built-in object hierarchy and their basic relationships.
Object | Description |
|---|---|
Organization | Defines your company or enterprise. Contains one or more programs. |
Program | Defines a set of parameters for a group of accounts. A program has a type, such as credit, debit, or prepaid. |
Entity | A legal entity (person, company, or organization). As an attribute, an entity object contains a government document number, such as a driver's license, as well as other legal information that identifies a person, company, or organization. Every customer is associated with an entity object. If you do not provide an entity object when calling the Create customer endpoint, Pismo automatically creates one. Within an organization, multiple customer records with different customer IDs can be linked to the same entity object, indicating that they represent the same person or company. This relationship can help identify and track a person’s or company’s activities across customer records within an organization and, potentially, across multiple organizations. To search organization data by entity ID, contact the Pismo Service Desk and request access to this capability. |
Account | Each account belongs to a single program. An attribute not defined for an account is inherited from its program. |
Customer | Each account contains at least one customer, either an individual or company. Accounts can have multiple customers (typically to accommodate additional cardholders) but only one designated owner. A customer can only belong to one account. |
The first thing you need to do is work with Pismo to onboard your organization and add the first program to the Pismo platform. When those are in place, you can start creating accounts and customers, issuing cards, and calling Pismo API endpoints.
Field detailsSpecific field names, lengths, and ranges are not detailed in this guide. You can find this information in the API endpoint reference documentation.
Organization
The Pismo implementation team works with you to set up your organization. The organization is the root object on the Pismo platform, which is the container for all your programs.
| Description | Org element | Example |
|---|---|---|
| Your organization or company's legal name | Official name | Change the World LLC |
| Your organization's preferred name on the Pismo platform | Organization name | Change the World |
| Your organization's document number | Document number | 08350504000143 |
| Street address name | Address | Maple Lane |
| Street address number | Number | 900 |
| Any additional address information, such as unit, floor, suite, and so on | Complementary address | Suite 200 |
| Neighborhood, as some countries use assigned neighborhoods in addresses | Neighborhood | Shady Oaks |
| Country postal code | Zipcode | 12230660 |
| City | City | London |
| State/Province/Region | State | SP |
| Country | Country | England |
| Your organization's legal representative | Legal proxy name | Pismo Organization LTDA |
[email protected] | ||
| ISO 4217 currency numeric code; for example, 986 (Brazilian real) | Currency numeric code | 986 |
| Timezone name | Timezone | America/Sao_Paulo |
When created, your organization is assigned an identifier that is referred to as either an organization ID, org ID or tenant ID and looks similar to this: TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be.
("TN" is short for tenant, the legacy term for organization.)
Refer to the following endpoints for specific details about organization fields.
Program
After you have set up your organization, you can use Control Center or Programs API to create your organization's first program. Program attributes depend on the program type.
Control Center limitationsYou can perform most program configurations using Control Center. However, some configuration steps may still require you to work through the Pismo implementation team.
Entity
An entity object contains legal information that identifies a person or a company. The Create account application endpoint creates a default entity object for the account owner based on document ID. You can also define an entity object with the Create customer endpoint.
Account
You can create an account with the Create account application endpoint. For more information, refer to the Accounts guide.
Customer
An account customer can be either a person or a company. When you create an account, the first customer—the account owner—is also created. Accounts can have multiple customers, typically to accommodate primary and additional cardholders, but only one owner. A customer can only belong to one account.
Call the Create customer endpoint to define either a person or company customer object and add this customer to an account. For more information, refer to the Accounts guide.
Other objects
Card
To get started issuing cards, refer to Get started with card issuing. You can issue a card with the Create card endpoint.
Cards also come with associated mode objects for combination cards—cards that can be used for both credit and debit transactions. For more information, refer to Create a combination card with modes.
Updated 3 days ago