-
Notifications
You must be signed in to change notification settings - Fork 0
/
plaid.proto
936 lines (794 loc) · 18.9 KB
/
plaid.proto
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
/*
* Copyright (c) 2020 Morgan Gallant
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
syntax = "proto3";
package plaid;
/* Accounts */
message Account {
string account_id = 1;
AccountBalances balances = 2;
string mask = 3;
string name = 4;
string official_name = 5;
string subtype = 6;
string type = 7;
string verification_status = 8;
}
message AccountBalances {
double available = 1;
double current = 2;
double limit = 3;
string iso_currency_code = 4;
string unofficial_currency_code = 5;
}
message ACHNumber {
string account = 1;
string account_id = 2;
string routing = 3;
string wire_routing = 4;
}
message EFTNumber {
string account = 1;
string account_id = 2;
string institution = 3;
string branch = 4;
}
message IBANNumber {
string account_id = 1;
string iban = 2;
string bic = 3;
}
message BACSNumber {
string account_id = 1;
string account = 2;
string sort_code = 3;
}
message GetBalancesRequestOptions {
repeated string account_ids = 1;
}
message GetBalancesRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
GetBalancesRequestOptions options = 4;
}
message GetBalancesResponse {
string request_id = 1;
repeated Account accounts = 2;
}
message GetAccountsRequestOptions {
repeated string account_ids = 1;
}
message GetAccountsRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
GetAccountsRequestOptions options = 4;
}
message GetAccountsResponse {
string request_id = 1;
repeated Account accounts = 2;
Item item = 3;
}
message GetAccountsOptions {
repeated string account_ids = 1;
}
message GetBalancesOptions {
repeated string account_ids = 1;
}
/* Assets */
message AssetReport {
string asset_report_id = 1;
string client_report_id = 2;
string date_generated = 3;
int64 days_requested = 4;
repeated AssetReportItem items = 5;
AssetReportUser user = 6;
}
message AssetReportItem {
repeated Account accounts = 1;
string date_last_updated = 2;
string institution_id = 3;
string institution_name = 4;
string item_id = 5;
}
message AssetReportUser {
string client_user_id = 1;
string email = 2;
string first_name = 3;
string last_name = 4;
string middle_name = 5;
string phone_number = 6;
string ssn = 7;
}
message GetAssetReportRequest {
string client_id = 1;
string secret = 2;
string asset_report_token = 3;
}
message GetAssetReportResponse {
string request_id = 1;
AssetReport report = 2;
repeated string warnings = 3;
}
message RemoveAssetReportRequest {
string client_id = 1;
string secret = 2;
string asset_report_token = 3;
}
message RemoveAssetReportResponse {
string request_id = 1;
bool removed = 2;
}
message CreateAuditCopyRequest {
string client_id = 1;
string secret = 2;
string asset_report_token = 3;
string auditor_id = 4;
}
message CreateAuditCopyTokenResponse {
string request_id = 1;
string audit_copy_token = 2;
}
/* Auth */
message GetAuthRequestOptions {
repeated string account_ids = 1;
}
message GetAuthRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
GetAuthRequestOptions options = 4;
}
message AccountNumberCollection {
repeated ACHNumber ach = 1;
repeated EFTNumber eft = 2;
repeated IBANNumber international = 3;
repeated BACSNumber bacs = 4;
}
message GetAuthResponse {
string request_id = 1;
repeated Account accounts = 2;
AccountNumberCollection numbers = 3;
}
message GetAuthOptions {
repeated string account_ids = 1;
}
/* Categories */
message Category {
string category_id = 1;
string group = 2;
repeated string hierarchy = 3;
}
message GetCategoriesResponse {
string request_id = 1;
repeated Category categories = 2;
}
/* Errors */
message Error {
string request_id = 1;
string error_type = 2;
string error_code = 3;
string error_message = 4;
string display_message = 5;
int64 status_code = 6;
}
/* Holdings */
message Security {
string security_id = 1;
string cusip = 2;
string sedol = 3;
string isin = 4;
string institution_security_id = 5;
string institution_id = 6;
string proxy_security_id = 7;
string name = 8;
string ticker_symbol = 9;
bool is_cash_equivalent = 10;
string type = 11;
double close_price = 12;
string close_price_as_of = 13;
string iso_currency_code = 14;
string unofficial_currency_code = 15;
}
message Holding {
string account_id = 1;
string security_id = 2;
double institution_value = 3;
double institution_price = 4;
double quantity = 5;
string institution_price_as_of = 6;
double cost_basis = 7;
string iso_currency_code = 8;
string unofficial_currency_code = 9;
}
message GetHoldingsRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
GetHoldingsOptions options = 4;
}
message GetHoldingsOptions {
repeated string account_ids = 1;
}
message GetHoldingsResponse {
string request_id = 1;
repeated Account accounts = 2;
Item item = 3;
repeated Security securities = 4;
repeated Holding holdings = 5;
}
/* Identity */
message Identity {
repeated Address addresses = 1;
repeated Email emails = 2;
repeated string names = 3;
repeated PhoneNumber phone_numbers = 4;
}
message Address {
AddressData data = 1;
bool primary = 2;
}
message AddressData {
string city = 1;
string region = 2;
string street = 3;
string postal_code = 4;
string country = 5;
}
message Email {
string data = 1;
bool primary = 2;
string type = 3;
}
message PhoneNumber {
bool primary = 1;
string type = 2;
string data = 3;
}
message GetIdentityRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message AccountWithOwners {
repeated Identity owners = 1;
string account_id = 2;
AccountBalances balances = 3;
string mask = 4;
string name = 5;
string official_name = 6;
string subtype = 7;
string type = 8;
string verification_status = 9;
}
message GetIdentityResponse {
string request_id = 1;
repeated AccountWithOwners accounts = 2;
Item item = 3;
}
/* Income */
message Income {
repeated IncomeStream income_streams = 1;
int64 last_year_income = 2;
int64 last_year_income_before_tax = 3;
int64 projected_yearly_income = 4;
int64 projected_yearly_income_before_tax = 5;
int64 max_number_of_overlapping_income_streams = 6;
int64 number_of_income_streams = 7;
}
message IncomeStream {
double confidence = 1;
int64 days = 2;
int64 monthly_income = 3;
string name = 4;
}
message GetIncomeRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message GetIncomeResponse {
string request_id = 1;
Income income = 2;
}
/* Institutions */
message Institution {
repeated Credential credentials = 1;
bool has_mfa = 2;
string institution_id = 3;
repeated string mfa = 4;
string name = 5;
repeated string products = 6;
repeated string country_codes = 7;
InstitutionStatus status = 8;
string primary_color = 9;
string url = 10;
string logo = 11;
}
message InstitutionStatus {
ItemLogins item_logins = 1;
}
message ItemLogins {
string status = 1;
string last_status_change = 2;
InstitutionStatusBreakdown breakdown = 3;
}
message InstitutionStatusBreakdown {
double success = 1;
double error_plaid = 2;
double error_institution = 3;
}
message Credential {
string label = 1;
string name = 2;
string type = 3;
}
message GetInstitutionsRequest {
string client_id = 1;
string secret = 2;
int64 count = 3;
int64 offset = 4;
GetInstitutionsOptions options = 5;
}
message GetInstitutionsOptions {
repeated string products = 1;
bool include_optional_metadata = 2;
repeated string country_codes = 3;
}
message GetInstitutionsResponse {
string request_id = 1;
repeated Institution institutions = 2;
int64 total = 3;
}
message GetInstitutionByIDRequest {
string institution_id = 1;
string public_key = 2;
GetInstitutionByIDOptions options = 3;
}
message GetInstitutionByIDOptions {
bool include_optional_metadata = 1;
bool include_status = 2;
}
message GetInstitutionByIDResponse {
string request_id = 1;
Institution institution = 2;
}
message SearchInstitutionsRequest {
string query = 1;
repeated string products = 2;
string public_key = 3;
SearchInstitutionsOptions options = 4;
}
message SearchInstitutionsOptions {
bool include_optional_metadata = 1;
repeated string country_codes = 2;
repeated string routing_numbers = 3;
}
message SearchInstitutionsResponse {
string request_id = 1;
repeated Institution institutions = 2;
}
/* Investment Transactions */
message InvestmentTransaction {
string investment_transaction_id = 1;
string account_id = 2;
string security_id = 3;
string cancel_transaction_id = 4;
string date = 5;
string name = 6;
double quantity = 7;
double amount = 8;
double price = 9;
double fees = 10;
string type = 11;
string iso_currency_code = 12;
string unofficial_currency_code = 13;
}
message GetInvestmentTransactionsResponse {
string request_id = 1;
Item item = 2;
repeated Account accounts = 3;
repeated InvestmentTransaction investment_transactions = 4;
repeated Security securities = 5;
int64 total_investment_transactions = 6;
}
message GetInvestmentTransactionsOptions {
string start_date = 1;
string end_date = 2;
repeated string account_ids = 3;
int64 count = 4;
int64 offset = 5;
}
message GetInvestmentTransactionsRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
string start_date = 4;
string end_date = 5;
GetInvestmentTransactionsRequestOptions options = 6;
}
message GetInvestmentTransactionsRequestOptions {
repeated string account_ids = 1;
int64 count = 2;
int64 offset = 3;
}
/* Items */
message Item {
repeated string available_products = 1;
repeated string billed_products = 2;
Error error = 3;
string institution_id = 4;
string item_id = 5;
string webhook = 6;
string consent_expiration_time = 7;
}
message GetItemRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message GetItemResponse {
string request_id = 1;
Item item = 2;
}
message RemoveItemRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message RemoveItemResponse {
string request_id = 1;
bool removed = 2;
}
message UpdateItemWebhookRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
string webhook = 4;
}
message UpdateItemWebhookResponse {
string request_id = 1;
Item item = 2;
}
message InvalidateAccessTokenRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message InvalidateAccessTokenResponse {
string request_id = 1;
string new_access_token = 2;
}
message UpdateAccessTokenVersionRequest {
string client_id = 1;
string secret = 2;
string access_token_v1 = 3;
}
message UpdateAccessTokenVersionResponse {
string request_id = 1;
string access_token = 2;
string item_id = 3;
}
message CreatePublicTokenRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message CreatePublicTokenResponse {
string request_id = 1;
string public_token = 2;
}
message ExchangePublicTokenRequest {
string client_id = 1;
string secret = 2;
string public_token = 3;
}
message ExchangePublicTokenResponse {
string request_id = 1;
string access_token = 2;
string item_id = 3;
}
/* Liabilities */
message StudentLoanLiability {
string account_id = 1;
string account_number = 2;
repeated string disbursement_dates = 3;
string expected_payoff_date = 4;
string guarantor = 5;
double interest_rate_percentage = 6;
bool is_overdue = 7;
double last_payment_amount = 8;
string last_payment_date = 9;
double last_satement_balance = 10;
string last_statement_issue_date = 11;
string loan_name = 12;
StudentLoanStatus loan_status = 13;
double minimum_payment_amount = 14;
string next_payment_due_date = 15;
string origination_date = 16;
double origination_principal_amount = 17;
double outstanding_interest_amount = 18;
string payment_reference_number = 19;
PSLFStatus pslf_status = 20;
StudentLoanRepaymentPlan repayment_plan = 21;
string sequence_number = 22;
StudentLoanServicerAddress servicer_address = 23;
double ytd_interest_paid = 24;
double ytd_principal_paid = 25;
}
message PSLFStatus {
string estimated_eligibility_date = 1;
int64 payments_made = 2;
int64 payments_remaining = 3;
}
message StudentLoanServicerAddress {
string city = 1;
string country = 2;
string postal_code = 3;
string region = 4;
string street = 5;
}
message StudentLoanStatus {
string type = 1;
string end_date = 2;
}
message StudentLoanRepaymentPlan {
string type = 1;
string description = 2;
}
message GetLiabilitiesRequestOptions {
repeated string account_ids = 1;
}
message GetLiabilitiesRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
GetLiabilitiesRequestOptions options = 4;
}
message GetLiabilitiesResponse {
string request_id = 1;
repeated Account accounts = 2;
Item item = 3;
Liabilities liabilities = 4;
}
message Liabilities {
repeated StudentLoanLiability student = 1;
}
message GetLiabilitiesOptions {
repeated string account_ids = 1;
}
/* Payment */
message PaymentRecipientAddress {
repeated string street = 1;
string city = 2;
string postal_code = 3;
string country = 4;
}
message CreatePaymentRecipientRequest {
string client_id = 1;
string secret = 2;
string name = 3;
string iban = 4;
PaymentRecipientAddress address = 5;
}
message CreatePaymentRecipientResponse {
string request_id = 1;
string recipient_id = 2;
}
message GetPaymentRecipientRequest {
string client_id = 1;
string secret = 2;
string recipient_id = 3;
}
message GetPaymentRecipientResponse {
string request_id = 1;
string recipient_id = 2;
string name = 3;
string iban = 4;
string address = 5;
}
message ListPaymentRecipientsRequest {
string client_id = 1;
string secret = 2;
}
message Recipient {
string recipient_id = 1;
string name = 2;
string iban = 3;
string address = 4;
}
message ListPaymentRecipientsResponse {
string request_id = 1;
repeated Recipient recipients = 2;
}
message PaymentAmount {
string currency = 1;
double value = 2;
}
message CreatePaymentRequest {
string client_id = 1;
string secret = 2;
string recipient_id = 3;
string reference = 4;
PaymentAmount amount = 5;
}
message CreatePaymentResponse {
string request_id = 1;
string payment_id = 2;
string status = 3;
}
message CreatePaymentTokenRequest {
string client_id = 1;
string secret = 2;
string payment_id = 3;
}
message CreatePaymentTokenResponse {
string request_id = 1;
string payment_token = 2;
string payment_token_expiration_time = 3;
}
message GetPaymentRequest {
string client_id = 1;
string secret = 2;
string payment_id = 3;
}
message GetPaymentResponse {
string request_id = 1;
string payment_id = 2;
string payment_token = 3;
string reference = 4;
PaymentAmount amount = 5;
string status = 6;
string last_status_update = 7;
string payment_token_expiration_time = 8;
string recipient_id = 9;
}
message ListPaymentsRequest {
string client_id = 1;
string secret = 2;
int64 count = 3;
string cursor = 4;
}
message Payment {
string payment_id = 1;
string payment_token = 2;
string reference = 3;
PaymentAmount amount = 4;
string status = 5;
string last_status_update = 6;
string payment_token_expiration_time = 7;
string recipient_id = 8;
}
message ListPaymentsResponse {
string request_id = 1;
repeated Payment payments = 2;
string next_cursor = 3;
}
message ListPaymentsOptions {
int64 count = 1;
string cursor = 2;
}
/* Processor */
message CreateProcessorTokenRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
string account_id = 4;
}
message CreateProcessorTokenResponse {
string request_id = 1;
string processor_token = 2;
}
message CreateStripeTokenRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
string account_id = 4;
}
message CreateStripeTokenResponse {
string request_id = 1;
string stripe_bank_account_token = 2;
}
/* Sandbox */
message CreateSandboxPublicTokenRequest {
string institution_id = 1;
repeated string inital_products = 2;
string public_key = 3;
}
message CreateSandboxPublicTokenResponse {
string request_id = 1;
string public_token = 2;
}
message ResetSandboxItemRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
}
message ResetSandboxItemResponse {
string request_id = 1;
bool reset_login = 2;
}
/* Transactions */
message Transaction {
string account_id = 1;
double amount = 2;
string iso_currency_code = 3;
string unofficial_currency_code = 4;
repeated string category = 5;
string category_id = 6;
string date = 7;
Location location = 8;
string name = 9;
PaymentMeta payment_meta = 10;
bool pending = 11;
string pending_transaction_id = 12;
string account_owner = 13;
string transaction_id = 14;
string transaction_type = 15;
}
message Location {
string addreess = 1;
string city = 2;
double lat = 3;
double lon = 4;
string region = 5;
string store_number = 6;
string postal_code = 7;
string country = 8;
}
message PaymentMeta {
string by_order_of = 1;
string payee = 2;
string payer = 3;
string payment_method = 4;
string payment_processor = 5;
string ppd_id = 6;
string reason = 7;
string reference_number = 8;
}
message GetTransactionsRequestOptions {
repeated string account_ids = 1;
int64 count = 2;
int64 offset = 3;
}
message GetTransactionsRequest {
string client_id = 1;
string secret = 2;
string access_token = 3;
string start_date = 4;
string end_date = 5;
GetTransactionsRequestOptions options = 6;
}
message GetTransactionsResponse {
string request_id = 1;
repeated Account accounts = 2;
Item item = 3;
repeated Transaction transactions = 4;
int64 total_transactions = 5;
}
message GetTransactionsOptions {
string start_date = 1;
string end_date = 2;
repeated string account_ids = 3;
int64 count = 4;
int64 offset = 5;
}