members

Aggregate member

Changed on

Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event.

post/users/{user_guid}/members/{member_guid}/aggregate

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/members/{member_guid}/aggregate
  • Auth
    HTTP basic

Path parameters

member_guidstring required

The unique id for a member.

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Query parameters

include_holdingsboolean

When set to false, the aggregation will not gather holdings data. Defaults to true.

include_transactionsboolean

When set to false, the aggregation will not gather transactions data. Defaults to true.

Headers

X-CALLBACK-PAYLOADstring

The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.

Response

Accepted

Changes

  • e74cd2b059b5Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      api tag members added

    • info

      api tag mx_platform removed

    • info

      added the new optional header request parameter X-CALLBACK-PAYLOAD

  • e1695c948c80Revision changes
    • info

      added the new optional query request parameter include_holdings

    • info

      added the new optional query request parameter include_transactions