billpay_request_returned

A bill payment was returned by the biller, the biller's bank, or the post office. The payment has not yet been returned to the account, so the available balance has not changed.

When the amount is returned to the account, a BADJ: adj event message is sent. Also see BPEX: billpay_expired for checks that expire without being cashed.

  • CodeBPCR
  • Event trigger — One of these things happens:
    • The check is returned in the mail.
    • The RPPS request fails.
  • Processes — These processes contain the event trigger:
    • Create Bill Payment endpoint
    • Scheduled billpay process
    • Mailing room receives the returned check
    • Check was canceled in the CST

Fields

All fields are strings. Your field names may vary. Default fields are included in the default webhook template. See Default and optional fields for more information.

Field Default Description
amount X

Amount of the payment. Example: "376.50"

balance_id X

The balance ID, also called the galileo_account_number. Example: "20211"

billpay_id X

Unique identifier for this billpay transaction. Example: "2436543"

description

Description for the billpay transaction. Example: "Nov 2023 bill"

merchant_number

Merchant number (DE042). Example: "L4DIV6D5LM4X7LF"

msg_event_id

Unique Galileo-generated identifier for this message. Example: "243693"

msg_id

The four-letter code to identify this event. Example: "BPCR"

open_to_buy X

The available balance to spend. Example: "500.00"

pmt_ref_no X

Galileo 12-digit payment reference number (PRN) for the account. Example: "999101003022"

prod_id X

The product ID of the account. Example: "1701"

prog_id X

The program ID of the account. Example: "305"

timestamp X

Date-time when this event was created in Mountain Standard Time (GMT -0700). Format: YYYY-MM-DD hh:mm:ss MST Example: "2025-01-31 17:20:33 MST"

type X

The name of this event: "billpay_request_returned"

Example

# billpay_request_returned example:
{
  "amount": "376.50",
  "balance_id": "20211",
  "billpay_id": "2436543",
  "description": "Nov 2023 bill",
  "merchant_number": "L4DIV6D5LM4X7LF",
  "msg_event_id": "243693",
  "msg_id": "BPCR",
  "open_to_buy": "500.00",
  "pmt_ref_no": "999101003022",
  "prod_id": "1701",
  "prog_id": "305",
  "timestamp": "2025-01-31 17:20:33 MST",
  "type": "billpay_request_returned"
}