Project entity
Overview
A Project defines an operational environment under a company—used to configure payment processors, define soft descriptors, manage API integrations, and assign users. It’s the primary workspace for transaction and chargeback operations.Fields
| Field | Type | Description |
|---|---|---|
Project Name | Text | Human-readable identifier for the project (e.g., “MagazineAgent”). |
Phone Number | String | Primary contact number for project-level communication. |
Soft Descriptor | Text | Descriptor used in transaction statements (e.g., “Magazine-Agent.com Inc”). |
Active Processing Relationships | List | Currently active payment processors (e.g., Cybersource). |
Inactive Processors | List | Archived or disabled processors (e.g., Payflow). |
Select Gateway | Dropdown | Gateway selection for routing transactions. |
Users | List | Project members with roles (admin, manager, operator). |
Settings | Object | Custom configuration flags (processor credentials, environment modes, etc.). |
Status | Enum | Defines whether the project is active, paused, or archived. |
Relationships
- Many-to-One → Company: Projects belong to one company.
- One-to-Many → User: Each project may have multiple users with project-specific roles.
- Linked Services: Projects reference gateway and processor configurations through system APIs.
Projects are the central unit of execution, connecting gateways, configurations, and users.