CRHD: create_hold

webhook

create_hold

A hold has been placed on all or part of the specified account. The available balance has changed. This event is triggered by holds that you create, ACH transactions, and automated processes, but not by holds created by card-network authorizations.

Trigger — A hold is placed on the account.
Processes — These processes contain the event trigger:
- Create Hold endpoint
- ACH transaction
- Customer Service Tool
- Automated processes

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.

description

string

Description for the hold.

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.

expiry_dt

string

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

ext_trans_id

string

External transaction ID.

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.

network

string

See Events Network Codes for possible values.

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