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: api/openapi.yaml
+28-25Lines changed: 28 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -316,8 +316,8 @@ paths:
316
316
type: integer
317
317
style: form
318
318
- description: "This specifies the number of records to be returned on each\
319
-
\ page. Defaults to `25`. The valid range is from `10` to `100`. If the\
320
-
\ value exceeds `100`, the default value of `25` will be used instead."
319
+
\ page. Defaults to `25`. The valid range is from `10` to `1000`. If the\
320
+
\ value exceeds `1000`, the default value of `25` will be used instead."
321
321
example: 10
322
322
explode: true
323
323
in: query
@@ -404,8 +404,8 @@ paths:
404
404
type: integer
405
405
style: form
406
406
- description: "This specifies the number of records to be returned on each\
407
-
\ page. Defaults to `25`. The valid range is from `10` to `100`. If the\
408
-
\ value exceeds `100`, the default value of `25` will be used instead."
407
+
\ page. Defaults to `25`. The valid range is from `10` to `1000`. If the\
408
+
\ value exceeds `1000`, the default value of `25` will be used instead."
409
409
example: 10
410
410
explode: true
411
411
in: query
@@ -773,7 +773,7 @@ paths:
773
773
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
774
774
775
775
:::warning
776
-
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).
776
+
Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects).
777
777
:::
778
778
operationId: deleteUser
779
779
parameters:
@@ -864,7 +864,7 @@ paths:
864
864
This endpoint returns a list of all the accounts associated with the specified `user`.
865
865
866
866
:::warning
867
-
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.
867
+
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/).
description: "Requests to this endpoint return a list of transactions associated\
1160
-
\ with the specified account. <br /><br />Enhanced transaction data may be\
1160
+
\ with the specified account. <br /><br />Enhanced transaction data may be\
1161
1161
\ requested using the `includes` parameter. To use this optional parameter,\
1162
1162
\ the value should include the optional metadata requested such as `repeating_transactions`,\
1163
1163
\ `merchants`, `classifications`, `geolocations`. For more information, see\
@@ -6156,7 +6156,7 @@ paths:
6156
6156
get:
6157
6157
description: "Requests to this endpoint will return the attributes of the specified\
6158
6158
\ `transaction`. To read a manual transaction, use the manual transaction\
6159
-
\ guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction\
6159
+
\ guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction\
6160
6160
\ data may be requested using the `includes` parameter. To use this optional\
6161
6161
\ parameter, the value should include the optional metadata requested such\
6162
6162
\ as `repeating_transactions`, `merchants`, `classifications`, `geolocations`.\
@@ -6882,7 +6882,7 @@ paths:
6882
6882
/users/{user_guid}/repeating_transactions:
6883
6883
get:
6884
6884
description: "Retrieve a list of all recurring transactions for a user. <br\
6885
-
\ /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)."
6885
+
\ /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)."
6886
6886
operationId: repeatingTransactions
6887
6887
parameters:
6888
6888
- description: "The unique identifier for a `user`, beginning with the prefix\
description: "Get a Specific Repeating Transaction. <br /><br />List For more\
6911
-
\ see the [Repeating Transactions guide](repeating-transactions-overview.mdx)"
6911
+
\ see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)"
6912
6912
operationId: specificRepeatingTransaction
6913
6913
parameters:
6914
6914
- description: "The unique identifier for a `user`, beginning with the prefix\
@@ -7313,8 +7313,8 @@ paths:
7313
7313
- microdeposits
7314
7314
get:
7315
7315
description: Use this endpoint to read the attributes of a specific microdeposit
7316
-
according to its unique GUID. <br /><br /> Webhooks for microdeposit status
7317
-
changes are triggered when a status changes. The actual status of the microdeposit
7316
+
according to its unique GUID. <br></br> Webhooks for microdeposit status changes
7317
+
are triggered when a status changes. The actual status of the microdeposit
7318
7318
guid updates every minute. You may force a status update by calling the read
7319
7319
microdeposit endpoint.
7320
7320
operationId: readUserMicrodeposit
@@ -7794,6 +7794,18 @@ components:
7794
7794
type: string
7795
7795
type: array
7796
7796
style: form
7797
+
recordsPerPageMax1000:
7798
+
description: "This specifies the number of records to be returned on each page.\
7799
+
\ Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds\
7800
+
\ `1000`, the default value of `25` will be used instead."
7801
+
example: 10
7802
+
explode: true
7803
+
in: query
7804
+
name: records_per_page
7805
+
required: false
7806
+
schema:
7807
+
type: integer
7808
+
style: form
7797
7809
supportsAccountIdentification:
7798
7810
description: Filter only institutions which support account identification.
7799
7811
example: true
@@ -7844,18 +7856,6 @@ components:
7844
7856
schema:
7845
7857
type: string
7846
7858
style: simple
7847
-
recordsPerPageMax1000:
7848
-
description: "This specifies the number of records to be returned on each page.\
7849
-
\ Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds\
7850
-
\ `1000`, the default value of `25` will be used instead."
7851
-
example: 10
7852
-
explode: true
7853
-
in: query
7854
-
name: records_per_page
7855
-
required: false
7856
-
schema:
7857
-
type: integer
7858
-
style: form
7859
7859
merchantLocationGuid:
7860
7860
description: The unique id for a `merchant_location`.
7861
7861
example: MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621
@@ -8838,6 +8838,9 @@ components:
8838
8838
nullable: true
8839
8839
type: string
8840
8840
instructional_text:
8841
+
description: "Render this text when end users are asked for their credentials,\
8842
+
\ as it helps end users provide the correct credentials when creating\
8843
+
\ a new member. May contain `<a></a>` tags to link to explanatory material."
8841
8844
example: Some instructional text <a href="https://example.url.mxbank.com/instructions"
8842
8845
id="instructional_text">for end users</a>.
8843
8846
nullable: true
@@ -13018,7 +13021,7 @@ components:
13018
13021
type: boolean
13019
13022
disable_institution_search:
13020
13023
description: |
13021
-
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`.
13024
+
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).
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
@@ -619,7 +619,7 @@ catch (ApiException e)
619
619
620
620
List accounts
621
621
622
-
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. :::
622
+
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** | **string** | | [optional]
8
8
**ForgotPasswordUrl** | **string** | | [optional]
9
9
**ForgotUsernameUrl** | **string** | | [optional]
10
-
**InstructionalText** | **string** | | [optional]
10
+
**InstructionalText** | **string** | 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
**InstructionalTextSteps** | **List<string>** | An array of instructional steps that may contain html elements. | [optional]
Copy file name to clipboardExpand all lines: docs/InstitutionsApi.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
@@ -40,7 +40,7 @@ namespace Example
40
40
varapiInstance=newInstitutionsApi(config);
41
41
varisoCountryCode=newList<string>?(); // List<string>? | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
42
42
varpage=1; // int? | Results are paginated. Specify current page. (optional)
43
-
varrecordsPerPage=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)
43
+
varrecordsPerPage=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)
44
44
45
45
try
46
46
{
@@ -85,7 +85,7 @@ catch (ApiException e)
85
85
|------|------|-------------|-------|
86
86
|**isoCountryCode**|[**List<string>?**](string.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]|
87
87
|**page**|**int?**| Results are paginated. Specify current page. |[optional]|
88
-
|**recordsPerPage**|**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]|
88
+
|**recordsPerPage**|**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]|
89
89
90
90
### Return type
91
91
@@ -239,7 +239,7 @@ namespace Example
239
239
varname=mxbank; // string? | This will list only institutions in which the appended string appears. (optional)
240
240
varisoCountryCode=newList<string>?(); // List<string>? | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
241
241
varpage=1; // int? | Results are paginated. Specify current page. (optional)
242
-
varrecordsPerPage=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)
242
+
varrecordsPerPage=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)
243
243
varsupportsAccountIdentification=true; // bool? | Filter only institutions which support account identification. (optional)
244
244
varsupportsAccountStatement=true; // bool? | Filter only institutions which support account statements. (optional)
245
245
varsupportsAccountVerification=true; // bool? | Filter only institutions which support account verification. (optional)
@@ -289,7 +289,7 @@ catch (ApiException e)
289
289
|**name**|**string?**| This will list only institutions in which the appended string appears. |[optional]|
290
290
|**isoCountryCode**|[**List<string>?**](string.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]|
291
291
|**page**|**int?**| Results are paginated. Specify current page. |[optional]|
292
-
|**recordsPerPage**|**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]|
292
+
|**recordsPerPage**|**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]|
293
293
|**supportsAccountIdentification**|**bool?**| Filter only institutions which support account identification. |[optional]|
294
294
|**supportsAccountStatement**|**bool?**| Filter only institutions which support account statements. |[optional]|
295
295
|**supportsAccountVerification**|**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
@@ -397,7 +397,7 @@ catch (ApiException e)
397
397
398
398
Read a microdeposit for a user
399
399
400
-
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.
400
+
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.
0 commit comments