Billpay Endpoints
This guide explains how to use the billpay-related endpoints. For additional billpay information, see these guides:
- About Bill Pay — General information about bill pay at Galileo
- Creating a Billpay Transaction — Instructions for creating billpay transactions, including adding billers and creating scheduled transactions
- Managing Billpay Transactions — Instructions for displaying and canceling billpay transactions and removing billers.
Search Biller Directory
Consult the Adding a biller section of the Creating a Billpay Transaction guide to see where this endpoint fits in the sequence of events.
This table explains the parameters that are specific to the Search Biller Directory endpoint. See the Search Biller Directory reference for details.
| Parameter | Usage |
|---|---|
billerAccountNo | Optional. When this parameter is passed, the search engine compares it to biller-supplied masks, and an account number that matches a mask will help narrow the search. |
billerName | Pass a complete or partial name of a biller to begin the search. In some cases, a single term will return multiple entries, and the account holder must select from among them. Alternatively, you can pass billerState and/or billerAccountNo to filter the results. |
billerState | Optional. When this parameter is passed, the search is narrowed to billers with addresses in that state or province. Galileo recommends passing this parameter to help distinguish between billers with the same name. |
In the response, the biller_account_no_patterns may include one or more masks that you can use to validate the billerAccountNo for the Add RPPS Biller endpoint.
Add RPPS Biller
Consult the Adding a biller section of the Creating a Billpay Transaction guide to see where this endpoint fits in the sequence of events.
Note
This endpoint can be used only when the account is active (
status: N).
This table explains the parameters that are specific to the Add RPPS Biller endpoint. See the Add RPPS Biller reference for details.
| Parameter | Usage |
|---|---|
rppsBillerId | This is the rpps_biller_id as returned by Search Biller Directory, if the biller is present in the directory. If it is not, use the Add Paper Biller endpoint to add the biller. |
billerAccountNo | This is the account number that the account holder has with the biller. The response to Search Biller Directory contains biller_account_no_patterns, which indicate how an account number must be formatted for that biller. The endpoint validates the account number in this parameter against those masks. If the number does not match the pattern, the endpoint returns status code: 485-03.This value cannot be updated with Modify RPPS Biller; if the account holder submits an incorrect billerAccountNo that is accepted by the endpoint, you must remove the biller and create the biller again with the correct billerAccountNo. |
| Scheduling parameters | Optional. Leave these blank to add a biller without setting up scheduled payments, or see Scheduling billpay transactions in the Creating a Billpay Transaction guide for instructions on setting up a schedule. |
Modify RPPS Biller
The only properties of an RPPS biller that you can modify are the schedule and the amount of recurring payments. If you need to change the biller account number, you must remove the biller and replace it with a new biller.
Note
This endpoint can be used only when the account is active (
status: N).
This table explains the parameters that are specific to the Modify RPPS Biller endpoint. See the Modify RPPS Biller reference for details.
| Parameter | Usage |
|---|---|
billerId | This is the biller_id from Add RPPS Biller or Get Billers. Do not use the rpps_biller_id from Search Biller Directory. |
| Scheduling parameters | See Scheduling billpay transactions in the Creating a Billpay Transaction guide for instructions on using these parameters. These parameters can be nullified. |
Add Paper Biller
Consult the Adding a biller section of the Creating a Billpay Transaction guide to see where this endpoint fits in the sequence of events.
Note
This endpoint can be used only when the account is active (
status: N).
This table explains the parameters that are specific to the Add Paper Biller endpoint. See the Add Paper Biller reference for details. These values are not validated.
| Parameter | Usage |
|---|---|
billerName | Display name, provided by the account holder. This value does not need to be unique—you can create multiple paper billers with this name as long as the addresses are different. |
| Address parameters | Mailing address for the biller. |
billerPhone | Optional. Phone number for the biller. |
billerAccountNo | This is the account number that the account holder has with the biller. This value is not validated against a formatting mask. This value cannot be edited with Modify Paper Biller; if the account holder submits an incorrect billerAccountNo, you must remove the biller and create the biller again with the correct billerAccountNo.You can also pass NA or another string when the check recipient is an individual or a business that doesn't maintain accounts for its clients. |
| Scheduling parameters | Optional. Leave these blank to add a biller without setting up scheduled payments, or see Scheduling billpay transactions in the Creating a Billpay Transaction guide for instructions on setting up a schedule. |
Modify Paper Biller
The only properties of a paper biller that you can modify are the biller address and phone, schedule, and the amount of recurring payments. If you need to change the biller account number, you must remove the biller and replace it with a new biller.
Note
This endpoint can be used only when the account is active (
status: N).
This table explains the parameters that are specific to the Modify Paper Biller endpoint. See the Modify Paper Biller reference for details.
| Parameter | Usage |
|---|---|
billerId | This is the biller_id from Add Paper Biller or Get Billers. |
| Address parameters | To update any of the address parameters, you must pass all of the address parameters. |
billerPhone | Update or nullify |
| Scheduling parameters | See Scheduling billpay transactions in the Creating a Billpay Transaction guide for instructions on using these parameters. These parameters can be nullified. |
Create Bill Payment
Use this endpoint to create a one-time bill payment for a biller that has already been added to the account. Consult Creating a one-time billpay transaction in the Creating a Billpay Transaction guide to see where this endpoint fits in the sequence of events.
Note
This endpoint can be used only when the account is active (
status: N).
This table explains the parameters that are specific to the Create Bill Payment endpoint. See the Create Bill Payment reference for details.
| Parameter | Usage |
|---|---|
billerId | This is the biller_id from Add RPPS Biller, Add Paper Biller or Get Billers. Do not use the rpps_biller_id from Search Biller Directory. |
processDate | Optional. Input a date in the future, or leave blank for the transaction to be processed on the current date. |
memo | Optional. This message will be printed on the check in the Memo field. |
Updated 8 months ago