Skip to main content

Passthrough Delete

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

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

Use this endpoint to:

  • Invoke MX Real Time DELETE APIs to remove users, members, accounts, transactions, or holdings (for example, deprovisioning closed accounts or removing stale transaction records).
  • Rely on MX cascading deletes to automatically remove dependent records (for example, deleting an account also removes its transactions and holdings, eliminating the need to delete child records first).
  • Deprovision institution data in MX when resources are no longer valid or required for MX-powered digital experiences.
  • Access MX Real Time delete 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 without modification.

Request​

Responses​

No Content