-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathmx_platform_api.yml
More file actions
8542 lines (8521 loc) · 289 KB
/
mx_platform_api.yml
File metadata and controls
8542 lines (8521 loc) · 289 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
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 aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
Just getting started? See our [use case guides](/use-cases/).
title: MX Platform API
version: '20111101'
servers:
- url: https://int-api.mx.com
- url: https://api.mx.com
security:
- basicAuth: []
tags:
- name: authorization
- name: widgets
- name: users
- name: members
- name: institutions
- name: accounts
- name: transactions
- name: microdeposits
- name: managed data
- name: transaction rules
- name: statements
- name: merchants
- name: categories
- name: insights
- name: investment holdings
- name: spending plan
- name: goals
- name: budgets
- name: monthly cash flow profile
- name: notifications
- name: taggings
- name: tags
- name: deprecated
- name: processor token
- name: verifiable credentials
- name: rewards
- name: ach return
paths:
/authorization_code:
post:
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 the scope, clients must have verified that member.
operationId: requestAuthorizationCode
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationCodeRequestBody'
description: The scope for the authorization code.
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AuthorizationCodeResponseBody'
description: OK
summary: Request an authorization code
tags:
- processor token
/ach_returns/{ach_return_guid}:
get:
description: |
:::warning
The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.
:::
Use this endpoint to get an ACH return by its `guid` or `id`.
operationId: readACHRetrun
parameters:
- $ref: '#/components/parameters/achReturnGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ACHReturnResponseBody'
description: OK
summary: Read ACH Return
tags:
- ach return
/ach_returns:
get:
description: |
:::warning
The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.
:::
Use this endpoint to get all ACH returns.
operationId: listACHRetruns
parameters:
- $ref: '#/components/parameters/institutionGuid'
- $ref: '#/components/parameters/returnedAt'
- $ref: '#/components/parameters/resolvedStatusAt'
- $ref: '#/components/parameters/returnCode'
- $ref: '#/components/parameters/returnStatus'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ACHReturnsResponseBody'
description: OK
summary: List ACH Returns
tags:
- ach return
post:
description: |
:::warning
The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change.
:::
Use this endpoint to create an ACH return in our system.
operationId: createACHReturn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ACHReturnCreateRequestBody'
description: ACH return object to be created.
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ACHReturnResponseBody'
description: OK
summary: Create ACH Return
tags:
- ach return
/categories/default:
get:
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 default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
operationId: listDefaultCategories
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoriesResponseBody'
description: OK
summary: List default categories
tags:
- categories
/categories/{category_guid}:
get:
description: Use this endpoint to read the attributes of a default category.
operationId: readDefaultCategory
parameters:
- $ref: '#/components/parameters/categoryGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoryResponseBody'
description: OK
summary: Read a default category
tags:
- categories
/institutions:
get:
description: This endpoint returns a list of institutions based on the specified search term or parameter.
operationId: listInstitutions
parameters:
- $ref: '#/components/parameters/institutionName'
- $ref: '#/components/parameters/isoCountryCode'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/supportsAccountIdentification'
- $ref: '#/components/parameters/supportsAccountStatement'
- $ref: '#/components/parameters/supportsAccountVerification'
- $ref: '#/components/parameters/supportsTransactionHistory'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InstitutionsResponseBody'
description: OK
summary: List institutions
tags:
- institutions
/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:
- $ref: '#/components/parameters/isoCountryCode'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InstitutionsResponseBody'
description: OK
summary: List favorite institutions
tags:
- institutions
/institutions/{institution_code}:
get:
description: This endpoint returns information about the institution specified by `institution_code`.
operationId: readInstitution
parameters:
- $ref: '#/components/parameters/institutionCode'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InstitutionResponseBody'
description: OK
summary: Read institution
tags:
- institutions
/institutions/{institution_code}/credentials:
get:
description: |
Use this endpoint to see which credentials will be needed to create a member for a specific institution.
Passing an invalid `institution_code` returns a `404`.
operationId: listInstitutionCredentials
parameters:
- $ref: '#/components/parameters/institutionCode'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CredentialsResponseBody'
description: OK
summary: List institution credentials
tags:
- institutions
/managed_institutions:
get:
description: This endpoint returns a list of institutions which can be used to create partner-managed members.
operationId: listManagedInstitutions
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InstitutionsResponseBody'
description: OK
summary: List managed institutions
tags:
- managed data
/merchant_locations/{merchant_location_guid}:
get:
description: This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects.
operationId: readMerchantLocation
parameters:
- $ref: '#/components/parameters/merchantLocationGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MerchantLocationResponseBody'
description: OK
summary: Read merchant location
tags:
- merchants
/merchants:
get:
description: This endpoint returns a paginated list of all the merchants in the MX system.
operationId: listMerchants
parameters:
- $ref: '#/components/parameters/merchantName'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MerchantsResponseBody'
description: OK
summary: List merchants
tags:
- merchants
/merchants/{merchant_guid}:
get:
description: Returns information about a particular merchant, such as a logo, name, and website.
operationId: readMerchant
parameters:
- $ref: '#/components/parameters/merchantGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MerchantResponseBody'
description: OK
summary: Read merchant
tags:
- merchants
/payment_processor_authorization_code:
post:
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 specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
operationId: deprecatedRequestPaymentProcessorAuthorizationCode
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentProcessorAuthorizationCodeRequestBody'
description: The scope for the authorization code.
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/PaymentProcessorAuthorizationCodeResponseBody'
description: OK
summary: (Deprecated) Request an authorization code
tags:
- processor token
/transactions/enhance:
post:
description: "Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions)."
operationId: enhanceTransactions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnhanceTransactionsRequestBody'
description: Transaction object to be enhanced
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/EnhanceTransactionsResponseBody'
description: OK
summary: Enhance transactions
tags:
- transactions
/users:
get:
description: Use this endpoint to list every user you've created in the MX Platform API.
operationId: listUsers
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userId'
- $ref: '#/components/parameters/userEmail'
- $ref: '#/components/parameters/userIsDisabled'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/UsersResponseBody'
description: OK
summary: List users
tags:
- users
post:
description: Use this endpoint to create a new user. The API will respond with the newly-created user object if successful, containing a `guid` that you'll set as the `user_guid` in other requests when required. 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 longer disabled.
operationId: createUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreateRequestBody'
description: User object to be created. (None of these parameters are required, but the user object cannot be empty)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/UserResponseBody'
description: OK
summary: Create user
tags:
- users
/users/{user_guid}:
delete:
description: |
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.
:::warning
Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects).
:::
operationId: deleteUser
parameters:
- $ref: '#/components/parameters/acceptHeader'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete user
tags:
- users
get:
description: Use this endpoint to read the attributes of a specific user.
operationId: readUser
parameters:
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/UserResponseBody'
description: OK
summary: Read user
tags:
- users
put:
description: Use this endpoint to update the attributes of the specified user.
operationId: updateUser
parameters:
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequestBody'
description: User object to be updated (None of these parameters are required, but the user object cannot be empty.)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/UserResponseBody'
description: OK
summary: Update user
tags:
- users
/users/{user_guid}/accounts:
get:
description: |
This endpoint returns a list of all the accounts associated with the specified `user`.
:::warning
This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/).
:::
operationId: listUserAccounts
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/memberIsManagedByUser'
- $ref: '#/components/parameters/accountIsManual'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/useCase'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountsResponseBody'
description: OK
summary: List accounts
tags:
- accounts
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..
operationId: createManualAccount
parameters:
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountCreateRequestBody'
description: Manual account object to be created.
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Create manual account
tags:
- accounts
/users/{user_guid}/accounts/{account_guid}:
get:
description: This endpoint returns the specified `account` resource.
operationId: readAccount
parameters:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountResponseBody'
description: OK
summary: Read account
tags:
- accounts
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:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/acceptHeader'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No content.
summary: Delete manual account
tags:
- accounts
/users/{user_guid}/accounts/{account_guid}/account_numbers:
get:
description: This endpoint returns a list of account numbers associated with the specified `account`.
operationId: listAccountNumbersByAccount
parameters:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountNumbersResponseBody'
description: OK
summary: List account numbers by account
tags:
- accounts
/users/{user_guid}/accounts/{account_guid}/insights:
get:
description: Use this endpoint to list all insights associated with an account GUID.
operationId: listInsightsByAccount
parameters:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InsightsResponseBody'
description: OK
summary: List insights by account
tags:
- insights
/users/{user_guid}/accounts/{account_guid}/transactions:
post:
operationId: createManualTransaction
tags:
- transactions
summary: Create manual transaction
description: This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/accountGuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionCreateRequestBody'
responses:
'200':
description: OK
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionCreateResponseBody'
get:
description: "Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter)."
operationId: listTransactionsByAccount
parameters:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/fromCreatedAt'
- $ref: '#/components/parameters/toCreatedAt'
- $ref: '#/components/parameters/fromUpdatedAt'
- $ref: '#/components/parameters/toUpdatedAt'
- $ref: '#/components/parameters/categoryGuidQuery'
- $ref: '#/components/parameters/categoryGuidQueryArray'
- $ref: '#/components/parameters/topLevelCategoryGuid'
- $ref: '#/components/parameters/topLevelCategoryGuidArray'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by account
tags:
- transactions
/users/{user_guid}/categories:
get:
description: Use this endpoint to list all categories associated with a `user`, including both default and custom categories.
operationId: listCategories
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoriesResponseBody'
description: OK
summary: List categories
tags:
- categories
post:
description: Use this endpoint to create a new custom category for a specific `user`.
operationId: createCategory
parameters:
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryCreateRequestBody'
description: Custom category object to be created
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoryResponseBody'
description: OK
summary: Create category
tags:
- categories
/users/{user_guid}/categories/default:
get:
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. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
operationId: listDefaultCategoriesByUser
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoriesResponseBody'
description: OK
summary: List default categories by user
tags:
- categories
/users/{user_guid}/categories/{category_guid}:
delete:
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:
- $ref: '#/components/parameters/categoryGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete category
tags:
- categories
get:
description: Use this endpoint to read the attributes of either a default category or a custom category.
operationId: readCategory
parameters:
- $ref: '#/components/parameters/categoryGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoryResponseBody'
description: OK
summary: Read a custom category
tags:
- categories
put:
description: Use this endpoint to update the attributes of a custom category according to its unique GUID.
operationId: updateCategory
parameters:
- $ref: '#/components/parameters/categoryGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryUpdateRequestBody'
description: Category object to be updated (While no single parameter is required, the `category` object cannot be empty)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoryResponseBody'
description: OK
summary: Update category
tags:
- categories
/users/{user_guid}/connect_widget_url:
post:
description: This endpoint will return a URL for an embeddable version of MX Connect.
operationId: requestConnectWidgetURL
parameters:
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectWidgetRequestBody'
description: Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ConnectWidgetResponseBody'
description: OK
summary: (Deprecated) Request connect widget URL
deprecated: true
tags:
- widgets
/users/{user_guid}/insights:
get:
description: Use this endpoint to list all the insights associated with the user.
operationId: listInsightsUser
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InsightsResponseBody'
description: OK
summary: List all insights for a user
tags:
- insights
/users/{user_guid}/insights/{insight_guid}/categories:
get:
description: Use this endpoint to list all the categories associated with the insight.
operationId: listCategoriesInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/CategoriesResponseBody'
description: OK
summary: List all categories associated with an insight
tags:
- insights
/users/{user_guid}/insights/{insight_guid}/accounts:
get:
description: Use this endpoint to list all the accounts associated with the insight.
operationId: listAccountsInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/AccountsResponseBody'
description: OK
summary: List all accounts associated with an insight
tags:
- insights
/users/{user_guid}/insights/{insight_guid}/merchants:
get:
description: Use this endpoint to list all the merchants associated with the insight.
operationId: listMerchantsInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MerchantsResponseBody'
description: OK
summary: List all merchants associated with an insight
tags:
- insights
/users/{user_guid}/insights/{insight_guid}/scheduled_payments:
get:
description: Use this endpoint to list all the scheduled payments associated with the insight.
operationId: listScheduledPaymentsInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/ScheduledPaymentsResponseBody'
description: OK
summary: List all scheduled payments associated with an insight
tags:
- insights
/users/{user_guid}/insights/{insight_guid}/transactions:
get:
description: Use this endpoint to list all the transactions associated with the insight.
operationId: listTransactionsInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPage'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBody'
description: OK
summary: List all transactions associated with an insight
tags:
- insights
/users/{user_guid}/insights/{insight_guid}:
get:
description: Use this endpoint to read the attributes of an insight according to its unique GUID.
operationId: readInsightUser
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InsightResponseBody'
description: OK
summary: Read insight
tags:
- insights
put:
description: Use this endpoint to update the attributes of an insight according to its unique GUID.
operationId: updateInsight
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/insightGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InsightUpdateRequestBody'
description: The insight to be updated (None of these parameters are required, but the user object cannot be empty.)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/InsightResponse'
description: OK
summary: Update insight
tags:
- insights
/users/{user_guid}/managed_members:
get:
description: This endpoint returns a list of all the partner-managed members associated with the specified `user`.
operationId: listManagedMembers
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MembersResponseBody'
description: OK
summary: List managed members
tags:
- managed data
post:
description: Use this endpoint to create a new partner-managed `member`.
operationId: createManagedMember
parameters:
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedMemberCreateRequestBody'
description: Managed member to be created.
required: true
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Create managed member
tags:
- managed data
/users/{user_guid}/managed_members/{member_guid}:
delete:
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:
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/acceptHeader'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete managed member
tags:
- managed data
get:
description: This endpoint returns the attributes of the specified partner-managed`member`.
operationId: readManagedMember
parameters:
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK
summary: Read managed member
tags:
- managed data
put:
description: Use this endpoint to update the attributes of the specified partner_managed `member`.
operationId: updateManagedMember
parameters:
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedMemberUpdateRequestBody'
description: Managed member object to be updated (While no single parameter is required, the request body can't be empty)
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: OK