added

Added new guide for Application Security of Branch Direct Embedded

A new guide for Application Security when integrating with Branch Direct Embedded is now available. Ensuring the security of your application is critical, as this provides access to worker banking and financial information.

improved

Added support for using /workers instead of /employees for certain API URLs

For API endpoints in certain categories that don't reference employee_id in their request/response structures, the default URL structure has been adjusted from /employees/{employeeId} to /workers/{workerId}. These categories include:

added

Added RETRY_LIMIT_EXCEEDED reason_code to CreateDisbursement response

There is now a limit of 100 retry attempts per request to the Create Disbursement endpoint. Once this limit is reached, any additional retry attempts will return a 200 response with status: SKIPPED and reason_code: RETRY_LIMIT_EXCEEDED.

improved

API Key Credentials are now saved across endpoints

Paste your Sandbox API key in the Credentials field to use it across multiple endpoints without needing re-entry. Learn more about using this in the API Reference Intro guide.

improved

URL subdirectory is now prefixed with /branch-developer

This change supports the addition of Branch's product documentation. Links will redirect automatically.
Example:
docs.branchapp.com/changelog -> docs.branchapp.com/branch-developer/changelog

added

Added iOS Swift and Android Kotlin examples for Adding a Debit Card with Branch Direct Embedded

The Add a Debit Card guide now has examples for embedding Branch Direct into native iOS or Android apps.

improved

Added detail to instructions for Adding a Debit Card

Added details to the guide for how to Add a Debit Card. Now includes the requirements for developing a backend server endpoint, and sample code for sending data to the backend in the iFrame callback.

improved

Added examples to all API reference fields

Each query parameter, body parameter, and response field in the API reference now has an example value.

improved

Added descriptions to all API reference fields

All query parameters, body parameters, and response fields in the API reference now have a description.

improved

Added details for implementing rate limited endpoints

In the Rate Limits guide, added specific rates for Create Wallet and Create Disbursement, and added implementation details for tuning a rate-limiting token bucket.