Skip to main content

Get Balance

GET 
/account/:account_id/balance

Allows Flex to retrieve any current bills for a specific customer.

URL Path Customization​

Partners may include an optional biller_id path parameter if their system requires it to identify the billing entity. For example:

  • /biller/{biller_id}/account/{account_id}/balance

Why This Endpoint Exists​

Allows Flex to retrieve active balance for a specific customer. This data is used for:

  • Determining the amount due when initiating a payment
  • Displaying the customer's current balance in the Flex UI

Implementation Notes​

Please see the data standards for details on field formats, status values, and error handling.

Request​

Responses​

Successful request