diff --git a/openapi/v20250224.yml b/openapi/v20250224.yml index fb8a0ea..3485073 100644 --- a/openapi/v20250224.yml +++ b/openapi/v20250224.yml @@ -464,7 +464,7 @@ paths: - merchants /transactions/enhance: post: - description: "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 guide](https://docs.mx.com/api-reference/platform-api/reference/transactions-overview#enhanced-transactions)." + description: 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 guide](https://docs.mx.com/api-reference/platform-api/reference/transactions-overview#enhanced-transactions). operationId: enhanceTransactions parameters: - $ref: '#/components/parameters/acceptVersion' @@ -610,6 +610,10 @@ paths: schema: $ref: '#/components/schemas/AccountsResponseBody' description: OK + headers: + acceptVersion: + schema: + $ref: '#/components/schemas/acceptVersion' summary: List accounts tags: - accounts @@ -769,7 +773,10 @@ paths: schema: $ref: '#/components/schemas/TransactionCreateResponseBody' get: - description: "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." + description: | + 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. operationId: listTransactionsByAccount parameters: - $ref: '#/components/parameters/acceptVersion' @@ -796,7 +803,10 @@ paths: - transactions /users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions: get: - description: "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." + description: | + 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. operationId: listTransactionsByAccountPerMember parameters: - $ref: '#/components/parameters/acceptVersion' @@ -2050,7 +2060,7 @@ paths: - members /users/{user_identifier}/members/{member_identifier}/transactions: get: - description: "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." + description: 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. operationId: listTransactionsByMember parameters: - $ref: '#/components/parameters/acceptVersion' @@ -2581,7 +2591,7 @@ paths: - tags /users/{user_identifier}/tags/{tag_guid}/transactions: get: - description: "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." + description: 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. operationId: listTransactionsByTag parameters: - $ref: '#/components/parameters/acceptVersion' @@ -2711,7 +2721,7 @@ paths: - transaction rules /users/{user_identifier}/transactions: get: - description: "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." + description: 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. operationId: listTransactions parameters: - $ref: '#/components/parameters/acceptVersion' @@ -2742,7 +2752,7 @@ paths: - $ref: '#/components/parameters/userGuid' - $ref: '#/components/parameters/transactionGuid' get: - description: "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." + description: 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. operationId: readTransaction responses: '200': @@ -2798,7 +2808,7 @@ paths: - $ref: '#/components/parameters/accountIdentifier' - $ref: '#/components/parameters/transactionIdentifier' get: - description: "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." + description: 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. operationId: readTransactionByAccount responses: '200': @@ -3117,7 +3127,6 @@ paths: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/recordsPerPageMax1000' - $ref: '#/components/parameters/acceptVersion' - - $ref: '#/components/parameters/userGuid' responses: '200': description: OK @@ -3146,7 +3155,7 @@ paths: $ref: '#/components/schemas/NotificationResponseBody' /users/{user_guid}/repeating_transactions: get: - description: "Retrieve a list of all recurring transactions for a user.

For more see the [Repeating Transactions guide](https://docs.mx.com/api-reference/platform-api/reference/repeating-transactions-overview)." + description: Retrieve a list of all recurring transactions for a user.

For more see the [Repeating Transactions guide](https://docs.mx.com/api-reference/platform-api/reference/repeating-transactions-overview). operationId: repeatingTransactions parameters: - $ref: '#/components/parameters/acceptVersion' @@ -3163,7 +3172,7 @@ paths: - transactions /users/{user_guid}/repeating_transactions/{repeating_transaction_guid}: get: - description: "Get a Specific Repeating Transaction.

List For more see the [Repeating Transactions guide](https://docs.mx.com/api-reference/platform-api/reference/repeating-transactions-overview)" + description: Get a Specific Repeating Transaction.

List For more see the [Repeating Transactions guide](https://docs.mx.com/api-reference/platform-api/reference/repeating-transactions-overview) operationId: specificRepeatingTransaction parameters: - $ref: '#/components/parameters/acceptVersion' @@ -3459,7 +3468,8 @@ paths: - microdeposits operationId: readUserMicrodeposit summary: Read a microdeposit for a user - description: "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." + description: | + 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. responses: '200': description: OK @@ -3872,7 +3882,7 @@ components: in: query name: use_case schema: - type: string + type: array accountGuid: description: The unique id for an `account`. example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 @@ -4616,7 +4626,9 @@ components: type: string instructional_text: description: 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 `` tags to link to explanatory material. - example: "Some instructional text for end users." + example: | + Some instructional text for end users. nullable: true type: string instructional_text_steps: @@ -5126,6 +5138,15 @@ components: user: $ref: '#/components/schemas/UserUpdateRequest' type: object + acceptVersion: + name: Accept-Version + in: header + required: true + schema: + type: string + default: v20250224 + example: v20250224 + description: MX Platform API version. AccountResponse: properties: account_number: @@ -8728,8 +8749,6 @@ components: - US - CA type: array - items: - type: string description: | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). is_mobile_webview: