---
title: "Get Hold History"
method: POST
path: "/getHoldHistory"
tags: ["Transactions"]
---

# Get Hold History

`POST /getHoldHistory`

Use the Get Hold History endpoint to retrieve a history of holds that were created for the specified account by the <a href="ref:post_createhold" target="_blank">Create Hold</a> endpoint.

## Response `default`

- object
  - `status_code` integer, nullable, required — The response status code. May return a string for some statuses.
  - `status` string, nullable, required — The condition of a process or response
  - `processing_time` number, float, nullable, required — The time elapsed in processing the transaction
  - `echo` object, nullable, required — A structure that contains transaction ID information
    - `transaction_id` string, nullable, required — An ID that represents an API transaction
    - `provider_timestamp` string, date-time, nullable, required — Store a related timestamp for reporting and troubleshooting purposes
    - `provider_transaction_id` string, nullable, required — Secondary transaction identifier (generated by a provider)
  - `system_timestamp` string, date-time, nullable, required — A system generated timestamp
  - `rtoken` string, nullable, required — A system-generated ID used for tracking
  - `errors` string[] — A list of errors generated while the request was processed
  - `response_data` object, nullable, required — A structure for the response data. It can be empty but usually will contain information.
    - `active_holds` object[], required — List of active holds
      - `hold_id` string, required — A unique ID for the hold to be expired
      - `create_dt` string, date-time, nullable, required — The date the hold was created
      - `expiry_dt` string, date-time, nullable, required — The date the hold will expire
      - `source_id` string, nullable, required — A code unique to the source of the activity (such as fees, adjustments, etc.)
      - `change_dt` string, date-time, nullable, required — The date the hold was last modified or created
      - `hold_type` string, nullable, required — The type of hold
      - `ext_id` string, nullable, required — An external identifier associate with the hold
      - `dscr` string, nullable, required — The description associated with the hold
      - `originating_system_id` string, nullable, required — The process that created the hold
      - `agent_id` string, nullable, required — The id for the agent that created the hold
      - `amount` number, required — The financial sum being held
      - `xid` string, required — The transaction ID associated with the hold
      - `expiring_system_id` string, nullable, required — The process that expired the hold
      - `expiring_agent_id` string, nullable, required — The id for the agent that expired the hold
    - `expired_holds` object[], required — List of expired holds
      - `hold_id` string, required — A unique ID for the hold to be expired
      - `create_dt` string, date-time, nullable, required — The date the hold was created
      - `expiry_dt` string, date-time, nullable, required — The date the hold will expire
      - `source_id` string, nullable, required — A code unique to the source of the activity (such as fees, adjustments, etc.)
      - `change_dt` string, date-time, nullable, required — The date the hold was last modified or created
      - `hold_type` string, nullable, required — The type of hold
      - `ext_id` string, nullable, required — An external identifier associate with the hold
      - `dscr` string, nullable, required — The description associated with the hold
      - `originating_system_id` string, nullable, required — The process that created the hold
      - `agent_id` string, nullable, required — The id for the agent that created the hold
      - `amount` number, required — The financial sum being held
      - `xid` string, required — The transaction ID associated with the hold
      - `expiring_system_id` string, nullable, required — The process that expired the hold
      - `expiring_agent_id` string, nullable, required — The id for the agent that expired the hold

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/versions/bcd728f97a18/schema)