Skip to main content

Passthrough Update

Loading...
API endpoint path: /mx/{mxPlatformResourcePath}

Transparent passthrough for PUT requests to the MX Platform APIs v20250224 and MX Platform APIs v20111101. The service provides RESTful operations for users, members, institutions, accounts, transactions, statements, and related resources; endpoint paths, headers, query parameters, and request/response schemas are defined in the MX documentation.

Use this endpoint to:

  • Invoke MX Platform PUT APIs to update users, members, accounts, transactions, budgets, categories, goals, taggings, transaction rules, spending plans, and notifications (for example, updating a user or revising transaction categorization).
  • Keep MX user, member, and account data current as institution status, credentials, or end-user preferences change, including enhanced data fields such as categorization and insights supported by the MX Platform pipeline.
  • Submit JSON request bodies with Content-Type: application/json, Accept: application/json, and Accept-Version: v20250224 (or v20111101 for legacy endpoints), or application/vnd.mx.api.v1+json when specified for the target operation.
  • Access MX Platform 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; replaces the Authorization header with MX Basic authentication, and removes Candescent-specific headers before forwarding the request to MX.
  • Proxies requests using the path /mx/{mxPlatformResourcePath}, where mxPlatformResourcePath corresponds to the MX Platform resource path as defined in the MX documentation.
  • 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 Platform endpoint. Refer to the MX Platform APIs v20250224 and MX Platform APIs v20111101 documentation for supported schemas and examples.