v1.0.5Changelog
Authentication Required

All endpoints except GET /api/health require client_id, client_secret, partnerId, and x-correlation-id headers. See Authentication.

Health

Customer Preferences

Account Management

Debit Transactions

Credit Transactions

Transfers

Bill Payments

Cardless Withdrawal

Common Request Patterns

All service endpoints (except health and preferences) share these common request objects. See Common Objects for full field documentation.

ObjectUsed InPurpose
headAll transaction endpointsAcquirer institution identifier and description
transactionAll transaction endpointsRRN, date, and transaction type
deviceInfoAll terminal-originated requestsTerminal ID, location, and acceptor ID
institutionAll endpointsFinancial institution identifier
paymentInstrumentFinancial transactionsAccount ID and card PAN
amountFinancial transactionsAmount, currency, and optional access fee
reverseInfoAll reversal endpointsReversal reason code and amount