This guide contains instructions for managing billpay transactions that have been initiated as well as how to manage billers. This guide also contains information about the External Trans API. Along with this guide you may want to read these other guides:

• <a href="doc:about-bill-pay" target="_blank">**About Bill Pay**</a> — General information about bill pay at Galileo

• <a href="doc:creating-a-billpay-transaction" target="_blank">**Creating a Billpay Transaction**</a> — Instructions for creating billpay transactions, including adding billers and creating scheduled transactions

## Displaying billpay transactions

• Call <a href="ref:post_getscheduledbillpayments" target="_blank">Get Scheduled Bill Payments</a> to retrieve transactions with process dates that are equal to or later than the current date.

• Call <a href="ref:post_getbillpayhistory" target="_blank">Get Bill Payment History</a> to retrieve all billpay transactions between the start and end dates, both past and future.

• Call any transaction-retrieval endpoint that returns posted transactions to display billpay transactions in a full transaction list:

  • <a href="ref:post_getaccountoverview" target="_blank">Get Account Overview</a>

  • <a href="ref:post_gettranshistory" target="_blank">Get Transaction History</a>

  • <a href="ref:post_getalltranshistory" target="_blank">Get All Transaction History</a>

## Canceling billpay transactions

To cancel a billpay transaction, follow one of these procedures:

• [Cancel an electronic transaction](🔗)

• [Cancel a paper check transaction](🔗)

• [Cancel one scheduled billpay transaction](🔗)

• [Cancel a scheduled billpay series](🔗)

### Cancel an electronic transaction

Because of the small interval between electronic transaction creation and processing, you cannot cancel electronic transactions after the transaction has been created. Do not attempt to use the Cancel Transaction endpoint to cancel an electronic transaction, or you could set up a race condition with undesirable results. However, you can cancel an electronic transaction with the Program API [that is scheduled for the future](🔗).

### Cancel a paper check transaction

You can cancel a paper check transaction using the Program API or <<glossary:CST>> when it is in `status: N` (not processed), `status: W` (waiting to be printed) or `status: P` (printed). (Sometimes, it's too late to cancel a check after it's been printed.) You can also cancel paper transactions [that are scheduled for the future](🔗).

<!--billpay-cancel-paper-payment.pngggg-->

1. The account holder launches a "cancel transaction" control on your interface for a paper biller.

2. Do one of the following:

   • Call <a href="ref:post_getbillpaythistory" target="_blank">Get Bill Payment History</a> and check the `status` on the transaction:

     • `N`, `W` or `P` — The transaction can be canceled. Call <a href="ref:post_cancelbillpayment" target="_blank">Cancel Bill Payment</a>.

     • **Other** — The transaction cannot be canceled.

   • Call <a href="ref:post_cancelbillpayment" target="_blank">Cancel Bill Payment</a>.

     • If the transaction can be canceled, the endpoint returns success.

     • If the transaction cannot be canceled, the endpoint returns `status_code: 435-02`.

3. If the amount has already been adjusted out of the account, Galileo returns the amount to the account, sends the <a href="ref:api-reference-events-api-adj" target="_blank">`BADJ: adj`</a> event message, and writes the adjustment to the Posted Transactions RDF. It takes approximately two days to return the funds to the account.

### Cancel one scheduled billpay transaction

To cancel the next transaction in a recurring series without canceling the series, follow these steps:

1. Call <a href="ref:post_getscheduledbillpayments" target="_blank">Get Scheduled Bill Payments</a>. The endpoint returns a `billpay_transaction_id` under `future_scheduled_payments` for all scheduled transactions.

2. Call <a href="ref:post_cancelbillpayment" target="_blank">Cancel Bill Payment</a> and populate the `billpayTransactionId` with the ID that you retrieved in the previous step.

### Cancel a scheduled billpay series

If an account holder has set up recurring billpay transactions and wants to cancel the whole series, follow these steps:

1. Call <a href="ref:post_getbillers" target="_blank">Get Billers</a> to retrieve the `biller_id` and `type`:

   • `type: E` — Call <a href="doc:billpay-endpoints#modify-rpps-biller" target="_blank">Modify RPPS Biller</a>.

   • `type: P` — Call <a href="doc:billpay-endpoints#modify-paper-biller" target="_blank">Modify Paper Biller</a>.

2. Do one of these things:

   • Set the `endDate` to today's date.

   • Pass `Null` for these parameters: `frequencyType`, `nextDate`, `endDate`.

📘

Note

You cannot cancel future transactions by removing the biller.

## Deleting a biller

📘

Note

When you delete a biller, any scheduled transactions for that biller are not deleted. If you also want to deactivate the scheduled transactions, first follow the procedure in [Cancel a scheduled billpay series](🔗), and then afterwards remove the biller using the steps below.

To remove a biller, follow these steps:

1. Call <a href="ref:post_getbillers" target="_blank">Get Billers</a> to retrieve the `biller_id` of the biller to delete.

2. Call <a href="ref:post_removebillers" target="_blank">Remove Biller</a> and populate `billerId` with the ID you retrieved in the previous step.

## Fees

You can configure these fees for your product, as desired:

The fee is assessed at the time that the billpay amount is adjusted out of the account. If there are insufficient funds for the billpay amount plus the fee, Galileo denies the transaction.

However, you can choose to defer the fee if there are insufficient funds for it by setting the BPPPF parameter. With that parameter set, the transaction is approved if there are sufficient funds for the billpay amount but not the fee. The fee remains in a pending state until sufficient funds are deposited in the account, at which time the fee is assessed.

In the Posted Transactions RDF, the fee is a separate transaction from the billpay adjustment, with the transaction code as shown in the table above.

See <a href="doc:creating-a-billpay-transaction#processing-fees" target="_blank">Processing fees</a> for the workflow.

## External Trans API

<!--Review copy: External Trans APIIII-->

If you are the system of record for your accounts, you can implement the <a href="ref:webhook_billpay_post" target="_blank">Billpay Webhook</a> of the External Trans API. Galileo sends you a webhook for each scheduled billpay transaction before it is adjusted out of the account, which you approve or deny for insufficient funds. Set the BPOTB parameter so that Galileo does not check for limit violations or for sufficient funds before sending you the webhook.

When using the Billpay Webhook, you can also determine whether transactions that you approve can drive the account negative, by setting the AAIGB parameter.

If you are the system of record for your program, perform your own balance check before calling the Create Bill Payment endpoint.

### External Trans API workflow

<!--billpay-external-trans.pngggg-->

1. The transaction is created by the scheduler, and Galileo runs through the same series of checks as in the <a href="doc:creating-a-billpay-transaction#scheduled-transaction-workflow" target="_blank">Scheduled transaction workflow</a>.

2. Galileo creates the transaction in `status: N` and sends the <a href="doc:ref:api-reference-events-api-billpay-request-made" target="_blank">`BPCQ: billpay_request_made`</a> event message.

3. Galileo sends you a billpay webhook for the transaction.

4. You check the account balance and send back a response code:

   • `99` (error; retry) or no response — If retry is set up for your program, Galileo sends the <a href="ref:api-reference-events-api-billpay-retry" target="_blank">`BPAR: billpay_retry`</a> event message, waits for a configured interval, and then resends the webhook.

   • `01` (insufficient funds) or `98` (error; no retry) — Transaction is changed to `status: E` and Galileo sends the <a href="ref:api-reference-events-api-billpay-rejected" target="_blank">`BRRJ: billpay_rejected`</a> event message for electronic transactions only.

   • `00` — The adjustment is posted to the account. Galileo sends the <a href="ref:api-reference-events-api-billpay" target="_blank">`BPAY: billpay`</a> event message.

5. The billpay process checks for a fee.

   • If there is a fee, the [Processing fees](🔗) process is followed.

   • If there is no fee, the process continues.

6. Galileo changes the transaction to one of these statuses:

   • `status: O` — Electronic transaction. See <a href="doc:creating-a-billpay-transaction#processing-an-electronic-transaction" target="_blank">Processing an electronic transaction</a> for next steps.

   • `status: W` — Paper check transaction. See <a href="</a>creating-a-billpay-transaction#processing-a-paper- billpay-transaction" target="_blank">Processing a paper billpay transaction</a> for next steps.

## Billpay transaction codes

These are some of the transaction codes that are associated with bill pay. To see exactly which transaction codes your program uses, consult the curated list of transaction codes that you received from Galileo.

## Events API

Arrange with Galileo to have some or all of these events sent to you to alert you of billpay-related events in real time.

## Galileo setup

Galileo will configure these product parameters according to your use case.