BPCR: billpay_request_returned

webhook

billpay_request_returned

A refund or billpay check was returned in the mail. 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.

Trigger — A returned check is recorded in the Galileo system
Processes — These processes contain the event trigger:
- The mailing room receives a returned check

Payload

amount

string

Amount of the transaction. Unsigned.

available_balance

string

Amount available to spend at the time of the event. Legacy field: balance.

balance_id

string

The balance ID, also called the galileo_account_number. Legacy field: account_id.

billpay_id

string

Unique identifier for this billpay or refund-check transaction.

description

string

Human-readable description of the transaction or event type.

event_ts

string

Timestamp when the message was ingested by SoFi Tech Solutions (Mountain Standard Time). Format: "YYYY-MM-DD hh:mm:ss MST". Legacy fields: timestamp, tran_timestamp.

external_account_id

string

User-supplied identifier to link to an external system.

merchant_number

string

Merchant number (DE042). Legacy field: merch_num.

method

string

Event category. Indicates the type of event.

msg_event_id

string

Unique system-generated identifier for this message.

msg_id

string

The four-letter code to identify this event.

original_balance_id

string

Refund checks only. Balance ID (galileo_account_number) of the closed account that is being refunded.

original_prn

string

Refund checks only. PRN of the closed account that is being refunded.

prn

string

SoFi Tech Solutions 12-digit payment reference number (PRN) for the account. Legacy field: pmt_ref_no.

prod_id

string

The product ID of the account.

prog_id

string

The program ID of the account.

type

string

The name of this event: "billpay_request_returned"