Skip to navigation

Clearing House List

View as Markdown

List all clearing houses.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieve every clearing house defined on the platform. Clearing houses are read-only reference data.

Common Failure Scenarios

  • 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.

Related Endpoints

Authentication

AuthorizationBearer

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

Response

ClearingHouse
namestring<=64 characters
idlongOptional