Developer Overview

Learn how to integrate with Branch

This guide is designed to help your organization seamlessly integrate with Branch's infrastructure for fast, flexible worker payments.

Through this guide, you’ll explore the full journey—from initial evaluation and solution selection to system design and implementation—enabling you to deliver reliable payouts to your workforce. From start to finish, we provide the tools and support to simplify every step of the process.

Start using the Branch API

Before using the Branch API, make sure you’ve connected with the Branch Sales Team so that you’re set up with the right solution for your organization: [email protected] or (800) 219-7212 (Press 1 for Sales).

Once you’ve had a kickoff call with Branch and your organization’s key business and technical stakeholders, the Branch team will provide an API key for the sandbox environment. Follow the API Reference guide to learn how you can use the sandbox API key to try the Branch API.

Begin worker onboarding

Branch offers multiple solutions to onboard workers. Onboarding a Worker authorizes and enables them to receive digital payments from your organization sent via Branch.

Authenticating workers links a WorkerID to a Branch account, which is claimed when the worker verifies matching contact information using a One-Time Password. The worker provides information for creating or linking a payment method, according to the system your organization implements for configuring worker payment methods. The organization activates worker payments upon confirmation of successful payment method configuration.

The configuration your organization chooses to develop for worker payment methods will impact how authenticating workers and activating worker payments are implemented.

Standard Onboarding Paths

Embedded API Onboarding Paths

Receive events from Branch using Webhooks

Follow the Webhook Implementation guide for a start-to-finish checklist and visualization of the Webhook system components. Using Webhooks for reacting to payment profile activation is required to ensure workers are eligible for payouts.

Pay Workers

Branch is able to provide payments to your organization's workers quickly without a fee, no pre-funding required. Enabling this feature requires your organization to provide funding sources for Branch to invoice the repayment of these disbursements using ACH.

Close Worker Accounts

Worker accounts can be closed for a variety of reasons, triggering events which prevent their payment eligibility. Follow the Wallet Closure guide for more details.

Find relevant documentation

Each guide for the important features listed on this page contains links to detailed implementation techniques. These guides are also visible on the sidebar, organized by categories, order, nesting, and naming to provide an intuitive experience when learning and navigating.

The API Reference groups the HTTP methods for each URL. WIthin each page, there are inputs with types and examples that you can fill in to make a sample request. There are example response structures and values for each HTTP Response Code.

At the top of each page you'll find a search bar, which can locate resources from both the Guides and the API Reference.

If you press Enter after entering search terms, a standard filterable search modal appears for you to browse through the relevant documentation pages.

If you press Command + Enter after entering search terms, your query will be submitted to Branch AI, which assembles a response for you using multiple sources within the documentation pages.

Certify and Launch the Branch integration

Branch will supply test cases and your organization will provide recorded demos for each scenario. Branch will certify the integration in Sandbox before Production secret keys are provided. Align on key deployment dates with your Branch implementation consultant; Beta release is typically 2 to 3 weeks before general availability.