Use the Search Biller Directory endpoint to find billers in the RPPS database. Pass billerName (required), billerState (recommended) and billerAccountNo (optional). If the biller is in the RPPS database, the endpoint returns the RPPS biller ID (rpps_biller_id), which you pass in the Add RPPS Biller endpoint call. If the biller is not present, use Add Paper Biller to add the biller.
If the biller is present in the RPPS directory, the endpoint might return biller_account_no_patterns, which you can use as a mask to validate the account number.
See Creating a Billpay Transaction for instructions on using this endpoint.
See Global Response Statuses for status codes that are common across endpoints.
The table below lists status codes that apply to this specific endpoint.
| Status Code | Code Description |
|---|---|
| 421-01 | No billers found matching the search criteria |
Account Patterns Legend
| Character | Definition |
|---|---|
| # | Any number |
| * | Any letter |
| @ | Any letter or number |
| ! | Any special character |