Quick Start

This guide walks you through the full integration journey — from getting your Sandbox credentials to going live in Production.

Integration overview

A typical integration follows these stages:

1. Provision Sandbox — CA sets up your Sandbox account and issues credentials.
2. Build & test — Develop against Sandbox, onboard test clients, and explore the API.
3. CA Sandbox review — CA reviews your integration and signs off.
4. Go live — CA provisions your Production credentials and delivers them to your developer email.

Step 1 — Getting your Sandbox credentials

To get started, provide the following to your CA Integration Support team:

What	Details
Sandbox user info	First name, last name, and email address of the person who will access the Sandbox Admin Portal
Developer email	The email address to be used as the developer account — this cannot be changed later, so we recommend using a shared or team inbox

CA will register your Sandbox account and send your apiUser and apiKey to your developer email.

Step 2 — 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 3 — 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 4 — 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.

Step 5 — CA Sandbox review & go live

Once you have completed your Sandbox integration, notify your Integration Support team. CA will review your implementation and, once signed off, will provision your Production apiUser and apiKey and deliver them to your developer email. 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

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.