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.
- Code —
CRHD
- Event 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
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 |
---|---|---|
avail_cash | For debit accounts, the |
|
avail_credit | For credit accounts, the available credit limit to spend. Example: |
|
balance_id | X | The balance ID, also called the |
ch_group_id | Corporate Hierarchy group identifier. Example: |
|
credit_balance | For credit accounts, the total amount of unpaid purchases and advances. Example: |
|
currency | Currency code for |
|
description | Description for the hold. Example: |
|
expiry_dt | Date-time when the hold will expire. Format: |
|
hold_amount | Amount of the hold. Example: |
|
hold_id | X | Unique identifier for the hold. Example: |
hold_source | The table that |
|
hold_type | The transaction type (otype) of the hold. See the curated list of hold types for your program. Example: |
|
msg_event_id | Unique Galileo-generated identifier for this message. Example: |
|
msg_id | The four-letter code to identify this event. Example: |
|
open_to_buy | X | The available balance to spend. Example: |
pmt_ref_no | X | Galileo 12-digit payment reference number (PRN) for the account. Example: |
prod_id | X | The product ID of the account. Example: |
prog_id | X | The program ID of the account. Example: |
timestamp | X | Date-time when this event was created in Mountain Standard Time (GMT -0700). Format: |
type | X | The name of this event: |
Example
# create_hold example:
{
"avail_cash": "143.11",
"avail_credit": "432.00",
"balance_id": "20211",
"credit_balance": "325.00",
"currency": "840",
"description": "Manual hold",
"expiry_dt": "2025-12-02 14:10:17",
"hold_amount": "25.00",
"hold_id": "234567",
"hold_source": "pmt_info",
"hold_type": "OR",
"msg_event_id": "243693",
"msg_id": "CRHD",
"open_to_buy": "500.00",
"pmt_ref_no": "999101003022",
"prod_id": "1701",
"prog_id": "305",
"timestamp": "2025-01-31 17:20:33 MST",
"type": "create_hold"
}