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

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/searchBillerDirectory
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

billerAccountNostring nullable

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"

billerNamestring required

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'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AE' | 'AP' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT' nullable

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

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "billerAccountNo": "3333223323455555",
  "billerName": "Netflix",
  "billerState": "UT"
}

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

Changes

No recorded changes to this operation across all 2 revisions of this API.