Projects are used to organize and track incoming payments within an Operation Company (Opco). Every project has to be linked to an Opco, and every payment is linked to both a project and a user — so you always know which payment belongs to which project and who made it.
For example, if you have 3 projects under the same Opco, each incoming payment is attributed to the specific project and user it belongs to, giving you full visibility over your payment activity.
Use these endpoints to create and manage projects. All endpoints use the /api/v1/projects base path.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/projects/create | Create a new project linked to an operation company |
GET | /api/v1/projects | List all projects for the current client |
GET | /api/v1/projects/{project_id} | Retrieve details of a specific project |
PUT | /api/v1/projects/{project_id} | Update a project's configuration (name, callback URLs, settings) |
Key Concepts
- Project ↔ Opco — Each project is associated with an operation company (Sub-TPP). The Opco just must not be
rejectedordeactivated— a project can be created under an Opco that is stilldraft,pending_superadmin_review, orawaiting_approval, not only one that is fullyactivated. - Freeze control — Projects can be frozen to temporarily disable payment processing. Freeze status changes trigger the
project.frozen_changedwebhook event. - Callback URLs — Each project defines its own
payment_return_urlfor redirecting users after checkout completion.
Required roles
Reading projects (GET /projects, GET /projects/{project_id}) is open to OWNER, DEVELOPER, and OPERATIONS. Creating or updating a project (POST /projects/create, PUT /projects/{project_id}) requires OWNER or OPERATIONS — the DEVELOPER role cannot create or update projects. See Roles and Permissions.
Related guides
- Core Concepts — How projects organize payments under OpCos
- Getting Started — Create your first project
- Error Reference — Project-related errors