Biller list

Biller list calls are optional API calls that return a list of the available billers to the originating system. The listBillers operation should be performed daily to ensure that the originating system's biller information is always up to date.

You can easily configure the biller list directly from Electrum Console, allowing you to specify which billers are allowed or not allowed. This integration seamlessly connects with your internal system to determine the billers shown to your customers. Additionally, if new billers are added to the Service Providers, you can manage these services without extra cost using the Electrum front-end.

Operation and Messages

A biller list call consists of a single set of messages described by the listBillers operation, GET/billers:

• Response payload: BillerListResponse
• Error payload: ErrorDetail

For more detail, refer to the Account Payments Service Interface.

Message Flows

Successful Biller List Transaction

• The originating system sends a GET call to the /billers API endpoint (listBillers operation).
• The API responds with a list of the billers in a BillerListResponse message payload.

Error or Timeout at Originating System

1. The originating system sends a GET call to the /billers API endpoint (listBillers operation).
2. An error occurs at the originating system or a timeout occurs when the originating system does not receive a response.
3. The transaction is considered failed and no further messaging is required, however, the originating system can attempt the transaction again.

Error at Service Provider

1. The originating system sends a GET call to the /billers API endpoint .
2. An error occurs at Electrum or the service provider (listBillers operation).
3. Electrum sends an HTTP status of 400, 500, 501, 503, or 504 and an ErrorDetail message payload to the originating system.
4. No further messaging is required, however, the originating system can attempt the transaction again.