Skip to main content
POST
Aggregate member
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.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-CALLBACK-PAYLOAD
string

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.

Path Parameters

member_guid
string
required

The unique id for a member.

user_guid
string
required

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

Query Parameters

include_holdings
boolean

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

include_transactions
boolean

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

Response

202 - application/vnd.mx.api.v1+json

Accepted

member
object