Skip to main content

Passthrough Read

Loading...
API endpoint path: /mx/{institutionId}/{mxRealTimeResourcePath}

Transparent passthrough for GET requests to the MX Real Time APIs. The service provides synchronous CRUD operations for users, members, accounts, transactions, and holdings; endpoint paths, headers, query parameters, and response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke any MX Real Time GET API to retrieve users, members, accounts, transactions, or holdings (for example, list users or read an account, transaction, or holding by ID).
  • Read core institution data previously pushed to MX in real time to support reconciliation, verification, or downstream processing in MX-powered digital experiences.
  • Request JSON or XML response bodies by including a URL extension (for example, .json or .xml) and a matching Accept header (application/vnd.moneydesktop.mdx.v5+json or application/vnd.moneydesktop.mdx.v5+xml), as documented by MX.
  • Access MX Real Time read operations through the Candescent API Gateway instead of calling MX directly.

Behavior and capabilities:

  • The gateway validates the OAuth V2 bearer token, correlationId, and ext_host, injects MD-API-KEY for MX Real Time routing, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{institutionId}/{mxRealTimeResourcePath}, where institutionId corresponds to the MX client_id (used in MX paths such as /{client_id}/...), must match the value in the OAuth V2 token, and is used when forwarding requests to MX.
  • Forwards all MX-supported headers, paths, and query parameters without modification.
  • Returns MX HTTP status codes and response payloads without modification.

Request​

Responses​

Response payload returned by the target MX Real Time endpoint. Refer to the MX Real Time APIs documentation for supported schemas and examples.