Skip to main content

Introduction

The Flex Partner API is a standard contract that enables Flex to integrate with partner billing systems. Partners implement these endpoints so Flex can retrieve account/billing information and initiate payments on behalf of customers.

How It Works​

  1. Customer enrollment - Customers link their utility account to Flex.
  2. Balance retrieval - Flex queries the partner's API to get current bill information.
  3. Payment processing - When a payment is due, Flex initiates payment through the partner's API.
  4. Status tracking - Flex monitors payment status until completion.

API Architecture​

Partner Hosted Endpoints​

These endpoints are implemented by the partner and called by Flex:

EndpointPurpose
Get AccountRetrieve account details for a customer
Get BalanceRetrieve current bills and amount due
Put Account PaymentInitiate a payment on behalf of a customer
Get Account PaymentRetrieve payment status

Flex Hosted Endpoints​

These endpoints are hosted by Flex and called by the partner:

EndpointPurpose
Create TokenCreate a token to initiate the Flex payment flow for a user

Create token flow​

URL Structure​

Partners define their own URL structure. The paths shown in this documentation are examples. The only requirement is that each endpoint includes the necessary path parameters (account_id, payment_id, flex_payment_id, etc.). Partner’s will be asked to provide a list of templated URLs for each endpoint. The request params are the available template strings for the url.

Example URL patterns:

# Partner A
https://api.partner-a.com/flex/account/{account_id}

# Partner B
https://partner-b.com/v1/billers/{biller_id}/accounts/{account_id}

# Partner C
https://flex-integration.partner-c.com/{biller_id}/{account_id}

Next Steps​