Skip to main content

Introduction

Welcome!​

Here you’ll find information for integrating with Branch and our API endpoints. We’ve tried to make this documentation simple and easy to understand. Keep in mind this is a work in progress and we will be constantly updating this documentation. In the meantime, please let us know if there are improvements we can make.

Looking for the API docs?

Go to API reference

Overview​

Branch provides a platform to help organizations get up and running with our financial services. We provide our users with a digital wallet, access to earned wages, and the ability to send out any type of payout or disbursement instantly.

Our APIs are organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

For our data partners, we've created this documentation to help you learn about our main features and show examples of how to get started integrating with Branch. If you'd like to become a Branch partner, please get in contact with our partnerships team by heading over to: https://www.branchapp.com/branch-partners

Main Features​

  1. Creating a wallet - A Partner System can send Branch an employee's data required to automatically create a digital wallet and order a card to the employee. Branch needs to know all of information required for the user to pass the KYC verification process.

  2. Get wallet account status - A Partner System can request whether or not an employee has a digital wallet created or not. This information can be returned for an individual user or for an entire organization's roster.

  3. Get wallet account and routing number - A Partner System can get the Branch wallet account and routing number for an employee.

  4. Send payout to wallet user - A Partner System can send an instant payout to an employees digital wallet.

Getting Started​

  1. Reach out to Branch Partnerships Team.
  2. Branch will then get you an access token and access to a Sandbox.
  3. Make some calls on sample data.
  4. When you are ready for a Production access, reach back out to us.

Questions?​

We're always happy to help with code or other questions you might have. You can look through our FAQs page, search our documentation, contact support, or connect with our sales team.