QwikLive API
A unified REST/JSON gateway for ATM acquiring, account services, and channel transactions — enabling ATM switches, IVR platforms, teller workstations, and mobile channels to integrate through a single API endpoint.
Overview
The QwikLive Experience API (EAPI v1.0.5) is the QwikLive gateway API for ATM acquiring, account services, and channel transactions.
What is this API?
The QwikLive Experience API (EAPI v1.0.5) provides a unified REST/JSON interface over core banking systems. It enables ATM switches, IVR platforms, teller workstations, and mobile channels to execute financial transactions through a single integration point.
The API exposes 14 endpoints across 8 functional domains: Health, Customer Preferences, Account Management, Debit Transactions, Credit Transactions, Transfers, Bill Payments, and Cardless Withdrawals.
The sandbox environment mirrors production behavior with synthetic data. No real funds are processed. Use path version v1 for all sandbox and production-aligned requests.
Endpoint Domains
All 14 service endpoints are grouped into 8 functional domains:
Key Capabilities
- Unified integration point — ATM, IVR, teller, and mobile channels through one API
- ISO 8583 alignment — Request structure maps to DE-37 (RRN), DE-38 (Auth ID), DE-42 (Acceptor ID) field conventions
- Idempotent operations — Preference delete is idempotent; safe to retry without side effects
- Reversal support — Every financial transaction type has a corresponding reversal endpoint
- Multi-account balance — Balance responses return arrays of Available, Balance, and PaymentDue types
- Cardless ATM — QR/NFC-based withdrawals without a physical card present
- Consistent error envelope — All errors return a uniform
errorDetails[]structure with stable machine-readable reason codes
High-Level Architecture
The QwikLive EAPI acts as the gateway layer between channel clients and core banking systems:
Typical Integration Flow
A standard ATM transaction session follows this sequence:
Health Check
Verify sandbox/production connectivity before starting a session. GET /api/health — no authentication required.
Account Lookup
Submit the card PAN and institution ID to retrieve the cardholder's linked accounts and their transaction capabilities.
Balance Inquiry (optional)
Check the available balance for the selected account before executing a financial transaction.
Execute Transaction
Post the financial transaction — withdrawal, deposit, transfer, bill payment, or cardless withdrawal — using the account ID from step 2.
Reversal (if needed)
If the transaction cannot complete on the channel side (e.g., ATM unable to dispense), submit a reversal using the original RRN. Each transaction type has a corresponding reversal endpoint.
Explore the Documentation
Target Audience
This documentation is written for:
- Integration developers building ATM switch, IVR, teller, or mobile channel integrations
- Solutions architects designing multi-channel banking integrations
- QA and test engineers validating integration behavior in sandbox and UAT
- Client integration teams onboarding to the QwikLive platform
- Support teams diagnosing transaction failures using correlationId and response codes