Guides

Getting Started with Omniwire

Suggest Edits

Welcome to the Omniwire integration hub. We provide secure and developer-friendly banking infrastructure — from KYC and account creation to ACH transfers and card issuing. This documentation will guide you through the entire integration process. A typical integration (KYC, accounts, core flows) can be completed in one to two weeks depending on your team size and scope; your account manager can provide a tailored timeline.

What You Can Build

Our platform allows you to create your own financial experience using our infrastructure. Once integrated, your clients will be able to:

  • Complete KYC verification
  • Create and manage their accounts
  • Issue virtual and physical debit cards
  • Send money to other users
  • Send funds via ACH (to banks or individuals)
  • Connect and fund accounts via ACH
  • Direct Deposit Enrollment of payroll into their accounts
  • Request money from other users
  • Access transaction history and account details

For step-by-step flows, see Account Management, Load Money & Account Funding, Transaction Flow, and Limits & Transaction Caps.

Integration Options

We support two integration methods. You should choose based on your architecture and how much session/account management you want to control.

Client API

The Client API is the same interface our frontend app uses. It establishes a persistent connection using Socket.IO, and manages sessions and authentication automatically. Your application can be connected directly to our backend via this API.

Use this option if you want a frontend-driven integration with minimal backend effort.

  • Built-in session and token handling
  • Full user profile management endpoints (set avatar, update email, subscribe to news, etc.)
  • Suitable for clients building mobile or web apps that connect directly

Resources:

Banking API (Server-to-Server)

The Banking API provides an event driven interface focused on banking functionality only. It does not manage sessions or user profiles — you are responsible for user authentication, storage, and account metadata on your side.

Use this option if you want full control of your frontend/backend stack and prefer to treat us as a pure service provider.

  • Endpoints for card issuance, ACH transactions, account management, etc.
  • No user profile management (e.g. no endpoint to set user avatar)
  • Best suited for server-to-server integrations

Resources:

Integration Checklist

To get started with your integration, follow these steps:

  1. Choose your integration method
    → Client API (Socket.IO) or Banking API (server-to-server)

  2. Set up authentication
    → Authentication for Client API — device PKI, JWT, session handling

  3. Use the simulator to test your flow
    → Omniwire Tools — test card transactions, ACH, and other flows without live connections

  4. Implement core flows
    → Account Management, Load Money, Transaction Flow, Limits

  5. Configure frontend
    → Clusters Configuration — countries, feature flags, URLs

Operation Modes (CLIENT)

The platform supports different operation modes. When integrating via the Client API, the application runs in CLIENT mode:

  • Full banking operations — transactions, KYC, cards, ACH, etc.
  • Schedulers enabled — ACH settlement, subscription renewal, auto payments, auth expiration
  • Client-facing flows — entity events, push notifications, confirmation flows

This mode is designed for apps that connect end users directly to the backend via Socket.IO. See Schedulers Reference for background job details.

Push Notifications

The platform sends push notifications for key events (transaction confirmation, money request, transaction status, subscription). Notifications are delivered via the client's push provider (FCM, APNs, etc.). For types, handling, and confirmation flow, see Push Notifications and Transaction Flow.

Localization & Multi-language

The platform supports multi-language content for:

  • Push notification messages
  • Error messages
  • Transaction descriptions
  • Countries and currencies

The client sends a language code (lng) with requests where applicable. See Localization for details.

Related

Need Help?

If you have questions during the integration process, contact your account manager or reach out to our support team. For technical support and integration issues, use the channel or ticketing system provided by your account manager.

Updated about 1 month ago