BPSE: billpay_switch_event

webhook

billpay_switch_event

The status of a payment method switch has changed.

Trigger — The status of a payment method switch changes.
Processes — These processes contain the event trigger:
- Account holder initiates a payment method switch.

Payload

account_type

string

Whether the payment account is a checking or savings.`

billpay_switch_event_type

string

Type of billpay switch event.

company

string

The service provider or merchant system for bill payment.

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_customer_id

string

Identifier used to associate multiple accounts under the same customer. This identifier is supplied by the provider, not SoFi Tech Solutions.

lastfour

string

Last four digits of the account number or card number.

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.

payment_type

string

Whether the payment method is a bank or card.

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.

routing_number

string

The routing number for the payment account.

status

string

enum

The new status of the payment method switch: processing, completed, failed

Allowed:

status_reason

string

The reason for the new status when status: failed. See Payment Method Switch Failure Status Reasons for valid values.

switch_transaction_id

string

Identifier for this billpay switch event.

task

string

Transaction ID for a sign-up attempt.

title

string

The title or description of the payment method.

type

string

The name of this event: "billpay_switch_event"