Skip to main content

Passthrough Update

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

Transparent passthrough for PUT 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 request/response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX Real Time PUT APIs to update existing users, members, accounts, transactions, or holdings (for example, refreshing account balances, correcting transaction details, or revising holding values).
  • Keep institution core data synchronized with MX in real time as balances, transactions, and holdings change in core banking systems, fulfilling partner responsibility for managing data sent to MX.
  • Submit JSON or XML request bodies using a URL extension (for example, .json or .xml) and a matching Content-Type header (application/vnd.moneydesktop.mdx.v5+json or application/vnd.moneydesktop.mdx.v5+xml), as documented by MX.
  • Access MX Real Time update 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, query parameters, and request payloads 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.