EXHD: expire_hold

webhook

expire_hold

A hold that was placed on a customer account has expired. The available balance has changed. This event is triggered by the expiration of holds that you created with the Program API, the Customer Service Tool and by automated processes. For authorization hold expiry see BEXP: auth_exp.

Trigger — A hold on an account expires.
Processes — These processes contain the event trigger:
- Expire Hold endpoint
- Reverse Payment, if any payment holds exist
- Customer Service Tool
- Internal process that expires holds

Payload

ach_trans_id

string

Unique system-generated identifier for an ACH transaction. For BADJ and BPMT, this field may contain the auth_id of a card-load transaction.

act_type

string

See Activity Type for possible values.

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.

currency_code

string

Currency code for hold_amount.`

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.

expiring_hold_system

string

The system that expired the hold: CST, API or COR.

expiring_hold_user

string

Identifier for the user who expired the hold, if any.

expiry_dt

string

Date-time when the hold will expire. Format: YYYY-MM-DD hh:mm:ss

ext_trans_id

string

External transaction ID.

external_account_id

string

User-supplied identifier to link to an external system.

hold_amount

string

Amount of the hold.

hold_id

string

Unique identifier for the hold.

hold_source

string

The table that hold_source_id comes from.

hold_type

string

The transaction type (otype) of the hold. See the curated list of hold types for your program.

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.

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: "expire_hold"