V2 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.
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.
Create Disbursement: Request
| New Parameters | |
| display_header_label | A description of the disbursement. This will be displayed to the worker. |
Create Disbursement: Response
| New Parameters | |
| display_header_label | A description of the disbursement. This will be displayed to the worker. |
| payout | payout parameters (id, payment-type, fee, time_completed) |
| reason codes | Reason code parameters added: |