---
title: "Get a Payout Hold"
method: GET
path: "/payout_holds/{payout_hold_id}"
tags: ["Payout Holds"]
---

# Get a Payout Hold

`GET /payout_holds/{payout_hold_id}`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/payout_holds/{payout_hold_id}`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/payout_holds/:payout_hold_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a specific payout hold by ID.

## Path parameters

- `payout_hold_id` string, required

## Headers

- `Authorization` string, required

## Response `200`

Successfully get a payout hold

- object
  - `id` string, uuid: the object id, also found in the data object
  - `type` string: the object type, or array of objects
  - `data` object: the attributes for the object
    - `id` string
    - `account_id` string
    - `hold_type` 'first_payment' | 'manual'
    - `issued_by` 'system' | 'platform'
    - `start_date` string, date
    - `end_date` string, date, nullable
    - `active` boolean
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` unknown

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)
