Struct Client 

pub struct Client { /* private fields */ }

Client for MX Platform API

The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.

Just getting started? See our use case guides.

Version: 20111101

Implementations

impl Client

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

impl Client

pub async fn request_authorization_code<'a>( &'a self, body: &'a AuthorizationCodeRequestBody, ) -> Result<ResponseValue<AuthorizationCodeResponseBody>, Error<()>>

Request an authorization code

Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.

Sends a POST request to /authorization_code

Arguments:

• body: The scope for the authorization code.

pub async fn read_ach_retrun<'a>( &'a self, ach_return_guid: &'a str, ) -> Result<ResponseValue<AchReturnResponseBody>, Error<()>>

Read ACH Return

:::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::

Use this endpoint to get an ACH return by its guid or id.

Sends a GET request to /ach_returns/{ach_return_guid}

Arguments:

• ach_return_guid: The unique identifier (guid) for the ACH return. Defined by MX.

pub async fn list_ach_retruns<'a>( &'a self, institution_guid: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, resolved_status_at: Option<&'a str>, return_code: Option<&'a str>, return_status: Option<&'a str>, returned_at: Option<&'a str>, ) -> Result<ResponseValue<AchReturnsResponseBody>, Error<()>>

List ACH Returns

:::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::

Use this endpoint to get all ACH returns.

Sends a GET request to /ach_returns

Arguments:

• institution_guid: The identifier for the institution associated with the ACH return. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.
• resolved_status_at: The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp
• return_code: The associated ACH return code and notice of change code. See [Return Codes](/api-reference/platform-api/reference/ach-return-fields# return-codes) for a complete list.
• return_status: The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields# return-status) for a complete list.
• returned_at: The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.

pub async fn create_ach_return<'a>( &'a self, body: &'a AchReturnCreateRequestBody, ) -> Result<ResponseValue<AchReturnResponseBody>, Error<()>>

Create ACH Return

:::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::

Use this endpoint to create an ACH return in our system.

Sends a POST request to /ach_returns

Arguments:

• body: ACH return object to be created.

pub async fn list_default_categories<'a>( &'a self, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CategoriesResponseBody>, Error<()>>

List default categories

Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its is_default field set to true. There are currently 119 default categories and subcategories. Both the list default categories and list default categories by user endpoints return the same results. The different routes are provided for convenience.

Sends a GET request to /categories/default

Arguments:

• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn read_default_category<'a>( &'a self, category_guid: &'a str, ) -> Result<ResponseValue<CategoryResponseBody>, Error<()>>

Read a default category

Use this endpoint to read the attributes of a default category.

Sends a GET request to /categories/{category_guid}

Arguments:

• category_guid: The unique id for a category.

pub async fn list_institutions<'a>( &'a self, iso_country_code: Option<&'a Vec<String>>, name: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, supports_account_identification: Option<bool>, supports_account_statement: Option<bool>, supports_account_verification: Option<bool>, supports_transaction_history: Option<bool>, ) -> Result<ResponseValue<InstitutionsResponseBody>, Error<()>>

List institutions

This endpoint returns a list of institutions based on the specified search term or parameter.

Sends a GET request to /institutions

Arguments:

• iso_country_code: An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include US, CA, and MX (Mexico).
• name: This will list only institutions in which the appended string appears.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.
• supports_account_identification: Filter only institutions which support account identification.
• supports_account_statement: Filter only institutions which support account statements.
• supports_account_verification: Filter only institutions which support account verification.
• supports_transaction_history: Filter only institutions which support extended transaction history.

pub async fn list_favorite_institutions<'a>( &'a self, iso_country_code: Option<&'a Vec<String>>, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InstitutionsResponseBody>, Error<()>>

List favorite institutions

This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.

Sends a GET request to /institutions/favorites

Arguments:

• iso_country_code: An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include US, CA, and MX (Mexico).
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn read_institution<'a>( &'a self, institution_code: &'a str, ) -> Result<ResponseValue<InstitutionResponseBody>, Error<()>>

Read institution

This endpoint returns information about the institution specified by institution_code.

Sends a GET request to /institutions/{institution_code}

Arguments:

• institution_code: The institution_code of the institution.

pub async fn list_institution_credentials<'a>( &'a self, institution_code: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CredentialsResponseBody>, Error<()>>

List institution credentials

Use this endpoint to see which credentials will be needed to create a member for a specific institution.

Passing an invalid institution_code returns a 404.

Sends a GET request to /institutions/{institution_code}/credentials

Arguments:

• institution_code: The institution_code of the institution.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_managed_institutions<'a>( &'a self, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InstitutionsResponseBody>, Error<()>>

List managed institutions

This endpoint returns a list of institutions which can be used to create partner-managed members.

Sends a GET request to /managed_institutions

Arguments:

• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_merchant_location<'a>( &'a self, merchant_location_guid: &'a str, ) -> Result<ResponseValue<MerchantLocationResponseBody>, Error<()>>

Read merchant location

This endpoint returns the specified merchant_location resource. The merchant_location_guid can be found on transaction objects.

Sends a GET request to /merchant_locations/{merchant_location_guid}

Arguments:

• merchant_location_guid: The unique id for a merchant_location.

pub async fn list_merchants<'a>( &'a self, name: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<MerchantsResponseBody>, Error<()>>

List merchants

This endpoint returns a paginated list of all the merchants in the MX system.

Sends a GET request to /merchants

Arguments:

• name: This will list only merchants in which the appended string appears.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_merchant<'a>( &'a self, merchant_guid: &'a str, ) -> Result<ResponseValue<MerchantResponseBody>, Error<()>>

Read merchant

Returns information about a particular merchant, such as a logo, name, and website.

Sends a GET request to /merchants/{merchant_guid}

Arguments:

• merchant_guid: The unique id for a merchant.

pub async fn deprecated_request_payment_processor_authorization_code<'a>( &'a self, body: &'a PaymentProcessorAuthorizationCodeRequestBody, ) -> Result<ResponseValue<PaymentProcessorAuthorizationCodeResponseBody>, Error<()>>

(Deprecated) Request an authorization code

(This endpoint is deprecated. Clients should use /authorization_code.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.

Sends a POST request to /payment_processor_authorization_code

Arguments:

• body: The scope for the authorization code.

pub async fn enhance_transactions<'a>( &'a self, body: &'a EnhanceTransactionsRequestBody, ) -> Result<ResponseValue<EnhanceTransactionsResponseBody>, Error<()>>

Enhance transactions

Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform.

For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions).

Sends a POST request to /transactions/enhance

Arguments:

• body: Transaction object to be enhanced

pub async fn list_users<'a>( &'a self, email: Option<&'a str>, id: Option<&'a str>, is_disabled: Option<bool>, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<UsersResponseBody>, Error<()>>

List users

Use this endpoint to list every user you’ve created in the MX Platform API.

Sends a GET request to /users

Arguments:

• email: The user email to search for.
• id: The user id to search for.
• is_disabled: Search for users that are diabled.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_user<'a>( &'a self, body: &'a UserCreateRequestBody, ) -> Result<ResponseValue<UserResponseBody>, Error<()>>

Create user

Use this endpoint to create a new user. The API will respond with the newly-created user object if successful, containing a guid that you’ll set as the user_guid in other requests when required. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.

Sends a POST request to /users

Arguments:

• body: User object to be created. (None of these parameters are required, but the user object cannot be empty)

pub async fn read_user<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<UserResponseBody>, Error<()>>

Read user

Use this endpoint to read the attributes of a specific user.

Sends a GET request to /users/{user_guid}

Arguments:

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

pub async fn update_user<'a>( &'a self, user_guid: &'a str, body: &'a UserUpdateRequestBody, ) -> Result<ResponseValue<UserResponseBody>, Error<()>>

Update user

Use this endpoint to update the attributes of the specified user.

Sends a PUT request to /users/{user_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: User object to be updated (None of these parameters are required, but the user object cannot be empty.)

pub async fn delete_user<'a>( &'a self, user_guid: &'a str, accept: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete user

Use this endpoint to delete the specified user. The response will have a status of 204 No Content without an object.

:::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see Deleting Objects. :::

Sends a DELETE request to /users/{user_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• accept: Specifies the media type expected in the response.

pub async fn list_user_accounts<'a>( &'a self, user_guid: &'a str, is_manual: Option<bool>, member_is_managed_by_user: Option<bool>, page: Option<i64>, records_per_page: Option<i64>, use_case: Option<&'a str>, ) -> Result<ResponseValue<AccountsResponseBody>, Error<()>>

List accounts

This endpoint returns a list of all the accounts associated with the specified user.

:::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to List account numbers by member, List account numbers by account, or the Fetch Account and Routing Numbers guide. :::

Sends a GET request to /users/{user_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• is_manual: List only accounts that were manually created.
• member_is_managed_by_user: List only accounts whose member is managed by the user.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
• use_case: The use case associated with the member. Valid values are PFM and MONEY_MOVEMENT. For example, you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.

pub async fn create_manual_account<'a>( &'a self, user_guid: &'a str, body: &'a AccountCreateRequestBody, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Create manual account

This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..

Sends a POST request to /users/{user_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Manual account object to be created.

pub async fn read_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Read account

This endpoint returns the specified account resource.

Sends a GET request to /users/{user_guid}/accounts/{account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.

pub async fn delete_manual_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, accept: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete manual account

This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of 204 No Content.

Sends a DELETE request to /users/{user_guid}/accounts/{account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• accept: Specifies the media type expected in the response.

pub async fn list_account_numbers_by_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountNumbersResponseBody>, Error<()>>

List account numbers by account

This endpoint returns a list of account numbers associated with the specified account.

Sends a GET request to /users/{user_guid}/accounts/{account_guid}/account_numbers

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_insights_by_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InsightsResponseBody>, Error<()>>

List insights by account

Use this endpoint to list all insights associated with an account GUID.

Sends a GET request to /users/{user_guid}/accounts/{account_guid}/insights

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_transactions_by_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, category_guid: Option<&'a str>, from_created_at: Option<&'a str>, from_date: Option<&'a str>, from_updated_at: Option<&'a str>, includes: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_created_at: Option<&'a str>, to_date: Option<&'a str>, to_updated_at: Option<&'a str>, top_level_category_guid: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBodyIncludes>, Error<()>>

List transactions by account

Requests to this endpoint return a list of transactions associated with the specified account.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions#optional-enhancement-query-parameter).

Sends a GET request to /users/{user_guid}/accounts/{account_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• category_guid: Filter transactions belonging to specified category_guid.

For example, ?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• category_guid: Filter transactions belonging to any specified category_guid[] in url.

For example, ?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• from_created_at: Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• from_updated_at: Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• includes: Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications, geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

• Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).

• Merchants: Enriches transactions with merchant name.

• Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.

• Geolocation: Provides geographic metadata.

• page: Results are paginated. Specify current page.

• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

• to_created_at: Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

• to_updated_at: Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• top_level_category_guid: Filter transactions belonging to specified top_level_category_guid. This must be top level category guid, use category_guid for subcategory guid.

For example, ?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• top_level_category_guid: Filter transactions belonging to any specified top_level_category_guid[] in url. This must be top level category guid(s), use category_guid for subcategory guid(s).

For example, ?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

pub async fn create_manual_transaction<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, body: &'a TransactionCreateRequestBody, ) -> Result<ResponseValue<TransactionCreateResponseBody>, Error<()>>

Create manual transaction

This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

Sends a POST request to /users/{user_guid}/accounts/{account_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• body

pub async fn list_categories<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CategoriesResponseBody>, Error<()>>

List categories

Use this endpoint to list all categories associated with a user, including both default and custom categories.

Sends a GET request to /users/{user_guid}/categories

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_category<'a>( &'a self, user_guid: &'a str, body: &'a CategoryCreateRequestBody, ) -> Result<ResponseValue<CategoryResponseBody>, Error<()>>

Create category

Use this endpoint to create a new custom category for a specific user.

Sends a POST request to /users/{user_guid}/categories

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Custom category object to be created

pub async fn list_default_categories_by_user<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CategoriesResponseBody>, Error<()>>

List default categories by user

Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its is_default field set to true. There are currently 119 default categories and subcategories. Both the list default categories and list default categories by user endpoints return the same results. The different routes are provided for convenience.

Sends a GET request to /users/{user_guid}/categories/default

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_category<'a>( &'a self, user_guid: &'a str, category_guid: &'a str, ) -> Result<ResponseValue<CategoryResponseBody>, Error<()>>

Read a custom category

Use this endpoint to read the attributes of either a default category or a custom category.

Sends a GET request to /users/{user_guid}/categories/{category_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• category_guid: The unique id for a category.

pub async fn update_category<'a>( &'a self, user_guid: &'a str, category_guid: &'a str, body: &'a CategoryUpdateRequestBody, ) -> Result<ResponseValue<CategoryResponseBody>, Error<()>>

Update category

Use this endpoint to update the attributes of a custom category according to its unique GUID.

Sends a PUT request to /users/{user_guid}/categories/{category_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• category_guid: The unique id for a category.
• body: Category object to be updated (While no single parameter is required, the category object cannot be empty)

pub async fn delete_category<'a>( &'a self, user_guid: &'a str, category_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete category

Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of 204 No Content.

Sends a DELETE request to /users/{user_guid}/categories/{category_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• category_guid: The unique id for a category.

pub async fn request_connect_widget_url<'a>( &'a self, user_guid: &'a str, body: &'a ConnectWidgetRequestBody, ) -> Result<ResponseValue<ConnectWidgetResponseBody>, Error<()>>

(Deprecated) Request connect widget URL

This endpoint will return a URL for an embeddable version of MX Connect.

Sends a POST request to /users/{user_guid}/connect_widget_url

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)

pub async fn list_insights_user<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InsightsResponseBody>, Error<()>>

List all insights for a user

Use this endpoint to list all the insights associated with the user.

Sends a GET request to /users/{user_guid}/insights

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_categories_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CategoriesResponseBody>, Error<()>>

List all categories associated with an insight

Use this endpoint to list all the categories associated with the insight.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}/categories

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_accounts_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountsResponseBody>, Error<()>>

List all accounts associated with an insight

Use this endpoint to list all the accounts associated with the insight.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_merchants_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<MerchantsResponseBody>, Error<()>>

List all merchants associated with an insight

Use this endpoint to list all the merchants associated with the insight.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}/merchants

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_scheduled_payments_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<ScheduledPaymentsResponseBody>, Error<()>>

List all scheduled payments associated with an insight

Use this endpoint to list all the scheduled payments associated with the insight.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}/scheduled_payments

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn list_transactions_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<TransactionsResponseBody>, Error<()>>

List all transactions associated with an insight

Use this endpoint to list all the transactions associated with the insight.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn read_insight_user<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, ) -> Result<ResponseValue<InsightResponseBody>, Error<()>>

Read insight

Use this endpoint to read the attributes of an insight according to its unique GUID.

Sends a GET request to /users/{user_guid}/insights/{insight_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.

pub async fn update_insight<'a>( &'a self, user_guid: &'a str, insight_guid: &'a str, body: &'a InsightUpdateRequestBody, ) -> Result<ResponseValue<InsightResponse>, Error<()>>

Update insight

Use this endpoint to update the attributes of an insight according to its unique GUID.

Sends a PUT request to /users/{user_guid}/insights/{insight_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• insight_guid: The unique identifier for the insight. Defined by MX.
• body: The insight to be updated (None of these parameters are required, but the user object cannot be empty.)

pub async fn list_managed_members<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<MembersResponseBody>, Error<()>>

List managed members

This endpoint returns a list of all the partner-managed members associated with the specified user.

Sends a GET request to /users/{user_guid}/managed_members

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_managed_member<'a>( &'a self, user_guid: &'a str, body: &'a ManagedMemberCreateRequestBody, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Create managed member

Use this endpoint to create a new partner-managed member.

Sends a POST request to /users/{user_guid}/managed_members

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Managed member to be created.

pub async fn read_managed_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Read managed member

This endpoint returns the attributes of the specified partner-managedmember.

Sends a GET request to /users/{user_guid}/managed_members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn update_managed_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, body: &'a ManagedMemberUpdateRequestBody, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Update managed member

Use this endpoint to update the attributes of the specified partner_managed member.

Sends a PUT request to /users/{user_guid}/managed_members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• body: Managed member object to be updated (While no single parameter is required, the request body can’t be empty)

pub async fn delete_managed_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, accept: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete managed member

Use this endpoint to delete the specified partner-managed member. The endpoint will respond with a status of 204 No Content without a resource.

Sends a DELETE request to /users/{user_guid}/managed_members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• accept: Specifies the media type expected in the response.

pub async fn list_managed_accounts<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountsResponseBody>, Error<()>>

List managed accounts

Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-managed member.

Sends a GET request to /users/{user_guid}/managed_members/{member_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_managed_account<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, body: &'a ManagedAccountCreateRequestBody, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Create managed account

Use this endpoint to create a partner-managed account.

Sends a POST request to /users/{user_guid}/managed_members/{member_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• body: Managed account to be created.

pub async fn read_managed_account<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Read managed account

Use this endpoint to read the attributes of a partner-managed account according to its unique guid.

Sends a GET request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.

pub async fn update_managed_account<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, body: &'a ManagedAccountUpdateRequestBody, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Update managed account

Use this endpoint to update the attributes of a partner-managed account according to its unique GUID.

Sends a PUT request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• body: Managed account object to be updated (While no single parameter is required, the request body can’t be empty)

pub async fn delete_managed_account<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete managed account

Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of 204 No Content.

Sends a DELETE request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.

pub async fn list_managed_transactions<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, from_date: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_date: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBody>, Error<()>>

List managed transactions

This endpoint returns a list of all the partner-managed transactions associated with the specified account, scoped through a user and a member.

Sends a GET request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

pub async fn create_managed_transaction<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, body: &'a ManagedTransactionCreateRequestBody, ) -> Result<ResponseValue<TransactionResponseBody>, Error<()>>

Create managed transaction

Use this endpoint to create a new partner-managed transaction.

Sends a POST request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• body: Managed transaction to be created.

pub async fn read_managed_transaction<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, transaction_guid: &'a str, ) -> Result<ResponseValue<TransactionResponseBody>, Error<()>>

Read managed transaction

Requests to this endpoint will return the attributes of the specified partner-managed transaction.

Sends a GET request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• transaction_guid: The unique id for a transaction.

pub async fn update_managed_transaction<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, transaction_guid: &'a str, body: &'a ManagedTransactionUpdateRequestBody, ) -> Result<ResponseValue<TransactionResponseBody>, Error<()>>

Update managed transaction

Use this endpoint to update the attributes of the specified partner_managed transaction.

Sends a PUT request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• transaction_guid: The unique id for a transaction.
• body: Managed transaction object to be updated (While no single parameter is required, the request body can’t be empty)

pub async fn delete_managed_transaction<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, transaction_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete managed transaction

Use this endpoint to delete the specified partner-managed transaction. The endpoint will respond with a status of 204 No Content without a resource.

Sends a DELETE request to /users/{user_guid}/managed_members/{member_guid}/accounts/ {account_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• transaction_guid: The unique id for a transaction.

pub async fn list_members<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, use_case: Option<&'a str>, ) -> Result<ResponseValue<MembersResponseBody>, Error<()>>

List members

This endpoint returns an array which contains information on every member associated with a specific user.

Sends a GET request to /users/{user_guid}/members

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
• use_case: The use case associated with the member. Valid values are PFM and MONEY_MOVEMENT. For example, you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.

pub async fn create_member<'a>( &'a self, user_guid: &'a str, x_callback_payload: Option<&'a str>, body: &'a MemberCreateRequestBody, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Create member

This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.

Sends a POST request to /users/{user_guid}/members

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• x_callback_payload: 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.
• body: Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code)

pub async fn read_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Read member

Use this endpoint to read the attributes of a specific member.

Sends a GET request to /users/{user_guid}/members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn update_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, x_callback_payload: Option<&'a str>, body: &'a MemberUpdateRequestBody, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Update member

Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint.

Sends a PUT request to /users/{user_guid}/members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• x_callback_payload: 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.
• body: Member object to be updated (While no single parameter is required, the request body can’t be empty)

pub async fn delete_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete member

Accessing this endpoint will permanently delete a member.

Sends a DELETE request to /users/{user_guid}/members/{member_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn list_account_numbers_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountNumbersResponseBody>, Error<()>>

List account numbers by member

This endpoint returns a list of account numbers associated with the specified member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/account_numbers

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_account_owners_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountOwnersResponseBody>, Error<()>>

List account owners by member

This endpoint returns an array with information about every account associated with a particular member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/account_owners

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_member_accounts<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, member_is_managed_by_user: Option<bool>, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<AccountsResponseBody>, Error<()>>

List accounts by member

This endpoint returns a list of all the accounts associated with the specified member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• member_is_managed_by_user: List only accounts whose member is managed by the user.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_account_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Read account by member

This endpoint allows you to read the attributes of an account resource.

Sends a GET request to /users/{user_guid}/members/{member_guid}/accounts/{account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.

pub async fn update_account_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, body: &'a AccountUpdateRequestBody, ) -> Result<ResponseValue<AccountResponseBody>, Error<()>>

Update account by member

This endpoint allows you to update certain attributes of an account resource, including manual accounts. For manual accounts, you can update every field listed. For aggregated accounts, you can only update is_business, is_hidden and metadata.

Sends a PUT request to /users/{user_guid}/members/{member_guid}/accounts/{account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• body

pub async fn update_transaction_by_account<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, account_guid: &'a str, transaction_guid: &'a str, body: &'a TransactionUpdateRequestBody, ) -> Result<ResponseValue<TransactionResponseBody>, Error<()>>

Update Transaction by Account

Use this endpoint to update a specific transaction according to its unique GUID.

Sends a PUT request to /users/{user_guid}/members/{member_guid}/accounts/{account_guid}/ transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• account_guid: The unique id for an account.
• transaction_guid: The unique id for a transaction.
• body: Transaction object to be updated

pub async fn aggregate_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, include_holdings: Option<bool>, include_transactions: Option<bool>, x_callback_payload: Option<&'a str>, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

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.

Sends a POST request to /users/{user_guid}/members/{member_guid}/aggregate

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• include_holdings: When set to false, the aggregation will not gather holdings data. Defaults to true.
• include_transactions: When set to false, the aggregation will not gather transactions data. Defaults to true.
• x_callback_payload: 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.

pub async fn list_member_challenges<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<ChallengesResponseBody>, Error<()>>

List member challenges

Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned. If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned - along with the corresponding credentials.

Sends a GET request to /users/{user_guid}/members/{member_guid}/challenges

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn check_balances<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Check balances

This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data.

Sends a POST request to /users/{user_guid}/members/{member_guid}/check_balance

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn list_member_credentials<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<CredentialsResponseBody>, Error<()>>

List member credentials

This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/credentials

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn extend_history<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Extend 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.

Sends a POST request to /users/{user_guid}/members/{member_guid}/extend_history

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn fetch_statements<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Fetch statements

Use this endpoint to fetch the statements associated with a particular member.

Sends a POST request to /users/{user_guid}/members/{member_guid}/fetch_statements

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn list_holdings_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InvestmentHoldingsResponseBody>, Error<()>>

List holdings by member

This endpoint lists all holdings associated with the specified member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/investment_holdings

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_holdings<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InvestmentHoldingsResponseBody>, Error<()>>

List holdings by user

This endpoint lists all holdings associated with the user across all accounts.

Sends a GET request to /users/{user_guid}/investment_holdings

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_holding<'a>( &'a self, user_guid: &'a str, holding_guid: &'a str, ) -> Result<ResponseValue<InvestmentHoldingResponseBody>, Error<()>>

Read holding

Use this endpoint to read the attributes of a specific holding.

Sends a GET request to /users/{user_guid}/investment_holdings/{holding_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• holding_guid: The unique id for a holding.

pub async fn list_holdings_by_account<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InvestmentHoldingsResponseBody>, Error<()>>

List holdings by account

This endpoint lists all holdings associated with the particular account defined.

Sends a GET request to /users/{user_guid}/accounts/{account_guid}/investment_holdings

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn deactivate_user<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<InvestmentHoldingsDeactivation>, Error<()>>

Deactivate user from Investment Holdings

This endpoint deactivates the specific user from the /investment_holdings product. To reactivate a user, use any of the current /investment_holding endpoints.

Sends a GET request to /users/{user_guid}/investment_holdings_deactivate

Arguments:

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

pub async fn identify_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Identify member

The identify endpoint begins an identification process for an already-existing member.

Sends a POST request to /users/{user_guid}/members/{member_guid}/identify

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn request_o_auth_window_uri<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, client_redirect_url: Option<&'a str>, enable_app2app: Option<&'a str>, referral_source: Option<&'a str>, skip_aggregation: Option<bool>, ui_message_webview_url_scheme: Option<&'a str>, ) -> Result<ResponseValue<OAuthWindowResponseBody>, Error<()>>

Request oauth window uri

This endpoint will generate an oauth_window_uri for the specified member.

Sends a GET request to /users/{user_guid}/members/{member_guid}/oauth_window_uri

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• client_redirect_url: A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with referral_source=APP.
• enable_app2app: This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to true. When set to false, any oauth_window_uri generated will not direct the end user to the institution’s mobile application. This setting is not persistent. This setting currently only affects Chase institutions.
• referral_source: Must be either BROWSER or APP depending on the implementation. Defaults to BROWSER.
• skip_aggregation: Setting this parameter to true will prevent the member from automatically aggregating after being redirected from the authorization page.
• ui_message_webview_url_scheme: A scheme for routing the user back to the application state they were previously in. Only available with referral_source=APP.

pub async fn resume_aggregation<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, body: &'a MemberResumeRequestBody, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Resume aggregation

This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.

Sends a PUT request to /users/{user_guid}/members/{member_guid}/resume

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• body: Member object with MFA challenge answers

pub async fn list_statements_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<StatementsResponseBody>, Error<()>>

List statements by member

Use this endpoint to get an array of available statements.

Sends a GET request to /users/{user_guid}/members/{member_guid}/statements

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_statement_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, statement_guid: &'a str, ) -> Result<ResponseValue<StatementResponseBody>, Error<()>>

Read statement by member

Use this endpoint to read a JSON representation of the statement.

Sends a GET request to /users/{user_guid}/members/{member_guid}/statements/{statement_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• statement_guid: The unique id for a statement.

pub async fn download_statement_pdf<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, statement_guid: &'a str, ) -> Result<ResponseValue<ByteStream>, Error<()>>

Download statement pdf

Use this endpoint to download a specified statement PDF.

Sends a GET request to /users/{user_guid}/members/{member_guid}/statements/{statement_guid}. pdf

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• statement_guid: The unique id for a statement.

pub async fn read_member_status<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberStatusResponseBody>, Error<()>>

Read member status

This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the current status of a members connection to a financial institution and the state of its aggregation - the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being.

Sends a GET request to /users/{user_guid}/members/{member_guid}/status

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn list_transactions_by_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, category_guid: Option<&'a str>, from_created_at: Option<&'a str>, from_date: Option<&'a str>, from_updated_at: Option<&'a str>, includes: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_created_at: Option<&'a str>, to_date: Option<&'a str>, to_updated_at: Option<&'a str>, top_level_category_guid: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBodyIncludes>, Error<()>>

List transactions by member

Requests to this endpoint return a list of transactions associated with the specified member, across all accounts associated with that member.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions#optional-enhancement-query-parameter).

Sends a GET request to /users/{user_guid}/members/{member_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• category_guid: Filter transactions belonging to specified category_guid.

For example, ?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• category_guid: Filter transactions belonging to any specified category_guid[] in url.

For example, ?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• from_created_at: Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• from_updated_at: Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• includes: Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications, geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

• Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).

• Merchants: Enriches transactions with merchant name.

• Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.

• Geolocation: Provides geographic metadata.

• page: Results are paginated. Specify current page.

• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

• to_created_at: Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

• to_updated_at: Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• top_level_category_guid: Filter transactions belonging to specified top_level_category_guid. This must be top level category guid, use category_guid for subcategory guid.

For example, ?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• top_level_category_guid: Filter transactions belonging to any specified top_level_category_guid[] in url. This must be top level category guid(s), use category_guid for subcategory guid(s).

For example, ?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

pub async fn verify_member<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, x_callback_payload: Option<&'a str>, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Verify member

The verify endpoint begins a verification process for a member.

Sends a POST request to /users/{user_guid}/members/{member_guid}/verify

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• x_callback_payload: 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.

pub async fn list_spending_plan_iteration_items<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanIterationItemsResponseBody>, Error<()>>

List spending plan iteration items

Use this endpoint to list all the spending plan iteration_items associated with the iteration.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current/iteration_items

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_spending_plan_iteration_item<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, body: &'a SpendingPlanIterationItemCreateRequestBody, ) -> Result<ResponseValue<SpendingPlanIterationItemResponse>, Error<()>>

Create spending plan iteration item

This endpoint creates a new spending_plan_iteration_item.

Sends a POST request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current/iteration_items

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• body: Iteration item to be created with required parameter (planned_amount)

pub async fn list_spending_plans<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlansResponseBody>, Error<()>>

List spending plans

Use this endpoint to list all the spending plans associated with the user.

Sends a GET request to /users/{user_guid}/spending_plans

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_spending_plan<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<SpendingPlanResponse>, Error<()>>

Create spending plan

This endpoint creates a new spending_plan for the user.

Sends a POST request to /users/{user_guid}/spending_plans

Arguments:

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

pub async fn read_spending_plan_account<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, spending_plan_account_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanAccountResponse>, Error<()>>

Read spending plan account

Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/ spending_plan_accounts/{spending_plan_account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• spending_plan_account_guid: The unique ID for the specified account.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn delete_spending_plan_account<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, spending_plan_account_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete spending plan account

Use this endpoint to delete a spending_plan_account.

Sends a DELETE request to /users/{user_guid}/spending_plans/{spending_plan_guid}/ spending_plan_accounts/{spending_plan_account_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• spending_plan_account_guid: The unique ID for the specified account.

pub async fn read_spending_plan_iteration_item<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, iteration_item_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanIterationItemResponse>, Error<()>>

Read a spending plan iteration item

Use this endpoint to read the attributes of a specific spending plan iteration_item according to its unique GUID.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current/iteration_items/{iteration_item_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• iteration_item_guid: The unique ID for the iteration_item.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn update_spending_plan_iteration_item<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, iteration_item_guid: &'a str, body: &'a SpendingPlanIterationItemCreateRequestBody, ) -> Result<ResponseValue<SpendingPlanIterationItemResponse>, Error<()>>

Update a spending plan iteration item

Use this endpoint to update an existing spending_plan_iteration_item.

Sends a PUT request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current/iteration_items/{iteration_item_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• iteration_item_guid: The unique ID for the iteration_item.
• body: Iteration item to be updated with required parameter (planned_amount)

pub async fn delete_spending_plan_iteration_item<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, iteration_item_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete spending plan iteration item

Use this endpoint to delete a spending plan iteration_item.

Sends a DELETE request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current/iteration_items/{iteration_item_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• iteration_item_guid: The unique ID for the iteration_item.

pub async fn read_spending_plan_user<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanResponse>, Error<()>>

Read a spending plan for a user

Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn delete_spending_plan<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete spending plan

Use this endpoint to delete a user’s spending_plan.

Sends a DELETE request to /users/{user_guid}/spending_plans/{spending_plan_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.

pub async fn list_spending_plan_accounts<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanAccountsResponse>, Error<()>>

List spending plan accounts

Use this endpoint to list all the spending plan accounts associated with the spending plan.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/ spending_plan_accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_spending_plan_iterations<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanIterationsResponse>, Error<()>>

List spending plan iterations

Use this endpoint to list all the spending plan iterations associated with the spending_plan.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_current_spending_plan_iteration<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanIterationResponse>, Error<()>>

Read current spending plan iteration

Use this endpoint to read the attributes of the current spending plan iteration.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ current

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn read_spending_plan_iteration<'a>( &'a self, user_guid: &'a str, spending_plan_guid: &'a str, iteration_number: i64, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<SpendingPlanIterationResponse>, Error<()>>

Read a spending plan iteration

Use this endpoint to read the attributes of a specific spending plan iteration according to its iteration_number.

Sends a GET request to /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/ {iteration_number}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• spending_plan_guid: The unique ID for the spending_plan.
• iteration_number: The current iteration number for the spending plan iteration.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn list_taggings<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<TaggingsResponseBody>, Error<()>>

List taggings

Use this endpoint to retrieve a list of all the taggings associated with a specific user.

Sends a GET request to /users/{user_guid}/taggings

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_tagging<'a>( &'a self, user_guid: &'a str, body: &'a TaggingCreateRequestBody, ) -> Result<ResponseValue<TaggingResponseBody>, Error<()>>

Create tagging

Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs.

Sends a POST request to /users/{user_guid}/taggings

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Tagging object to be created with required parameters (tag_guid and transaction_guid)

pub async fn read_tagging<'a>( &'a self, user_guid: &'a str, tagging_guid: &'a str, ) -> Result<ResponseValue<TaggingResponseBody>, Error<()>>

Read tagging

Use this endpoint to read the attributes of a tagging according to its unique GUID.

Sends a GET request to /users/{user_guid}/taggings/{tagging_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tagging_guid: The unique id for a tagging.

pub async fn update_tagging<'a>( &'a self, user_guid: &'a str, tagging_guid: &'a str, body: &'a TaggingUpdateRequestBody, ) -> Result<ResponseValue<TaggingResponseBody>, Error<()>>

Update tagging

Use this endpoint to update a tagging.

Sends a PUT request to /users/{user_guid}/taggings/{tagging_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tagging_guid: The unique id for a tagging.
• body: Tagging object to be updated with required parameter (tag_guid)

pub async fn delete_tagging<'a>( &'a self, user_guid: &'a str, tagging_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete tagging

Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content.

Sends a DELETE request to /users/{user_guid}/taggings/{tagging_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tagging_guid: The unique id for a tagging.

pub async fn list_tags<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<TagsResponseBody>, Error<()>>

List tags

Use this endpoint to list all tags associated with the specified user. Each user includes the Business tag by default.

Sends a GET request to /users/{user_guid}/tags

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_tag<'a>( &'a self, user_guid: &'a str, body: &'a TagCreateRequestBody, ) -> Result<ResponseValue<TagResponseBody>, Error<()>>

Create tag

Use this endpoint to create a new custom tag.

Sends a POST request to /users/{user_guid}/tags

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: Tag object to be created with required parameters (tag_guid)

pub async fn read_tag<'a>( &'a self, user_guid: &'a str, tag_guid: &'a str, ) -> Result<ResponseValue<TagResponseBody>, Error<()>>

Read tag

Use this endpoint to read the attributes of a particular tag according to its unique GUID.

Sends a GET request to /users/{user_guid}/tags/{tag_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tag_guid: The unique id for a tag.

pub async fn update_tag<'a>( &'a self, user_guid: &'a str, tag_guid: &'a str, body: &'a TagUpdateRequestBody, ) -> Result<ResponseValue<TagResponseBody>, Error<()>>

Update tag

Use this endpoint to update the name of a specific tag according to its unique GUID.

Sends a PUT request to /users/{user_guid}/tags/{tag_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tag_guid: The unique id for a tag.
• body: Tag object to be updated with required parameter (tag_guid)

pub async fn delete_tag<'a>( &'a self, user_guid: &'a str, tag_guid: &'a str, accept: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete tag

Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of 204 No Content.

Sends a DELETE request to /users/{user_guid}/tags/{tag_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tag_guid: The unique id for a tag.
• accept: Specifies the media type expected in the response.

pub async fn list_transactions_by_tag<'a>( &'a self, user_guid: &'a str, tag_guid: &'a str, category_guid: Option<&'a str>, from_created_at: Option<&'a str>, from_date: Option<&'a str>, from_updated_at: Option<&'a str>, includes: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_created_at: Option<&'a str>, to_date: Option<&'a str>, to_updated_at: Option<&'a str>, top_level_category_guid: Option<&'a str>, use_case: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBodyIncludes>, Error<()>>

List transactions by tag

Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions#optional-enhancement-query-parameter).

Sends a GET request to /users/{user_guid}/tags/{tag_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• tag_guid: The unique id for a tag.
• category_guid: Filter transactions belonging to specified category_guid.

For example, ?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• category_guid: Filter transactions belonging to any specified category_guid[] in url.

For example, ?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• from_created_at: Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• from_updated_at: Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• includes: Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications, geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

• Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).

• Merchants: Enriches transactions with merchant name.

• Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.

• Geolocation: Provides geographic metadata.

• page: Results are paginated. Specify current page.

• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

• to_created_at: Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

• to_updated_at: Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• top_level_category_guid: Filter transactions belonging to specified top_level_category_guid. This must be top level category guid, use category_guid for subcategory guid.

For example, ?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• top_level_category_guid: Filter transactions belonging to any specified top_level_category_guid[] in url. This must be top level category guid(s), use category_guid for subcategory guid(s).

For example, ?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• use_case: The use case associated with the member. Valid values are PFM and MONEY_MOVEMENT. For example, you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.

pub async fn list_transaction_rules<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<TransactionRulesResponseBody>, Error<()>>

List transaction rules

Use this endpoint to read the attributes of all existing transaction rules belonging to the user.

Sends a GET request to /users/{user_guid}/transaction_rules

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

pub async fn create_transaction_rule<'a>( &'a self, user_guid: &'a str, body: &'a TransactionRuleCreateRequestBody, ) -> Result<ResponseValue<TransactionRuleResponseBody>, Error<()>>

Create transaction rule

Use this endpoint to create a new transaction rule. The newly-created transaction_rule object will be returned if successful.

Sends a POST request to /users/{user_guid}/transaction_rules

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description)

pub async fn read_transaction_rule<'a>( &'a self, user_guid: &'a str, transaction_rule_guid: &'a str, ) -> Result<ResponseValue<TransactionRuleResponseBody>, Error<()>>

Read transaction rule

Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID.

Sends a GET request to /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_rule_guid: The unique id for a transaction_rule.

pub async fn update_transaction_rule<'a>( &'a self, user_guid: &'a str, transaction_rule_guid: &'a str, body: &'a TransactionRuleUpdateRequestBody, ) -> Result<ResponseValue<TransactionRuleResponseBody>, Error<()>>

Update transaction rule

Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged.

Sends a PUT request to /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_rule_guid: The unique id for a transaction_rule.
• body: TransactionRule object to be updated

pub async fn delete_transaction_rule<'a>( &'a self, user_guid: &'a str, transaction_rule_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete transaction rule

Use this endpoint to permanently delete a transaction rule based on its unique GUID.

Sends a DELETE request to /users/{user_guid}/transaction_rules/{transaction_rule_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_rule_guid: The unique id for a transaction_rule.

pub async fn list_transactions<'a>( &'a self, user_guid: &'a str, category_guid: Option<&'a str>, from_created_at: Option<&'a str>, from_date: Option<&'a str>, from_updated_at: Option<&'a str>, includes: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_created_at: Option<&'a str>, to_date: Option<&'a str>, to_updated_at: Option<&'a str>, top_level_category_guid: Option<&'a str>, use_case: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBodyIncludes>, Error<()>>

List transactions

Requests to this endpoint return a list of transactions associated with the specified user, across all members and accounts associated with that user.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions#optional-enhancement-query-parameter).

Sends a GET request to /users/{user_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• category_guid: Filter transactions belonging to specified category_guid.

For example, ?category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• category_guid: Filter transactions belonging to any specified category_guid[] in url.

For example, ?category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• from_created_at: Filter transactions from the date the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• from_updated_at: Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
• includes: Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications, geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

• Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).

• Merchants: Enriches transactions with merchant name.

• Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.

• Geolocation: Provides geographic metadata.

• page: Results are paginated. Specify current page.

• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

• to_created_at: Filter transaction to the date in which the transaction was created. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

• to_updated_at: Filter transactions to the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.

• top_level_category_guid: Filter transactions belonging to specified top_level_category_guid. This must be top level category guid, use category_guid for subcategory guid.

For example, ?top_level_category_guid=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• top_level_category_guid: Filter transactions belonging to any specified top_level_category_guid[] in url. This must be top level category guid(s), use category_guid for subcategory guid(s).

For example, ?top_level_category_guid[]=CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874.

• use_case: The use case associated with the member. Valid values are PFM and MONEY_MOVEMENT. For example, you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.

pub async fn read_transaction<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, includes: Option<&'a str>, ) -> Result<ResponseValue<TransactionsResponseBodyIncludes>, Error<()>>

Read transaction

Requests to this endpoint will return the attributes of the specified transaction. To read a manual transaction, use the manual transaction guid in the path as the transactionGuid.

Enhanced transaction data may be requested using the includes parameter. To use this optional parameter, the value should include the optional metadata requested such as repeating_transactions, merchants, classifications, geolocations. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview# enhanced-transactions#optional-enhancement-query-parameter).

Sends a GET request to /users/{user_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.
• includes: Options for enhanced transactions. This query parameter is optional. Possible additional metadata: repeating_transactions, merchants, classifications, geolocations. The query value is format sensitive. To retrieve all available enhancements, append:

?includes=repeating_transactions,merchants,classifications, geolocations.

The query options may be combined to specific enhancements. For example, to request Repeating Transactions and Geolocation data, use:

?includes=repeating_transactions,geolocations.

• Repeating Transactions: Identifies transactions with predictable recurrence patterns (e.g., Bill, Income, Subscription).
• Merchants: Enriches transactions with merchant name.
• Classifications: Provides more insight into the type of money movement that is occurring on the transaction, whether it be retail or investments.
• Geolocation: Provides geographic metadata.

pub async fn update_transaction<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, body: &'a TransactionUpdateRequestBody, ) -> Result<ResponseValue<TransactionResponseBody>, Error<()>>

Update transaction

Use this endpoint to update a specific transaction according to its unique GUID.

Sends a PUT request to /users/{user_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.
• body: Transaction object with the fields to be updated.

pub async fn delete_manual_transactions<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete manual transactions

Delete a manual transaction. In the path, use the manual transaction guid as the transaction_guid, such as MAN-810828b0-5210-4878-9bd3-f4ce514f90c4.

Sends a DELETE request to /users/{user_guid}/transactions/{transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.

pub async fn request_widget_url<'a>( &'a self, user_guid: &'a str, accept_language: Option<&'a str>, x_callback_payload: Option<&'a str>, body: &'a WidgetRequestBody, ) -> Result<ResponseValue<WidgetResponseBody>, Error<()>>

Request widget URL

Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You’ll need to obtain a new URL each time the page loads or reloads.

Include the widget_type in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types.

To embed the Connect Widget, set widget_type to connect_widget.

For a full list of available widget types, see Widget Types.

Sends a POST request to /users/{user_guid}/widget_urls

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• accept_language: The desired language of the widget.
• x_callback_payload: 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.
• body: The widget url configuration options.

pub async fn auto_generate_budgets<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<BudgetResponseBody>, Error<()>>

Auto-generate budgets

This endpoint will automatically create budgets for several categories based on existing transactions; these budgets are returned as an array. Specifically, budgets will only be generated if the user has at least one transaction in a given category during each of the two previous calendar months. For example, if the request is made on March 6, and there is at least one “Bills & Utilities” transaction in both January and February, a budget will be generated for “Bills & Utilities.” If there are two “Bills & Utilities” transactions in February but none in January, no budget will be generated for that category. If budgets already exist for particular categories, new budgets will be generated and returned based on the available transactions. If one or more budgets remain unchanged, they will nevertheless be returned in the response. If no transaction data for the user meet the above criteria, a 422 Unprocessable Entity error will be returned with status code 4221 along with the message, There aren't enough transactions to automatically create any budgets.

Sends a POST request to /users/{user_guid}/budgets/generate

Arguments:

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

pub async fn list_all_budgets<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<BudgetResponseBody>, Error<()>>

List all budgets

List all budgets

Sends a GET request to /users/{user_guid}/budgets

Arguments:

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

pub async fn create_budget<'a>( &'a self, user_guid: &'a str, body: &'a BudgetCreateRequestBody, ) -> Result<ResponseValue<BudgetResponseBody>, Error<()>>

Create a budget

Create a budget. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for “Gas”, but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint.

Sends a POST request to /users/{user_guid}/budgets

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body

pub async fn read_specific_budget<'a>( &'a self, user_guid: &'a str, budget_guid: &'a str, ) -> Result<ResponseValue<BudgetResponseBody>, Error<()>>

Read a specific budget

Read a specific budget.

Sends a GET request to /users/{user_guid}/budgets/{budget_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• budget_guid: The unique identifier for the budget. Defined by MX.

pub async fn update_specific_budget<'a>( &'a self, user_guid: &'a str, budget_guid: &'a str, body: &'a BudgetUpdateRequestBody, ) -> Result<ResponseValue<BudgetResponseBody>, Error<()>>

Update a specific budget

Update a specific budget.

Sends a PUT request to /users/{user_guid}/budgets/{budget_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• budget_guid: The unique identifier for the budget. Defined by MX.
• body

pub async fn delete_budget<'a>( &'a self, user_guid: &'a str, budget_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete a budget

Delete a budget.

Sends a DELETE request to /users/{user_guid}/budgets/{budget_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• budget_guid: The unique identifier for the budget. Defined by MX.

pub async fn list_goals<'a>( &'a self, user_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, accept: &'a str, ) -> Result<ResponseValue<GoalsResponseBody>, Error<()>>

List goals

List all goals a user can set.

Sends a GET request to /users/{user_guid}/goals

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
• accept: Specifies the media type expected in the response.

pub async fn create_goal<'a>( &'a self, user_guid: &'a str, body: &'a GoalRequestBody, ) -> Result<ResponseValue<GoalResponseBody>, Error<()>>

Create a goal

Create a goal. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.

Sends a POST request to /users/{user_guid}/goals

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body

pub async fn read_goal<'a>( &'a self, user_guid: &'a str, goal_guid: &'a str, ) -> Result<ResponseValue<GoalResponseBody>, Error<()>>

Read a goal

Read a specific goal.

Sends a GET request to /users/{user_guid}/goals/{goal_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• goal_guid: The unique identifier for a goal. Defined by MX.

pub async fn update_goal<'a>( &'a self, user_guid: &'a str, goal_guid: &'a str, body: &'a UpdateGoalRequestBody, ) -> Result<ResponseValue<GoalResponseBody>, Error<()>>

Update a goal

This endpoint updates a specific goal.

Sends a PUT request to /users/{user_guid}/goals/{goal_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• goal_guid: The unique identifier for a goal. Defined by MX.
• body

pub async fn delete_goal<'a>( &'a self, user_guid: &'a str, goal_guid: &'a str, accept: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete a goal

Delete a goal.

Sends a DELETE request to /users/{user_guid}/goals/{goal_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• goal_guid: The unique identifier for a goal. Defined by MX.
• accept: Specifies the media type expected in the response.

pub async fn reposition_goals<'a>( &'a self, user_guid: &'a str, body: &'a RepositionRequestBody, ) -> Result<ResponseValue<RepositionResponseBody>, Error<()>>

Reposition goals

This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly.

Sends a PUT request to /users/{user_guid}/goals/reposition

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body

pub async fn list_notifications<'a>( &'a self, user_guid: &'a str, from_date: Option<&'a str>, page: Option<i64>, records_per_page: Option<i64>, to_date: Option<&'a str>, ) -> Result<ResponseValue<NotificationsResponseBody>, Error<()>>

List notifications

All notifications for the user can be listed, including notifications created by MX for other channels besides PUSH.

Sends a GET request to /users/{user_guid}/notifications

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• from_date: Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.
• to_date: Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.

pub async fn create_notification<'a>( &'a self, user_guid: &'a str, content: &'a str, subject: &'a str, ) -> Result<ResponseValue<NotificationResponseBody>, Error<()>>

Create a notification

All notifications created through the API will be of notification type API_NOTIFICATION, channel PUSH, and will not be associated to an entity. No other channels are supported. This will only have an effect for clients using an MX mobile application.

Sends a POST request to /users/{user_guid}/notifications

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• content: The information related to the notification.
• subject: The subject related to the notification.

pub async fn read_notifications<'a>( &'a self, user_guid: &'a str, notification_guid: &'a str, ) -> Result<ResponseValue<NotificationResponseBody>, Error<()>>

Read notifications

Can pull up any notification associated with the user, including notifications created by MX for other channels besides PUSH.

Sends a GET request to /users/{user_guid}/notifications/{notification_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• notification_guid: The unique identifier for notifications. Defined by MX.

pub async fn repeating_transactions<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<RepeatingTransactionsResponseBody>, Error<()>>

List Repeating Transactions

Retrieve a list of all recurring transactions for a user.

For more see the Repeating Transactions guide.

Sends a GET request to /users/{user_guid}/repeating_transactions

Arguments:

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

pub async fn specific_repeating_transaction<'a>( &'a self, user_guid: &'a str, repeating_transaction_guid: &'a str, ) -> Result<ResponseValue<RepeatingTransactionsResponseBody>, Error<()>>

Get a Repeating Transaction

Get a Specific Repeating Transaction.

List For more see the Repeating Transactions guide

Sends a GET request to /users/{user_guid}/repeating_transactions/{repeating_transaction_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• repeating_transaction_guid: The unique id for a recurring transaction.

pub async fn list_insights_by_transaction<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, page: Option<i64>, records_per_page: Option<i64>, ) -> Result<ResponseValue<InsightsResponseBody>, Error<()>>

List insights by transaction

Use this endpoint to list all insights associated with a transaction GUID.

Sends a GET request to /users/{user_guid}/transactions/{transaction_guid}/insights

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.
• page: Results are paginated. Specify current page.
• records_per_page: This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 100. If the value exceeds 100, the default value of 25 will be used instead.

pub async fn create_split_transactions<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, body: &'a SplitTransactionRequestBody, ) -> Result<ResponseValue<SplitTransactionsResponseBody>, Error<()>>

Create split transactions

This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction’s has_been_split field will automatically be updated to true and the child transactions’ parent_guid will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can’t be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction’s has_been_split field to false. You can then re-split the parent transaction by calling Create Split Transaction again.

Sends a POST request to /users/{user_guid}/transactions/{transaction_guid}/split

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.
• body

pub async fn delete_split_transactions<'a>( &'a self, user_guid: &'a str, transaction_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete split transactions

This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction’s has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.

Sends a DELETE request to /users/{user_guid}/transactions/{transaction_guid}/split

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• transaction_guid: The unique id for a transaction.

pub async fn read_monthly_cash_flow_profile<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<MonthlyCashFlowResponseBody>, Error<()>>

Read monthly cash flow profile

Read monthly cash flow profile.

Sends a GET request to /users/{user_guid}/monthly_cash_flow_profile

Arguments:

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

pub async fn update_monthly_cash_flow_profile<'a>( &'a self, user_guid: &'a str, body: &'a MonthlyCashFlowProfileRequestBody, ) -> Result<ResponseValue<MonthlyCashFlowResponseBody>, Error<()>>

Update monthly cash flow profile

Use this endpoint to update the attributes of a monthly_cash_flow_profile.

Sends a PUT request to /users/{user_guid}/monthly_cash_flow_profile

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body

pub async fn list_tokens<'a>( &'a self, body: &'a TokenRequestBody, ) -> Result<ResponseValue<TokenResponseBody>, Error<()>>

View a List of Tokens

View a list of tokens that exist for a user, member, or account.

Sends a GET request to /tokens

pub async fn request_account_number<'a>( &'a self, ) -> Result<ResponseValue<ProcessorAccountNumberBody>, Error<()>>

Request an account number (Processors Only)

Get account information such as routing number and account number, scoped to your access token.

Sends a GET request to /account/account_numbers

pub async fn check_real_time_account_balance<'a>( &'a self, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Check Real Time Account Balance (Processors Only)

Check the real-time account balance using your access token.

Sends a POST request to /account/check_balance

pub async fn read_account_balance<'a>( &'a self, ) -> Result<ResponseValue<PaymentAccountBody>, Error<()>>

Read the account balance (Processors Only)

Read the account balance (Processors Only)

Sends a GET request to /payment_account

pub async fn get_account_owner_info<'a>( &'a self, ) -> Result<ResponseValue<ProcessorOwnerBody>, Error<()>>

Get account owner information (Processors Only)

Get account owner information (Processors Only)

Sends a GET request to /account/transactions

pub async fn list_user_microdeposits<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<MicrodepositsResponseBody>, Error<()>>

List all microdeposits for a user

Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

Sends a GET request to /users/{user_guid}/micro_deposits

Arguments:

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

pub async fn create_microdeposit<'a>( &'a self, user_guid: &'a str, body: &'a MicrodepositRequestBody, ) -> Result<ResponseValue<MicrodepositResponseBody>, Error<()>>

Create or pre-initiate a microdeposit

Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of INITIATED or PREINITIATED respectively.

To pre-initiate a microdeposit, you only need to set email (string), first_name (string), and last_name (string) in the request body.

Pre-initiating a microdeposit allows you to pass the end user’s first name, last name, and email if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated micro_deposit will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated micro_deposit will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-initiating, make sure to set the current_microdeposit_guid to the resulting microdeposit’s guid and set the mode to verification. If you use this enhanced flow, a micro_deposit should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as current_microdeposit_guid and set the mode to verification when requesting a Connect URL. Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.

Sends a POST request to /users/{user_guid}/micro_deposits

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• body

pub async fn read_user_microdeposit<'a>( &'a self, user_guid: &'a str, micro_deposit_guid: &'a str, ) -> Result<ResponseValue<MicrodepositResponseBody>, Error<()>>

Read a microdeposit for a user

Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.

Sends a GET request to /users/{user_guid}/micro_deposits/{micro_deposit_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• micro_deposit_guid: The unique identifier for the microdeposit. Defined by MX.

pub async fn delete_microdeposit<'a>( &'a self, user_guid: &'a str, micro_deposit_guid: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Delete a microdeposit

Use this endpoint to delete the specified microdeposit.

Sends a DELETE request to /users/{user_guid}/micro_deposits/{micro_deposit_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• micro_deposit_guid: The unique identifier for the microdeposit. Defined by MX.

pub async fn verify_microdeposit<'a>( &'a self, micro_deposit_guid: &'a str, body: &'a MicrodepositVerifyRequestBody, ) -> Result<ResponseValue<MicrodepositResponseBody>, Error<()>>

Verify a Microdeposit

Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the status is VERIFIED. Poll the /users/{user_guid}/micro_deposits/{micro_deposit_guid} (read microdeposit) endpoint until you see this status or an error state.

Sends a PUT request to /micro_deposits/{micro_deposit_guid}/verify

Arguments:

• micro_deposit_guid: The unique identifier for the microdeposit. Defined by MX.
• body

pub async fn list_user_verifications<'a>( &'a self, user_guid: &'a str, ) -> Result<ResponseValue<MicrodepositResponseBody>, Error<()>>

List all verifications for a user

This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications.

Sends a GET request to /users/{user_guid}/account_verifications

Arguments:

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

pub async fn fetch_rewards<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<MemberResponseBody>, Error<()>>

Fetch Rewards

Calling this endpoint initiates an aggregation-type event which will gather the member’s rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations. Member and Rewards guids are defined by MX.

Sends a POST request to /users/{user_guid}/members/{member_guid}/fetch_rewards

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn list_rewards<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<RewardsResponseBody>, Error<()>>

List Rewards

Use this endpoint to list all the rewards associated with a specified member. Member guids are defined by MX.

Sends a GET request to /users/{user_guid}/members/{member_guid}/rewards

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn read_rewards<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, reward_guid: &'a str, ) -> Result<ResponseValue<RewardResponseBody>, Error<()>>

Read Reward

Use this endpoint to read a specific reward based on its unique GUID. Member and Rewards guids are defined by MX.

Sends a GET request to /users/{user_guid}/members/{member_guid}/rewards/{reward_guid}

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.
• reward_guid: The unique identifier for the rewards. Defined by MX.

pub async fn credit_card<'a>( &'a self, credit_card_product_guid: &'a str, ) -> Result<ResponseValue<CreditCardProductResponse>, Error<()>>

Read a Credit Card Product

This endpoint returns the specified credit_card_product according to the unique GUID.

Sends a GET request to /credit_card_products/{credit_card_product_guid}

Arguments:

• credit_card_product_guid: The required credit_card_product_guid can be found on the account object.

pub async fn get_identity_data<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<ByteStream>, Error<()>>

Get Identity Data

Get an MX-issued verifiable credential of a user’s identity data.

Sends a GET request to /vc/users/{user_guid}/members/{member_guid}/customers

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn get_accounts_data<'a>( &'a self, user_guid: &'a str, member_guid: &'a str, ) -> Result<ResponseValue<ByteStream>, Error<()>>

Get Accounts Data

Get an MX-issued verifiable credential of a user’s accounts data.

Sends a GET request to /vc/users/{user_guid}/members/{member_guid}/accounts

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• member_guid: The unique id for a member.

pub async fn get_transactions_data<'a>( &'a self, user_guid: &'a str, account_guid: &'a str, end_time: Option<&'a str>, start_time: Option<&'a str>, ) -> Result<ResponseValue<ByteStream>, Error<()>>

Get Transactions Data

Get an MX-issued verifiable credential of a user’s transaction data.

Sends a GET request to /vc/users/{user_guid}/accounts/{account_guid}/transactions

Arguments:

• user_guid: The unique identifier for a user, beginning with the prefix USR-.
• account_guid: The unique id for an account.
• end_time: Filter transactions to this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.
• start_time: Filter transactions from this date. Must be in the format YYYY-MM-DD. The range is limited to 1 year.

Trait Implementations

impl ClientHooks for &Client

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this:

impl ClientInfo<()> for Client

fn api_version() -> &'static str

Get the version of this API.

fn baseurl(&self) -> &str

Get the base URL to which requests are made.

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.

fn inner(&self) -> &()

Get the inner value of type T if one is specified.

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.