JUjustifi
Payout Holds

Get a Payout Hold

Retrieve a specific payout hold by ID.

get/payout_holds/{payout_hold_id}

Request

Path parameters

payout_hold_idstring required

Payout hold public ID with poh_ prefix

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully get a payout hold

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "payout_hold",
  "data": {
    "id": "poh_abc123xyz",
    "account_id": "acc_sub123",
    "hold_type": "manual",
    "issued_by": "platform",
    "start_date": "2024-01-01",
    "end_date": "2024-01-31",
    "active": true,
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2024-01-01T10:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.