Skip to navigation

Clearing House Item

View as Markdown

Retrieve a clearing house by ID.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve a single clearingHouseId to its clearing house record. Clearing houses are read-only reference data.

Common Failure Scenarios

  • No clearing house matches the id. This returns HTTP 404 with an empty body.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • 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)404No clearing house matches the id.
(no message text)404The id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

ClearingHouse
namestring<=64 characters
idlongOptional