V2 API Migration guide

Starting in early December 2023 customers can migrate to a v2 version of the Branch API, which includes changes to the disbursement endpoints, providing additional parameters that give you more fine-tune control over disbursements.

Both the v1 and v2 API endpoints are documented in detail in the API reference section.

Example Migration Reference

To make things easy, we've created an infographic as a quick visual reference demonstrating some differences between v1 and v2. This infographic covers the endpoint migration from Create Disbursement V1 to Create Disbursement V2. We will be adding more endpoints to the graphic in the coming days.

Usage and best practices for migration

As you can see in the reference documentation and the infographic above, the Branch v2 API endpoints can be identified by urls that begin with v2.

v2/organizations/:orgId/workers/:workerId/disbursements

The documentation shows these new urls and the parameters for both requests and responses when using v2, and the infographic highlights the differences between v1 and v2, to help you adjust your integration to adapt to v2. The tables below provide explanations of new and changed parameters. For a complete reference view of the parameters see the diagrams above.

Create Disbursement: Request

Create Disbursement: Response

id
payment_type
amount
fee
time_completed

Migrating the Disbursement reason_code