Skip to main content

Get Account

GET 
/account/:account_id

Allows Flex to get the account details for a specific customer on the partner's system.

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}

Why This Endpoint Exists​

Flex calls this endpoint to retrieve account details when a customer initiates a payment flow. This information is used to:

  • Verify the account exists and is in good standing before allowing payments
  • Display the customer's account information 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