Getting Started
Everything you need to make your first authenticated API call to the QwikLive API in minutes.
Prerequisites
Before making your first API call, ensure you have:
- Sandbox credentials —
client_idandclient_secretissued from the QwikLive Developer Portal (sandbox tier) - Partner ID — A
partnerIdstring assigned to your integration (e.g.,PARTNER-ATM-001) - An HTTP client capable of sending JSON POST requests (curl, Postman, or your integration framework)
- Ability to generate UUID v4 values for per-request correlation IDs
Contact QwikLive to request sandbox credentials and a partnerId for your integration project. Credentials are environment-scoped — sandbox credentials do not work in production.
Environments
| Environment | Purpose | Path Version | Real Funds |
|---|---|---|---|
| Sandbox | Integration development and testing with synthetic data | v1 |
No |
| QA / UAT | Pre-production validation and client acceptance testing | v1 |
No |
| Production | Live transactions against real core banking | v1 |
Yes |
Production base URLs are provisioned during onboarding and are not published in this documentation. Contact QwikLive support for your production endpoint.
Base URL
All service endpoints (excluding /api/health) follow this URL pattern:
https://{host}/api/ssb/accountservices/{version}/{endpoint}
Replace {version} with v1 for all current sandbox and production requests. The health check endpoint uses a separate base path:
https://{host}/api/health
Authentication
The QwikLive EAPI uses Client ID / Client Secret header-based authentication. Both headers must be present on every request. A partnerId header is also required on all service endpoints.
| Header | Required | Description |
|---|---|---|
| x-correlation-id | Yes | Unique UUID v4 per request. Used for end-to-end tracing and must be included in all support queries. |
| client_id | Conditional | Client ID for policy enforcement. Required when client-ID-based policies are active in your environment. |
| client_secret | Conditional | Client secret paired with client_id. Required when client-ID-based policies are active. |
| partnerId | Yes* | Identifies the integration partner that initiated the transaction. Required on all endpoints except /api/health. |
| Content-Type | Yes | Must be application/json on all POST requests. |
Complete Header Example
POST /api/ssb/accountservices/v1/accounts/balance Content-Type: application/json x-correlation-id: 550e8400-e29b-41d4-a716-446655440000 client_id: your-sandbox-client-id client_secret: your-sandbox-client-secret partnerId: PARTNER-ATM-001
Generate a fresh UUID v4 for x-correlation-id on every request. Reusing correlation IDs makes support tracing unreliable and may cause issues with idempotency detection.
Your First API Call
The simplest call to verify connectivity is the health check endpoint — it requires no authentication and no request body:
curl -s https://{sandbox-host}/api/health
A successful response looks like:
{
"status": "ok",
"environment": "sandbox",
"version": "v1.0.5",
"dependencies": [
{ "name": "Gateway", "status": "UP", "latencyMs": 12 },
{ "name": "CoreBanking", "status": "UP", "latencyMs": 45 }
]
}
Once health returns "status": "ok", proceed to make an authenticated account lookup call:
curl -s -X POST https://{sandbox-host}/api/ssb/accountservices/v1/accounts \
-H "Content-Type: application/json" \
-H "x-correlation-id: $(uuidgen)" \
-H "client_id: $CLIENT_ID" \
-H "client_secret: $CLIENT_SECRET" \
-H "partnerId: PARTNER-ATM-001" \
-d '{
"head": { "acquirerId": "10001", "description": "ATM Account Lookup" },
"transaction": { "rrn": "250603001001", "date": "20260603", "type": "ACCOUNTLOOKUP" },
"deviceInfo": {
"terminalId": "ATM00001",
"terminalLoc": "100 Main St, New York NY 10001",
"acceptorId": "ACCEPTOR000001"
},
"institution": { "id": "000100" },
"card": { "pan": "543100XXXXXXXXX0781" }
}'
Sandbox Setup
The sandbox provides pre-configured synthetic test data. Use these values in all sandbox requests:
| Resource | Value | Notes |
|---|---|---|
| Institution ID | 000100 |
Default test financial institution |
| Card PAN | 543100XXXXXXXXX0781 |
Standard debit card — happy path for all card-present operations |
| DDA Account | DDA1234567890 |
Primary checking account — balance $4,821.50 |
| Savings Account | SAV9876543210 |
Savings account — balance $12,400.00 |
| Zero-Balance Account | DDA0000000000 |
Triggers responseCode 110 (Insufficient Funds) |
| Biller ID / BIN | 600001 |
Test biller for bill payment scenarios |
| Partner ID | PARTNER-ATM-001 |
Use in partnerId header for all sandbox requests |
All sandbox PANs, account IDs, and institution IDs are fictional and safe to share. See Sandbox & Testing for the full scenario coverage matrix.