Balance API Enhancement

We're improving our Balance API by separating collection balances from pre-funding balances to provide clearer financial management capabilities.

Changes

  • New Field Added: totalAvailablePrefundingBalance will now represent funds available for payouts
  • Balance Separation: Clear distinction between collection balances (totalUnsettledAmount) and prefunding balances
  • Payout Source Change: Payouts will now draw exclusively from totalAvailablePrefundingBalance
  • Fund Transfer Process: Collection balances can still fund payouts via an internal transfer to the prefunding balance

Integration Requirements

  • Update your integration to reference totalAvailablePrefundingBalance instead of totalUnsettledAmount as the source for all payout operations
  • Ensure your systems accommodate this new field in the Balance API response

Important Dates

  • Changelog Publication: March 17th, 2025
  • Decommissioning: March 28th, 2025

Support

For migration assistance, please contact our support team through your established communication channels.