Skip to main content

​
Overview

To apply your orchestrator fees and branding to a platform’s payments, link that platform’s Client ID (cli_* token) to your orchestrator. There are two ways to link: directly, when you already have the client ID, or via an onboarding link intent, when a recipient creates and links the client ID themselves. All linking endpoints use the x-orchestrator-key header.
Linking is one-to-one from the client ID side: a client ID can be actively linked to at most one orchestrator. Re-linking a client ID that is already linked to a different orchestrator is rejected; re-linking to the same orchestrator is idempotent.

​
List linked client IDs

Results are paginated with page and limit. When the platform has already shared its cli_* token with you, link it directly:
When you want a recipient to create and link a client ID themselves, create a link intent. It returns a single-use onboarding URL you hand to the recipient; redeeming it creates a client ID under the name you chose and links it to your orchestrator.
The response contains an onboarding url carrying a single-use access token. Share it with the recipient to complete onboarding.
A link intent is single-use and expires. Once redeemed, the new client ID is linked to your orchestrator and appears in GET /v2/orchestrators/client-ids.
Unlinking revokes the active link. The client ID itself continues to exist and work; it simply no longer carries your orchestrator’s fees and branding.

Orchestrator fees

Apply fees and per-client-ID overrides to linked client IDs.

Client ID Management

How platforms create and manage the cli_* client IDs you link.