-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
7605 lines (7605 loc) · 455 KB
/
swagger.yaml
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
---
basePath: "/"
paths:
/transactions:
get:
summary: "Get Transactions"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The Transaction service is used to get a list of transactions for a user.<br>By default, this service returns the last 30 days of transactions from today's date.<br>The search is performed on these attributes: original, consumer, and simple descriptions.<br>Values for categoryId parameter can be fetched from get transaction category list service.<br>The categoryId is used to filter transactions based on system-defined category as well as user-defined category.<br>User-defined categoryIds should be provided in the filter with the prefix \"U\". E.g. U10002 <br>The skip and top parameters are useful for paginating transactions (i.e., to fetch small transaction <br>payloads for performance reasons)<br>Double quotes in the merchant name will be prefixed by backslashes (\) in the response, <br>e.g. Toys \"R\" Us.<br><b>Note</b> <br><a href=\"https://developer.yodlee.com/Yodlee_API/Transaction_Data_Enrichment\">TDE</a> is made available for bank and card accounts and for the US market only.The address field in the response is available only when the TDE key is turned on.<br>"
operationId: "getTransactions"
responses:
200:
schema:
$ref: "#/definitions/TransactionResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for baseType<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for category<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for container<br>Y809 : Invalid date range<br>Y804 : Permitted values of top between 1 - 500<br>Y805 : Multiple containers not supported<br>Y800 : Invalid value for transaction type<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of highLevelCategoryIds permitted is 100<br>Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled<br>Y823 : detailCategoryId is not for applicable containers other than bank and card<br>Y824 : The maximum number of detailCategoryIds permitted is 100<br>Y800 : Invalid value for detailCategoryId"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "Comma separated accountIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "baseType"
description: "DEBIT/CREDIT"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryId"
description: "Comma separated categoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryType"
description: "Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "container"
description: "bank/creditCard/investment/insurance/loan"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "detailCategoryId"
description: "Comma separated detailCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "Transaction from date(YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "highLevelCategoryId"
description: "Comma separated highLevelCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "keyword"
description: "Transaction search text"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "Transaction end date (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "type"
description: "Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment"
type: "string"
required: false
tags:
- "Transactions"
/auth/apiKey/{key}:
delete:
summary: "Delete API Key"
deprecated: false
produces:
- "*/*"
description: "This endpoint allows an existing API key to be deleted.<br>You can use one of the following authorization methods to access this API:<br><ol><li>cobsession</li><li>JWT token</li></ol><b>Notes:</b><br>This service is not available in developer sandbox environment and will be made available<br>for testing in your dedicated environment. "
operationId: "deleteApiKey"
responses:
201:
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y807 : Resource not found<br>Y806 : Invalid input"
401:
description: "Unauthorized"
204:
description: "No Content"
404:
description: "Not Found"
parameters:
- in: "path"
name: "key"
description: "key"
type: "string"
required: true
tags:
- "Auth"
/cobrand/login:
post:
summary: "Cobrand Login"
deprecated: false
produces:
- "application/json"
description: "The cobrand login service authenticates a cobrand.<br>Cobrand session in the response includes the cobrand session token (cobSession) <br>which is used in subsequent API calls like registering or signing in the user. <br>The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be <br>invoked to create a new cobrand session token. <br><b>Note:</b> This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.<br>The content type has to be passed as application/json for the body parameter. <br>"
operationId: "cobrandLogin"
responses:
200:
schema:
$ref: "#/definitions/CobrandLoginResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for cobrandParam"
401:
schema:
$ref: "#/definitions/YodleeError"
description: "Y003 : Account is locked, contact Yodlee customer care<br>Y001 : User name and password required"
404:
description: "Not Found"
parameters:
- schema:
$ref: "#/definitions/CobrandLoginRequest"
in: "body"
name: "cobrandLoginRequest"
description: "cobrandLoginRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
/providerAccounts:
post:
summary: "Add Account"
deprecated: false
produces:
- "application/json"
description: "1. The add account service is used to link the user's account with the provider site to the Yodlee system. <br> 2. Providers that need multifactor authentication are also supported by this service.<br> 3. The loginForm or the field array are the objects under the provider object which is <br>obtained from the <a href=\"https://developer.yodlee.com/apidocs/index.php#!/providers/getSiteDetail\">get provider details</a> service response. The credentials provided by the user should be <br>embedded in the loginForm or field array object.<br> <b>Note:</b> If you are testing <a href=\"https://developer.yodlee.com/KnowledgeBase/How_to_use_PKI\">PKI feature</a>, for encrypting the credentials use <a href=\"https://developer.yodlee.com/apidocs/utility/encrypt.html\">encryption utility</a>.<br> 4. Data to be retrieved from the provider site can be passed using datasetName or dataset. If you pass datasetName, all the attributes that are implicitly configured for the dataset will be retrieved. <br> 5. The response includes the Yodlee generated ID (providerAccountId) for the account along with the refresh information.<br> 6. The <a href=\"https://developer.yodlee.com/apidocs/index.php#!/providerAccounts/getRefreshForProviderAccount\">get provider account details</a> service has to be polled continuously till the account addition status is FAILED or PARTIAL_SUCCESS or SUCCESS<br> 7. If the customer has not subscribed to the event notification for accounts that need multifactor authentication (MFA), the get providerAccount service has to be called continuously till the login form (supported types are token, question & answer, and captcha) is returned in the response.<br> 8. The <a href=\"https://developer.yodlee.com/apidocs/index.php#!/providerAccounts/updateAccount\">update account</a> service should be called to post the MFA information to continue adding the account. <br> 9. Refer to the <a href=\"https://developer.yodlee.com/Yodlee_API/docs/v1_1/API_Flow\">add account</a> flow chart for implementation.<br> 10. This API has <a href=\"https://developer.yodlee.com/Yodlee_API/docs/v1_1/Webhooks\">webhooks</a> support. If the customer has subscribed to the REFRESH event notification and invoked this API for adding an account, relevant notifications will be sent to the customer. <br> 11.The add account service is used to link the user's account with the provider site to the Yodlee system. The generated consent id for the provider site, authorization code received in the PUT consent along with the token received needs to be provided in the request.<br> <b>Note:</b> A dataset may depend on another dataset for retrieval, so the response will include the requested datasets and the dependent datasets.<br> It is necessary to check all the dataset additional statuses returned in the response, as the provider account status is drawn from the dataset additional statuses.<br> The content type has to be passed as application/json for the body parameter<br>"
operationId: "linkProviderAccount"
responses:
200:
schema:
$ref: "#/definitions/AddedProviderAccountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : providerId is mandatory<br>Y803 : Invalid value for credentialsParam<br>Y400 : id and value in credentialsParam are mandatory<br>Y901 : Service not supported"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- schema:
$ref: "#/definitions/ProviderAccountRequest"
in: "body"
name: "providerAccountRequest"
description: "loginForm or field entity"
required: true
- in: "query"
allowEmptyValue: false
name: "providerId"
format: "int64"
description: "providerId"
type: "integer"
required: true
tags:
- "ProviderAccounts"
consumes:
- "application/json"
get:
summary: "Get Provider Accounts"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get provider accounts service is used to return all the provider accounts added by the user. <br>This includes the failed and successfully added provider accounts.<br>"
operationId: "getAllProviderAccounts"
responses:
200:
schema:
$ref: "#/definitions/ProviderAccountResponse"
description: "OK"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
name: "include"
description: "include"
type: "string"
required: true
tags:
- "ProviderAccounts"
put:
summary: "Update Account"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "<b>Credential-based Implementation Notes:</b> <br>The update account API is used to: • Retrieve the latest information for accounts that belong to one providerAccount from the provider site. You must allow at least 15 min between requests. <br> • Update account credentials when the user has changed the authentication information at the provider site. <br> • Post MFA information for the MFA-enabled provider accounts during add and update accounts. <br> • Retrieve the latest information of all the eligible accounts that belong to the user. <br><br><b>Edit Credentials - Notes: </b> <br> • If credentials have to be updated in the Yodlee system, one of the following should be provided: <br> ◦ LoginForm <br> ◦ Field array <br> • LoginForm or the field array, can be obtained from the GET providerAccounts/{providerAccountId}?include=credentials API response. <br> • The credentials provided by the user should be embedded in the loginForm or field array object before you pass to this API. <br><b>Posting MFA Info - Notes: </b> <br>1. You might receive the MFA request details to be presented to the end user in the GET providerAccounts/{providerAccount} API during polling or through REFRESH webhooks notificaiton. <br>2. After receiving the inputs from your user: <br> a.Embed the MFA information provided by the user in the loginForm or field array object.<br> b.Pass one of the following objects as input to this API:<br> • LoginForm<br> • Field array<br/><br><b>Points to consider:</b><br>• Data to be retrieved from the provider site can be overridden using datasetName or dataset. If you do pass datasetName, all the datasets that are implicitly configured for <br>the dataset will be retrieved. This action is allowed for edit credentials and single provider account refresh flows only. <br>• Encrypt the credentials and MFA information using the public key.<br>• While testing the PKI feature in sandbox environment, encrypt the password credentials and answers to the MFA questions using the encryption tool.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>Open Banking (OB)-based Authentication - Notes:</b><br>The update account API is used to:<br>• Retrieve the latest information for accounts from the provider site.<br>• Update the renewed consent for an existing provider account.<br>• Retrieve the latest information for all the eligible accounts that belong to the user.<br/><br>Yodlee recommendations: <br/>• Create the field entity with the authParameters provided in the get provider details API.<br>• Populate the field entity with the values received from the OB site and pass it to this API.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>Update All Eligible Accounts - Notes: </b><br>• This API will trigger a refresh for all the eligible provider accounts(both OB and credential-based accounts).<br>• This API will not refresh closed, inactive, or UAR accounts, or accounts with refreshes in-progress or recently refreshed non-OB accounts.<br>• No parameters should be passed to this API to trigger this action.<br>• Do not call this API often. Our recommendation is to call this only at the time the user logs in to your app because it can hamper other API calls performance. <br>• The response only contains information for accounts that were refreshed. If no accounts are eligible for refresh, no response is returned.<br/><br><b>--------------------------------------------------------------------------------------------------------------------------------</b><br><b>What follows are common to both OB and credential-based authentication implementations: </b><br>• Check the status of the providerAccount before invoking this API. Do not call this API to trigger any action on a providerAccount when an action is already in progress for the providerAccount. <br>• If the customer has subscribed to the REFRESH event notification and invoked this API, relevant notifications will be sent to the customer.<br>• A dataset may depend on another dataset for retrieval, so the response will include the requested and dependent datasets.<br>• Check all the dataset additional statuses returned in the response because the provider account status is drawn from the dataset additional statuses.<br>• Updating preferences using this API will trigger refreshes.<br>• Pass linkedProviderAccountId in the input to link a user’s credential-based providerAccount with the OB providerAccount or viceversa. Ensure that the both the providerAccounts belong to the same institution. <br>• The content type has to be passed as application/json for the body parameter.<br>"
operationId: "editCredentialsOrRefreshProviderAccount"
responses:
200:
schema:
$ref: "#/definitions/UpdatedProviderAccountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y805 : Multiple providerAccountId not supported for updating credentials<br>Y800 : Invalid value for credentialsParam<br>Y400 : id and value in credentialsParam are mandatory<br>Y806 : Invalid input<br>Y823 : Credentials are not applicable for real estate aggregated / manual accounts<br>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "providerAccountIds"
description: "comma separated providerAccountIds"
type: "string"
required: true
- schema:
$ref: "#/definitions/ProviderAccountRequest"
in: "body"
name: "providerAccountRequest"
description: "loginForm or field entity"
required: false
tags:
- "ProviderAccounts"
consumes:
- "application/json"
/derived/transactionSummary:
get:
summary: "Get Transaction Summary"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The transaction summary service provides the summary values of transactions for the given date range by category type, high-level categories, or system-defined categories.<br><br>Yodlee has the transaction data stored for a day, month, year and week per category as per the availability of user's data. If the include parameter value is passed as details, then summary details will be returned depending on the interval passed-monthly is the default.<br><br><b>Notes:</b><br>1.Details can be requested for only one system-defined category<br>2.Dates will not be respected for monthly, yearly, and weekly details<br>3.When monthly details are requested, only the fromDate and toDate month will be respected<br>4.When yearly details are requested, only the fromDate and toDate year will be respected<br>5.For weekly data points, details will be provided for every Sunday date available within the fromDate and toDate<br>"
operationId: "getTransactionSummary"
responses:
200:
schema:
$ref: "#/definitions/DerivedTransactionSummaryResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y010 : Invalid session<br>Y800 : Invalid value for accountId<br>Y800 : Invalid value for groupBy<br>Y803 : groupBy required<br>Y803 : categoryType required<br>Y800 : Invalid value for categoryId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for fromDate or toDate<br>Y814 : Exchange rate not available for currency<br>Y815 : Cannot apply filter on categoryId if groupBy value is CATEGORY_TYPE<br>Y816 : User-defined category details can only be requested for one system categoryId with groupBy='CATEGORY'<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of categoryTypes permitted is 100"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "comma separated account Ids"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryId"
description: "comma separated categoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryType"
description: "INCOME, EXPENSE, TRANSFER, UNCATEGORIZE or DEFERRED_COMPENSATION"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "YYYY-MM-DD format"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "groupBy"
description: "CATEGORY_TYPE, HIGH_LEVEL_CATEGORY or CATEGORY"
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "include"
description: "details"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "includeUserCategory"
description: "TRUE/FALSE"
type: "boolean"
required: false
- in: "query"
allowEmptyValue: false
name: "interval"
description: "D-daily, W-weekly, M-mothly or Y-yearly"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "YYYY-MM-DD format"
type: "string"
required: false
tags:
- "Derived"
/transactions/count:
get:
summary: "Get Transactions Count"
deprecated: false
produces:
- "application/json"
description: "The count service provides the total number of transactions for a specific user depending on the input parameters passed.<br>If you are implementing pagination for transactions, call this endpoint before calling GET /transactions to know the number of transactions that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /transactions endpoint.<br>"
operationId: "getTransactionsCount"
responses:
200:
schema:
$ref: "#/definitions/TransactionCountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for detailCategoryId<br>Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled<br>Y823 : detailCategoryId is not applicable for containers other than bank and card<br>Y824 : The maximum number of detailCategoryIds permitted is 100<br>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "Comma separated accountIds\t"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "baseType"
description: "DEBIT/CREDIT"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryId"
description: "Comma separated categoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryType"
description: "Transaction Category Type(UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "container"
description: "bank/creditCard/investment/insurance/loan"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "detailCategoryId"
description: "Comma separated detailCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "Transaction from date(YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "highLevelCategoryId"
description: "Comma separated highLevelCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "keyword"
description: "Transaction search text\t"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "Transaction end date (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "type"
description: "Transaction Type(SELL,SWEEP, etc.)"
type: "string"
required: false
tags:
- "Transactions"
/dataExtracts/userData:
get:
summary: "Get userData"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.<br>Cobrand session only has to be passed to invoke this service. The time difference between fromDate and toDate fields cannot be more than 60 minutes.<br>"
operationId: "getDataExtractsUserData"
responses:
200:
schema:
$ref: "#/definitions/DataExtractsUserDataResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "From DateTime (YYYY-MM-DDThh:mm:ssZ)"
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "loginName"
description: "Login Name"
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "To DateTime (YYYY-MM-DDThh:mm:ssZ)"
type: "string"
required: true
tags:
- "DataExtracts"
/providers:
get:
summary: "Get Providers"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get provider service is used to get all the providers that are enabled, <br>search a provider service by name or routing number and get popular sites of a region. <br>The valid values for priority are: <br> 1. cobrand: Returns providers enabled for the cobrand (Default priority)<br> 2. popular: Returns providers popular among users of the customer<br><br>Datasets,attributes and containers that are enabled for the customer alone will be returned in the response<br>Input for the dataset$filter should adhere to the following expression:<br><dataset.name>[<attribute.name>.container[<container> OR <container>] OR <attribute.name>.container[<container>]] <br>OR <dataset.name>[<attribute.name> OR <attribute.name>]<br><b>dataset$filter value examples:</b><br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]<br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA<br>BASIC_AGG_DATA OR ACCT_PROFILE<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT <br>BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ] <br><br><b>Note:</b> <br>1. When this service is invoked without any filters, the service performs slowly and takes a few minutes to return data in the response.<br>2. The recommendation is to use this service with filters when used in a flow involving user interactions."
operationId: "getAllProviders"
responses:
200:
schema:
$ref: "#/definitions/ProviderResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have atleast 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "capability"
description: "CHALLENGE_DEPOSIT_VERIFICATION"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "dataset$filter"
description: "Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "name"
description: "Name in minimum 1 character or routing number."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "priority"
description: "Search priority"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0) - This is not applicable along with 'name' parameter."
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500) - This is not applicable along with 'name' parameter."
type: "integer"
required: false
tags:
- "Providers"
/providers/{providerId}:
get:
summary: "Get Provider Details"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get provider detail service is used to get detailed information including the login form for a provider.<br>The response is a provider object that includes information such as name of the provider, <br>provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.<br>Only enabled datasets, attributes and containers gets returned in the response.<br>"
operationId: "getProvider"
responses:
200:
schema:
$ref: "#/definitions/ProviderDetailResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for providerId"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "providerId"
format: "int64"
description: "providerId"
type: "integer"
required: true
tags:
- "Providers"
/cobrand/config/notifications/events/{eventName}:
post:
summary: "Subscribe Event"
deprecated: false
produces:
- "application/json"
description: "The subscribe events service is used to subscribe to an event for receiving notifications.<br>The callback URL, where the notification will be posted should be provided to this service.<br>Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.<br><br><b>Notes</b>:<br>This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.<br>The content type has to be passed as application/json for the body parameter.<br>"
operationId: "createSubscriptionEvent"
responses:
201:
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
- schema:
$ref: "#/definitions/CreateCobrandNotificationEventRequest"
in: "body"
name: "eventRequest"
description: "eventRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
delete:
summary: "Delete Subscription"
deprecated: false
produces:
- "application/json"
description: "The delete events service is used to unsubscribe from an events service.<br>"
operationId: "deleteSubscribedEvent"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
tags:
- "Cobrand"
put:
summary: "Update Subscription"
deprecated: false
produces:
- "application/json"
description: "The update events service is used to update the callback URL.<br><b>Note:</b> The content type has to be passed as application/json for the body parameter. <br>"
operationId: "updateSubscribedEvent"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
- schema:
$ref: "#/definitions/UpdateCobrandNotificationEventRequest"
in: "body"
name: "eventRequest"
description: "eventRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
/transactions/categories/txnRules:
get:
summary: "Get Transaction Categorization Rules"
deprecated: false
produces:
- "application/json"
description: "The get transaction categorization rule service is used to get all the categorization rules.<br>"
operationId: "getTransactionCategorizationRules"
responses:
200:
schema:
$ref: "#/definitions/TransactionCategorizationRuleResponse"
description: "OK"
401:
description: "Unauthorized"
404:
description: "Not Found"
tags:
- "Transactions"
/transactions/categories/{categoryId}:
delete:
summary: "Delete Category"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The delete transaction categories service is used to delete the given user-defined category.<br>The HTTP response code is 204 (Success without content).<br>"
operationId: "deleteTransactionCategory"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for categoryId"
401:
description: "Unauthorized"
204:
description: "Deleted Successfully"
404:
description: "Not Found"
parameters:
- in: "path"
name: "categoryId"
format: "int64"
description: "categoryId"
type: "integer"
required: true
tags:
- "Transactions"
/documents:
get:
summary: "Get Documents"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get documents service allows customers to search or retrieve metadata related to documents. <br>The API returns the document as per the input parameters passed. If no date range is provided then all downloaded <br>documents will be retrieved. Details of deleted documents or documents associated to closed providerAccount will not be returned <br>Metadata related to documents can be searched or retrieved only if the document related dataset attributes are subscribed. <br>"
operationId: "getDocuments"
responses:
200:
schema:
$ref: "#/definitions/DocumentResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for accountId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for docType"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "Keyword"
description: "The string used to search a document by its name."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "The unique identifier of an account. Retrieve documents for a given accountId."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "docType"
description: "Accepts only one of the following valid document types: STMT, TAX, and EBILL."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "The date from which documents have to be retrieved."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "The date to which documents have to be retrieved."
type: "string"
required: false
tags:
- "Documents"
/accounts/{accountId}:
get:
summary: "Get Account Details"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get account details service provides detailed information of an account.<br>"
operationId: "getAccount"
responses:
200:
schema:
$ref: "#/definitions/AccountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for container"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "accountId"
format: "int64"
description: "accountId"
type: "integer"
required: true
- in: "query"
allowEmptyValue: false
name: "container"
description: "bank/creditCard/investment/insurance/loan/reward/bill/realEstate/otherAssets/otherLiabilities\n* bank: Applicable for Aggregated and Manual<br>\n* creditCard: Applicable for Aggregated and Manual<br>\n* investment: Applicable for Aggregated and Manual<br>\n* insurance: Applicable for Aggregated and Manual<br>\n* loan: Applicable for Aggregated and Manual<br>\n* reward: Applicable for Aggregated and Manual<br>\n* bill: Applicable for Aggregated and Manual<br>\n* realEstate: Applicable for Manual<br>\n* otherAssets: Applicable for Manual<br>\n* otherLiabilities: Applicable for Manual"
type: "string"
required: true
enum:
- "bank"
- "creditCard"
- "investment"
- "insurance"
- "loan"
- "reward"
- "bill"
- "realEstate"
- "otherAssets"
- "otherLiabilities"
- in: "query"
allowEmptyValue: false
name: "include"
description: "profile, holder, fullAccountNumber, paymentProfile, autoRefresh"
type: "string"
required: false
tags:
- "Accounts"
delete:
summary: "Delete Account"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The delete account service allows an account to be deleted.<br>This service does not return a response. The HTTP response code is 204 (Success with no content).<br>"
operationId: "deleteAccount"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for accountId"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "accountId"
format: "int64"
description: "accountId"
type: "integer"
required: true
tags:
- "Accounts"
put:
summary: "Update Account"
deprecated: false
produces:
- "application/json"
description: "The update account service is used to update manual and aggregated accounts.<br>The HTTP response code is 204 (Success without content).<br>Update manual account support is available for bank, card, investment, insurance, loan, bills, otherAssets, otherLiabilities and realEstate containers only.<br><b>Note:</b> A real estate account update is only supported for manual valuation.<br>"
operationId: "updateAccount"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for accountId<br>Y800 : Invalid value for updateParam"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "accountId"
format: "int64"
description: "accountId"
type: "integer"
required: true
- schema:
$ref: "#/definitions/UpdateAccountRequest"
in: "body"
name: "accountRequest"
description: "accountRequest"
required: true
tags:
- "Accounts"
consumes:
- "application/json"
/accounts/historicalBalances:
get:
summary: "Get Historical Balances"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The historical balances service is used to retrieve the historical balances for an account or a user.<br>Historical balances are daily (D), weekly (W), and monthly (M). <br>The interval input should be passed as D, W, and M to retrieve the desired historical balances. The default interval is daily (D). <br>When no account id is provided, historical balances of the accounts that are active, to be closed, and closed are provided in the response. <br>If the fromDate and toDate are not passed, the last 90 days of data will be provided. <br>The fromDate and toDate should be passed in the YYYY-MM-DD format. <br>The date field in the response denotes the date for which the balance is requested.<br>includeCF needs to be sent as true if the customer wants to return carried forward balances <br>for a date when the data is not available. <br>asofDate field in the response denotes the date as of which the balance was updated for that account.<br>When there is no balance available for a requested date and if includeCF is sent as true, the previous <br>date for which the balance is available is provided in the response. When there is no previous <br>balance available, no data will be sent. <br>"
operationId: "getHistoricalBalances"
responses:
200:
schema:
$ref: "#/definitions/AccountHistoricalBalancesResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for accountId<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "accountId"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "from date for balance retrieval (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "includeCF"
description: "Consider carry forward logic for missing balances"
type: "boolean"
required: false
- in: "query"
allowEmptyValue: false
name: "interval"
description: "D-daily, W-weekly or M-monthly"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "toDate for balance retrieval (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500)"
type: "integer"
required: false
tags:
- "Accounts"
/providers/count:
get:
summary: "Get Providers Count"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.<br>If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /providers endpoint<br>."
operationId: "getProvidersCount"
responses:
200:
schema:
$ref: "#/definitions/ProvidersCountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have at least 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "capability"
description: "CHALLENGE_DEPOSIT_VERIFICATION"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "dataset$filter"
description: "Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "name"