Search Biller Directory

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/searchBillerDirectory

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.

Status codes

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	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

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

billerAccountNo

string | null

Valid biller account number. As applicable, this value is validated against a biller-supplied mask.
Pattern: A Max 60 alphanumeric characters including space and hyphen
Example: "3333223323455555"

billerName

string

required

length between 1 and 128

Pass a complete or partial name of a biller to begin the search. When a single term returns multiple entries, the account holder must select from among them. Pass billerState and/or billerAccountNo to filter the results.
Pattern: Max 50 alphanumeric characters, no punctuation
Example: "Netflix"

billerState

string | null

enum

Biller state or province.
Pattern: 2-character state or provincial abbreviation
Example: "UT"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

Account Patterns Legend

default