diff --git a/openapi/mx_platform_api.yml b/openapi/mx_platform_api.yml index 78aa831..15a1c2a 100644 --- a/openapi/mx_platform_api.yml +++ b/openapi/mx_platform_api.yml @@ -339,7 +339,7 @@ paths: - processor token /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 fields guide](/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 fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions)." operationId: enhanceTransactions requestBody: content: @@ -593,10 +593,7 @@ 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter). + 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)." operationId: listTransactionsByAccount parameters: - $ref: '#/components/parameters/accountGuid' @@ -1767,7 +1764,7 @@ paths: - members /users/{user_guid}/members/{member_guid}/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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter). + 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)." operationId: listTransactionsByMember parameters: - $ref: '#/components/parameters/memberGuid' @@ -2273,7 +2270,7 @@ paths: - tags /users/{user_guid}/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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter). + 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)." operationId: listTransactionsByTag parameters: - $ref: '#/components/parameters/userGuid' @@ -2396,7 +2393,7 @@ paths: - transaction rules /users/{user_guid}/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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter). + 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)." operationId: listTransactions parameters: - $ref: '#/components/parameters/userGuid' @@ -2429,7 +2426,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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter). + 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](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)." operationId: readTransaction responses: '200': @@ -2766,7 +2763,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](repeating-transactions-overview.mdx). + description: "Retrieve a list of all recurring transactions for a user.

For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)." operationId: repeatingTransactions parameters: - $ref: '#/components/parameters/userGuid' @@ -2782,7 +2779,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](repeating-transactions-overview.mdx) + description: "Get a Specific Repeating Transaction.

List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)" operationId: specificRepeatingTransaction parameters: - $ref: '#/components/parameters/userGuid' @@ -3026,8 +3023,7 @@ 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 @@ -3523,9 +3519,7 @@ components: nullable: true type: string instructional_text: - example: | - Some instructional text for end users. + example: "Some instructional text for end users." nullable: true type: string instructional_text_steps: