Explore our APIs
Please check back later for the latest information.
Qash provides a collection of REST APIs that let you build financial products, automate banking operations, and integrate directly the Qash platform.
Whetever you're building a digital bank, a fintech application, or internal tooling, our APIs are designed to be consistent, secure, and easy to integrate.
How Qash APIs are organized
Our APIs are grouped by business domain.
| Business Domain | Description | Resources |
|---|---|---|
| Authentication | Authenticate users and applications, manage sessions and credentials. | Authentication |
| Users | Manage platform users, profiles, permissions, and identities. | Users |
| Partners | Manage financial partners and external organizations connected to Qash. | Partners |
| Partner Integrations | Configure how partners connect and interact with Qash. | Partners – API Keys, Partners – Webhooks |
| Partner Settlement | Manage settlement accounts, routing, and reserve connections for partners. | Partners – Federal Reserve Connections, Partners – Settlements |
| Financial Institutions | Manage banks, credit unions, and other regulated financial institutions. | Financial Institutions (DoC) |
| Core Banking | Core banking services for customer accounts and balances. | CBS – Account Holders, CBS – Accounts |
| Cash Management | Treasury, liquidity, vaults, and cash operations. | CBS – Cash Management |
| Mandates | Direct debit authorizations, payment mandates, and customer consent. | Mandates |
| Payments & Transactions | Payment processing, transfers, network messages, and transaction lifecycle. | Network Transactions |
| Securities | Securities custody, issuance, trading, and settlement. | CES – Securities |
| Datasets | Reference data, lookup tables, configuration, and metadata used across the platform. | Datasets |
API Design
All APIs follow the same principles.
- RESTful JSON endpoints
- HTTPS only
- UTF-8 encoded requests
- Standard HTTP status codes
We will enhance our API in version 2 to ensure new principles :
- ISO 8601 timestamps
- Cursor-based pagination
- Predictable error responses
Authentication
Most endpoints require an access token.
Depending on your integration, you may authenticate using:
- A partner API key, intended for automated systems of registered partners in a HTTP Basic Authorization
Soon, you may also authenticate using OAuth 2.
Environments
Qash provides separate environments for development and production.
| Environment | Purpose |
|---|---|
| Staging | Testing integrations with simulated banking data. |
| Production | Live financial operations. |
Staging credentials cannot access production data, as well as production credentials cannot access staging data.
Rate limits
Each API has rate limits to ensure platform stability.
When a limit is exceeded, the API returns :
429 Too Many Requests
X-Retry-At: <timestamp ms>
Versioning
Most APIs are versioned. New versions are introduced without breaking existing integrations whenever possible.
Partners using deprecated APIs will be notified before removal.
Webhooks
Instead of polling, applications can subscribe to events such as :
- ch.transaction.request - Clearing House Transaction Request
- ch.transaction.rejected - Clearing House Transaction Rejected
- cbs.deposit-request.created - CBS Deposit Request Created
- mandate.request-emitted - CH Mandate Request Emitted
Each webhook is cryptographically signed to verify authenticity.
Quick Start
The fastest way to being is:
- Join our Discord
- Candidate as a Network or Payment Partner
- Get your Staging organization set up
- Generate an API Key
- Make your first requests
- Subscribe to webhooks
Most developers can complete this in under 30 minutes.