v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Transactions

Search Biller Directory

Use the Search Biller Directory endpoint to find billers in the <glossary: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 <a href="ref:post_addrppsbiller" target="_blank">Add RPPS Biller</a> endpoint call. If the biller is not present, use <a href="ref:post_addpaperbiller" target="_blank">Add Paper Biller</a> 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 <a href="doc:creating-a-billpay-transaction" target="_blank">Creating a Billpay Transaction</a> for instructions on using this endpoint.

post/searchBillerDirectory

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed