{ "member": { "aggregated_at": "2016-10-13T18:07:57.000Z", "background_aggregation_is_disabled": false, "connection_status": "CONNECTED", "connection_status_message": "Connected to MX Bank", "error": { "error_type": "MEMBER", "error_code": "NO_VERIFIABLE_ACCOUNTS", "error_message": "This Member has no eligible checking, savings, or money market accounts.", "user_message": "We couldn't find any accounts eligible for transfers. Please link a checking or savings account.", "locale": "en" }, "guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b", "id": "unique_id", "institution_code": "mxbank", "institution_guid": "INS-12345678-90ab-cdef-1234-567890abcdef", "is_being_aggregated": false, "is_managed_by_user": false, "is_manual": false, "is_oauth": false, "metadata": "\\\"credentials_last_refreshed_at\\\": \\\"2015-10-15\\", "most_recent_job_detail_code": null, "most_recent_job_detail_text": null, "most_recent_job_guid": "JOB-12345678-90ab-cdef-1234-567890abcdef", "name": "MX Bank", "needs_updated_credentials": false, "oauth_window_uri": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2", "successfully_aggregated_at": "2016-10-13T17:57:38.000Z", "use_cases": [ "PFM" ], "user_guid": "USR-fa7537f3-48aa-a683-a02a-b18940482f54", "user_id": "u-1234" }}
Transactions
Aggregate Transaction History
Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
To authenticate with the Platform API, include your Base64-encoded client_id and api_key in the Authorization header of every request:
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'
The date and time the most recent aggregation-type job was started, given in ISO 8601 format with a time component.
A job will automatically be started when a member is created or its credentials are updated, unless the skip_aggregation parameter is used.
Jobs can also be started via manual aggregations, background aggregations, API endpoints, or when opening an MX widget.
A job can be a normal aggregation, or a premium job such as identification, verification, fetching statements, or fetching an extended transaction history.
If a member is deleted and then re-created with the skip_aggregation parameter set to true or if it is re-created within the throttle window (typically three hours), the previous value will be returned.
Details about why the member's most recent aggregation failed. This is null unless the aggregation failed for one of the reasons in Member Connection Errors.
Indicates whether the member is managed by the user or the MX partner. Members created with the managed member feature will have this field set to false.
Internal field used by MX in some circumstances. When set to true, MX will not attempt to aggregate the member. It will be set to false automatically when the member's credentials are updated.
The use case associated with the member. Valid values are PFM and/or MONEY_MOVEMENT. Only set this if you've met with MX and have opted in to using this field.