JUjustifi
Payout Holds

List Payout Holds

List the payout holds that belong to this account. This endpoint supports pagination.

get/payout_holds

Request

Query parameters

created_beforestring date-time

filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

created_afterstring date-time

filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

start_date_beforestring date

Filter by start date before the specified date (ISO 8601 format)

start_date_afterstring date

Filter by start date after the specified date (ISO 8601 format)

end_date_beforestring date

Filter by end date before the specified date (ISO 8601 format)

end_date_afterstring date

Filter by end date after the specified date (ISO 8601 format)

Headers

Authorizationstring required

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

Response

Successfully list payout holds

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "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"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

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