diff --git a/openapi/mx_platform_api.yml b/openapi/mx_platform_api.yml index 160ebef..23a4b9c 100644 --- a/openapi/mx_platform_api.yml +++ b/openapi/mx_platform_api.yml @@ -580,7 +580,7 @@ components: is_off_track: description: If the budget is off track, this field will be true. Otherwise, this field will be false. example: true - type: boolean + type: boolean metadata: description: Additional information a partner can store on the budget. example: some metadata @@ -593,8 +593,8 @@ components: nullable: true off_track_percentage: description: The percentage amount of off track spending. (Deprecated). - nullable: true - type: number + nullable: true + type: number parent_guid: description: Unique identifier for the parent budget. Defined by MX. nullable: true @@ -618,7 +618,7 @@ components: updated_at: description: Date and time the budget was updated, represented in ISO 8601 format with timestamp. example: 2022-06-14T21:17:11+00:00 - user_guid: + user_guid: description: Unique identifier for the user. Defined by MX. example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c BudgetCreateRequest: @@ -636,13 +636,13 @@ components: description: Amount of the budget. type: integer metadata: - example: Additional information + example: Additional information description: Additional information a partner can store on the budget. type: string skip_webhook: example: true description: When set to true, this parameter will prevent a webhook from being triggered by the request. - type: boolean + type: boolean required: - category_guid - parent_guid @@ -654,7 +654,7 @@ components: description: Amount of the budget. type: integer metadata: - example: Additional information + example: Additional information description: Additional information a partner can store on the budget. type: string skip_webhook: @@ -665,17 +665,17 @@ components: BudgetCreateRequestBody: properties: budget: - "$ref": "#/components/schemas/BudgetCreateRequest" + "$ref": "#/components/schemas/BudgetCreateRequest" type: object BudgetUpdateRequestBody: properties: budget: - "$ref": "#/components/schemas/BudgetUpdateRequest" + "$ref": "#/components/schemas/BudgetUpdateRequest" type: object BudgetResponseBody: properties: budget: - "$ref": "#/components/schemas/BudgetResponse" + "$ref": "#/components/schemas/BudgetResponse" type: object CategoriesResponseBody: properties: @@ -924,13 +924,13 @@ components: guid: example: CCA-b5bcd822-6d01-4e23-b8d6-846a225e714a type: string - has_cashback_rewards: + has_cashback_rewards: example: false type: boolean has_other_rewards: example: true type: boolean - has_travel_rewards: + has_travel_rewards: example: true type: boolean has_zero_introductory_annual_fee: @@ -938,7 +938,7 @@ components: type: boolean has_zero_percent_introductory_rate: example: false - type: boolean + type: boolean has_zero_percent_introductory_rate_on_balance_transfer: example: true type: boolean @@ -951,7 +951,7 @@ components: is_small_business_card: example: true type: boolean - name: + name: example: Chase Credit Card type: string CreditCardProductResponse: @@ -1098,27 +1098,27 @@ components: GoalRequest: properties: account_guid: - description: Unique identifier of the account for the goal. + description: Unique identifier of the account for the goal. example: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf type: string amount: - description: Amount of the goal. + description: Amount of the goal. example: 4500.50 type: number - goal_type_name: - description: The goal type. + goal_type_name: + description: The goal type. example: PAYOFF type: string meta_type_name: - description: The category of the goal. + description: The category of the goal. example: VACATION type: string - name: - description: The name of the goal. - example: Save for Europe + name: + description: The name of the goal. + example: Save for Europe type: string completed_at: - description: Date and time the goal was completed. + description: Date and time the goal was completed. example: 2015-06-19T10:37:04-06:00 type: string has_been_spent: @@ -1126,15 +1126,15 @@ components: example: false type: boolean is_complete: - description: Determines if the goal is complete. + description: Determines if the goal is complete. example: false type: boolean metadata: - description: Additional information a partner can store on the goal. + description: Additional information a partner can store on the goal. example: Additional information type: string - position: - description: The priority of the goal in relation to multiple goals. + position: + description: The priority of the goal in relation to multiple goals. example: 3 type: integer targeted_to_complete_at: @@ -1151,28 +1151,28 @@ components: GoalRequestBody: properties: goal: - "$ref": "#/components/schemas/GoalRequest" + "$ref": "#/components/schemas/GoalRequest" type: object GoalResponse: properties: account_guid: - description: Unique identifier of the account for the goal. + description: Unique identifier of the account for the goal. example: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf type: string amount: - description: Amount of the goal. + description: Amount of the goal. example: 4500.0 type: number completed_at: - description: Date and time the goal was completed. + description: Date and time the goal was completed. example: 2015-06-19T10:37:04-06:00 type: string current_amount: - description: The current amount of the goal. + description: The current amount of the goal. example: 1651.27 type: number - goal_type_name: - description: The goal type. + goal_type_name: + description: The goal type. example: PAYOFF type: string guid: @@ -1180,27 +1180,27 @@ components: example: GOL-f223463-4355-48d0-rce7-fe2rb345617c type: string has_been_spent: - description: Determines if the goal has been spent. + description: Determines if the goal has been spent. example: false type: boolean is_complete: - description: Determines if the goal is complete. + description: Determines if the goal is complete. example: false type: boolean metadata: - description: Additional information a partner can store on the goal. + description: Additional information a partner can store on the goal. example: Additional information type: string meta_type_name: - description: The category of the goal. + description: The category of the goal. example: VACATION type: string - name: - description: The name of the goal. + name: + description: The name of the goal. example: Save for Europe type: string - position: - description: The priority of the goal in relation to multiple goals. + position: + description: The priority of the goal in relation to multiple goals. example: 3 type: integer projected_to_complete_at: @@ -1215,17 +1215,17 @@ components: example: Track Type Name type: string user_guid: - description: The unique identifier for the the user. Defined by MX. + description: The unique identifier for the the user. Defined by MX. example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c type: string GoalsResponse: properties: account_guid: - description: Unique identifier of the account for the goal. + description: Unique identifier of the account for the goal. example: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf type: string amount: - description: Amount of the goal. + description: Amount of the goal. example: 4500.0 type: number current_amount: @@ -1233,23 +1233,23 @@ components: example: 1651.27 type: number guid: - description: The unique identifier for the goal. Defined by MX. + description: The unique identifier for the goal. Defined by MX. example: GOL-524ca5db-a2d5-44f3-b048-16de16059024 type: string - goal_type_name: - description: The goal type. + goal_type_name: + description: The goal type. example: PAYOFF type: string meta_type_name: - description: The category of the goal. + description: The category of the goal. example: VACATION type: string - name: - description: The name of the goal. - example: Save for Europe + name: + description: The name of the goal. + example: Save for Europe type: string completed_at: - description: Date and time the goal was completed. + description: Date and time the goal was completed. example: 2015-06-19T10:37:04-06:00 type: string has_been_spent: @@ -1257,19 +1257,19 @@ components: example: false type: boolean is_complete: - description: Determines if the goal is complete. + description: Determines if the goal is complete. example: false type: boolean metadata: - description: Additional information a partner can store on the goal. + description: Additional information a partner can store on the goal. example: Additional information type: string - position: - description: The priority of the goal in relation to multiple goals. + position: + description: The priority of the goal in relation to multiple goals. example: 3 type: integer projected_to_complete_at: - description: The date on which the project was completed. + description: The date on which the project was completed. example: 2022-06-14T16:03:53-00:00 type: string targeted_to_complete_at: @@ -1279,19 +1279,19 @@ components: example: Track Type Name type: string user_guid: - description: The unique identifier for the the user. Defined by MX. + description: The unique identifier for the the user. Defined by MX. example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c type: string GoalResponseBody: properties: goal: - "$ref": "#/components/schemas/GoalResponse" + "$ref": "#/components/schemas/GoalResponse" type: object GoalsResponseBody: properties: goals: items: - "$ref": "#/components/schemas/GoalsResponse" + "$ref": "#/components/schemas/GoalsResponse" type: array pagination: "$ref": "#/components/schemas/PaginationResponse" @@ -2023,6 +2023,10 @@ components: type: object MemberResponse: properties: + actionable_error: + example: '{\"error_type\": \"MEMBER\", \"error_code\": 1000, \"error_message\": \"This Member has no eligible checking, savings, or money market accounts.\", \"user_message\": \"We could not find any accounts eligible for transfers. Please link a checking or savings account.\", \"locale\": \"en\"}' + nullable: true + type: string aggregated_at: example: "2016-10-13T18:07:57.000Z" nullable: true @@ -2320,18 +2324,18 @@ components: example: CHECKING type: string routing_number: - example: "091000019" + example: "091000019" type: string account_name: example: My test account type: string - email: + email: example: joshyboy2@example.com type: string first_name: example: Joshy type: string - last_name: + last_name: example: Grobanne type: string required: @@ -2354,16 +2358,16 @@ components: account_type: type: string example: CHECKING - email: + email: type: string example: joshyboy2@example.com first_name: type: string example: Joshy - last_name: + last_name: type: string example: Grobanne - routing_number: + routing_number: type: string example: 091000019 error_message: @@ -2403,7 +2407,7 @@ components: type: object MonthlyCashFlowResponse: properties: - guid: + guid: example: MCF-4e431124-4a29-abf9-f059-ab232ac14dbf type: string description: Unique identifier for the monthly cash flow profile. Defined by MX. @@ -2411,7 +2415,7 @@ components: example: USR-6c83f63c-efcc-0189-3f14-100f0bad378a type: string description: Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX. - budgeted_income: + budgeted_income: example: 1200.12 type: number description: The amount of the budgeted income for the user. @@ -2419,7 +2423,7 @@ components: example: 1000.00 type: number description: The amount of the budgeted expenses for the user. - goals_contribution: + goals_contribution: example: 150.00 type: number description: The monthly dollar amount allocated for goals. @@ -2427,13 +2431,13 @@ components: example: null type: integer description: The estimated monthly dollar amount allocated for goals calculated from income and budgets. - uses_estimated_goals_contribution: + uses_estimated_goals_contribution: example: false type: boolean MonthlyCashFlowResponseBody: properties: monthly_cash_flow_profile: - "$ref": "#/components/schemas/MonthlyCashFlowResponse" + "$ref": "#/components/schemas/MonthlyCashFlowResponse" type: object MonthlyCashFlowProfileRequest: properties: @@ -2446,7 +2450,7 @@ components: type: boolean description: Determines if the user uses estimated goals contribution. MonthlyCashFlowProfileRequestBody: - properties: + properties: institution: "$ref": "#/components/schemas/MonthlyCashFlowProfileRequest" type: object @@ -2527,7 +2531,7 @@ components: RepositionRequest: properties: guid: - description: The unique identifier for the goal. Defined by MX. + description: The unique identifier for the goal. Defined by MX. example: GOL-97665947-235c-b213-ca25-8cf0174774f5 type: string position: @@ -2541,14 +2545,14 @@ components: properties: goals: items: - "$ref": "#/components/schemas/RepositionRequest" + "$ref": "#/components/schemas/RepositionRequest" type: array type: object RepositionResponseBody: properties: goals: items: - "$ref": "#/components/schemas/GoalsResponse" + "$ref": "#/components/schemas/GoalsResponse" type: array type: object RewardsResponse: @@ -2556,25 +2560,25 @@ components: account_guid: example: ACT-1234 type: string - balance_type: + balance_type: example: EXPIRING_BALANCE type: string - balance: + balance: example: 102 type: integer created_at: example: 2020-01-28T21:09:01+0000 type: string - description: + description: example: A description of the reward. - type: string - expires_on: + type: string + expires_on: example: 2020-02-28 type: string - guid: + guid: example: RWD-1234 type: string - member_guid: + member_guid: example: MBR-4567 type: string unit_type: @@ -2585,7 +2589,7 @@ components: type: string user_guid: example: USR-1234 - type: string + type: string RewardsResponseBody: properties: rewards: @@ -2595,30 +2599,30 @@ components: pagination: "$ref": "#/components/schemas/PaginationResponse" type: object - RewardResponse: + RewardResponse: properties: account_guid: example: ACT-1234 type: string - balance_type: + balance_type: example: EXPIRING_BALANCE type: string - balance: + balance: example: 102 type: integer created_at: example: 2020-01-28T21:09:01+0000 type: string - description: + description: example: A description of the reward. - type: string - expires_on: + type: string + expires_on: example: 2020-02-28 type: string - guid: + guid: example: RWD-1234 type: string - member_guid: + member_guid: example: MBR-4567 type: string unit_type: @@ -2879,16 +2883,16 @@ components: type: object SplitTransactionRequest: properties: - amount: - description: Amount of money you want to re-categorize. + amount: + description: Amount of money you want to re-categorize. example: 54.19 type: number description: - description: Description for the split transaction. + description: Description for the split transaction. example: Chevron Gas type: string category_guid: - description: Unique identifier of the category. + description: Unique identifier of the category. example: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e type: string memo: @@ -3155,7 +3159,7 @@ components: example: DEBIT type: string category_guid: - description: Unique identifier of the category. + description: Unique identifier of the category. example: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e type: string currency_code: @@ -3656,27 +3660,27 @@ components: UpdateGoalRequest: properties: account_guid: - description: Unique identifier of the account for the goal. + description: Unique identifier of the account for the goal. example: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf type: string amount: - description: Amount of the goal. + description: Amount of the goal. example: 4500.50 type: number - goal_type_name: - description: The goal type. + goal_type_name: + description: The goal type. example: PAYOFF type: string meta_type_name: - description: The category of the goal. + description: The category of the goal. example: VACATION type: string - name: - description: The name of the goal. - example: Save for Europe + name: + description: The name of the goal. + example: Save for Europe type: string completed_at: - description: Date and time the goal was completed. + description: Date and time the goal was completed. example: 2015-06-19T10:37:04-06:00 type: string has_been_spent: @@ -3684,15 +3688,15 @@ components: example: false type: boolean is_complete: - description: Determines if the goal is complete. + description: Determines if the goal is complete. example: false type: boolean metadata: - description: Additional information a partner can store on the goal. + description: Additional information a partner can store on the goal. example: Additional information type: string - position: - description: The priority of the goal in relation to multiple goals. + position: + description: The priority of the goal in relation to multiple goals. example: 3 type: integer targeted_to_complete_at: @@ -3703,7 +3707,7 @@ components: UpdateGoalRequestBody: properties: goal: - "$ref": "#/components/schemas/UpdateGoalRequest" + "$ref": "#/components/schemas/UpdateGoalRequest" type: object UserCreateRequest: properties: @@ -3965,7 +3969,7 @@ paths: - mx_platform "/credit_card_products/{credit_card_product_guid}": get: - description: This endpoint returns the specified `credit_card_product` according to the unique GUID. + description: This endpoint returns the specified `credit_card_product` according to the unique GUID. operationId: creditCard parameters: - description: The required `credit_card_product_guid` can be found on the `account` object. @@ -3982,7 +3986,7 @@ paths: schema: "$ref": "#/components/schemas/CreditCardProductResponse" description: OK - summary: Read a Credit Card Product + summary: Read a Credit Card Product tags: - mx_platform "/institutions": @@ -4707,24 +4711,24 @@ paths: - insights "/users/{user_guid}/accounts/{account_guid}/transactions": post: - tags: + tags: - transactions summary: Create manual transaction description: This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter. parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. in: path required: true schema: type: string - name: account_guid - description: The unique identifier for the account. + description: The unique identifier for the account. in: path required: true schema: type: string - requestBody: + requestBody: required: true content: application/json: @@ -4792,13 +4796,13 @@ paths: tags: - mx_platform "/users/{user_guid}/budgets/generate": - post: + post: tags: - budgets - summary: Auto-generate budgets + summary: Auto-generate budgets parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: @@ -4812,18 +4816,18 @@ paths: schema: $ref: '#/components/schemas/BudgetResponseBody' "/users/{user_guid}/budgets": - post: + post: tags: - budgets summary: Create a budget parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: type: string - description: Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for "Gas", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint. + description: Create a budget. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. You cannot create a duplicate budget. For example, if you attempt to create a budget for "Gas", but that budget already exist, the request will fail. You can retrieve a list of all existing categories by using the List Categories endpoint. requestBody: required: true content: @@ -4837,14 +4841,14 @@ paths: application/json: schema: $ref: '#/components/schemas/BudgetResponseBody' - get: + get: tags: - budgets summary: List all budgets - description: List all budgets + description: List all budgets parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: @@ -4857,23 +4861,23 @@ paths: schema: $ref: '#/components/schemas/BudgetResponseBody' "/users/{user_guid}/budgets/{budget_guid}": - get: + get: tags: - budgets summary: Read a specific budget - description: Read a specific budget. + description: Read a specific budget. parameters: - name: budget_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: user_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string responses: '200': @@ -4885,20 +4889,20 @@ paths: put: tags: - budgets - summary: Update a specific budget - description: Update a specific budget. + summary: Update a specific budget + description: Update a specific budget. parameters: - name: user_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: budget_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string requestBody: required: false @@ -4913,23 +4917,23 @@ paths: application/json: schema: $ref: '#/components/schemas/BudgetResponseBody' - delete: + delete: tags: - budgets summary: Delete a budget - description: Delete a budget. + description: Delete a budget. parameters: - name: user_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: budget_guid - description: The unique identifier for the budget. Defined by MX. + description: The unique identifier for the budget. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string responses: "204": @@ -5175,12 +5179,12 @@ paths: tags: - goals summary: Create a goal - description: Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. + description: Create a goal. This endpoint accepts the optional `MX-Skip-Webhook` header and `skip_webhook` parameter. parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. in: path - required: true + required: true schema: type: string requestBody: @@ -5195,58 +5199,58 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: '#/components/schemas/GoalResponseBody' get: tags: - goals summary: List goals - description: List all goals a user can set. + description: List all goals a user can set. parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. in: path required: true schema: type: string - name: page description: Results are returned in paginated sets, this is the page of the results you would like to view. Defaults to page 1 if no page is specified. - example: + example: in: query required: false - schema: + 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. - example: + example: in: query required: false - schema: - type: string + schema: + type: string responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/GoalsResponseBody' + $ref: '#/components/schemas/GoalsResponseBody' "/users/{user_guid}/goals/{goal_guid}": - delete: + delete: tags: - goals summary: Delete a goal - description: Delete a goal. + description: Delete a goal. parameters: - name: goal_guid - description: The unique identifier for a goal. Defined by MX. + description: The unique identifier for a goal. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: user_guid description: The unique identifier for a user. required: true - in: path - schema: + in: path + schema: type: string responses: "204": @@ -5255,19 +5259,19 @@ paths: tags: - goals summary: Read a goal - description: Read a specific goal. + description: Read a specific goal. parameters: - name: goal_guid - description: The unique identifier for a goal. Defined by MX. + description: The unique identifier for a goal. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: user_guid description: The unique identifier for a user. required: true - in: path - schema: + in: path + schema: type: string responses: '200': @@ -5275,24 +5279,24 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: '#/components/schemas/GoalResponseBody' put: tags: - goals summary: Update a goal - description: This endpoint updates a specific goal. + description: This endpoint updates a specific goal. parameters: - name: goal_guid - description: The unique identifier for a goal. Defined by MX. + description: The unique identifier for a goal. Defined by MX. required: true - in: path - schema: + in: path + schema: type: string - name: user_guid description: The unique identifier for a user. required: true - in: path - schema: + in: path + schema: type: string requestBody: required: true @@ -5306,7 +5310,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GoalResponseBody' + $ref: '#/components/schemas/GoalResponseBody' "/users/{user_guid}/goals/reposition": put: tags: @@ -5315,7 +5319,7 @@ paths: description: This endpoint repositions goal priority levels. If one goal is set to a lower priority, then any other goals need to be adjusted accordingly. parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. required: true in: path schema: @@ -5332,7 +5336,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/RepositionResponseBody' + $ref: '#/components/schemas/RepositionResponseBody' "/users/{user_guid}/holdings": get: description: @@ -5444,7 +5448,7 @@ 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. @@ -5719,7 +5723,7 @@ paths: description: OK summary: Update insight tags: - - insights + - insights "/users/{user_guid}/managed_members": get: description: @@ -6895,7 +6899,7 @@ paths: required: true schema: type: string - - description: The unique identifier for the member. Defined by MX. + - description: The unique identifier for the member. Defined by MX. example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54 in: path name: member_guid @@ -7185,7 +7189,7 @@ paths: required: true schema: type: string - - description: The unique identifier for the member. Defined by MX. + - description: The unique identifier for the member. Defined by MX. example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54 in: path name: member_guid @@ -7214,14 +7218,14 @@ paths: required: true schema: type: string - - description: The unique identifier for the member. Defined by MX. + - description: The unique identifier for the member. Defined by MX. example: MBR-fa7537f3-48aa-a683-a02a-b18345562f54 in: path name: member_guid required: true schema: type: string - - description: The unique identifier for the rewards. Defined by MX. + - description: The unique identifier for the rewards. Defined by MX. example: RWD-fa7537f3-48aa-a683-a02a-b324322f54 in: path name: reward_guid @@ -7598,15 +7602,15 @@ paths: description: Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: type: string - responses: + responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MicrodepositsResponseBody' @@ -7617,7 +7621,7 @@ paths: description: Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED. parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: @@ -7628,10 +7632,10 @@ paths: schema: "$ref": "#/components/schemas/MicrodepositRequestBody" required: true - responses: + responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MicrodepositResponseBody' @@ -7644,7 +7648,7 @@ paths: Use this endpoint to delete the specified microdeposit. parameters: - name: micro_deposit_guid - description: The unique identifier for the microdeposit. Defined by MX. + description: The unique identifier for the microdeposit. Defined by MX. in: path required: true example: MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb @@ -7667,21 +7671,21 @@ paths: 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. parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: type: string - name: micro_deposit_guid - description: The unique identifier for the microdeposit. Defined by MX. + description: The unique identifier for the microdeposit. Defined by MX. in: path required: true schema: type: string - responses: + responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MicrodepositResponseBody' @@ -7693,7 +7697,7 @@ paths: description: Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state. parameters: - name: microdeposit_guid - description: The unique identifier for the microdeposit. Defined by MX. + description: The unique identifier for the microdeposit. Defined by MX. in: path required: true schema: @@ -7703,10 +7707,10 @@ paths: application/json: schema: "$ref": "#/components/schemas/MicrodepositVerifyRequestBody" - responses: + responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MicrodepositResponseBody' @@ -7714,7 +7718,7 @@ paths: get: parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. in: path required: true schema: @@ -7722,7 +7726,7 @@ paths: responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MonthlyCashFlowResponseBody' @@ -7733,7 +7737,7 @@ paths: description: Use this endpoint to update the attributes of a `monthly_cash_flow_profile`. parameters: - name: user_guid - description: The unique identifier for the user. + description: The unique identifier for the user. in: path required: true schema: @@ -7747,7 +7751,7 @@ paths: responses: '200': description: OK - content: + content: application/json: schema: $ref: '#/components/schemas/MonthlyCashFlowResponseBody' @@ -8965,13 +8969,13 @@ paths: description: This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again. parameters: - name: user_guid - description: The unique identifier for the user. Defined by MX. + description: The unique identifier for the user. Defined by MX. in: path required: true schema: type: string - name: transaction_guid - description: The unique identifier for the transaction. Defined by MX. + description: The unique identifier for the transaction. Defined by MX. in: path required: true schema: