diff --git a/openapi/mx_platform_api.yml b/openapi/mx_platform_api.yml index 4964725..d0c0ae9 100644 --- a/openapi/mx_platform_api.yml +++ b/openapi/mx_platform_api.yml @@ -4,7 +4,7 @@ components: AccountCreateRequest: properties: account_subtype: - example: "PERSONAL" + example: PERSONAL type: string account_type: example: SAVINGS @@ -67,8 +67,8 @@ components: example: true type: boolean required: - - name - - account_type + - name + - account_type type: object AccountCreateRequestBody: properties: @@ -114,6 +114,15 @@ components: nullable: true type: string type: object + AccountNumbersResponseBody: + properties: + account_numbers: + items: + "$ref": "#/components/schemas/AccountNumberResponse" + type: array + pagination: + "$ref": "#/components/schemas/PaginationResponse" + type: object AccountOwnerResponse: properties: account_guid: @@ -185,19 +194,19 @@ components: AccountResponse: properties: account_number: - example: "5366" + example: '5366' nullable: true type: string account_ownership: - example: 'INDIVIDUAL' + example: INDIVIDUAL nullable: true type: string annuity_policy_to_date: - example: "2016-10-13T17:57:37.000Z" + example: '2016-10-13T17:57:37.000Z' nullable: true type: string annuity_provider: - example: 'Metlife' + example: Metlife nullable: true type: string annuity_term_year: @@ -233,7 +242,7 @@ components: nullable: true type: number created_at: - example: "2023-07-25T17:14:46Z" + example: '2023-07-25T17:14:46Z' nullable: false type: string credit_limit: @@ -261,19 +270,19 @@ components: nullable: true type: number id: - example: "1040434698" + example: '1040434698' nullable: true type: string imported_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' nullable: true type: string institution_code: - example: '3af3685e-05d9-7060-359f-008d0755e993' + example: 3af3685e-05d9-7060-359f-008d0755e993 nullable: true type: string insured_name: - example: 'Tommy Shelby' + example: Tommy Shelby nullable: true type: string interest_rate: @@ -297,7 +306,7 @@ components: nullable: true type: number last_payment_at: - example: "2023-07-25T17:14:46Z" + example: '2023-07-25T17:14:46Z' nullable: true type: string loan_amount: @@ -309,7 +318,7 @@ components: nullable: true type: number matures_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' nullable: true type: string member_guid: @@ -325,7 +334,7 @@ components: nullable: true type: boolean metadata: - example: 'some metadata' + example: some metadata nullable: true type: string minimum_balance: @@ -353,7 +362,7 @@ components: nullable: true type: number payment_due_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' nullable: true type: string payoff_balance: @@ -369,11 +378,11 @@ components: nullable: true type: string routing_number: - example: "68899990000000" + example: '68899990000000' nullable: true type: string started_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' nullable: true type: string subtype: @@ -397,7 +406,7 @@ components: nullable: true type: string updated_at: - example: "2016-10-13T18:08:00.000Z" + example: '2016-10-13T18:08:00.000Z' nullable: true type: string user_guid: @@ -405,7 +414,7 @@ components: nullable: true type: string user_id: - example: 'user123' + example: user123 nullable: true type: string type: object @@ -414,19 +423,10 @@ components: account: "$ref": "#/components/schemas/AccountResponse" type: object - AccountNumbersResponseBody: - properties: - account_numbers: - items: - "$ref": "#/components/schemas/AccountNumberResponse" - type: array - pagination: - "$ref": "#/components/schemas/PaginationResponse" - type: object AccountUpdateRequest: properties: account_subtype: - example: "PERSONAL" + example: PERSONAL type: string account_type: example: SAVINGS @@ -447,7 +447,7 @@ components: example: 1000.0 type: number credit_limit: - example: 100.00 + example: 100.0 type: number currency_code: example: USD @@ -506,8 +506,7 @@ components: AuthorizationCodeRequest: properties: scope: - example: - user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a + example: user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a account-guid:ACT-32a64160-582a-4f00-ab34-5f49cc35ed35 read-protected nullable: true type: string @@ -551,7 +550,7 @@ components: example: CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f type: string required: - - name + - name type: object CategoryCreateRequestBody: properties: @@ -561,7 +560,7 @@ components: CategoryResponse: properties: created_at: - example: "2015-04-13T18:01:23.000Z" + example: '2015-04-13T18:01:23.000Z' nullable: true type: string guid: @@ -589,7 +588,7 @@ components: nullable: true type: string updated_at: - example: "2015-05-13T18:01:23.000Z" + example: '2015-05-13T18:01:23.000Z' nullable: true type: string type: object @@ -882,8 +881,8 @@ components: example: DEBIT type: string required: - - description - - id + - description + - id type: object EnhanceTransactionsRequestBody: properties: @@ -910,7 +909,7 @@ components: nullable: true type: number created_at: - example: "2015-04-13T18:01:23.000Z" + example: '2015-04-13T18:01:23.000Z' nullable: true type: string currency_code: @@ -970,7 +969,7 @@ components: nullable: true type: string updated_at: - example: "2015-04-13T18:01:23.000Z" + example: '2015-04-13T18:01:23.000Z' nullable: true type: string user_guid: @@ -1088,6 +1087,13 @@ components: user_id: example: user-partner-defined-1234 type: object + InsightResponseBody: + properties: + insight: + items: + "$ref": "#/components/schemas/InsightResponse" + type: object + type: object InsightUpdateRequest: properties: has_been_displayed: @@ -1097,13 +1103,6 @@ components: example: false type: boolean type: object - InsightResponseBody: - properties: - insight: - items: - "$ref": "#/components/schemas/InsightResponse" - type: object - type: object InsightsResponseBody: properties: insights: @@ -1128,8 +1127,7 @@ components: nullable: true type: string instructional_text: - example: - Some instructional text for end users. nullable: true type: string @@ -1191,7 +1189,7 @@ components: ManagedAccountCreateRequest: properties: account_number: - example: "5366" + example: '5366' type: string apr: example: 1.0 @@ -1224,7 +1222,7 @@ components: example: 1000 type: integer id: - example: "1040434698" + example: '1040434698' type: string interest_rate: example: 1.0 @@ -1239,13 +1237,13 @@ components: example: 100.0 type: number last_payment_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string loan_amount: example: 1000.0 type: number matures_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string metadata: example: some metadata @@ -1266,16 +1264,16 @@ components: example: 10.0 type: number payment_due_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string payoff_balance: example: 10.0 type: number routing_number: - example: "68899990000000" + example: '68899990000000' type: string started_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string subtype: example: NONE @@ -1284,9 +1282,9 @@ components: example: SAVINGS type: string required: - - balance - - name - - type + - balance + - name + - type type: object ManagedAccountCreateRequestBody: properties: @@ -1296,7 +1294,7 @@ components: ManagedAccountUpdateRequest: properties: account_number: - example: "5366" + example: '5366' type: string apr: example: 1.0 @@ -1329,7 +1327,7 @@ components: example: 1000 type: integer id: - example: "1040434698" + example: '1040434698' type: string interest_rate: example: 1.0 @@ -1344,13 +1342,13 @@ components: example: 100.0 type: number last_payment_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string loan_amount: example: 1000.0 type: number matures_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string metadata: example: some metadata @@ -1371,16 +1369,16 @@ components: example: 10.0 type: number payment_due_at: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string payoff_balance: example: 10.0 type: number routing_number: - example: "68899990000000" + example: '68899990000000' type: string started_on: - example: "2015-10-13T17:57:37.000Z" + example: '2015-10-13T17:57:37.000Z' type: string subtype: example: NONE @@ -1409,7 +1407,7 @@ components: example: MX Bank type: string required: - - institution_code + - institution_code type: object ManagedMemberCreateRequestBody: properties: @@ -1436,13 +1434,13 @@ components: ManagedTransactionCreateRequest: properties: amount: - example: "61.11" + example: '61.11' type: string category: example: Groceries type: string check_number_string: - example: "6812" + example: '6812' type: string currency_code: example: USD @@ -1484,23 +1482,23 @@ components: example: some metadata type: string posted_at: - example: "2016-10-07T06:00:00.000Z" + example: '2016-10-07T06:00:00.000Z' type: string status: example: POSTED type: string transacted_at: - example: "2016-10-06T13:00:00.000Z" + example: '2016-10-06T13:00:00.000Z' type: string type: example: DEBIT type: string required: - - amount - - description - - status - - transacted_at - - type + - amount + - description + - status + - transacted_at + - type type: object ManagedTransactionCreateRequestBody: properties: @@ -1510,13 +1508,13 @@ components: ManagedTransactionUpdateRequest: properties: amount: - example: "61.11" + example: '61.11' type: string category: example: Groceries type: string check_number_string: - example: "6812" + example: '6812' type: string currency_code: example: USD @@ -1558,13 +1556,13 @@ components: example: some metadata type: string posted_at: - example: "2016-10-07T06:00:00.000Z" + example: '2016-10-07T06:00:00.000Z' type: string status: example: POSTED type: string transacted_at: - example: "2016-10-06T13:00:00.000Z" + example: '2016-10-06T13:00:00.000Z' type: string type: example: DEBIT @@ -1600,8 +1598,8 @@ components: example: false type: boolean required: - - credentials - - institution_code + - credentials + - institution_code type: object MemberCreateRequestBody: properties: @@ -1623,7 +1621,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: @@ -1666,11 +1664,11 @@ components: nullable: true type: string most_recent_job_detail_code: - example: (deprecated) + example: "(deprecated)" nullable: true type: string most_recent_job_detail_text: - example: (deprecated) + example: "(deprecated)" nullable: true type: string name: @@ -1682,7 +1680,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 user_guid: @@ -1714,7 +1712,7 @@ components: MemberStatusResponse: properties: aggregated_at: - example: "2016-10-13T18:07:57.000Z" + example: '2016-10-13T18:07:57.000Z' nullable: true type: string challenges: @@ -1729,11 +1727,11 @@ components: example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b nullable: true type: string - has_processed_accounts: + has_processed_account_numbers: example: true nullable: true type: boolean - has_processed_account_numbers: + has_processed_accounts: example: true nullable: true type: boolean @@ -1750,7 +1748,7 @@ components: nullable: true type: boolean successfully_aggregated_at: - example: "2016-10-13T17:57:38.000Z" + example: '2016-10-13T17:57:38.000Z' nullable: true type: string type: object @@ -1827,7 +1825,7 @@ components: nullable: true type: string postal_code: - example: "801121436" + example: '801121436' nullable: true type: string state: @@ -1851,7 +1849,7 @@ components: MerchantResponse: properties: created_at: - example: "2017-04-20T19:30:12.000Z" + example: '2017-04-20T19:30:12.000Z' nullable: true type: string guid: @@ -1867,7 +1865,7 @@ components: nullable: true type: string updated_at: - example: "2018-09-28T21:13:53.000Z" + example: '2018-09-28T21:13:53.000Z' nullable: true type: string website_url: @@ -1963,91 +1961,89 @@ components: payment_processor_authorization_code: "$ref": "#/components/schemas/PaymentProcessorAuthorizationCodeResponse" type: object - SpendingPlanAccountResponse: + ScheduledPaymentResponse: properties: - account_guid: - example: ACT-97d3948f-ebe7-434a-9bd0-20b29d67c9d4 - type: string - client_guid: - example: CLT-024284fc-a6a7-42ee-b363-dab9343e3f72 - type: string + amount: + example: 13.54 + type: number created_at: - example: 2023-04-27T23:14:16Z + example: 2023-04-27 23:14:16.000000000 Z + type: string + description: + example: Netflix type: string guid: example: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a type: string - spending_plan_guid: - example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600 + is_completed: + example: false + type: boolean + is_recurring: + example: true + type: boolean + merchant_guid: + example: MCH-b8a2624c-2176-59ec-c150-37854bc38aa8 + type: string + occurs_on: + example: 2022-01-15 + type: string + recurrence_day: + example: 15 + type: integer + recurrence_type: + example: EVERY_MONTH + type: string + transaction_type: + example: DEBIT type: string updated_at: - example: 2023-04-27T23:14:16Z + example: 2023-04-27 23:14:16.000000000 Z type: string user_guid: example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7 type: string type: object - SpendingPlanAccountsResponse: + ScheduledPaymentsResponseBody: properties: - spending_plan_accounts: - items: - "$ref": "#/components/schemas/SpendingPlanAccountResponse" - type: array pagination: "$ref": "#/components/schemas/PaginationResponse" - type: object - SpendingPlanIterationsResponse: - properties: - iterations: + scheduled_payments: items: - "$ref": "#/components/schemas/SpendingPlanIterationResponse" + "$ref": "#/components/schemas/ScheduledPaymentResponse" type: array - pagination: - "$ref": "#/components/schemas/PaginationResponse" type: object - SpendingPlanIterationResponse: + SpendingPlanAccountResponse: properties: - created_at: - example: "2016-10-13T18:08:00+00:00" - nullable: true + account_guid: + example: ACT-97d3948f-ebe7-434a-9bd0-20b29d67c9d4 type: string - end_on: - example: 2023-05-31 - nullable: true + client_guid: + example: CLT-024284fc-a6a7-42ee-b363-dab9343e3f72 + type: string + created_at: + example: 2023-04-27 23:14:16.000000000 Z type: string guid: - example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102 - nullable: true + example: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a type: string - iteration_number: - example: 1 - nullable: true - type: integer spending_plan_guid: example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600 - nullable: true - type: string - start_on: - example: 2023-05-01 - nullable: true type: string updated_at: - example: 2016-10-13T18:09:00+00:00 - nullable: true + example: 2023-04-27 23:14:16.000000000 Z type: string user_guid: example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7 - nullable: true type: string type: object - SpendingPlanIterationItemsResponseBody: + SpendingPlanAccountsResponse: properties: - iteration_items: - items: - "$ref": "#/components/schemas/SpendingPlanIterationItemResponse" - type: array pagination: "$ref": "#/components/schemas/PaginationResponse" + spending_plan_accounts: + items: + "$ref": "#/components/schemas/SpendingPlanAccountResponse" + type: array type: object SpendingPlanIterationItemCreateRequestBody: properties: @@ -2067,7 +2063,7 @@ components: example: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8 type: string required: - - planned_amount + - planned_amount type: object SpendingPlanIterationItemResponse: properties: @@ -2080,7 +2076,7 @@ components: nullable: true type: string created_at: - example: "2016-10-13T18:08:00+00:00" + example: '2016-10-13T18:08:00+00:00' nullable: true type: string guid: @@ -2088,7 +2084,7 @@ components: nullable: true type: string item_type: - example: "0" + example: '0' nullable: true type: string planned_amount: @@ -2114,7 +2110,7 @@ components: type: string type: array updated_at: - example: 2016-10-13T18:09:00+00:00 + example: 2016-10-13 12:09:00.000000000 -06:00 nullable: true type: string user_guid: @@ -2122,87 +2118,89 @@ components: nullable: true type: string type: object - SpendingPlansResponseBody: + SpendingPlanIterationItemsResponseBody: properties: - spending_plans: + iteration_items: items: - "$ref": "#/components/schemas/SpendingPlanResponse" + "$ref": "#/components/schemas/SpendingPlanIterationItemResponse" type: array pagination: "$ref": "#/components/schemas/PaginationResponse" type: object - SpendingPlanResponse: + SpendingPlanIterationResponse: properties: created_at: - example: 2016-10-13T18:08:00+00:00 + example: '2016-10-13T18:08:00+00:00' nullable: true type: string - current_iteration_number: + end_on: + example: 2023-05-31 + nullable: true + type: string + guid: + example: SPI-848e6648-3fa3-4632-ac8f-e65f03167102 + nullable: true + type: string + iteration_number: example: 1 nullable: true type: integer - guid: - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + spending_plan_guid: + example: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600 + nullable: true + type: string + start_on: + example: 2023-05-01 nullable: true type: string updated_at: - example: "2016-10-13T18:09:00+00:00" + example: 2016-10-13 12:09:00.000000000 -06:00 nullable: true type: string user_guid: - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7 nullable: true type: string type: object - ScheduledPaymentResponse: + SpendingPlanIterationsResponse: + properties: + iterations: + items: + "$ref": "#/components/schemas/SpendingPlanIterationResponse" + type: array + pagination: + "$ref": "#/components/schemas/PaginationResponse" + type: object + SpendingPlanResponse: properties: - amount: - example: 13.54 - type: number created_at: - example: 2023-04-27T23:14:16Z - type: string - description: - example: Netflix - type: string - guid: - example: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a - type: string - is_completed: - example: false - type: boolean - is_recurring: - example: true - type: boolean - merchant_guid: - example: MCH-b8a2624c-2176-59ec-c150-37854bc38aa8 - type: string - occurs_on: - example: 2022-01-15 + example: 2016-10-13 12:08:00.000000000 -06:00 + nullable: true type: string - recurrence_day: - example: 15 + current_iteration_number: + example: 1 + nullable: true type: integer - recurrence_type: - example: EVERY_MONTH - type: string - transaction_type: - example: DEBIT + guid: + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + nullable: true type: string updated_at: - example: 2023-04-27T23:14:16Z + example: '2016-10-13T18:09:00+00:00' + nullable: true type: string user_guid: - example: USR-72086f59-6684-4adf-8f29-c4d32db43cd7 + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + nullable: true type: string type: object - ScheduledPaymentsResponseBody: + SpendingPlansResponseBody: properties: pagination: "$ref": "#/components/schemas/PaginationResponse" - scheduled_payments: + spending_plans: items: - "$ref": "#/components/schemas/ScheduledPaymentResponse" + "$ref": "#/components/schemas/SpendingPlanResponse" type: array type: object StatementResponse: @@ -2216,7 +2214,7 @@ components: nullable: true type: string created_at: - example: "2016-10-13T18:08:00+00:00" + example: '2016-10-13T18:08:00+00:00' nullable: true type: string guid: @@ -2228,7 +2226,7 @@ components: nullable: true type: string updated_at: - example: "2016-10-13T18:09:00+00:00" + example: '2016-10-13T18:09:00+00:00' nullable: true type: string uri: @@ -2260,7 +2258,7 @@ components: example: MY TAG type: string required: - - name + - name type: object TagCreateRequestBody: properties: @@ -2293,7 +2291,7 @@ components: example: MY TAG type: string required: - - name + - name type: object TagUpdateRequestBody: properties: @@ -2309,8 +2307,8 @@ components: example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 type: string required: - - tag_guid - - transaction_guid + - tag_guid + - transaction_guid type: object TaggingCreateRequestBody: properties: @@ -2351,7 +2349,7 @@ components: example: TAG-40faf068-abb4-405c-8f6a-e883ed541fff type: string required: - - tag_guid + - tag_guid type: object TaggingUpdateRequestBody: properties: @@ -2383,7 +2381,7 @@ components: nullable: true type: string created_at: - example: "2022-10-18T19:23:16Z" + example: '2022-10-18T19:23:16Z' nullable: true type: string document_type: @@ -2395,7 +2393,7 @@ components: nullable: true type: string issued_on: - example: "2022-03-31" + example: '2022-03-31' nullable: true type: string member_guid: @@ -2403,11 +2401,11 @@ components: nullable: true type: string tax_year: - example: "2023" + example: '2023' nullable: true type: string updated_at: - example: "2022-10-18T19:23:16Z" + example: '2022-10-18T19:23:16Z' nullable: true type: string uri: @@ -2456,11 +2454,11 @@ components: nullable: true type: string check_number_string: - example: "6812" + example: '6812' nullable: true type: string created_at: - example: "2016-10-06T09:43:42.000Z" + example: '2016-10-06T09:43:42.000Z' nullable: true type: string currency_code: @@ -2468,7 +2466,7 @@ components: nullable: true type: string date: - example: "2013-09-23T00:00:00.000Z" + example: '2013-09-23T00:00:00.000Z' nullable: true type: string description: @@ -2576,7 +2574,7 @@ components: nullable: true type: string posted_at: - example: "2016-10-07T06:00:00.000Z" + example: '2016-10-07T06:00:00.000Z' nullable: true type: string status: @@ -2588,7 +2586,7 @@ components: nullable: true type: string transacted_at: - example: "2016-10-06T13:00:00.000Z" + example: '2016-10-06T13:00:00.000Z' nullable: true type: string type: @@ -2596,7 +2594,7 @@ components: nullable: true type: string updated_at: - example: "2016-10-07T05:49:12.000Z" + example: '2016-10-07T05:49:12.000Z' nullable: true type: string user_guid: @@ -2625,8 +2623,8 @@ components: example: Wal-mart type: string required: - - category_guid - - match_description + - category_guid + - match_description type: object TransactionRuleCreateRequestBody: properties: @@ -2640,7 +2638,7 @@ components: nullable: true type: string created_at: - example: "2018-10-02T22:00:50+00:00" + example: '2018-10-02T22:00:50+00:00' nullable: true type: string description: @@ -2656,7 +2654,7 @@ components: nullable: true type: string updated_at: - example: "2018-10-02T23:54:40+00:00" + example: '2018-10-02T23:54:40+00:00' nullable: true type: string user_guid: @@ -2701,7 +2699,7 @@ components: example: new description type: string required: - - description + - description type: object TransactionUpdateRequestBody: properties: @@ -2851,7 +2849,7 @@ components: example: connect_widget type: string required: - - widget_type + - widget_type type: object WidgetRequestBody: properties: @@ -2886,8 +2884,7 @@ info: contact: name: MX Platform API url: https://www.mx.com/products/platform-api - description: - The MX Platform API is a powerful, fully-featured API designed to make + description: The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. title: MX Platform API @@ -2896,8 +2893,7 @@ openapi: 3.0.0 paths: "/authorization_code": post: - description: - Clients use this endpoint to request an authorization code according + description: Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in @@ -2911,7 +2907,7 @@ paths: description: The scope for the authorization code. required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -2919,11 +2915,10 @@ paths: description: OK summary: Request an authorization code. tags: - - mx_platform + - mx_platform "/categories/default": get: - description: - Use this endpoint to retrieve a list of all the default categories + description: Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list @@ -2931,20 +2926,20 @@ paths: the same results. The different routes are provided for convenience. operationId: listDefaultCategories parameters: - - 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: 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: @@ -2952,21 +2947,21 @@ paths: description: OK summary: List default categories tags: - - mx_platform + - mx_platform "/categories/{category_guid}": get: description: Use this endpoint to read the attributes of a default category. operationId: readDefaultCategory parameters: - - description: The unique id for a `category`. - example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 - in: path - name: category_guid - required: true - schema: - type: string + - description: The unique id for a `category`. + example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 + in: path + name: category_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -2974,90 +2969,87 @@ paths: description: OK summary: Read a default category tags: - - mx_platform + - mx_platform "/institutions": get: - description: - This endpoint returns a list of institutions based on the specified + description: This endpoint returns a list of institutions based on the specified search term or parameter. operationId: listInstitutions parameters: - - description: - This will list only institutions in which the appended string - appears. - example: chase - in: query - name: name - 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: Filter only institutions which support account identification. - example: true - in: query - name: supports_account_identification - schema: - type: boolean - - description: Filter only institutions which support account statements. - example: true - in: query - name: supports_account_statement - schema: - type: boolean - - description: Filter only institutions which support account verification. - example: true - in: query - name: supports_account_verification - schema: - type: boolean - - description: Filter only institutions which support extended transaction history. - example: true - in: query - name: supports_transaction_history - schema: - type: boolean - responses: - "200": - content: - application/vnd.mx.api.v1+json: - schema: - "$ref": "#/components/schemas/InstitutionsResponseBody" - description: OK - summary: List institutions - tags: - - mx_platform - "/institutions/favorites": - get: - description: - This endpoint returns a paginated list containing institutions + - description: This will list only institutions in which the appended string + appears. + example: chase + in: query + name: name + 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: Filter only institutions which support account identification. + example: true + in: query + name: supports_account_identification + schema: + type: boolean + - description: Filter only institutions which support account statements. + example: true + in: query + name: supports_account_statement + schema: + type: boolean + - description: Filter only institutions which support account verification. + example: true + in: query + name: supports_account_verification + schema: + type: boolean + - description: Filter only institutions which support extended transaction history. + example: true + in: query + name: supports_transaction_history + schema: + type: boolean + responses: + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/InstitutionsResponseBody" + description: OK + summary: List institutions + tags: + - mx_platform + "/institutions/favorites": + get: + description: This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites. operationId: listFavoriteInstitutions parameters: - - 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: 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: @@ -3065,23 +3057,22 @@ paths: description: OK summary: List favorite institutions tags: - - mx_platform + - mx_platform "/institutions/{institution_code}": get: - description: - This endpoint returns information about the institution specified + description: This endpoint returns information about the institution specified by `institution_code`. operationId: readInstitution parameters: - - description: The institution_code of the institution. - example: chase - in: path - name: institution_code - required: true - schema: - type: string + - description: The institution_code of the institution. + example: chase + in: path + name: institution_code + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3089,35 +3080,34 @@ paths: description: OK summary: Read institution tags: - - mx_platform + - mx_platform "/institutions/{institution_code}/credentials": get: - description: - Use this endpoint to see which credentials will be needed to create + description: Use this endpoint to see which credentials will be needed to create a member for a specific institution. operationId: listInstitutionCredentials parameters: - - description: The institution_code of the institution. - example: chase - in: path - name: institution_code - 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 institution_code of the institution. + example: chase + in: path + name: institution_code + 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: @@ -3125,28 +3115,27 @@ paths: description: OK summary: List institution credentials tags: - - mx_platform + - mx_platform "/managed_institutions": get: - description: - This endpoint returns a list of institutions which can be used + description: This endpoint returns a list of institutions which can be used to create partner-managed members. operationId: listManagedInstitutions parameters: - - 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: 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: @@ -3154,21 +3143,21 @@ paths: description: OK summary: List managed institutions tags: - - mx_platform + - mx_platform "/merchant_locations/{merchant_location_guid}": get: description: This endpoint returns the specified merchant_location resource. operationId: readMerchantLocation parameters: - - description: The unique id for a `merchant_location`. - example: MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621 - in: path - name: merchant_location_guid - required: true - schema: - type: string + - description: The unique id for a `merchant_location`. + example: MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621 + in: path + name: merchant_location_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3176,28 +3165,27 @@ paths: description: OK summary: Read merchant location tags: - - mx_platform + - mx_platform "/merchants": get: - description: - This endpoint returns a paginated list of all the merchants in + description: This endpoint returns a paginated list of all the merchants in the MX system. operationId: listMerchants parameters: - - 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: 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: @@ -3205,23 +3193,22 @@ paths: description: OK summary: List merchants tags: - - mx_platform + - mx_platform "/merchants/{merchant_guid}": get: - description: - Returns information about a particular merchant, such as a logo, + description: Returns information about a particular merchant, such as a logo, name, and website. operationId: readMerchant parameters: - - description: The unique id for a `merchant`. - example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b - in: path - name: merchant_guid - required: true - schema: - type: string + - description: The unique id for a `merchant`. + example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b + in: path + name: merchant_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3229,11 +3216,10 @@ paths: description: OK summary: Read merchant tags: - - mx_platform + - mx_platform "/payment_processor_authorization_code": post: - description: - "(This endpoint is deprecated. Clients should use `/authorization_code`.) + description: "(This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account @@ -3248,7 +3234,7 @@ paths: description: The scope for the authorization code. required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3256,11 +3242,10 @@ paths: description: OK summary: "(Deprecated) Request an authorization code." tags: - - mx_platform + - mx_platform "/transactions/enhance": post: - description: - Use this endpoint to categorize, cleanse, and classify transactions. + description: Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. operationId: enhanceTransactions requestBody: @@ -3271,7 +3256,7 @@ paths: description: Transaction object to be enhanced required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3279,46 +3264,45 @@ paths: description: OK summary: Enhance transactions tags: - - mx_platform + - mx_platform "/users": get: - description: - Use this endpoint to list every user you've created in the MX Platform + description: Use this endpoint to list every user you've created in the MX Platform API. operationId: listUsers parameters: - - 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 user `id` to search for. - example: u-12324-abdc - in: query - name: id - schema: - type: string - - description: The user `email` to search for. - example: example@example.com - in: query - name: email - schema: - type: string - - description: Search for users that are diabled. - example: true - in: query - name: is_disabled - schema: - type: boolean + - 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 user `id` to search for. + example: u-12324-abdc + in: query + name: id + schema: + type: string + - description: The user `email` to search for. + example: example@example.com + in: query + name: email + schema: + type: string + - description: Search for users that are diabled. + example: true + in: query + name: is_disabled + schema: + type: boolean responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3326,10 +3310,9 @@ paths: description: OK summary: List users tags: - - mx_platform + - mx_platform post: - description: - Use this endpoint to create a new user. The API will respond with + description: Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no @@ -3340,12 +3323,11 @@ paths: application/json: schema: "$ref": "#/components/schemas/UserCreateRequestBody" - description: - User object to be created. (None of these parameters are required, + description: User object to be created. (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: @@ -3353,40 +3335,39 @@ paths: description: OK summary: Create user tags: - - mx_platform + - mx_platform "/users/{user_guid}": delete: - description: - Use this endpoint to delete the specified `user`. The response + description: Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. operationId: deleteUser parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete user tags: - - mx_platform + - mx_platform get: description: Use this endpoint to read the attributes of a specific user. operationId: readUser parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `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: @@ -3394,29 +3375,28 @@ paths: description: OK summary: Read user tags: - - mx_platform + - mx_platform put: description: Use this endpoint to update the attributes of the specified user. operationId: updateUser parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/UserUpdateRequestBody" - description: - User object to be updated (None of these parameters are required, + description: User object 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: @@ -3424,47 +3404,46 @@ paths: description: OK summary: Update user tags: - - mx_platform + - mx_platform "/users/{user_guid}/accounts": get: - description: - This endpoint returns a list of all the accounts associated with + description: This endpoint returns a list of all the accounts associated with the specified `user`. operationId: listUserAccounts parameters: - - description: List only accounts whose member is managed by the user. - example: true - in: query - name: member_is_managed_by_user - schema: - type: boolean - - description: Specify current page. - example: 1 - in: query - name: page - schema: - type: integer - - description: List only accounts that were manually created. - example: true - in: query - name: is_manual - schema: - type: boolean - - description: Specify records per page. - example: 10 - in: query - name: records_per_page - schema: - type: integer - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: List only accounts whose member is managed by the user. + example: true + in: query + name: member_is_managed_by_user + schema: + type: boolean + - description: Specify current page. + example: 1 + in: query + name: page + schema: + type: integer + - description: List only accounts that were manually created. + example: true + in: query + name: is_manual + schema: + type: boolean + - description: Specify records per page. + example: 10 + in: query + name: records_per_page + schema: + type: integer + - description: The unique id for a `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: @@ -3472,18 +3451,21 @@ paths: description: OK summary: List accounts tags: - - mx_platform + - mx_platform post: - description: This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed. + description: This endpoint can only be used to create manual accounts. Creating + a manual account will automatically create it under the Manual Institution + member. Since a manual account has no credentials tied to the member, the + account will never aggregate or include data from a data feed. operationId: createManualAccount parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -3492,7 +3474,7 @@ paths: description: Manual account object to be created. required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3500,97 +3482,95 @@ paths: description: OK summary: Create manual account tags: - - mx_platform + - mx_platform "/users/{user_guid}/accounts/{account_guid}": delete: 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: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No content. summary: Delete manual account tags: - - mx_platform + - 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`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - responses: - "200": - content: + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + responses: + '200': + content: application/vnd.mx.api.v1+json: schema: "$ref": "#/components/schemas/AccountResponseBody" description: OK summary: Read account tags: - - mx_platform + - mx_platform "/users/{user_guid}/accounts/{account_guid}/account_numbers": get: - description: - This endpoint returns a list of account numbers associated with + description: This endpoint returns a list of account numbers associated with the specified `account`. operationId: listAccountNumbersByAccount parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + 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 a `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: @@ -3598,54 +3578,53 @@ paths: description: OK summary: List account numbers by account tags: - - mx_platform + - mx_platform "/users/{user_guid}/accounts/{account_guid}/holdings": get: - description: - This endpoint returns all holdings associated with the specified + description: This endpoint returns all holdings associated with the specified `account`. operationId: listHoldingsByAccount 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: Filter holdings from this date. - example: "2015-09-20" - in: query - name: from_date - 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: Filter holdings to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - 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: Filter holdings from this date. + example: '2015-09-20' + in: query + name: from_date + 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: Filter holdings to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - 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: @@ -3653,10 +3632,11 @@ paths: description: OK summary: List holdings by account tags: - - mx_platform + - mx_platform "/users/{user_guid}/accounts/{account_guid}/insights": get: - description: Use this endpoint to list all insights associated with a specified account GUID. + description: Use this endpoint to list all insights associated with a specified + account GUID. operationId: listInsightsByAccount parameters: - description: The unique id for the `account`. @@ -3697,51 +3677,50 @@ paths: - insights "/users/{user_guid}/accounts/{account_guid}/transactions": get: - description: - This endpoint returns a list of the last 90 days of transactions + description: This endpoint returns a list of the last 90 days of transactions associated with the specified account. operationId: listTransactionsByAccount parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: Filter transactions from this date. - example: "2015-09-20" - in: query - name: from_date - 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: Filter transactions to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: Filter transactions from this date. + example: '2015-09-20' + in: query + name: from_date + 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: Filter transactions to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `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: @@ -3749,35 +3728,34 @@ paths: description: OK summary: List transactions by account tags: - - mx_platform + - mx_platform "/users/{user_guid}/categories": get: - description: - Use this endpoint to list all categories associated with a `user`, + description: Use this endpoint to list all categories associated with a `user`, including both default and custom categories. operationId: listCategories parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -3785,20 +3763,19 @@ paths: description: OK summary: List categories tags: - - mx_platform + - mx_platform post: - description: - Use this endpoint to create a new custom category for a specific + description: Use this endpoint to create a new custom category for a specific `user`. operationId: createCategory parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -3807,7 +3784,7 @@ paths: description: Custom category object to be created required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3815,11 +3792,10 @@ paths: description: OK summary: Create category tags: - - mx_platform + - mx_platform "/users/{user_guid}/categories/default": get: - description: - Use this endpoint to retrieve a list of all the default categories + description: Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. @@ -3827,27 +3803,27 @@ paths: return the same results. The different routes are provided for convenience. operationId: listDefaultCategoriesByUser parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -3855,57 +3831,55 @@ paths: description: OK summary: List default categories by user tags: - - mx_platform + - mx_platform "/users/{user_guid}/categories/{category_guid}": delete: - description: - Use this endpoint to delete a specific custom category according + description: Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`. operationId: deleteCategory parameters: - - description: The unique id for a `category`. - example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 - in: path - name: category_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `category`. + example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 + in: path + name: category_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete category tags: - - mx_platform + - mx_platform get: - description: - Use this endpoint to read the attributes of either a default category + description: Use this endpoint to read the attributes of either a default category or a custom category. operationId: readCategory parameters: - - description: The unique id for a `category`. - example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 - in: path - name: category_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `category`. + example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 + in: path + name: category_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -3913,38 +3887,36 @@ paths: description: OK summary: Read a custom category tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the attributes of a custom category + description: Use this endpoint to update the attributes of a custom category according to its unique GUID. operationId: updateCategory parameters: - - description: The unique id for a `category`. - example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 - in: path - name: category_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `category`. + example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874 + in: path + name: category_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/CategoryUpdateRequestBody" - description: - Category object to be updated (While no single parameter is required, + description: Category object to be updated (While no single parameter is required, the `category` object cannot be empty) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3952,32 +3924,30 @@ paths: description: OK summary: Update category tags: - - mx_platform + - mx_platform "/users/{user_guid}/connect_widget_url": post: - description: - This endpoint will return a URL for an embeddable version of MX + description: This endpoint will return a URL for an embeddable version of MX Connect. operationId: requestConnectWidgetURL parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/ConnectWidgetRequestBody" - description: - Optional config options for WebView (is_mobile_webview, current_institution_code, + description: Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -3985,76 +3955,75 @@ paths: description: OK summary: Request connect widget url tags: - - mx_platform + - mx_platform "/users/{user_guid}/holdings": get: - description: - This endpoint returns all holdings associated with the specified + description: This endpoint returns all holdings associated with the specified `user` across all accounts and members. operationId: listHoldings parameters: - - description: Filter holdings from this date. - example: "2015-09-20" - in: query - name: from_date - 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: Filter holdings to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - responses: - "200": - content: - application/vnd.mx.api.v1+json: - schema: - "$ref": "#/components/schemas/HoldingsResponseBody" - description: OK - summary: List holdings - tags: - - mx_platform - "/users/{user_guid}/holdings/{holding_guid}": - get: - description: Use this endpoint to read the attributes of a specific `holding`. - operationId: readHolding - parameters: - - description: The unique id for a `holding`. - example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2 - in: path - name: holding_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: Filter holdings from this date. + example: '2015-09-20' + in: query + name: from_date + 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: Filter holdings to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + responses: + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/HoldingsResponseBody" + description: OK + summary: List holdings + tags: + - mx_platform + "/users/{user_guid}/holdings/{holding_guid}": + get: + description: Use this endpoint to read the attributes of a specific `holding`. + operationId: readHolding + parameters: + - description: The unique id for a `holding`. + example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2 + in: path + name: holding_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -4062,7 +4031,7 @@ paths: description: OK summary: Read holding tags: - - mx_platform + - mx_platform "/users/{user_guid}/insights": get: description: Use this endpoint to list all the insights associated with the @@ -4097,11 +4066,12 @@ paths: description: OK summary: List all insights for a user. tags: - - insights - "/users/{user_guid}/insights/{insight_guid}/categories": + - insights + "/users/{user_guid}/insights/{insight_guid}/accounts": get: - description: Use this endpoint to list all the categories associated with the insight. - operationId: listCategoriesInsight + 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 @@ -4134,16 +4104,16 @@ paths: content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/CategoriesResponseBody" + "$ref": "#/components/schemas/AccountsResponseBody" description: OK - summary: List all categories associated with an insight. + summary: List all accounts associated with an insight. tags: - insights - "/users/{user_guid}/insights/{insight_guid}/accounts": + "/users/{user_guid}/insights/{insight_guid}/categories": get: - description: Use this endpoint to list all the accounts associated with the + description: Use this endpoint to list all the categories associated with the insight. - operationId: listAccountsInsight + operationId: listCategoriesInsight parameters: - description: The unique identifier for the user. Defined by MX. example: USR-1234-abcd @@ -4176,9 +4146,9 @@ paths: content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/AccountsResponseBody" + "$ref": "#/components/schemas/CategoriesResponseBody" description: OK - summary: List all accounts associated with an insight. + summary: List all categories associated with an insight. tags: - insights "/users/{user_guid}/insights/{insight_guid}/merchants": @@ -4225,7 +4195,8 @@ paths: - insights "/users/{user_guid}/insights/{insight_guid}/scheduled_payments": get: - description: Use this endpoint to list all the scheduled payments associated with the insight. + 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. @@ -4372,35 +4343,34 @@ paths: description: OK summary: Update insight tags: - - insights + - insights "/users/{user_guid}/managed_members": get: - description: - This endpoint returns a list of all the partner-managed members + description: This endpoint returns a list of all the partner-managed members associated with the specified `user`. operationId: listManagedMembers parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -4408,18 +4378,18 @@ paths: description: OK summary: List managed members tags: - - mx_platform + - mx_platform post: description: Use this endpoint to create a new partner-managed `member`. operationId: createManagedMember parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -4428,7 +4398,7 @@ paths: description: Managed member to be created. required: true responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -4436,56 +4406,54 @@ paths: description: OK summary: Create managed member tags: - - mx_platform + - mx_platform "/users/{user_guid}/managed_members/{member_guid}": delete: - description: - Use this endpoint to delete the specified partner-managed `member`. + description: Use this endpoint to delete the specified partner-managed `member`. The endpoint will respond with a status of `204 No Content` without a resource. operationId: deleteManagedMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete managed member tags: - - mx_platform + - mx_platform get: - description: - This endpoint returns the attributes of the specified partner-managed + description: This endpoint returns the attributes of the specified partner-managed `member`. operationId: readManagedMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -4493,38 +4461,36 @@ paths: description: OK summary: Read managed member tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the attributes of the specified partner_managed + description: Use this endpoint to update the attributes of the specified partner_managed `member`. operationId: updateManagedMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/ManagedMemberUpdateRequestBody" - description: - Managed member object to be updated (While no single parameter + description: Managed member object to be updated (While no single parameter is required, the request body can't be empty) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -4532,42 +4498,41 @@ paths: description: OK summary: Update managed member tags: - - mx_platform + - mx_platform "/users/{user_guid}/managed_members/{member_guid}/accounts": get: - description: - Use this endpoint to retrieve a list of all the partner-managed + description: Use this endpoint to retrieve a list of all the partner-managed accounts associated with the given partner-manage member. operationId: listManagedAccounts parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -4575,25 +4540,25 @@ paths: description: OK summary: List managed accounts tags: - - mx_platform + - mx_platform post: description: Use this endpoint to create a partner-managed account. operationId: createManagedAccount parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -4602,7 +4567,7 @@ paths: description: Managed account to be created. required: true responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -4610,71 +4575,69 @@ paths: description: OK summary: Create managed account tags: - - mx_platform + - mx_platform "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}": delete: - description: - Use this endpoint to delete a partner-managed account according + description: Use this endpoint to delete a partner-managed account according to its unique GUID. If successful, the API will respond with a status of `204 No Content`. operationId: deleteManagedAccount parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete managed account tags: - - mx_platform + - mx_platform get: - description: - Use this endpoint to read the attributes of a partner-managed account + description: Use this endpoint to read the attributes of a partner-managed account according to its unique guid. operationId: readManagedAccount parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -4682,45 +4645,43 @@ paths: description: OK summary: Read managed account tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the attributes of a partner-managed + description: Use this endpoint to update the attributes of a partner-managed account according to its unique GUID. operationId: updateManagedAccount parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/ManagedAccountUpdateRequestBody" - description: - Managed account object to be updated (While no single parameter + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/ManagedAccountUpdateRequestBody" + description: Managed account object to be updated (While no single parameter is required, the request body can't be empty) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -4728,49 +4689,48 @@ paths: description: OK summary: Update managed account tags: - - mx_platform - ? "/users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions" - : get: - description: - This endpoint returns a list of all the partner-managed transactions + - mx_platform + "/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`. operationId: listManagedTransactions parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -4778,32 +4738,32 @@ paths: description: OK summary: List managed transactions tags: - - mx_platform + - mx_platform post: description: Use this endpoint to create a new partner-managed `transaction`. operationId: createManagedTransaction parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -4812,7 +4772,7 @@ paths: description: Managed transaction to be created. required: true responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -4820,84 +4780,82 @@ paths: description: OK summary: Create managed transaction tags: - - mx_platform - ? "/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`. + - mx_platform + "/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. operationId: deleteManagedTransaction parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `transaction`. - example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 - in: path - name: transaction_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `transaction`. + example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 + in: path + name: transaction_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete managed transaction tags: - - mx_platform + - mx_platform get: - description: - Requests to this endpoint will return the attributes of the specified + description: Requests to this endpoint will return the attributes of the specified partner-managed `transaction`. operationId: readManagedTransaction parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `transaction`. - example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 - in: path - name: transaction_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `transaction`. + example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 + in: path + name: transaction_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -4905,52 +4863,50 @@ paths: description: OK summary: Read managed transaction tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the attributes of the specified partner_managed + description: Use this endpoint to update the attributes of the specified partner_managed `transaction`. operationId: updateManagedTransaction parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `transaction`. - example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 - in: path - name: transaction_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `transaction`. + example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 + in: path + name: transaction_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/ManagedTransactionUpdateRequestBody" - description: - Managed transaction object to be updated (While no single parameter + description: Managed transaction object to be updated (While no single parameter is required, the request body can't be empty) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -4958,35 +4914,34 @@ paths: description: OK summary: Update managed transaction tags: - - mx_platform + - mx_platform "/users/{user_guid}/members": get: - description: - This endpoint returns an array which contains information on every + description: This endpoint returns an array which contains information on every member associated with a specific user. operationId: listMembers parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -4994,10 +4949,9 @@ paths: description: OK summary: List members tags: - - mx_platform + - mx_platform post: - description: - This endpoint allows you to create a new member. Members are created + description: This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided @@ -5008,24 +4962,23 @@ paths: and transactions. operationId: createMember parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/MemberCreateRequestBody" - description: - Member object to be created with optional parameters (id and + description: Member object to be created with optional parameters (id and metadata) and required parameters (credentials and institution_code) required: true responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5033,52 +4986,52 @@ paths: description: Accepted summary: Create member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}": delete: description: Accessing this endpoint will permanently delete a member. operationId: deleteMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete member tags: - - mx_platform + - mx_platform get: description: Use this endpoint to read the attributes of a specific member. operationId: readMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -5086,39 +5039,37 @@ paths: description: OK summary: Read member tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update a members attributes. Only the credentials, + description: Use this endpoint to update a members attributes. Only the credentials, id, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint. operationId: updateMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/MemberUpdateRequestBody" - description: - Member object to be updated (While no single parameter is required, + description: Member object to be updated (While no single parameter is required, the request body can't be empty) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -5126,42 +5077,41 @@ paths: description: OK summary: Update member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/account_numbers": get: - description: - This endpoint returns a list of account numbers associated with + description: This endpoint returns a list of account numbers associated with the specified `member`. operationId: listAccountNumbersByMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5169,42 +5119,41 @@ paths: description: OK summary: List account numbers by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/account_owners": get: - description: - This endpoint returns an array with information about every account + description: This endpoint returns an array with information about every account associated with a particular member. operationId: listAccountOwnersByMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5212,48 +5161,47 @@ paths: description: OK summary: List account owners by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/accounts": get: - description: - This endpoint returns a list of all the accounts associated with + description: This endpoint returns a list of all the accounts associated with the specified `member`. operationId: listMemberAccounts parameters: - - description: List only accounts whose member is managed by the user. - example: true - in: query - name: member_is_managed_by_user - schema: - type: boolean - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string + - description: List only accounts whose member is managed by the user. + example: true + in: query + name: member_is_managed_by_user + schema: + type: boolean + - 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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -5261,37 +5209,36 @@ paths: description: OK summary: List accounts by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/accounts/{account_guid}": get: - description: - This endpoint allows you to read the attributes of an `account` + description: This endpoint allows you to read the attributes of an `account` resource. operationId: readAccountByMember parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -5299,34 +5246,33 @@ paths: description: OK summary: Read account by member tags: - - mx_platform + - mx_platform put: - description: - This endpoint allows you to update certain attributes of an `account` + description: This endpoint allows you to update certain attributes of an `account` resource. operationId: updateAccountByMember parameters: - - description: The unique id for an `account`. - example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: account_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for an `account`. + example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: account_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -5335,7 +5281,7 @@ paths: description: Account object to be created with optional parameters (is_hidden) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -5343,32 +5289,31 @@ paths: description: OK summary: Update account by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/aggregate": post: - description: - Calling this endpoint initiates an aggregation event for the member. + description: Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event. operationId: aggregateMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5376,11 +5321,10 @@ paths: description: Accepted summary: Aggregate member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/challenges": get: - description: - Use this endpoint for information on what multi-factor authentication + description: Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member. If the aggregation is not challenged, i.e., the member does not have a connection status of `CHALLENGED`, then code `204 No Content` will be returned. If the aggregation has been challenged, @@ -5388,34 +5332,34 @@ paths: `200 OK` will be returned - along with the corresponding credentials. operationId: listMemberChallenges parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5423,31 +5367,30 @@ paths: description: OK summary: List member challenges tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/check_balance": post: - description: - This endpoint operates much like the aggregate member endpoint + description: This endpoint operates much like the aggregate member endpoint except that it gathers only account balance information; it does not gather any transaction data. operationId: checkBalances parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5455,42 +5398,41 @@ paths: description: Accepted summary: Check balances tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/credentials": get: - description: - This endpoint returns an array which contains information on every + description: This endpoint returns an array which contains information on every non-MFA credential associated with a specific member. operationId: listMemberCredentials parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5498,32 +5440,31 @@ paths: description: OK summary: List member credentials tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/extend_history": post: - description: - Some institutions allow developers to access an extended transaction + description: Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication. operationId: extendHistory parameters: - - description: The unique identifier for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique identifier for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique identifier for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique identifier for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5531,30 +5472,29 @@ paths: description: Accepted summary: Extend history tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/fetch_statements": post: - description: - Use this endpoint to fetch the statements associated with a particular + description: Use this endpoint to fetch the statements associated with a particular member. operationId: fetchStatements parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5562,11 +5502,10 @@ paths: description: Accepted summary: Fetch statements tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/fetch_tax_documents": post: - description: - Use this endpoint to fetch (aggregate) the tax documents associated + description: Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated @@ -5575,77 +5514,76 @@ paths: a specific process for answering authentication challenges. operationId: fetchTaxDocuments parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - responses: - "202": - content: + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + responses: + '202': + content: application/vnd.mx.api.v1+json: schema: "$ref": "#/components/schemas/MemberResponseBody" description: Accepted summary: Fetch Tax Documents tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/holdings": get: - description: - This endpoint returns all holdings associated with the specified + description: This endpoint returns all holdings associated with the specified `member` across all accounts. operationId: listHoldingsByMember parameters: - - description: Filter holdings from this date. - example: "2015-09-20" - in: query - name: from_date - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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: Filter holdings to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: Filter holdings from this date. + example: '2015-09-20' + in: query + name: from_date + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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: Filter holdings to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `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: @@ -5653,30 +5591,29 @@ paths: description: OK summary: List holdings by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/identify": post: - description: - The identify endpoint begins an identification process for an already-existing + description: The identify endpoint begins an identification process for an already-existing member. operationId: identifyMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5684,69 +5621,65 @@ paths: description: Accepted summary: Identify member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/oauth_window_uri": get: - description: - This endpoint will generate an `oauth_window_uri` for the specified + description: This endpoint will generate an `oauth_window_uri` for the specified `member`. operationId: requestOAuthWindowURI parameters: - - description: - A URL that MX will redirect to at the end of OAuth with additional - query parameters. Only available with `referral_source=APP`. - example: https://mx.com - in: query - name: client_redirect_url - schema: - type: string - - description: This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. This setting is not persistent. - example: false - in: query - name: enable_app2app - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: - Must be either `BROWSER` or `APP` depending on the implementation. - Defaults to `BROWSER`. - example: APP - in: query - name: referral_source - schema: - type: string - - description: - Setting this parameter to `true` will prevent the member from - automatically aggregating after being redirected from the authorization - page. - example: false - in: query - name: skip_aggregation - schema: - type: boolean - - description: - A scheme for routing the user back to the application state they - were previously in. Only available with `referral_source=APP`. - example: mx - in: query - name: ui_message_webview_url_scheme - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: A URL that MX will redirect to at the end of OAuth with additional + query parameters. Only available with `referral_source=APP`. + example: https://mx.com + in: query + name: client_redirect_url + schema: + type: string + - description: This indicates whether OAuth app2app behavior is enabled for + institutions that support it. Defaults to `true`. This setting is not persistent. + example: false + in: query + name: enable_app2app + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: Must be either `BROWSER` or `APP` depending on the implementation. + Defaults to `BROWSER`. + example: APP + in: query + name: referral_source + schema: + type: string + - description: Setting this parameter to `true` will prevent the member from + automatically aggregating after being redirected from the authorization + page. + example: false + in: query + name: skip_aggregation + schema: + type: boolean + - description: A scheme for routing the user back to the application state they + were previously in. Only available with `referral_source=APP`. + example: mx + in: query + name: ui_message_webview_url_scheme + schema: + type: string + - description: The unique id for a `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: @@ -5754,28 +5687,27 @@ paths: description: OK summary: Request oauth window uri tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/resume": put: - description: - This endpoint answers the challenges needed when a member has been + description: This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication. operationId: resumeAggregation parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -5784,7 +5716,7 @@ paths: description: Member object with MFA challenge answers required: true responses: - "202": + '202': content: application/vnd.mx.api.v1+json: schema: @@ -5792,40 +5724,40 @@ paths: description: Accepted summary: Resume aggregation tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/statements": get: description: Use this endpoint to get an array of available statements. operationId: listStatementsByMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5833,35 +5765,35 @@ paths: description: OK summary: List statements by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/statements/{statement_guid}": get: description: Use this endpoint to read a JSON representation of the statement. operationId: readStatementByMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `statement`. - example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: statement_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `statement`. + example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: statement_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -5869,35 +5801,35 @@ paths: description: OK summary: Read statement by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf": get: description: Use this endpoint to download a specified statement PDF. operationId: downloadStatementPDF parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `statement`. - example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1 - in: path - name: statement_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `statement`. + example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1 + in: path + name: statement_guid + required: true + schema: + type: string + - description: The unique id for a `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+pdf: schema: @@ -5906,11 +5838,10 @@ paths: description: OK summary: Download statement pdf tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/status": get: - description: - This endpoint provides the status of the members most recent aggregation + description: This endpoint provides the status of the members most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member. MX has introduced new, more detailed information on the @@ -5921,22 +5852,22 @@ paths: being. operationId: readMemberStatus parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -5944,40 +5875,40 @@ paths: description: OK summary: Read member status tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/tax_documents": get: description: Use this endpoint to get a paginated list of tax documents. operationId: listTaxDocuments parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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 a `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: @@ -5985,73 +5916,72 @@ paths: description: OK summary: List Tax Documents tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}": get: description: Use this endpoint to read the attributes of the specified tax document. operationId: readTaxDocument parameters: - - description: The unique id for a `tax_document`. - example: TAX-987dfds1b-e582-15b6-60c0-358f12466b4b - in: path - name: tax_document_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - responses: - "200": - content: - application/vnd.mx.api.v1+json: - schema: - "$ref": "#/components/schemas/TaxDocumentResponseBody" - description: OK - summary: Read a Tax Document - tags: - - mx_platform - ? "/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. - operationId: downloadTaxDocument - parameters: - - description: The unique id for a `tax_document`. - example: TAX-987dfds1b-e582-15b6-60c0-358f12466b4b - in: path - name: tax_document_guid - required: true - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tax_document`. + example: TAX-987dfds1b-e582-15b6-60c0-358f12466b4b + in: path + name: tax_document_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: + "$ref": "#/components/schemas/TaxDocumentResponseBody" + description: OK + summary: Read a Tax Document + tags: + - mx_platform + "/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. + operationId: downloadTaxDocument + parameters: + - description: The unique id for a `tax_document`. + example: TAX-987dfds1b-e582-15b6-60c0-358f12466b4b + in: path + name: tax_document_guid + required: true + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + responses: + '200': content: application/vnd.mx.api.v1+pdf: schema: @@ -6060,54 +5990,53 @@ paths: description: OK summary: Download a Tax Document PDF tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/transactions": get: - description: - Requests to this endpoint return a list of transactions associated + description: Requests to this endpoint return a list of transactions associated with the specified `member`, accross all accounts associated with that `member`. operationId: listTransactionsByMember parameters: - - description: Filter transactions from this date. - example: "2015-09-20" - in: query - name: from_date - schema: - type: string - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_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: Filter transactions to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: Filter transactions from this date. + example: '2015-09-20' + in: query + name: from_date + schema: + type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_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: Filter transactions to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `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: @@ -6115,28 +6044,28 @@ paths: description: OK summary: List transactions by member tags: - - mx_platform + - mx_platform "/users/{user_guid}/members/{member_guid}/verify": post: description: The verify endpoint begins a verification process for a member. operationId: verifyMember parameters: - - description: The unique id for a `member`. - example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b - in: path - name: member_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `member`. + example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b + in: path + name: member_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -6144,288 +6073,320 @@ paths: description: OK summary: Verify member tags: - - mx_platform - ? "/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 + - mx_platform + "/users/{user_guid}/spending_plans": + get: + description: Use this endpoint to list all the spending plans associated with + the user. + operationId: listSpendingPlans parameters: - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/SpendingPlanIterationItemCreateRequestBody" - description: Iteration item to be created with required parameter (planned_amount) + - 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 a `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: - "$ref": "#/components/schemas/SpendingPlanIterationItemResponse" + "$ref": "#/components/schemas/SpendingPlansResponseBody" description: OK - summary: Create spending plan iteration item + summary: List spending plans tags: - - spending plan - get: - description: Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`. - operationId: listSpendingPlanIterationItems + - spending plan + post: + description: This endpoint creates a new `spending_plan` for the user. + operationId: createSpendingPlan parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string + - description: The unique id for a `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: - "$ref": "#/components/schemas/SpendingPlanIterationItemsResponseBody" + "$ref": "#/components/schemas/SpendingPlanResponse" description: OK - summary: List spending plan iteration items + summary: Create spending plan tags: - - spending plan - "/users/{user_guid}/spending_plans": - post: - description: This endpoint creates a new `spending_plan` for the user. - operationId: createSpendingPlan + - spending plan + "/users/{user_guid}/spending_plans/{spending_plan_guid}": + delete: + description: Use this endpoint to delete a user's `spending_plan`. + operationId: deleteSpendingPlan parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique ID for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string responses: - "200": + '204': + description: No Content + summary: Delete spending plan + tags: + - spending plan + get: + description: Use this endpoint to read the attributes of a specific spending + plan according to its unique GUID. + operationId: readSpendingPlanUser + parameters: + - 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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + responses: + '200': content: application/vnd.mx.api.v1+json: schema: "$ref": "#/components/schemas/SpendingPlanResponse" description: OK - summary: Create spending plan + summary: Read a spending plan for a user tags: - - spending plan + - spending plan + "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations": get: - description: Use this endpoint to list all the spending plans associated with the user. - operationId: listSpendingPlans + description: Use this endpoint to list all the spending plan `iterations` associated + with the `spending_plan`. + operationId: listSpendingPlanIterations parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/SpendingPlansResponseBody" + "$ref": "#/components/schemas/SpendingPlanIterationsResponse" description: OK - summary: List spending plans + summary: List spending plan iterations tags: - - spending plan - ? "/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 + - spending plan + "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items": + get: + description: Use this endpoint to list all the spending plan `iteration_items` + associated with the `iteration`. + operationId: listSpendingPlanIterationItems parameters: - - description: The unique ID for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique ID for the specified account. - example: ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c - in: path - name: spending_plan_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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string responses: - "204": - description: No Content - summary: Delete spending plan account + '200': + content: + application/vnd.mx.api.v1+json: + schema: + "$ref": "#/components/schemas/SpendingPlanIterationItemsResponseBody" + description: OK + summary: List spending plan iteration items tags: - - spending plan - get: - description: Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID. - operationId: readSpendingPlanAccount + - spending plan + post: + description: This endpoint creates a new `spending_plan_iteration_item`. + operationId: createSpendingPlanIterationItem parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique ID for the specified account. - example: ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c - in: path - name: spending_plan_account_guid - required: true - schema: - type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/SpendingPlanIterationItemCreateRequestBody" + description: Iteration item to be created with required parameter (planned_amount) + required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/SpendingPlanAccountResponse" + "$ref": "#/components/schemas/SpendingPlanIterationItemResponse" description: OK - summary: Read spending plan account + summary: Create spending plan iteration item tags: - - spending plan - ? "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}" - : delete: + - spending plan + "/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: - - description: The unique ID for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique ID for the `iteration_item`. - example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 - in: path - name: iteration_item_guid - required: true - schema: - type: string + - description: The unique ID for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique ID for the `iteration_item`. + example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 + in: path + name: iteration_item_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete spending plan iteration item tags: - - spending plan + - spending plan get: - description: Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID. + description: Use this endpoint to read the attributes of a specific spending + plan `iteration_item` according to its unique GUID. operationId: readSpendingPlanIterationItem parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique ID for the `iteration_item`. - example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 - in: path - name: iteration_item_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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique ID for the `iteration_item`. + example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 + in: path + name: iteration_item_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6433,32 +6394,32 @@ paths: description: OK summary: Read a spending plan iteration item tags: - - spending plan + - spending plan put: description: Use this endpoint to update an existing `spending_plan_iteration_item`. operationId: updateSpendingPlanIterationItem parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The unique ID for the `iteration_item`. - example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 - in: path - name: iteration_item_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique ID for the `iteration_item`. + example: SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3 + in: path + name: iteration_item_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -6467,7 +6428,7 @@ paths: description: Iteration item to be updated with required parameter (planned_amount) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6475,105 +6436,90 @@ paths: description: OK summary: Update a spending plan iteration item tags: - - spending plan - "/users/{user_guid}/spending_plans/{spending_plan_guid}": - delete: - description: Use this endpoint to delete a user's `spending_plan`. - operationId: deleteSpendingPlan - parameters: - - description: The unique ID for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - responses: - "204": - description: No Content - summary: Delete spending plan - tags: - - spending plan + - spending plan + "/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 according to its unique GUID. - operationId: readSpendingPlanUser + description: Use this endpoint to read the attributes of a specific spending + plan `iteration` according to its `iteration_number`. + operationId: readSpendingPlanIteration parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The current iteration number for the spending plan `iteration``. + example: 1 + in: path + name: iteration_number + required: true + schema: + type: integer responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/SpendingPlanResponse" + "$ref": "#/components/schemas/SpendingPlanIterationResponse" description: OK - summary: Read a spending plan for a user + summary: Read a spending plan iteration tags: - - spending plan - ? "/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. + - spending plan + "/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: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6581,124 +6527,114 @@ paths: description: OK summary: List spending plan accounts tags: - - spending plan - "/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations": - get: - description: Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`. - operationId: listSpendingPlanIterations + - spending plan + "/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: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string + - description: The unique ID for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique ID for the specified account. + example: ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c + in: path + name: spending_plan_account_guid + required: true + schema: + type: string responses: - "200": - content: - application/vnd.mx.api.v1+json: - schema: - "$ref": "#/components/schemas/SpendingPlanIterationsResponse" - description: OK - summary: List spending plan iterations + '204': + description: No Content + summary: Delete spending plan account tags: - - spending plan - ? "/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 + - spending plan + get: + description: Use this endpoint to read the attributes of a specific spending + plan account according to its unique GUID. + operationId: readSpendingPlanAccount parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string - - description: The unique ID for the `spending_plan`. - example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 - in: path - name: spending_plan_guid - required: true - schema: - type: string - - description: The current iteration number for the spending plan `iteration``. - example: 1 - in: path - name: iteration_number - required: true - schema: - type: integer + - 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 a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string + - description: The unique ID for the `spending_plan`. + example: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262 + in: path + name: spending_plan_guid + required: true + schema: + type: string + - description: The unique ID for the specified account. + example: ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c + in: path + name: spending_plan_account_guid + required: true + schema: + type: string responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: - "$ref": "#/components/schemas/SpendingPlanIterationResponse" + "$ref": "#/components/schemas/SpendingPlanAccountResponse" description: OK - summary: Read a spending plan iteration + summary: Read spending plan account tags: - - spending plan + - spending plan "/users/{user_guid}/taggings": get: - description: - Use this endpoint to retrieve a list of all the taggings associated + description: Use this endpoint to retrieve a list of all the taggings associated with a specific user. operationId: listTaggings parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -6706,31 +6642,29 @@ paths: description: OK summary: List taggings tags: - - mx_platform + - mx_platform post: - description: - Use this endpoint to create a new association between a tag and + description: Use this endpoint to create a new association between a tag and a particular transaction, according to their unique GUIDs. operationId: createTagging parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/TaggingCreateRequestBody" - description: - Tagging object to be created with required parameters (tag_guid + description: Tagging object to be created with required parameters (tag_guid and transaction_guid) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6738,57 +6672,55 @@ paths: description: Accepted summary: Create tagging tags: - - mx_platform + - mx_platform "/users/{user_guid}/taggings/{tagging_guid}": delete: - description: - Use this endpoint to delete a tagging according to its unique GUID. + description: Use this endpoint to delete a tagging according to its unique GUID. If successful, the API will respond with an empty body and a status of 204 NO Content. operationId: deleteTagging parameters: - - description: The unique id for a `tagging`. - example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe - in: path - name: tagging_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tagging`. + example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe + in: path + name: tagging_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete tagging tags: - - mx_platform + - mx_platform get: - description: - Use this endpoint to read the attributes of a `tagging` according + description: Use this endpoint to read the attributes of a `tagging` according to its unique GUID. operationId: readTagging parameters: - - description: The unique id for a `tagging`. - example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe - in: path - name: tagging_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tagging`. + example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe + in: path + name: tagging_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -6796,25 +6728,25 @@ paths: description: OK summary: Read tagging tags: - - mx_platform + - mx_platform put: description: Use this endpoint to update a tagging. operationId: updateTagging parameters: - - description: The unique id for a `tagging`. - example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe - in: path - name: tagging_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tagging`. + example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe + in: path + name: tagging_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -6823,7 +6755,7 @@ paths: description: Tagging object to be updated with required parameter (tag_guid) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6831,35 +6763,34 @@ paths: description: OK summary: Update tagging tags: - - mx_platform + - mx_platform "/users/{user_guid}/tags": get: - description: - Use this endpoint to list all tags associated with the specified + description: Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default. operationId: listTags parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -6867,18 +6798,18 @@ paths: description: OK summary: List tags tags: - - mx_platform + - mx_platform post: description: Use this endpoint to create a new custom tag. operationId: createTag parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -6887,7 +6818,7 @@ paths: description: Tag object to be created with required parameters (tag_guid) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6895,57 +6826,55 @@ paths: description: OK summary: Create tag tags: - - mx_platform + - mx_platform "/users/{user_guid}/tags/{tag_guid}": delete: - description: - Use this endpoint to permanently delete a specific tag based on + description: Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`. operationId: deleteTag parameters: - - description: The unique id for a `tag`. - example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 - in: path - name: tag_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tag`. + example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 + in: path + name: tag_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete tag tags: - - mx_platform + - mx_platform get: - description: - Use this endpoint to read the attributes of a particular tag according + description: Use this endpoint to read the attributes of a particular tag according to its unique GUID. operationId: readTag parameters: - - description: The unique id for a `tag`. - example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 - in: path - name: tag_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tag`. + example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 + in: path + name: tag_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -6953,27 +6882,26 @@ paths: description: OK summary: Read tag tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the name of a specific tag according + description: Use this endpoint to update the name of a specific tag according to its unique GUID. operationId: updateTag parameters: - - description: The unique id for a `tag`. - example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 - in: path - name: tag_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `tag`. + example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 + in: path + name: tag_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -6982,7 +6910,7 @@ paths: description: Tag object to be updated with required parameter (tag_guid) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -6990,56 +6918,55 @@ paths: description: OK summary: Update tag tags: - - mx_platform + - mx_platform "/users/{user_guid}/tags/{tag_guid}/transactions": get: - description: - Use this endpoint to get a list of all transactions associated + description: Use this endpoint to get a list of all transactions associated with a particular tag according to the tag’s unique GUID. In other words, a list of all transactions that have been assigned to a particular tag using the create a tagging endpoint. operationId: listTransactionsByTag parameters: - - description: Filter transactions from this date. - example: "2015-09-20" - in: query - name: from_date - 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 a `tag`. - example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 - in: path - name: tag_guid - required: true - schema: - type: string - - description: Filter transactions to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: Filter transactions from this date. + example: '2015-09-20' + in: query + name: from_date + 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 a `tag`. + example: TAG-aef36e72-6294-4c38-844d-e573e80aed52 + in: path + name: tag_guid + required: true + schema: + type: string + - description: Filter transactions to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `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: @@ -7047,35 +6974,34 @@ paths: description: OK summary: List transactions by tag tags: - - mx_platform + - mx_platform "/users/{user_guid}/transaction_rules": get: - description: - Use this endpoint to read the attributes of all existing transaction + description: Use this endpoint to read the attributes of all existing transaction rules belonging to the user. operationId: listTransactionRules parameters: - - 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 a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - 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 id for a `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: @@ -7083,31 +7009,29 @@ paths: description: OK summary: List transaction rules tags: - - mx_platform + - mx_platform post: - description: - Use this endpoint to create a new transaction rule. The newly-created + description: Use this endpoint to create a new transaction rule. The newly-created `transaction_rule` object will be returned if successful. operationId: createTransactionRule parameters: - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: schema: "$ref": "#/components/schemas/TransactionRuleCreateRequestBody" - description: - TransactionRule object to be created with optional parameters + description: TransactionRule object to be created with optional parameters (description) and required parameters (category_guid and match_description) required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -7115,56 +7039,54 @@ paths: description: OK summary: Create transaction rule tags: - - mx_platform + - mx_platform "/users/{user_guid}/transaction_rules/{transaction_rule_guid}": delete: - description: - Use this endpoint to permanently delete a transaction rule based + description: Use this endpoint to permanently delete a transaction rule based on its unique GUID. operationId: deleteTransactionRule parameters: - - description: The unique id for a `transaction_rule`. - example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 - in: path - name: transaction_rule_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `transaction_rule`. + example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 + in: path + name: transaction_rule_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string responses: - "204": + '204': description: No Content summary: Delete transaction rule tags: - - mx_platform + - mx_platform get: - description: - Use this endpoint to read the attributes of an existing transaction + description: Use this endpoint to read the attributes of an existing transaction rule based on the rule’s unique GUID. operationId: readTransactionRule parameters: - - description: The unique id for a `transaction_rule`. - example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 - in: path - name: transaction_rule_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `transaction_rule`. + example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 + in: path + name: transaction_rule_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -7172,28 +7094,27 @@ paths: description: OK summary: Read transaction rule tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the attributes of a specific transaction + description: Use this endpoint to update the attributes of a specific transaction rule based on its unique GUID. The API will respond with the updated transaction_rule object. Any attributes not provided will be left unchanged. operationId: updateTransactionRule parameters: - - description: The unique id for a `transaction_rule`. - example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 - in: path - name: transaction_rule_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `transaction_rule`. + example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3 + in: path + name: transaction_rule_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -7202,7 +7123,7 @@ paths: description: TransactionRule object to be updated required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -7210,48 +7131,47 @@ paths: description: OK summary: Update transaction_rule tags: - - mx_platform + - mx_platform "/users/{user_guid}/transactions": get: - description: - Requests to this endpoint return a list of transactions associated + description: Requests to this endpoint return a list of transactions associated with the specified `user`, accross all members and accounts associated with that `user`. operationId: listTransactions parameters: - - description: Filter transactions from this date. - example: "2015-09-20" - in: query - name: from_date - 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: Filter transactions to this date. - example: "2019-10-20" - in: query - name: to_date - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: Filter transactions from this date. + example: '2015-09-20' + in: query + name: from_date + 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: Filter transactions to this date. + example: '2019-10-20' + in: query + name: to_date + schema: + type: string + - description: The unique id for a `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: @@ -7259,30 +7179,29 @@ paths: description: OK summary: List transactions tags: - - mx_platform + - mx_platform "/users/{user_guid}/transactions/{transaction_guid}": get: - description: - Requests to this endpoint will return the attributes of the specified + description: Requests to this endpoint will return the attributes of the specified `transaction`. operationId: readTransaction parameters: - - description: The unique id for a `transaction`. - example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 - in: path - name: transaction_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `transaction`. + example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 + in: path + name: transaction_guid + required: true + schema: + type: string + - description: The unique id for a `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: @@ -7290,27 +7209,26 @@ paths: description: OK summary: Read transaction tags: - - mx_platform + - mx_platform put: - description: - Use this endpoint to update the `description` of a specific transaction + description: Use this endpoint to update the `description` of a specific transaction according to its unique GUID. operationId: updateTransaction parameters: - - description: The unique id for a `transaction`. - example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 - in: path - name: transaction_guid - required: true - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The unique id for a `transaction`. + example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4 + in: path + name: transaction_guid + required: true + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -7319,7 +7237,7 @@ paths: description: Transaction object to be updated with a new description required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -7330,27 +7248,26 @@ paths: - mx_platform "/users/{user_guid}/widget_urls": post: - description: - This endpoint allows partners to get a URL by passing the `widget_type` + description: This endpoint allows partners to get a URL by passing the `widget_type` in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the `widget_type` to `connect_widget`. Partners may also pass an optional `Accept-Language` header as well as a number of configuration options. Note that this is a `POST` request. operationId: requestWidgetURL parameters: - - description: The desired language of the widget. - example: en-US - in: header - name: Accept-Language - schema: - type: string - - description: The unique id for a `user`. - example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 - in: path - name: user_guid - required: true - schema: - type: string + - description: The desired language of the widget. + example: en-US + in: header + name: Accept-Language + schema: + type: string + - description: The unique id for a `user`. + example: USR-fa7537f3-48aa-a683-a02a-b18940482f54 + in: path + name: user_guid + required: true + schema: + type: string requestBody: content: application/json: @@ -7359,7 +7276,7 @@ paths: description: The widget url configuration options. required: true responses: - "200": + '200': content: application/vnd.mx.api.v1+json: schema: @@ -7367,11 +7284,11 @@ paths: description: OK summary: Request widget url tags: - - mx_platform + - mx_platform security: - - basicAuth: [] +- basicAuth: [] servers: - - url: https://api.mx.com - - url: https://int-api.mx.com +- url: https://api.mx.com +- url: https://int-api.mx.com tags: - - name: mx_platform +- name: mx_platform