Skip to navigation

Clearing House Items

View as Markdown

Retrieve several clearing houses by ID.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve multiple clearingHouseIds to their clearing house records in a single call. Prefer this over repeated clearingHouseItem calls when you need to resolve several IDs at once. Clearing houses are read-only reference data.

Common Failure Scenarios

  • An ID in ids that doesn’t match a clearing house is left out of the response array. The call still succeeds, so compare the returned records against the IDs you requested.
  • The ids parameter is missing or repeated (HTTP 404), or contains a value that isn’t a number (HTTP 500).
  • The caller’s user type, or the API key’s permissions, can’t read clearing houses. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read clearing houses.
(no message text)404The ids parameter is missing or repeated.
"Internal Server Error, error id: {id}"500A value in ids isn’t a number. The error ID is generated per request.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idslist of longsRequired

Response

ClearingHouse
namestring<=64 characters
idlongOptional