You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/AccountsApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -519,7 +519,7 @@ Name | Type | Description | Notes
519
519
520
520
List accounts
521
521
522
-
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](https://docs.mx.com/api-reference/platform-api/reference/list-account-numbers-by-member/), [List account numbers by account](https://docs.mx.com/api-reference/platform-api/reference/list-account-numbers-by-account/), or the [Fetch Account and Routing Numbers](https://docs.mx.com/products/connectivity/instant-account-verification/fetch-account-routing-number-api/#4-read-the-account-numbers) guide. :::
522
+
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](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
Copy file name to clipboardExpand all lines: docs/InstitutionResponse.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
**code** | **str** | | [optional]
8
8
**forgot_password_url** | **str** | | [optional]
9
9
**forgot_username_url** | **str** | | [optional]
10
-
**instructional_text** | **str** | | [optional]
10
+
**instructional_text** | **str** | Render this text when end users are asked for their credentials, as it helps end users provide the correct credentials when creating a new member. May contain `<a></a>` tags to link to explanatory material. | [optional]
11
11
**instructional_text_steps** | **List[str]** | An array of instructional steps that may contain html elements. | [optional]
iso_country_code = ['[\"US\",\"CA\"]'] # List[str] | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
53
53
page =1# int | Results are paginated. Specify current page. (optional)
54
-
records_per_page =10# int | 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. (optional)
54
+
records_per_page =10# int | 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. (optional)
55
55
56
56
try:
57
57
# List favorite institutions
@@ -70,7 +70,7 @@ Name | Type | Description | Notes
**iso_country_code** | [**List[str]**](str.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional]
72
72
**page** | **int**| Results are paginated. Specify current page. | [optional]
73
-
**records_per_page** | **int**| 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. | [optional]
73
+
**records_per_page** | **int**| 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. | [optional]
74
74
75
75
### Return type
76
76
@@ -216,7 +216,7 @@ with mx_platform_python.ApiClient(configuration) as api_client:
216
216
name ='mxbank'# str | This will list only institutions in which the appended string appears. (optional)
217
217
iso_country_code = ['[\"US\",\"CA\"]'] # List[str] | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
218
218
page =1# int | Results are paginated. Specify current page. (optional)
219
-
records_per_page =10# int | 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. (optional)
219
+
records_per_page =10# int | 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. (optional)
220
220
supports_account_identification = true # bool | Filter only institutions which support account identification. (optional)
221
221
supports_account_statement = true # bool | Filter only institutions which support account statements. (optional)
222
222
supports_account_verification = true # bool | Filter only institutions which support account verification. (optional)
@@ -240,7 +240,7 @@ Name | Type | Description | Notes
240
240
**name** | **str**| This will list only institutions in which the appended string appears. | [optional]
241
241
**iso_country_code** | [**List[str]**](str.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional]
242
242
**page** | **int**| Results are paginated. Specify current page. | [optional]
243
-
**records_per_page** | **int**| 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. | [optional]
243
+
**records_per_page** | **int**| 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. | [optional]
244
244
**supports_account_identification** | **bool**| Filter only institutions which support account identification. | [optional]
245
245
**supports_account_statement** | **bool**| Filter only institutions which support account statements. | [optional]
246
246
**supports_account_verification** | **bool**| Filter only institutions which support account verification. | [optional]
Copy file name to clipboardExpand all lines: docs/MicrodepositsApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -331,7 +331,7 @@ Name | Type | Description | Notes
331
331
332
332
Read a microdeposit for a user
333
333
334
-
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br /><br /> 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.
334
+
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> 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.
Copy file name to clipboardExpand all lines: docs/TransactionsApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -689,7 +689,7 @@ Name | Type | Description | Notes
689
689
690
690
List transactions by account
691
691
692
-
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />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).
692
+
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />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).
693
693
694
694
### Example
695
695
@@ -1009,7 +1009,7 @@ Name | Type | Description | Notes
1009
1009
1010
1010
Read transaction
1011
1011
1012
-
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`. <br /><br />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).
1012
+
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`. <br /><br />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).
1013
1013
1014
1014
### Example
1015
1015
@@ -1091,7 +1091,7 @@ Name | Type | Description | Notes
1091
1091
1092
1092
List Repeating Transactions
1093
1093
1094
-
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
1094
+
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
1095
1095
1096
1096
### Example
1097
1097
@@ -1169,7 +1169,7 @@ Name | Type | Description | Notes
1169
1169
1170
1170
Get a Repeating Transaction
1171
1171
1172
-
Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
1172
+
Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
Copy file name to clipboardExpand all lines: docs/UsersApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,7 +95,7 @@ Name | Type | Description | Notes
95
95
96
96
Delete user
97
97
98
-
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](https://docs.mx.com/api-reference/platform-api/overview/deleting-objects). :::
98
+
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](/api-reference/platform-api/overview/deleting-objects). :::
Copy file name to clipboardExpand all lines: docs/WidgetRequest.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
11
11
**current_institution_guid** | **str** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional]
12
12
**current_member_guid** | **str** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state. `current_member_guid` takes precedence over `current_institution_code` and `current_institution_guid`. | [optional]
13
13
**disable_background_agg** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX. | [optional]
14
-
**disable_institution_search** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. | [optional]
14
+
**disable_institution_search** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. If you set `disable_institution_search` to `true`, you must also listen for the [backToSearch event](/connect/guides/handling-events/#back-to-search) to intercept the user from navigating back to search during the flow. Don't listen for any Primary Action postMessages when you disable search. All buttons that will take a user to the search institution page are still displayed in the Connect Widget experience and your user can still select them. This may trigger during several steps in the Connect Widget flow, such as Connected, MDV/Microdeposits Verified, Login Error, and Credentials/OAuth (back button). | [optional]
15
15
**enable_app2app** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional]
16
16
**include_identity** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the `mode`. Defaults to `false`. This can be set in either `aggregation` or `verification` mode. The AOI runs after the primary process is complete. | [optional]
17
17
**include_transactions** | **bool** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether transaction data are retrieved. Defaults to `true` in aggregation mode and `false` in verification mode. This can be set in either `aggregation` or `verification` mode. This option does not affect future foreground or background aggregations. | [optional]
0 commit comments