From 54baa99fbf2bf670addff77f08f755d42379703a Mon Sep 17 00:00:00 2001 From: Tommy Valletta Date: Fri, 18 Jul 2025 07:11:39 -0600 Subject: [PATCH] update EnhanceTransactionResponse properties with top_level_category_guid and user_guid --- openapi/mx_platform_api.yml | 646 ++++++++++++++++++------------------ 1 file changed, 330 insertions(+), 316 deletions(-) diff --git a/openapi/mx_platform_api.yml b/openapi/mx_platform_api.yml index b7260d9..b384c7b 100644 --- a/openapi/mx_platform_api.yml +++ b/openapi/mx_platform_api.yml @@ -567,7 +567,7 @@ components: minimum_payment_set_by: example: 1 nullable: true - type: integer + type: integer name: example: "Test account 2" nullable: true @@ -575,7 +575,7 @@ components: name_set_by: example: 1 nullable: true - type: integer + type: integer nickname: example: "My Checking" nullable: true @@ -583,7 +583,7 @@ components: nickname_set_by: example: 1 nullable: true - type: integer + type: integer original_balance: example: 10.0 nullable: true @@ -667,7 +667,7 @@ components: total_account_value_ugl: example: 1.0 nullable: true - type: number + type: number type: example: "SAVINGS" nullable: true @@ -685,7 +685,7 @@ components: nullable: true type: string user_id: - example: 'user123' + example: "user123" nullable: true type: string type: object @@ -931,7 +931,7 @@ components: BudgetResponseBody: properties: budget: - "$ref": "#/components/schemas/BudgetResponse" + "$ref": "#/components/schemas/BudgetResponse" type: object CategoriesResponseBody: properties: @@ -1305,10 +1305,18 @@ components: example: ubr* pending.uber.com nullable: true type: string + top_level_category_guid: + example: CAT-50af068-abb4-405c-8f6a-e883ed541f4f + nullable: true + type: string type: example: DEBIT nullable: true type: string + user_guid: + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + nullable: true + type: string type: object EnhanceTransactionsRequest: properties: @@ -1667,7 +1675,7 @@ components: InsightResponse: properties: active_at: - example: '2022-01-07T12:00:00Z' + example: "2022-01-07T12:00:00Z" nullable: true type: string client_guid: @@ -1675,15 +1683,16 @@ components: nullable: true type: string created_at: - example: '2022-01-12T18:16:51Z' + example: "2022-01-12T18:16:51Z" nullable: true type: string cta_clicked_at: - example: '2022-01-12T18:16:51Z' + example: "2022-01-12T18:16:51Z" nullable: true type: string description: - example: Gold's Gym charged you $36.71 more this month than normal. Did + example: + Gold's Gym charged you $36.71 more this month than normal. Did you upgrade your service? nullable: true type: string @@ -1736,7 +1745,7 @@ components: nullable: true type: string updated_at: - example: '2022-01-12T18:16:51Z' + example: "2022-01-12T18:16:51Z" nullable: true type: string user_guid: @@ -2284,7 +2293,7 @@ components: MemberResponse: properties: aggregated_at: - example: '2016-10-13T18:07:57.000Z' + example: "2016-10-13T18:07:57.000Z" nullable: true type: string background_aggregation_is_disabled: @@ -2295,7 +2304,7 @@ components: nullable: true type: string connection_status_message: - example: 'Connected to MX Bank' + example: "Connected to MX Bank" nullable: true type: string error: @@ -2363,7 +2372,7 @@ components: nullable: true type: string successfully_aggregated_at: - example: '2016-10-13T17:57:38.000Z' + example: "2016-10-13T17:57:38.000Z" nullable: true type: string use_cases: @@ -3503,7 +3512,7 @@ components: nullable: true type: string created_at: - example: '2016-10-08T09:43:42.000Z' + example: "2016-10-08T09:43:42.000Z" nullable: true type: string currency_code: @@ -3511,7 +3520,7 @@ components: nullable: true type: string date: - example: '2016-10-06T00:00:00.000Z' + example: "2016-10-06T00:00:00.000Z" nullable: true type: string description: @@ -3643,7 +3652,7 @@ components: nullable: false type: string updated_at: - example: '2016-10-08T05:49:12.000Z' + example: "2016-10-08T05:49:12.000Z" nullable: false type: string user_guid: @@ -4799,7 +4808,8 @@ paths: - mx_platform "/users/{user_guid}/accounts/{account_guid}": delete: - description: This endpoint deletes accounts that were manually created. The + description: + This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`. operationId: deleteManualAccount parameters: @@ -4824,8 +4834,7 @@ paths: tags: - mx_platform get: - description: - This endpoint returns the specified `account` resource. + description: This endpoint returns the specified `account` resource. operationId: readAccount parameters: - description: The unique id for an `account`. @@ -4955,34 +4964,34 @@ paths: description: Use this endpoint to list all insights associated with a specified account GUID. operationId: listInsightsByAccount parameters: - - description: The unique id for the `account`. - example: ACT-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: account_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer - - description: The unique id for the `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for the `account`. + example: ACT-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: account_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer + - description: The unique id for the `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -4990,7 +4999,7 @@ paths: description: OK summary: List insights by account tags: - - insights + - insights "/users/{user_guid}/accounts/{account_guid}/transactions": post: tags: @@ -5015,14 +5024,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/TransactionCreateRequestBody' + "$ref": "#/components/schemas/TransactionCreateRequestBody" responses: - '200': + "200": description: OK content: application/vnd.mx.api.v1+json: schema: - $ref: '#/components/schemas/TransactionCreateResponseBody' + $ref: "#/components/schemas/TransactionCreateResponseBody" get: description: This endpoint returns a list of the last 90 days of transactions @@ -5091,12 +5100,12 @@ paths: type: string description: 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`. responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/BudgetResponseBody' + $ref: "#/components/schemas/BudgetResponseBody" "/users/{user_guid}/budgets": post: tags: @@ -5115,14 +5124,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/BudgetCreateRequestBody' + "$ref": "#/components/schemas/BudgetCreateRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/BudgetResponseBody' + $ref: "#/components/schemas/BudgetResponseBody" get: tags: - budgets @@ -5136,12 +5145,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/BudgetResponseBody' + $ref: "#/components/schemas/BudgetResponseBody" "/users/{user_guid}/budgets/{budget_guid}": get: tags: @@ -5162,12 +5171,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/BudgetResponseBody' + $ref: "#/components/schemas/BudgetResponseBody" put: tags: - budgets @@ -5191,14 +5200,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/BudgetUpdateRequestBody' + "$ref": "#/components/schemas/BudgetUpdateRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/BudgetResponseBody' + $ref: "#/components/schemas/BudgetResponseBody" delete: tags: - budgets @@ -5474,14 +5483,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/GoalRequestBody' + "$ref": "#/components/schemas/GoalRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: "#/components/schemas/GoalResponseBody" get: tags: - goals @@ -5502,19 +5511,19 @@ paths: schema: type: string - name: records_per_age - description: The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used. + description: The supported range is from 10 to 1000. If the records_per_page parameter is not specified or is outside this range, a default of 25 records per page will be used. example: in: query required: false schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/GoalsResponseBody' + $ref: "#/components/schemas/GoalsResponseBody" "/users/{user_guid}/goals/{goal_guid}": delete: tags: @@ -5556,12 +5565,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: "#/components/schemas/GoalResponseBody" put: tags: - goals @@ -5585,14 +5594,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/UpdateGoalRequestBody' + "$ref": "#/components/schemas/UpdateGoalRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: "#/components/schemas/GoalResponseBody" "/users/{user_guid}/goals/reposition": put: tags: @@ -5611,14 +5620,14 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/RepositionRequestBody' + "$ref": "#/components/schemas/RepositionRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/RepositionResponseBody' + $ref: "#/components/schemas/RepositionResponseBody" "/users/{user_guid}/holdings": get: description: @@ -5698,31 +5707,32 @@ paths: - mx_platform "/users/{user_guid}/insights": get: - description: Use this endpoint to list all the insights associated with the + description: + Use this endpoint to list all the insights associated with the user. operationId: listInsightsUser parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5730,40 +5740,40 @@ paths: description: OK summary: List all insights for a user. tags: - - insights + - insights "/users/{user_guid}/insights/{insight_guid}/categories": get: description: Use this endpoint to list all the categories associated with the insight. operationId: listCategoriesInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5771,41 +5781,42 @@ paths: description: OK summary: List all categories associated with an insight. tags: - - insights + - insights "/users/{user_guid}/insights/{insight_guid}/accounts": get: - description: Use this endpoint to list all the accounts associated with the + description: + Use this endpoint to list all the accounts associated with the insight. operationId: listAccountsInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5813,41 +5824,42 @@ paths: description: OK summary: List all accounts associated with an insight. tags: - - insights + - insights "/users/{user_guid}/insights/{insight_guid}/merchants": get: - description: Use this endpoint to list all the merchants associated with the + description: + Use this endpoint to list all the merchants associated with the insight. operationId: listMerchantsInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5855,40 +5867,40 @@ paths: description: OK summary: List all merchants associated with an insight. tags: - - insights + - insights "/users/{user_guid}/insights/{insight_guid}/scheduled_payments": get: description: Use this endpoint to list all the scheduled payments associated with the insight. operationId: listScheduledPaymentsInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5896,41 +5908,42 @@ paths: description: OK summary: List all scheduled payments associated with an insight tags: - - insights + - insights "/users/{user_guid}/insights/{insight_guid}/transactions": get: - description: Use this endpoint to list all the transactions associated with + description: + Use this endpoint to list all the transactions associated with the insight. operationId: listTransactionsInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5938,29 +5951,30 @@ paths: description: OK summary: List all transactions associated with an insight. tags: - - insights + - insights "/users/{user_guid}/insights{insight_guid}": get: - description: Use this endpoint to read the attributes of a specific insight + description: + Use this endpoint to read the attributes of a specific insight according to its unique GUID. operationId: readInsightsUser parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-1234-abcd - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string + - description: The unique identifier for the user. Defined by MX. + example: USR-1234-abcd + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -5968,36 +5982,38 @@ paths: description: OK summary: Read a specific insight. tags: - - insights + - insights put: - description: Use this endpoint to update the attributes of a particular insight + description: + Use this endpoint to update the attributes of a particular insight according to its unique GUID. operationId: updateInsight parameters: - - description: The unique identifier for the user. Defined by MX. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique identifier for the insight. Defined by MX. - example: BET-1234-abcd - in: path - name: insight_guid - required: true - schema: - type: string + - description: The unique identifier for the user. Defined by MX. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique identifier for the insight. Defined by MX. + example: BET-1234-abcd + in: path + name: insight_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/InsightUpdateRequest" - description: The insight to be updated (None of these parameters are required, + description: + The insight to be updated (None of these parameters are required, but the user object cannot be empty.) required: true responses: - '200': + "200": content: application/vnd.mx.api.v1+json: schema: @@ -6005,7 +6021,7 @@ paths: description: OK summary: Update insight tags: - - insights + - insights "/users/{user_guid}/managed_members": get: description: @@ -6362,8 +6378,8 @@ paths: summary: Update managed account tags: - mx_platform - ? "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions" - : get: + "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions": + get: description: This endpoint returns a list of all the partner-managed transactions associated with the specified `account`, scoped through a `user` and a `member`. @@ -6454,8 +6470,8 @@ paths: summary: Create managed transaction tags: - mx_platform - ? "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}" - : delete: + "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}": + delete: description: Use this endpoint to delete the specified partner-managed `transaction`. The endpoint will respond with a status of `204 No Content` without a resource. @@ -6940,8 +6956,7 @@ paths: tags: - mx_platform put: - description: - 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`. + description: 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`. operationId: updateAccountByMember parameters: - description: The unique id for an `account`. @@ -7004,19 +7019,19 @@ paths: required: true schema: type: string - - description: When set to `false`, the aggregation will not gather holdings data. Defaults to `true`. + - description: When set to `false`, the aggregation will not gather holdings data. Defaults to `true`. example: false in: query name: include_holdings required: false - schema: + schema: type: boolean - - description: When set to `false`, the aggregation will not gather transactions data. Defaults to `true`. + - description: When set to `false`, the aggregation will not gather transactions data. Defaults to `true`. example: false in: query name: include_transactions required: false - schema: + schema: type: boolean responses: "202": @@ -7767,8 +7782,8 @@ paths: summary: Read a Tax Document tags: - mx_platform - ? "/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf" - : get: + "/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf": + get: description: Use this endpoint to download a PDF version of the specified tax document. The endpoint URL is the base URL appended with the uri of the tax_document. @@ -7904,12 +7919,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MicrodepositsResponseBody' + $ref: "#/components/schemas/MicrodepositsResponseBody" post: tags: - microdeposits @@ -7929,19 +7944,18 @@ paths: "$ref": "#/components/schemas/MicrodepositRequestBody" required: true responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MicrodepositResponseBody' + $ref: "#/components/schemas/MicrodepositResponseBody" "/users/{user_guid}/micro_deposits/{micro_deposit_guid}": delete: tags: - microdeposits summary: Delete a microdeposit - description: - Use this endpoint to delete the specified microdeposit. + description: Use this endpoint to delete the specified microdeposit. parameters: - name: micro_deposit_guid description: The unique identifier for the microdeposit. Defined by MX. @@ -7979,12 +7993,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MicrodepositResponseBody' + $ref: "#/components/schemas/MicrodepositResponseBody" "/micro_deposits/{microdeposit_guid}/verify": put: tags: @@ -8004,12 +8018,12 @@ paths: schema: "$ref": "#/components/schemas/MicrodepositVerifyRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MicrodepositResponseBody' + $ref: "#/components/schemas/MicrodepositResponseBody" "/users/{user_guid}/monthly_cash_flow_profile": get: parameters: @@ -8020,12 +8034,12 @@ paths: schema: type: string responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MonthlyCashFlowResponseBody' + $ref: "#/components/schemas/MonthlyCashFlowResponseBody" tags: - mx_platform summary: Read monthly cash flow profile @@ -8043,19 +8057,19 @@ paths: content: application/json: schema: - "$ref": '#/components/schemas/MonthlyCashFlowProfileRequestBody' + "$ref": "#/components/schemas/MonthlyCashFlowProfileRequestBody" responses: - '200': + "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/MonthlyCashFlowResponseBody' + $ref: "#/components/schemas/MonthlyCashFlowResponseBody" tags: - - mx_platform + - mx_platform summary: Update monthly cash flow profile - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items" - : post: + "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items": + post: description: This endpoint creates a new `spending_plan_iteration_item`. operationId: createSpendingPlanIterationItem parameters: @@ -8185,8 +8199,8 @@ paths: summary: List spending plans tags: - spending plan - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}" - : delete: + "/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}": + delete: description: Use this endpoint to delete a `spending_plan_account`. operationId: deleteSpendingPlanAccount parameters: @@ -8264,8 +8278,8 @@ paths: summary: Read spending plan account tags: - spending plan - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}" - : delete: + "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}": + delete: description: Use this endpoint to delete a spending plan `iteration_item`. operationId: deleteSpendingPlanIterationItem parameters: @@ -8450,8 +8464,8 @@ paths: summary: Read a spending plan for a user tags: - spending plan - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts" - : get: + "/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts": + get: description: Use this endpoint to list all the spending plan accounts associated with the spending plan. operationId: listSpendingPlanAccounts parameters: @@ -8532,8 +8546,8 @@ paths: summary: List spending plan iterations tags: - spending plan - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}" - : get: + "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}": + get: description: Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`. operationId: readSpendingPlanIteration parameters: @@ -9236,7 +9250,7 @@ paths: description: OK summary: Update transaction tags: - - mx_platform + - mx_platform "/users/{user_guid}/transactions/{transaction_guid}/split": delete: description: 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.