-
Notifications
You must be signed in to change notification settings - Fork 36
/
2020-09-14.yml
11864 lines (11645 loc) · 478 KB
/
2020-09-14.yml
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
servers:
- description: Production
url: https://production.plaid.com
- description: Development
url: https://development.plaid.com
- description: Sandbox
url: https://sandbox.plaid.com
info:
title: The Plaid API
version: 2020-09-14_1.18.1
description: The Plaid REST API. Please see https://plaid.com/docs/api for more details.
contact:
name: Plaid Developer Team
url: https://plaid.com
termsOfService: https://plaid.com/legal/
tags:
- name: plaid
description: The Plaid API
security:
- clientId: []
secret: []
plaidVersion: []
paths:
/item/application/list:
post:
tags:
- plaid
summary: List a user’s connected applications
operationId: itemApplicationList
description: List a user’s connected applications
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationListResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationListRequest'
/item/application/scopes/update:
post:
tags:
- plaid
summary: Update the scopes of access for a particular application
operationId: itemApplicationScopesUpdate
description: Enable consumers to update product access on selected accounts for an application.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationScopesUpdateResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationScopesUpdateRequest'
/application/get:
post:
tags:
- plaid
summary: Retrieve information about a Plaid application
operationId: applicationGet
description: Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetRequest'
description: ""
/item/get:
post:
tags:
- plaid
summary: Retrieve an Item
externalDocs:
url: /api/items/#itemget
operationId: itemGet
description: Returns information about the status of an Item.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemGetResponse'
examples:
example-1:
value:
item:
available_products:
- balance
- auth
billed_products:
- identity
- transactions
error: null
institution_id: ins_109508
item_id: Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr
update_type: background
webhook: https://plaid.com/example/hook
consent_expiration_time: null
status:
transactions:
last_successful_update: 2019-02-15T15:52:39
last_failed_update: 2019-01-22T04:32:00
last_webhook:
sent_at: 2019-02-15T15:53:00
code_sent: DEFAULT_UPDATE
request_id: m8MDnv9okwxFNBV
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemGetRequest'
description: ""
/auth/get:
post:
tags:
- plaid
summary: Retrieve auth data
externalDocs:
url: /api/products/#authget
operationId: authGet
description: |-
The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.
Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetResponse'
examples:
example-1:
value:
accounts:
- account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
balances:
available: 100
current: 110
limit: null
iso_currency_code: USD
unofficial_currency_code: null
mask: "9606"
name: Plaid Checking
official_name: Plaid Gold Checking
subtype: checking
type: depository
numbers:
ach:
- account: "9900009606"
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
routing: "011401533"
wire_routing: "021000021"
eft:
- account: "111122223333"
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
institution: "021"
branch: "01140"
international:
- account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
bic: NWBKGB21
iban: GB29NWBK60161331926819
bacs:
- account: "31926819"
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
sort_code: "601613"
item:
available_products:
- balance
- identity
- payment_initiation
- transactions
billed_products:
- assets
- auth
consent_expiration_time: null
error: null
institution_id: ins_117650
item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
update_type: background
webhook: https://www.genericwebhookurl.com/webhook
request_id: m8MDnv9okwxFNBV
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Default error
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetRequest'
examples: {}
description: ""
/transactions/get:
post:
tags:
- plaid
summary: Get transaction data
externalDocs:
url: /api/products/#transactionsget
operationId: transactionsGet
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 110
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "0000"
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
transactions:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
amount: 2307.21
iso_currency_code: USD
unofficial_currency_code: null
category:
- Shops
- Computers and Electronics
category_id: "19013000"
date: "2017-01-29"
datetime: null
authorized_date: "2017-01-27"
authorized_datetime: null
location:
address: 300 Post St
city: San Francisco
region: CA
postal_code: "94108"
country: US
lat: 40.740352
lon: -74.001761
store_number: "1235"
name: Apple Store
merchant_name: Apple
payment_meta:
by_order_of: null
payee: null
payer: null
payment_method: null
payment_processor: null
ppd_id: null
reason: null
reference_number: null
payment_channel: in store
pending: false
pending_transaction_id: null
account_owner: null
transaction_id: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje
transaction_code: null
transaction_type: place
item:
available_products:
- balance
- identity
- investments
billed_products:
- assets
- auth
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: https://www.genericwebhookurl.com/webhook
total_transactions: 1
request_id: 45QSn
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions).
Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions.
Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint.
Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsGetRequest'
examples: {}
/transactions/refresh:
post:
tags:
- plaid
summary: Refresh transaction data
externalDocs:
url: /api/products/#transactionsrefresh
operationId: transactionsRefresh
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRefreshResponse'
examples:
example-1:
value:
request_id: 1vwmF5TBQwiqfwP
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
`/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`.
Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRefreshRequest'
/institutions/get:
post:
tags:
- plaid
summary: Get details of all supported institutions
externalDocs:
url: /api/institutions/#institutionsget
operationId: institutionsGet
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetResponse'
examples:
example-1:
value:
institutions:
- country_codes:
- US
institution_id: ins_1
name: Bank of America
oauth: false
products:
- assets
- auth
- balance
- transactions
- identity
- liabilities
routing_numbers:
- "011000138"
- "011200365"
- "011400495"
- "011500010"
- "011900254"
- "021000322"
- "021200339"
- "026009593"
- "031202084"
- "051000017"
- "052001633"
- "053000196"
- "053904483"
- "054001204"
- "061000052"
- "063100277"
- "064000020"
- "071214579"
- "072000805"
- "073000176"
- "081000032"
- "081904808"
- "082000073"
- "101100045"
- "103000017"
- "107000327"
- "111000025"
- "121000358"
- "122101706"
- "122400724"
- "123103716"
- "125000024"
- "323070380"
request_id: tbFyCEqkU774ZGG
total: 11384
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.
This data changes frequently. If you store it locally on your system, be sure to update it regularly.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetRequest'
description: ""
/institutions/search:
post:
tags:
- plaid
summary: Search institutions
externalDocs:
url: /api/institutions/#institutionssearch
operationId: institutionsSearch
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsSearchResponse'
examples:
example-1:
value:
institutions:
- country_codes:
- US
institution_id: ins_118923
name: Red Platypus Bank - Red Platypus Bank
oauth: false
products:
- assets
- auth
- balance
- transactions
- identity
routing_numbers: []
request_id: Ggmk0enW4smO2Tp
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsSearchRequest'
/institutions/get_by_id:
post:
tags:
- plaid
summary: Get details of an institution
externalDocs:
url: /api/institutions/#institutionsget_by_id
operationId: institutionsGetById
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetByIdResponse'
examples:
example-1:
value:
institution:
country_codes:
- US
institution_id: ins_109512
name: Houndstooth Bank
products:
- auth
- balance
- identity
- transactions
routing_numbers:
- "110000000"
oauth: false
status:
item_logins:
status: HEALTHY
last_status_change: "2019-02-15T15:53:00Z"
breakdown:
success: 0.9
error_plaid: 0.01
error_institution: 0.09
transactions_updates:
status: HEALTHY
last_status_change: "2019-02-12T08:22:00Z"
breakdown:
success: 0.95
error_plaid: 0.02
error_institution: 0.03
refresh_interval: NORMAL
auth:
status: HEALTHY
last_status_change: "2019-02-15T15:53:00Z"
breakdown:
success: 0.91
error_plaid: 0.01
error_institution: 0.08
balance:
status: HEALTHY
last_status_change: "2019-02-15T15:53:00Z"
breakdown:
success: 0.89
error_plaid: 0.02
error_institution: 0.09
identity:
status: DEGRADED
last_status_change: "2019-02-15T15:50:00Z"
breakdown:
success: 0.42
error_plaid: 0.08
error_institution: 0.5
investments_updates:
status: HEALTHY
last_status_change: "2019-02-12T08:22:00Z"
breakdown:
success: 0.95
error_plaid: 0.02
error_institution: 0.03
refresh_interval: NORMAL
primary_color: '#004966'
url: https://plaid.com
logo: null
request_id: m8MDnv9okwxFNBV
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetByIdRequest'
description: ""
/item/remove:
post:
tags:
- plaid
summary: Remove an Item
externalDocs:
url: /api/items/#itemremove
operationId: itemRemove
description: |-
The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item.
Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support.
Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRemoveResponse'
examples:
example-1:
value:
request_id: m8MDnv9okwxFNBV
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRemoveRequest'
description: ""
/accounts/get:
post:
tags:
- plaid
summary: Retrieve accounts
externalDocs:
url: /api/accounts/#accountsget
operationId: accountsGet
description: |-
The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "0000"
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: 6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk
balances:
available: null
current: 23631.9805
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "6666"
name: Plaid 401k
official_name: null
subtype: 401k
type: investment
- account_id: XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58
balances:
available: null
current: 65262
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "7777"
name: Plaid Student Loan
official_name: null
subtype: student
type: loan
item:
available_products:
- balance
- identity
- payment_initiation
- transactions
billed_products:
- assets
- auth
consent_expiration_time: null
error: null
institution_id: ins_117650
item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
update_type: background
webhook: https://www.genericwebhookurl.com/webhook
request_id: bkVE1BHWMAZ9Rnr
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetRequest'
examples:
example-1:
value:
client_id: string
secret: string
access_token: string
options:
account_ids:
- string
/categories/get:
post:
security: []
tags:
- plaid
summary: Get Categories
externalDocs:
url: /api/products/#categoriesget
operationId: categoriesGet
description: Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesGetResponse'
examples:
example-1:
value:
categories:
- category_id: "10000000"
group: special
hierarchy:
- Bank Fees
- category_id: "10001000"
group: special
hierarchy:
- Bank Fees
- Overdraft
- category_id: "12001000"
group: place
hierarchy:
- Community
- Animal Shelter
request_id: ixTBLZGvhD4NnmB
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesGetRequest'
/sandbox/processor_token/create:
post:
tags:
- plaid
summary: Create a test Item and processor token
externalDocs:
url: /api/sandbox/#sandboxprocessor_tokencreate
operationId: sandboxProcessorTokenCreate
description: Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxProcessorTokenCreateResponse'
examples:
example-1:
value:
processor_token: processor-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
request_id: Aim3b
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxProcessorTokenCreateRequest'
/sandbox/public_token/create:
post:
tags:
- plaid
summary: Create a test Item
externalDocs:
url: /api/sandbox/#sandboxpublic_tokencreate
operationId: sandboxPublicTokenCreate
description: Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxPublicTokenCreateResponse'
examples:
example-1:
value:
public_token: public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
request_id: Aim3b
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxPublicTokenCreateRequest'
/sandbox/item/fire_webhook:
post:
tags:
- plaid
summary: Fire a test webhook
externalDocs:
url: /api/sandbox/#sandboxitemfire_webhook
operationId: sandboxItemFireWebhook
description: The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result.
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemFireWebhookResponse'
examples:
example-1:
value:
webhook_fired: true
request_id: 1vwmF5TBQwiqfwP
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
description: ""
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemFireWebhookRequest'
/accounts/balance/get:
post:
tags:
- plaid
summary: Retrieve real-time balance data
externalDocs:
url: /api/products/#accountsbalanceget
operationId: accountsBalanceGet
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "0000"
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
balances:
available: null
current: 410
iso_currency_code: USD
limit: 2000
unofficial_currency_code: null
mask: "3333"
name: Plaid Credit Card
official_name: Plaid Diamond 12.5% APR Interest Credit Card
subtype: credit card
type: credit
- account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
balances:
available: null
current: 65262
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: "7777"
name: Plaid Student Loan
official_name: null
subtype: student
type: loan
item:
available_products:
- balance
- identity
- investments
billed_products:
- assets
- auth
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: https://www.genericwebhookurl.com/webhook
request_id: qk5Bxes3gDfv4F2
description: The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsBalanceGetRequest'
examples:
example-1:
value:
access_token: string
secret: string
client_id: string
options:
account_ids:
- string
/identity/get:
post:
tags:
- plaid
summary: Retrieve identity data
externalDocs:
url: /api/products/#identityget
operationId: identityGet
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityGetResponse'
examples:
example-1:
value:
accounts: