Client API
Welcome to the CAPAY Client API. It lets you move money globally—send payments, collect deposits, hold balances across currencies, convert FX, and receive real-time event notifications—for yourself and for the underlying customers you serve.
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 Client, a single idea shapes almost every call: the optional clientId
parameter. Omit it and you act as yourself; provide it and you act for a
specific underlying customer. Read
Understanding Your Account
early—it makes everything else click.
What you can do
| Area | Capabilities |
|---|---|
| Authentication | Exchange apiUser + apiKey for a short-lived access token |
| Accounts, Balances & Transactions | Query balances, manage virtual accounts, reconcile the ledger |
| Fund Flow | Understand House / Sub-Accounts and POBO / COBO movements |
| Beneficiaries | Create and validate payees, 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 Client 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.