Welcome to TAPP Cash
TAPP Cash is a financial platform API that lets organizations embed banking capabilities into their products. With TAPP Cash, you can build and manage the full client lifecycle — from inviting users and verifying their identity through daily banking operations including transfers, account management, and reporting.
These docs are for engineering teams integrating the TAPP Cash API on behalf of your organization.
What can you build?
Compliant KYC and KYB onboarding with phone OTP, security questions, W9 certification, and identity documents.
Business Owners invite team members as Operators with scoped permissions — transfer funds, run ACH, or schedule payments.
Internal transfers between accounts (TBA) and external ACH via Plaid — with fee preview before every execution.
Recurring scheduled payments — weekly, biweekly, or monthly — with a fixed end date, spend cap, or until cancelled.
Create branches, assign admin roles at every tier, and configure transfer approval rules per branch.
Balance charts, transaction history, PDF statements, and XLSX portfolio exports — all scoped by admin role.
Quickstart
A Tech Admin enables API access for your organization and issues a clientId + clientSecret from the admin portal.
POST your credentials to /entrypoint/org/v1/sessions — receive a sessionId valid for 24 hours.
Send X-Session-Id and X-Client-Id headers on every request.
Call DELETE /entrypoint/org/v1/sessions/{id} on logout or job completion.
Recipes
End-to-end integration patterns with every API call in sequence.
ClientId + ClientSecret → sessionId → call endpoints with session headers → revoke on logout.
Advisor invite → 10-step KYC (W9, security questions, phone OTP, identity) → full access token and live accounts.
5-step KYB → invite Operators with scoped permissions (transferFunds, autoPay) → Operator KYC.
BaaS token → Plaid Link → list external accounts → preview fees → execute pull or push.
Preview fee → create with stop condition (end date, spend cap, or until cancelled) → cancel when needed.
Enable branch approval → client submits → pending_approval → Branch Manager approves or rejects.
Base URL
Your base URL follows the pattern https://api-{tenant}.stage2.tappbank.com where {tenant} is your organization's subdomain.
| Environment | Base URL pattern |
|---|---|
| Staging | https://api-{tenant}.stage2.tappbank.com |
| Production | https://api-{tenant}.tappcash.com |
Contact [email protected] to get your tenant name.
Selecting Your Tenant in the API Reference
Every endpoint in the API Reference has a Try It panel that lets you make live requests directly from the docs. For it to work, you must set your tenant name first.
How to set your tenant:
- Open any endpoint page in the API Reference (e.g. Sign in)
- In the Try It panel on the right, click the server URL dropdown at the top — it shows the current environment
- Look for the
tenantvariable field and replacetestwith your actual tenant name (e.g.wire-network) - Your requests will now go to
https://api-{your-tenant}.stage2.tappbank.com
If you skip this step and leave the tenant as
test, requests will fail or return a CORS error becauseapi-testis a placeholder and may not resolve to your organization's environment.
The tenant setting persists for your browser session across all endpoints in the same spec section.
Authentication
All requests use session-based authentication. Include these two headers on every API call:
X-Session-Id: <sessionId>
X-Client-Id: <clientId>
Sessions are obtained from POST /entrypoint/org/v1/sessions using your clientId and clientSecret. Sessions are valid for 24 hours.
To obtain credentials, contact [email protected].
Rate Limits
The API gateway enforces rate limits per client IP. Limits are configured per endpoint — every response includes headers
so you can track your current usage.
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests allowed in the current window |
X-RateLimit-Remaining | Requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the window resets |
When the limit is exceeded the API returns 429 Too Many Requests. Back off and retry after the time indicated by
X-RateLimit-Reset. See Error Handling for the full retry strategy.
Standard Response Format
Every response — success or error — follows the same envelope.
Success
{
"data": {},
"meta": {}
}Error
{
"errors": [
{
"code": "ERROR_CODE",
"title": "Human-readable summary",
"details": "Additional context",
"target": "field | common",
"source": "fieldName"
}
]
}| Code | Meaning |
|---|---|
| 400 | Bad request — check the errors array for field-level details |
| 401 | Unauthorized — missing or expired Bearer token |
| 403 | Forbidden — valid token but endpoint is outside your role |
| 404 | Resource not found |
| 409 | Conflict — e.g. pending transactions block account closure |
| 422 | Unprocessable — business logic rejection, see code field |
| 500 | Internal server error — contact support |
Role-Based Access
Your token is scoped to a role. Calling an endpoint outside your role returns 403 Forbidden.
| Role | Access |
|---|---|
| Root Advisor | Full organizational management — branches, admin tiers, all client portfolios, and reports |
| Head Branch Manager | Manage Advisors, oversee all client activity — transfers, transfer requests, auto-payments, and reports |
| Branch Manager | Manage Advisors, review client portfolios, transfer requests, reports, and configure approval settings |
| Advisor | Invite and manage Individual and Business Owner clients — transfers, transfer requests, auto-payments, and reports |
| Business Owner | Hold business accounts, complete KYB, invite and manage Operators, initiate transfers and auto-payments |
| Individual | Hold personal accounts, complete KYC, initiate transfers (TBA and ACH), and view account activity |
| Operator | Manage a Business Owner's accounts with granted permissions — transfer funds and set up auto-payments |
Support
| Topic | Contact |
|---|---|
| Credentials & access | [email protected] |
| Developer docs | developers.tappcash.com |
| API reference | developers.tappcash.com/reference |
Updated about 1 month ago
