Program Manager API
Welcome to the CAPAY Program Manager API. CA operates as a SaaS platform — as a Program Manager you are the administrator of your own Tenant, an isolated environment within the CA system. You onboard and manage the Clients within your Tenant, and initiate payments, deposits, balances, FX, and real-time event notifications for them.
Guides vs API Reference
This documentation has two parts:
- Guides (you're here) explain how the platform works and how to accomplish real tasks, with the business context behind each flow.
- API Reference is the technical specification—every endpoint, parameter, and response object, generated from our OpenAPI schema.
The one concept to learn first
As a Program Manager you are the Tenant administrator. Every API operation
targets a specific Client within your Tenant, identified by clientId —
this parameter is required on all transactions. Read
Understanding Your Role early—it
makes everything else click.
What you can do
| Area | Capabilities |
|---|---|
| Authentication | Exchange apiUser + apiKey for a short-lived access token |
| Client Management | Onboard, approve, and maintain the clients you manage |
| Accounts, Balances & Transactions | Query balances, manage virtual accounts, reconcile the ledger |
| Beneficiary Management | Create and validate payees per client, including Confirmation of Payee |
| Payments | Send standard and FX payments and track their lifecycle |
| Deposits | Collect funds via virtual accounts and simulate deposits in Sandbox |
| FX Rates | Get indicative rates and lock firm quotations |
| Webhooks | Subscribe to encrypted real-time event notifications |
The API does not support standalone FX conversions. Currency conversion is only available as part of a payment — you create a Payment with a currency conversion attached. If you need to convert funds without an outbound payment, you can do so directly through the Admin Portal.
Get started
Head to Quick Start to authenticate and make your first API call in minutes.
Need help?
Your Account Manager and Integration Support team are always ready to assist.