Operation Companies (Opcos) are the merchant entities through which you receive funds from your clients. If you operate multiple companies or legal entities that each need to receive payments independently, create a separate Opco for each one.
Opco registration is a one-time setup. Once an Opco is approved by the UrbanpayX compliance team (typically 3–5 business days), it is ready to accept payments and does not need to be registered again.
Use these endpoints to create, update, and submit operation companies for review and activation. All endpoints use the /api/v1/opcos base path.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/opcos/create | Create a new operation company in draft status |
GET | /api/v1/opcos | List all operation companies for the current client |
GET | /api/v1/opcos/{opco_id} | Retrieve details of a specific operation company |
PATCH | /api/v1/opcos/{opco_id} | Update an operation company while it is still in draft status |
POST | /api/v1/opcos/{opco_id}/submit | Submit a draft operation company to review and activation |
Lifecycle
An operation company follows this status flow:
- Draft — Created via
POST /create. Fields can be edited viaPATCH. - Submitted — Sent to UrbanpayX via
POST /submit. No further edits allowed. - Active / Rejected — Final status determined by UrbanpayX review. Status changes trigger the
opco.status_changedwebhook event.
Required roles
OWNER or OPERATIONS — DEVELOPER role cannot manage OpCos. See Roles and Permissions.
Related guides
- Core Concepts — What OpCos are and how they fit in the payment flow
- Getting Started — Create your first OpCo step by step
- Sandbox and Testing — OpCo approval takes minutes in sandbox
- Error Reference — OpCo-related errors and fixes