Quick Start

This guide takes you from your Sandbox credentials to your first successful API call.

Before you start

Sandbox credentials are issued as part of the CA integration process: you submit a requirements sheet, we run a kickoff meeting, and CA then opens your Sandbox. If you do not have credentials yet, start with the Integration Process — it covers every stage, including the requirements sheet you need to complete first.

Step 1 — Authenticate

Exchange your credentials for a short-lived access token.

curl -X POST https://api.sandbox.capay.com.au/authenticate \
  -H "Content-Type: application/json" \
  -d '{ "apiUser": "your-api-user", "apiKey": "your-api-key" }'

Response:

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresInSeconds": 3600
}

See Authentication for the full token lifecycle.

Step 2 — Make your first call

Use the token as a Bearer credential. For example, list the clients you manage:

curl "https://api.sandbox.capay.com.au/clients/businesses" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Step 3 — Learn the model

One concept underpins everything: as a Program Manager you are the Tenant administrator — you are not a transacting entity yourself. Every API operation targets a specific Client within your Tenant, identified by clientId, which is required on all transactions. Read Understanding Your Role to understand the Tenant model and how clientId works.

Environments

Only the base URL changes when you switch environments:

Environment	Base URL
Sandbox	https://api.sandbox.capay.com.au
Production	https://api.capay.com.au

Going live

Once your internal testing in Sandbox is complete, notify your Integration Support team. CA reviews your integration against the requirements sheet you submitted and, after sign-off, issues your Production credentials to your Company Admin. See the integration process for how the review and the credential handover work.

Where to go next

To…	See
Onboard and approve clients	Client Management
Understand accounts, balances, and the ledger	Accounts, Balances & Transactions
Add a beneficiary for a client	Beneficiary Management
Send a payment	Payments
Receive funds	Deposits
Get real-time updates	Webhooks

Need help? Your Account Manager and Integration Support team are ready to assist.