Developer Overview

Learn how to integrate with Branch

Follow the story below to learn how your Organization can evaluate, select, design, and implement systems using Branch infrastructure, solving Worker payments from start to finish.

Start using the Branch API

Become a partner by contacting Branch: [email protected] or (800) 219-7212 (Press 1 for Sales). Branch will schedule a kickoff call with key business and technical stakeholders from your Organization and your Branch partnership team. Coordinate with the Branch team for API keys to use the sandbox environment. Follow the API Reference guide to learn how you can use the sandbox API key to try the Branch API.

Onboarding Workers

Onboarding a Worker authorizes and enables them to receive digital payments from your Organization.

Authenticating Workers links a Worker ID 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.

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 disburse payouts to your Organization's Workers instantly without a fee as soon as earnings are available by performing internal operations using Branch's funds. 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 of the guides for the important features listed on this page contains links to the specific techniques for implementing them. These guides are also visible on the sidebar, and use categories, order, nesting, and naming to provide a natural 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 listed 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 Branch, with Beta release for 2 to 3 weeks before general availability.