Clearing House List
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 401with"Access is denied".
Error Messages
Related Endpoints
- Use
clearingHouseItemto resolve a singleclearingHouseId. - Use
clearingHouseFindto look up a clearing house’sidby name.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
ClearingHouse
name
id