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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217
//! This library is generated by [`openapi-client-generator`].
//!
//! The [`PlaidClient`] is the main entry point for this library.
#![allow(non_camel_case_types)]
use serde_json::json;
use serde::{Serialize, Deserialize};
use httpclient::RequestBuilder;
pub struct PlaidClient {
client: httpclient::Client,
authentication: Option<PlaidAuthentication>,
}
impl PlaidClient {
pub fn new(url: &str) -> Self {
let client = httpclient::Client::new(Some(url.to_string()));
let authentication = None;
Self { client, authentication }
}
pub fn with_authentication(mut self, authentication: PlaidAuthentication) -> Self {
self.authentication = Some(authentication);
self
}
pub fn with_middleware<M: httpclient::Middleware + 'static>(
mut self,
middleware: M,
) -> Self {
self.client = self.client.with_middleware(middleware);
self
}
///List a user’s connected applications
pub async fn item_application_list(
&self,
access_token: Option<String>,
) -> anyhow::Result<ItemApplicationListResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Update the scopes of access for a particular application
Enable consumers to update product access on selected accounts for an application.*/
pub async fn item_application_scopes_update(
&self,
access_token: String,
application_id: String,
scopes: serde_json::Value,
state: String,
context: String,
) -> anyhow::Result<ItemApplicationScopesUpdateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "application_id" :
application_id, "scopes" : scopes, "state" : state, "context" :
context }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve information about a Plaid application
Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences*/
pub async fn application_get(
&self,
application_id: String,
) -> anyhow::Result<ApplicationGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "application_id" : application_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve an Item
Returns information about the status of an Item.
See full Plaid docs at <https://plaid.com/docs/api/items/#itemget>*/
pub async fn item_get(
&self,
access_token: String,
) -> anyhow::Result<ItemGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve auth data
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.
Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
See full Plaid docs at <https://plaid.com/docs/api/products/#authget>*/
pub async fn auth_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<AuthGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get transaction data
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.
See full Plaid docs at <https://plaid.com/docs/api/products/#transactionsget>*/
pub async fn transactions_get(
&self,
options: serde_json::Value,
access_token: String,
start_date: String,
end_date: String,
) -> anyhow::Result<TransactionsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "options" : options, "access_token" : access_token,
"start_date" : start_date, "end_date" : end_date }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Refresh transaction data
`/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.
See full Plaid docs at <https://plaid.com/docs/api/products/#transactionsrefresh>*/
pub async fn transactions_refresh(
&self,
access_token: String,
) -> anyhow::Result<TransactionsRefreshResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get streams of recurring transactions
The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts.
The product is currently in beta. To request access, contact transactions-feedback@plaid.com.*/
pub async fn transactions_recurring_get(
&self,
access_token: String,
account_ids: Vec<String>,
) -> anyhow::Result<TransactionsRecurringGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!({ "access_token" : access_token, "account_ids" : account_ids }),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get incremental transaction updates on an Item
The `/transactions/sync` endpoint returns item transactions as a set of delta updates.
Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint
The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
See full Plaid docs at <https://plaid.com/docs/api/products/#transactionssync>*/
pub async fn transactions_sync(
&self,
access_token: String,
cursor: String,
count: i64,
) -> anyhow::Result<TransactionsSyncResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "cursor" : cursor, "count" :
count }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get details of all supported institutions
Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.
If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
See full Plaid docs at <https://plaid.com/docs/api/institutions/#institutionsget>*/
pub async fn institutions_get(
&self,
count: i64,
offset: i64,
country_codes: Vec<CountryCode>,
options: serde_json::Value,
) -> anyhow::Result<InstitutionsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "count" : count, "offset" : offset, "country_codes" :
country_codes, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Search institutions
Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
See full Plaid docs at <https://plaid.com/docs/api/institutions/#institutionssearch>*/
pub async fn institutions_search(
&self,
query: String,
products: Option<Vec<Products>>,
country_codes: Vec<CountryCode>,
options: serde_json::Value,
) -> anyhow::Result<InstitutionsSearchResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "query" : query, "products" : products, "country_codes" :
country_codes, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get details of an institution
Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
See full Plaid docs at <https://plaid.com/docs/api/institutions/#institutionsget_by_id>*/
pub async fn institutions_get_by_id(
&self,
institution_id: String,
country_codes: Vec<CountryCode>,
options: serde_json::Value,
) -> anyhow::Result<InstitutionsGetByIdResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "institution_id" : institution_id, "country_codes" :
country_codes, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Remove an Item
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.
API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
See full Plaid docs at <https://plaid.com/docs/api/items/#itemremove>*/
pub async fn item_remove(
&self,
access_token: String,
) -> anyhow::Result<ItemRemoveResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve accounts
The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.
This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.
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. Note that some information is nullable.
See full Plaid docs at <https://plaid.com/docs/api/accounts/#accountsget>*/
pub async fn accounts_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<AccountsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get Categories
Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
See full Plaid docs at <https://plaid.com/docs/api/products/#categoriesget>*/
pub async fn categories_get(&self) -> anyhow::Result<CategoriesGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({}))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a test Item and processor token
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.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxprocessor_tokencreate>*/
pub async fn sandbox_processor_token_create(
&self,
institution_id: String,
options: serde_json::Value,
) -> anyhow::Result<SandboxProcessorTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "institution_id" : institution_id, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a test Item
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. `/sandbox/public_token/create` cannot be used with OAuth institutions.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxpublic_tokencreate>*/
pub async fn sandbox_public_token_create(
&self,
institution_id: String,
initial_products: Vec<Products>,
options: serde_json::Value,
) -> anyhow::Result<SandboxPublicTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "institution_id" : institution_id, "initial_products" :
initial_products, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Fire a test webhook
The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger 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. This endpoint can also trigger a `NEW_ACCOUNTS_AVAILABLE` webhook to be fired for a given Sandbox Item created with Account Select v2. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxitemfire_webhook>*/
pub async fn sandbox_item_fire_webhook(
&self,
access_token: String,
webhook_code: String,
) -> anyhow::Result<SandboxItemFireWebhookResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "webhook_code" : webhook_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve real-time balance data
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.
See full Plaid docs at <https://plaid.com/docs/api/products/#accountsbalanceget>*/
pub async fn accounts_balance_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<AccountsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve identity data
The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.
Note: This request may take some time to complete if identity 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.
See full Plaid docs at <https://plaid.com/docs/api/products/#identityget>*/
pub async fn identity_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<IdentityGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve Auth data
The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.
Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
See full Plaid docs at <https://plaid.com/docs/api/processors/#processorauthget>*/
pub async fn processor_auth_get(
&self,
processor_token: String,
) -> anyhow::Result<ProcessorAuthGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "processor_token" : processor_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a bank transfer as a processor
Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
See full Plaid docs at <https://plaid.com/docs/api/processors/#bank_transfercreate>*/
pub async fn processor_bank_transfer_create(
&self,
idempotency_key: String,
processor_token: String,
typeStruct: String,
network: String,
amount: String,
iso_currency_code: String,
description: String,
ach_class: String,
user: serde_json::Value,
custom_tag: Option<String>,
metadata: Option<serde_json::Value>,
origination_account_id: Option<String>,
) -> anyhow::Result<ProcessorBankTransferCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "idempotency_key" : idempotency_key, "processor_token" :
processor_token, "type" : typeStruct, "network" : network,
"amount" : amount, "iso_currency_code" : iso_currency_code,
"description" : description, "ach_class" : ach_class, "user" :
user, "custom_tag" : custom_tag, "metadata" : metadata,
"origination_account_id" : origination_account_id }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve Identity data
The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
See full Plaid docs at <https://plaid.com/docs/api/processors/#processoridentityget>*/
pub async fn processor_identity_get(
&self,
processor_token: String,
) -> anyhow::Result<ProcessorIdentityGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "processor_token" : processor_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve Balance data
The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
See full Plaid docs at <https://plaid.com/docs/api/processors/#processorbalanceget>*/
pub async fn processor_balance_get(
&self,
processor_token: String,
options: serde_json::Value,
) -> anyhow::Result<ProcessorBalanceGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!({ "processor_token" : processor_token, "options" : options }),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Update Webhook URL
The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-update-acknowledged) webhook to the newly specified webhook URL.
See full Plaid docs at <https://plaid.com/docs/api/items/#itemwebhookupdate>*/
pub async fn item_webhook_update(
&self,
access_token: String,
webhook: Option<String>,
) -> anyhow::Result<ItemWebhookUpdateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "webhook" : webhook }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Invalidate access_token
By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.
You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
See full Plaid docs at <https://plaid.com/docs/api/tokens/#itemaccess_tokeninvalidate>*/
pub async fn item_access_token_invalidate(
&self,
access_token: String,
) -> anyhow::Result<ItemAccessTokenInvalidateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get webhook verification key
Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header.
The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
See full Plaid docs at <https://plaid.com/docs/api/webhooks/webhook-verification/#webhook_verification_keyget>*/
pub async fn webhook_verification_key_get(
&self,
key_id: String,
) -> anyhow::Result<WebhookVerificationKeyGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "key_id" : key_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve Liabilities data
The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate).
The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
See full Plaid docs at <https://plaid.com/docs/api/products/#liabilitiesget>*/
pub async fn liabilities_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<LiabilitiesGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create payment recipient
Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK.
The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationrecipientcreate>*/
pub async fn payment_initiation_recipient_create(
&self,
name: String,
iban: Option<String>,
bacs: Option<serde_json::Value>,
address: Option<serde_json::Value>,
) -> anyhow::Result<PaymentInitiationRecipientCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "name" : name, "iban" : iban, "bacs" : bacs, "address" :
address }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Reverse an existing payment
Reverse a previously initiated payment.
A payment can only be reversed once and will be refunded to the original sender's account.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationpaymentreverse>*/
pub async fn payment_initiation_payment_reverse(
&self,
payment_id: String,
) -> anyhow::Result<PaymentInitiationPaymentReverseResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "payment_id" : payment_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get payment recipient
Get details about a payment recipient you have previously created.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationrecipientget>*/
pub async fn payment_initiation_recipient_get(
&self,
recipient_id: String,
) -> anyhow::Result<PaymentInitiationRecipientGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "recipient_id" : recipient_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List payment recipients
The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationrecipientlist>*/
pub async fn payment_initiation_recipient_list(
&self,
) -> anyhow::Result<PaymentInitiationRecipientListResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({}))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a payment
After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day.
Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationpaymentcreate>*/
pub async fn payment_initiation_payment_create(
&self,
recipient_id: String,
reference: String,
amount: serde_json::Value,
schedule: serde_json::Value,
options: Option<serde_json::Value>,
) -> anyhow::Result<PaymentInitiationPaymentCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "recipient_id" : recipient_id, "reference" : reference,
"amount" : amount, "schedule" : schedule, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create payment token
The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link.
The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
See full Plaid docs at <https://plaid.com/docs/link/maintain-legacy-integration/#creating-a-payment-token>*/
pub async fn create_payment_token(
&self,
payment_id: String,
) -> anyhow::Result<PaymentInitiationPaymentTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "payment_id" : payment_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Force a Sandbox Item into an error state
`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item.
In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxitemreset_login>*/
pub async fn sandbox_item_reset_login(
&self,
access_token: String,
) -> anyhow::Result<SandboxItemResetLoginResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Set verification status for Sandbox account
The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.
Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).
For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxitemset_verification_status>*/
pub async fn sandbox_item_set_verification_status(
&self,
access_token: String,
account_id: String,
verification_status: String,
) -> anyhow::Result<SandboxItemSetVerificationStatusResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "account_id" : account_id,
"verification_status" : verification_status }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Exchange public token for an access token
Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes.
The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
See full Plaid docs at <https://plaid.com/docs/api/tokens/#itempublic_tokenexchange>*/
pub async fn item_public_token_exchange(
&self,
public_token: String,
) -> anyhow::Result<ItemPublicTokenExchangeResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "public_token" : public_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create public token
Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode).
If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`.
A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally.
The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
See full Plaid docs at <https://plaid.com/docs/api/tokens/#itempublic_tokencreate>*/
pub async fn item_create_public_token(
&self,
access_token: String,
) -> anyhow::Result<ItemPublicTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get payment details
The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationpaymentget>*/
pub async fn payment_initiation_payment_get(
&self,
payment_id: String,
) -> anyhow::Result<PaymentInitiationPaymentGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "payment_id" : payment_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List payments
The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.
See full Plaid docs at <https://plaid.com/docs/api/products/#payment_initiationpaymentlist>*/
pub async fn payment_initiation_payment_list(
&self,
count: Option<i64>,
cursor: Option<String>,
) -> anyhow::Result<PaymentInitiationPaymentListResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "count" : count, "cursor" : cursor }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create an Asset Report
The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.
The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#assets-webhooks).
The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportcreate>*/
pub async fn asset_report_create(
&self,
access_tokens: Vec<AccessToken>,
days_requested: i64,
options: serde_json::Value,
) -> anyhow::Result<AssetReportCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_tokens" : access_tokens, "days_requested" :
days_requested, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Refresh an Asset Report
An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available.
The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportrefresh>*/
pub async fn asset_report_refresh(
&self,
asset_report_token: String,
days_requested: Option<i64>,
options: serde_json::Value,
) -> anyhow::Result<AssetReportRefreshResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "asset_report_token" : asset_report_token, "days_requested" :
days_requested, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Delete an Asset Report
The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically.
The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportremove>*/
pub async fn asset_report_remove(
&self,
asset_report_token: String,
) -> anyhow::Result<AssetReportRemoveResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "asset_report_token" : asset_report_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Filter Asset Report
By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint.
To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data.
Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed.
Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportfilter>*/
pub async fn asset_report_filter(
&self,
asset_report_token: String,
account_ids_to_exclude: Vec<String>,
) -> anyhow::Result<AssetReportFilterResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "asset_report_token" : asset_report_token,
"account_ids_to_exclude" : account_ids_to_exclude }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve an Asset Report
The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved.
By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report.
To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportget>*/
pub async fn asset_report_get(
&self,
asset_report_token: String,
include_insights: bool,
) -> anyhow::Result<AssetReportGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "asset_report_token" : asset_report_token, "include_insights" :
include_insights }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create Asset Report Audit Copy
Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.
To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportaudit_copycreate>*/
pub async fn asset_report_audit_copy_create(
&self,
asset_report_token: String,
auditor_id: String,
) -> anyhow::Result<AssetReportAuditCopyCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "asset_report_token" : asset_report_token, "auditor_id" :
auditor_id }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Remove Asset Report Audit Copy
The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
See full Plaid docs at <https://plaid.com/docs/api/products/#asset_reportaudit_copyremove>*/
pub async fn asset_report_audit_copy_remove(
&self,
audit_copy_token: String,
) -> anyhow::Result<AssetReportAuditCopyRemoveResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "audit_copy_token" : audit_copy_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get Investment holdings
The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
See full Plaid docs at <https://plaid.com/docs/api/products/#investmentsholdingsget>*/
pub async fn investments_holdings_get(
&self,
access_token: String,
options: serde_json::Value,
) -> anyhow::Result<InvestmentsHoldingsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token, "options" : options }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get investment transactions
The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.
Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
See full Plaid docs at <https://plaid.com/docs/api/products/#investmentstransactionsget>*/
pub async fn investments_transactions_get(
&self,
access_token: String,
start_date: String,
end_date: String,
options: serde_json::Value,
) -> anyhow::Result<InvestmentsTransactionsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "start_date" : start_date,
"end_date" : end_date, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create processor token
Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations.
See full Plaid docs at <https://plaid.com/docs/api/processors/#processortokencreate>*/
pub async fn processor_token_create(
&self,
access_token: String,
account_id: String,
processor: String,
) -> anyhow::Result<ProcessorTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "account_id" : account_id,
"processor" : processor }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create Stripe bank account token
Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
See full Plaid docs at <https://plaid.com/docs/api/processors/#processorstripebank_account_tokencreate>*/
pub async fn processor_stripe_bank_account_token_create(
&self,
access_token: String,
account_id: String,
) -> anyhow::Result<ProcessorStripeBankAccountTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!({ "access_token" : access_token, "account_id" : account_id }),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create Apex bank account token
Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
See full Plaid docs at <https://plaid.com/docs/none/>*/
pub async fn processor_apex_processor_token_create(
&self,
access_token: String,
account_id: String,
) -> anyhow::Result<ProcessorTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!({ "access_token" : access_token, "account_id" : account_id }),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a deposit switch
This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
See full Plaid docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchcreate>*/
pub async fn deposit_switch_create(
&self,
target_access_token: String,
target_account_id: String,
country_code: Option<String>,
options: serde_json::Value,
) -> anyhow::Result<DepositSwitchCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "target_access_token" : target_access_token,
"target_account_id" : target_account_id, "country_code" :
country_code, "options" : options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Import Item
`/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you.
Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).*/
pub async fn item_import(
&self,
products: Vec<Products>,
user_auth: serde_json::Value,
options: serde_json::Value,
) -> anyhow::Result<ItemImportResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "products" : products, "user_auth" : user_auth, "options" :
options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a deposit switch token
In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
See full Plaid docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchtokencreate>*/
pub async fn deposit_switch_token_create(
&self,
deposit_switch_id: String,
) -> anyhow::Result<DepositSwitchTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "deposit_switch_id" : deposit_switch_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create Link Token
The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow.
A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
See full Plaid docs at <https://plaid.com/docs/api/tokens/#linktokencreate>*/
pub async fn link_token_create(
&self,
client_name: String,
language: String,
country_codes: Vec<CountryCode>,
user: serde_json::Value,
products: Vec<Products>,
webhook: String,
access_token: String,
link_customization_name: String,
redirect_uri: String,
android_package_name: String,
account_filters: serde_json::Value,
eu_config: serde_json::Value,
institution_id: String,
payment_initiation: serde_json::Value,
deposit_switch: serde_json::Value,
income_verification: serde_json::Value,
auth: serde_json::Value,
transfer: serde_json::Value,
update: serde_json::Value,
) -> anyhow::Result<LinkTokenCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "client_name" : client_name, "language" : language,
"country_codes" : country_codes, "user" : user, "products" :
products, "webhook" : webhook, "access_token" : access_token,
"link_customization_name" : link_customization_name,
"redirect_uri" : redirect_uri, "android_package_name" :
android_package_name, "account_filters" : account_filters,
"eu_config" : eu_config, "institution_id" : institution_id,
"payment_initiation" : payment_initiation, "deposit_switch" :
deposit_switch, "income_verification" : income_verification,
"auth" : auth, "transfer" : transfer, "update" : update }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get Link Token
The `/link/token/get` endpoint gets information about a previously-created `link_token` using the
`/link/token/create` endpoint. It can be useful for debugging purposes.
See full Plaid docs at <https://plaid.com/docs/api/tokens/#linktokenget>*/
pub async fn link_token_get(
&self,
link_token: String,
) -> anyhow::Result<LinkTokenGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "link_token" : link_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve an Asset Report Audit Copy
`/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`.
See full Plaid docs at <https://plaid.com/docs/none/>*/
pub async fn asset_report_audit_copy_get(
&self,
audit_copy_token: String,
) -> anyhow::Result<AssetReportGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "audit_copy_token" : audit_copy_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a deposit switch
This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
See full Plaid docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchget>*/
pub async fn deposit_switch_get(
&self,
deposit_switch_id: String,
) -> anyhow::Result<DepositSwitchGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "deposit_switch_id" : deposit_switch_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a transfer
The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
See full Plaid docs at <https://plaid.com/docs/api/products#transferget>*/
pub async fn transfer_get(
&self,
transfer_id: String,
) -> anyhow::Result<TransferGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "transfer_id" : transfer_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a bank transfer
The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferget>*/
pub async fn bank_transfer_get(
&self,
bank_transfer_id: String,
) -> anyhow::Result<BankTransferGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "bank_transfer_id" : bank_transfer_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a transfer authorization
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk.
In Plaid's sandbox environment the decisions will be returned as follows:
- To approve a transfer, make an authorization request with an `amount` less than the available balance in the account.
- To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
- To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
- To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).
- To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).
All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
See full Plaid docs at <https://plaid.com/docs/api/products#transferauthorizationcreate>*/
pub async fn transfer_authorization_create(
&self,
access_token: String,
account_id: String,
typeStruct: String,
network: String,
amount: String,
ach_class: String,
user: serde_json::Value,
device: serde_json::Value,
origination_account_id: String,
iso_currency_code: String,
) -> anyhow::Result<TransferAuthorizationCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "account_id" : account_id,
"type" : typeStruct, "network" : network, "amount" : amount,
"ach_class" : ach_class, "user" : user, "device" : device,
"origination_account_id" : origination_account_id,
"iso_currency_code" : iso_currency_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a transfer
Use the `/transfer/create` endpoint to initiate a new transfer.
See full Plaid docs at <https://plaid.com/docs/api/products#transfercreate>*/
pub async fn transfer_create(
&self,
idempotency_key: String,
access_token: String,
account_id: String,
authorization_id: String,
typeStruct: String,
network: String,
amount: String,
description: String,
ach_class: String,
user: serde_json::Value,
metadata: Option<serde_json::Value>,
origination_account_id: Option<String>,
iso_currency_code: String,
) -> anyhow::Result<TransferCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "idempotency_key" : idempotency_key, "access_token" :
access_token, "account_id" : account_id, "authorization_id" :
authorization_id, "type" : typeStruct, "network" : network,
"amount" : amount, "description" : description, "ach_class" :
ach_class, "user" : user, "metadata" : metadata,
"origination_account_id" : origination_account_id,
"iso_currency_code" : iso_currency_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a bank transfer
Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfercreate>*/
pub async fn bank_transfer_create(
&self,
idempotency_key: String,
access_token: String,
account_id: String,
typeStruct: String,
network: String,
amount: String,
iso_currency_code: String,
description: String,
ach_class: String,
user: serde_json::Value,
custom_tag: Option<String>,
metadata: Option<serde_json::Value>,
origination_account_id: Option<String>,
) -> anyhow::Result<BankTransferCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "idempotency_key" : idempotency_key, "access_token" :
access_token, "account_id" : account_id, "type" : typeStruct,
"network" : network, "amount" : amount, "iso_currency_code" :
iso_currency_code, "description" : description, "ach_class" :
ach_class, "user" : user, "custom_tag" : custom_tag, "metadata" :
metadata, "origination_account_id" : origination_account_id }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List transfers
Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
See full Plaid docs at <https://plaid.com/docs/api/products#transferlist>*/
pub async fn transfer_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
count: i64,
offset: i64,
origination_account_id: Option<String>,
) -> anyhow::Result<TransferListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date, "count" :
count, "offset" : offset, "origination_account_id" :
origination_account_id }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List bank transfers
Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferlist>*/
pub async fn bank_transfer_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
count: i64,
offset: i64,
origination_account_id: Option<String>,
direction: Option<String>,
) -> anyhow::Result<BankTransferListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date, "count" :
count, "offset" : offset, "origination_account_id" :
origination_account_id, "direction" : direction }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Cancel a transfer
Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
See full Plaid docs at <https://plaid.com/docs/api/products#transfercancel>*/
pub async fn transfer_cancel(
&self,
transfer_id: String,
) -> anyhow::Result<TransferCancelResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "transfer_id" : transfer_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Cancel a bank transfer
Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfercancel>*/
pub async fn bank_transfer_cancel(
&self,
bank_transfer_id: String,
) -> anyhow::Result<BankTransferCancelResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "bank_transfer_id" : bank_transfer_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List transfer events
Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
See full Plaid docs at <https://plaid.com/docs/api/products#transfereventlist>*/
pub async fn transfer_event_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
transfer_id: Option<String>,
account_id: Option<String>,
transfer_type: Option<String>,
event_types: Vec<TransferEventType>,
sweep_id: String,
count: Option<i64>,
offset: Option<i64>,
origination_account_id: Option<String>,
) -> anyhow::Result<TransferEventListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date, "transfer_id"
: transfer_id, "account_id" : account_id, "transfer_type" :
transfer_type, "event_types" : event_types, "sweep_id" :
sweep_id, "count" : count, "offset" : offset,
"origination_account_id" : origination_account_id }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List bank transfer events
Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfereventlist>*/
pub async fn bank_transfer_event_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
bank_transfer_id: Option<String>,
account_id: Option<String>,
bank_transfer_type: Option<String>,
event_types: Vec<BankTransferEventType>,
count: Option<i64>,
offset: Option<i64>,
origination_account_id: Option<String>,
direction: Option<String>,
) -> anyhow::Result<BankTransferEventListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date,
"bank_transfer_id" : bank_transfer_id, "account_id" : account_id,
"bank_transfer_type" : bank_transfer_type, "event_types" :
event_types, "count" : count, "offset" : offset,
"origination_account_id" : origination_account_id, "direction" :
direction }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Sync transfer events
`/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
See full Plaid docs at <https://plaid.com/docs/api/products#transfereventsync>*/
pub async fn transfer_event_sync(
&self,
after_id: i64,
count: Option<i64>,
) -> anyhow::Result<TransferEventSyncResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "after_id" : after_id, "count" : count }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Sync bank transfer events
`/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfereventsync>*/
pub async fn bank_transfer_event_sync(
&self,
after_id: i64,
count: Option<i64>,
) -> anyhow::Result<BankTransferEventSyncResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "after_id" : after_id, "count" : count }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a sweep
The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
See full Plaid docs at <https://plaid.com/docs/api/products#transfersweepget>*/
pub async fn transfer_sweep_get(
&self,
sweep_id: String,
) -> anyhow::Result<TransferSweepGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "sweep_id" : sweep_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a sweep
The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
See full Plaid docs at <https://plaid.com/docs/api/products#bank_transfersweepget>*/
pub async fn bank_transfer_sweep_get(
&self,
sweep_id: String,
) -> anyhow::Result<BankTransferSweepGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "sweep_id" : sweep_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List sweeps
The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
See full Plaid docs at <https://plaid.com/docs/api/products#transfersweeplist>*/
pub async fn transfer_sweep_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
count: Option<i64>,
offset: i64,
) -> anyhow::Result<TransferSweepListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date, "count" :
count, "offset" : offset }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List sweeps
The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
See full Plaid docs at <https://plaid.com/docs/api/products#bank_transfersweeplist>*/
pub async fn bank_transfer_sweep_list(
&self,
origination_account_id: Option<String>,
start_time: Option<String>,
end_time: Option<String>,
count: Option<i64>,
) -> anyhow::Result<BankTransferSweepListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "origination_account_id" : origination_account_id, "start_time"
: start_time, "end_time" : end_time, "count" : count }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Get balance of your Bank Transfer account
Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.
The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.
Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transferbalanceget>*/
pub async fn bank_transfer_balance_get(
&self,
origination_account_id: Option<String>,
) -> anyhow::Result<BankTransferBalanceGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "origination_account_id" : origination_account_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Migrate account into Bank Transfers
As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference#bank_transfermigrate_account>*/
pub async fn bank_transfer_migrate_account(
&self,
account_number: String,
routing_number: String,
account_type: String,
) -> anyhow::Result<BankTransferMigrateAccountResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "account_number" : account_number, "routing_number" :
routing_number, "account_type" : account_type }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a transfer intent object to invoke the Transfer UI
Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
See full Plaid docs at <https://plaid.com/docs/api/products#transferintentcreate>*/
pub async fn transfer_intent_create(
&self,
account_id: Option<String>,
mode: String,
amount: String,
description: String,
ach_class: String,
origination_account_id: Option<String>,
user: serde_json::Value,
metadata: Option<serde_json::Value>,
iso_currency_code: String,
) -> anyhow::Result<TransferIntentCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "account_id" : account_id, "mode" : mode, "amount" : amount,
"description" : description, "ach_class" : ach_class,
"origination_account_id" : origination_account_id, "user" : user,
"metadata" : metadata, "iso_currency_code" : iso_currency_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve more information about a transfer intent
Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
See full Plaid docs at <https://plaid.com/docs/api/products#transferintentget>*/
pub async fn transfer_intent_get(
&self,
transfer_intent_id: String,
) -> anyhow::Result<TransferIntentGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "transfer_intent_id" : transfer_intent_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Lists historical repayments
The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
See full Plaid docs at <https://plaid.com/docs/api/products#transferrepaymentlist>*/
pub async fn transfer_repayment_list(
&self,
start_date: Option<String>,
end_date: Option<String>,
count: Option<i64>,
offset: i64,
) -> anyhow::Result<TransferRepaymentListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "start_date" : start_date, "end_date" : end_date, "count" :
count, "offset" : offset }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List the returns included in a repayment
The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
See full Plaid docs at <https://plaid.com/docs/api/products#transferrepaymentreturnlist>*/
pub async fn transfer_repayment_return_list(
&self,
repayment_id: String,
count: Option<i64>,
offset: i64,
) -> anyhow::Result<TransferRepaymentReturnListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "repayment_id" : repayment_id, "count" : count, "offset" :
offset }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Simulate a bank transfer event in Sandbox
Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference/#sandboxbank_transfersimulate>*/
pub async fn sandbox_bank_transfer_simulate(
&self,
bank_transfer_id: String,
event_type: String,
failure_reason: Option<serde_json::Value>,
) -> anyhow::Result<SandboxBankTransferSimulateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "bank_transfer_id" : bank_transfer_id, "event_type" :
event_type, "failure_reason" : failure_reason }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Simulate creating a sweep
Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `reversed` transfers with a sweep status of `swept` will become `reverse_swept`.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxtransfersweepsimulate>*/
pub async fn sandbox_transfer_sweep_simulate(
&self,
) -> anyhow::Result<SandboxTransferSweepSimulateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({}))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Simulate a transfer event in Sandbox
Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxtransfersimulate>*/
pub async fn sandbox_transfer_simulate(
&self,
transfer_id: String,
event_type: String,
failure_reason: Option<serde_json::Value>,
) -> anyhow::Result<SandboxTransferSimulateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "transfer_id" : transfer_id, "event_type" : event_type,
"failure_reason" : failure_reason }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Trigger the creation of a repayment
Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxtransferrepaymentsimulate>*/
pub async fn sandbox_transfer_repayment_simulate(
&self,
) -> anyhow::Result<SandboxTransferRepaymentSimulateResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({}))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Search employer database
`/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.
The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
See full Plaid docs at <https://plaid.com/docs/api/employers/#employerssearch>*/
pub async fn employers_search(
&self,
query: String,
products: Vec<String>,
) -> anyhow::Result<EmployersSearchResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "query" : query, "products" : products }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**(Deprecated) Create an income verification instance
`/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationcreate>*/
pub async fn income_verification_create(
&self,
webhook: String,
precheck_id: String,
options: serde_json::Value,
) -> anyhow::Result<IncomeVerificationCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "webhook" : webhook, "precheck_id" : precheck_id, "options" :
options }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**(Deprecated) Retrieve a summary of information derived from income verification
`/income/verification/summary/get` returns a verification summary for the income that was verified for an end user. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationsummaryget>*/
pub async fn income_verification_summary_get(
&self,
income_verification_id: Option<String>,
access_token: Option<String>,
) -> anyhow::Result<IncomeVerificationSummaryGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id,
"access_token" : access_token }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**(Deprecated) Retrieve information from a single paystub used for income verification
/income/verification/paystub/get returns information from a single paystub used for income verification*/
pub async fn income_verification_paystub_get(
&self,
income_verification_id: Option<String>,
access_token: Option<String>,
) -> anyhow::Result<IncomeVerificationPaystubGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id,
"access_token" : access_token }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve information from the paystubs used for income verification
`/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationpaystubsget>*/
pub async fn income_verification_paystubs_get(
&self,
income_verification_id: Option<String>,
access_token: Option<String>,
) -> anyhow::Result<IncomeVerificationPaystubsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id,
"access_token" : access_token }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Refresh an income verification
`/income/verification/refresh` refreshes a given income verification.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationrefresh>*/
pub async fn income_verification_refresh(
&self,
income_verification_id: Option<String>,
access_token: Option<String>,
) -> anyhow::Result<IncomeVerificationRefreshResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id,
"access_token" : access_token }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve information from the tax documents used for income verification
`/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationtaxformsget>*/
pub async fn income_verification_taxforms_get(
&self,
income_verification_id: Option<String>,
access_token: Option<String>,
) -> anyhow::Result<IncomeVerificationTaxformsGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id,
"access_token" : access_token }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Check digital income verification eligibility and optimize conversion
`/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income.
While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result.
See full Plaid docs at <https://plaid.com/docs/api/products/#incomeverificationprecheck>*/
pub async fn income_verification_precheck(
&self,
user: Option<serde_json::Value>,
employer: Option<serde_json::Value>,
transactions_access_token: serde_json::Value,
transactions_access_tokens: Vec<AccessToken>,
us_military_info: Option<serde_json::Value>,
) -> anyhow::Result<IncomeVerificationPrecheckResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "user" : user, "employer" : employer,
"transactions_access_token" : transactions_access_token,
"transactions_access_tokens" : transactions_access_tokens,
"us_military_info" : us_military_info }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Retrieve a summary of an individual's employment information
`/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
See full Plaid docs at <https://plaid.com/docs/api/products/#employmentverificationget>*/
pub async fn employment_verification_get(
&self,
access_token: String,
) -> anyhow::Result<EmploymentVerificationGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "access_token" : access_token }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Create a deposit switch without using Plaid Exchange
This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
See full Plaid docs at <https://plaid.com/docs/deposit-switch/reference#deposit_switchaltcreate>*/
pub async fn deposit_switch_alt_create(
&self,
target_account: serde_json::Value,
target_user: serde_json::Value,
options: serde_json::Value,
country_code: Option<String>,
) -> anyhow::Result<DepositSwitchAltCreateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "target_account" : target_account, "target_user" : target_user,
"options" : options, "country_code" : country_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Manually fire a Bank Transfer webhook
Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
See full Plaid docs at <https://plaid.com/docs/bank-transfers/reference/#sandboxbank_transferfire_webhook>*/
pub async fn sandbox_bank_transfer_fire_webhook(
&self,
webhook: String,
) -> anyhow::Result<SandboxBankTransferFireWebhookResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "webhook" : webhook }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Manually fire an Income webhook
Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
See full Plaid docs at <https://plaid.com/docs/api/sandbox/#sandboxincomefire_webhook>*/
pub async fn sandbox_income_fire_webhook(
&self,
income_verification_id: String,
item_id: String,
webhook: String,
verification_status: String,
) -> anyhow::Result<SandboxIncomeFireWebhookResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "income_verification_id" : income_verification_id, "item_id" :
item_id, "webhook" : webhook, "verification_status" :
verification_status }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
///Save the selected accounts when connecting to the Platypus Oauth institution
pub async fn sandbox_oauth_select_accounts(
&self,
oauth_state_id: String,
accounts: Vec<String>,
) -> anyhow::Result<SandboxOauthSelectAccountsResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!({ "oauth_state_id" : oauth_state_id, "accounts" : accounts }),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Evaluate a planned ACH transaction
Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.
In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
See full Plaid docs at <https://plaid.com/docs/signal/reference#signalevaluate>*/
pub async fn signal_evaluate(
&self,
access_token: String,
account_id: String,
client_transaction_id: String,
amount: f64,
user_present: Option<bool>,
client_user_id: String,
user: serde_json::Value,
device: serde_json::Value,
) -> anyhow::Result<SignalEvaluateResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "access_token" : access_token, "account_id" : account_id,
"client_transaction_id" : client_transaction_id, "amount" :
amount, "user_present" : user_present, "client_user_id" :
client_user_id, "user" : user, "device" : device }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Report whether you initiated an ACH transaction
After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
See full Plaid docs at <https://plaid.com/docs/signal/reference#signaldecisionreport>*/
pub async fn signal_decision_report(
&self,
client_transaction_id: String,
initiated: bool,
days_funds_on_hold: Option<i64>,
) -> anyhow::Result<SignalDecisionReportResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "client_transaction_id" : client_transaction_id, "initiated" :
initiated, "days_funds_on_hold" : days_funds_on_hold }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Report a return for an ACH transaction
Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the foo to incorporate the latest risk trend in your portfolio.
See full Plaid docs at <https://plaid.com/docs/signal/reference#signalreturnreport>*/
pub async fn signal_return_report(
&self,
client_transaction_id: String,
return_code: String,
) -> anyhow::Result<SignalReturnReportResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "client_transaction_id" : client_transaction_id, "return_code"
: return_code }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Fetch an e-wallet
Fetch an e-wallet. The response includes the current balance.
See full Plaid docs at <https://plaid.com/docs/api/products/#walletget>*/
pub async fn wallet_get(
&self,
wallet_id: String,
) -> anyhow::Result<WalletGetResponse> {
{
let res = self
.client
.post("/item/get")
.json(json!({ "wallet_id" : wallet_id }))
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**Execute a transaction using an e-wallet
Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
See full Plaid docs at <https://plaid.com/docs/api/products/#wallettransactionexecute>*/
pub async fn wallet_transaction_execute(
&self,
idempotency_key: String,
wallet_id: String,
counterparty: serde_json::Value,
amount: serde_json::Value,
reference: String,
) -> anyhow::Result<WalletTransactionExecuteResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "idempotency_key" : idempotency_key, "wallet_id" : wallet_id,
"counterparty" : counterparty, "amount" : amount, "reference" :
reference }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
/**List e-wallet transactions
This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
See full Plaid docs at <https://plaid.com/docs/api/products/#wallettransactionslist>*/
pub async fn wallet_transactions_list(
&self,
wallet_id: String,
cursor: String,
count: i64,
) -> anyhow::Result<WalletTransactionsListResponse> {
{
let res = self
.client
.post("/item/get")
.json(
json!(
{ "wallet_id" : wallet_id, "cursor" : cursor, "count" : count }
),
)
.authenticate(&self.authentication)
.send()
.await
.unwrap()
.error_for_status();
match res {
Ok(res) => res.json().await.map_err(|e| anyhow::anyhow!("{:?}", e)),
Err(res) => {
let text = res.text().await.map_err(|e| anyhow::anyhow!("{:?}", e));
Err(anyhow::anyhow!("{:?}", text))
}
}
}
}
}
pub enum PlaidAuthentication {
ClientId { client_id: String, secret: String, plaid_version: String },
}
impl PlaidAuthentication {
pub fn from_env() -> Self {
Self::ClientId {
client_id: std::env::var("PLAID_CLIENT_ID")
.expect("Environment variable PLAID_CLIENT_ID not set"),
secret: std::env::var("PLAID_SECRET")
.expect("Environment variable PLAID_SECRET not set"),
plaid_version: std::env::var("PLAID_VERSION")
.expect("Environment variable PLAID_VERSION not set"),
}
}
}
trait Authenticatable {
fn authenticate(self, authenticator: &Option<PlaidAuthentication>) -> Self;
}
impl<'a> Authenticatable for RequestBuilder<'a> {
fn authenticate(self, authenticator: &Option<PlaidAuthentication>) -> Self {
if let Some(authenticator) = authenticator {
match authenticator {
PlaidAuthentication::ClientId { client_id, secret, .. } => {
self
.push_json(
json!({ "client_id" : client_id, "secret" : secret, }),
)
}
}
} else {
self
}
}
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemGetResponse {
///Metadata about the Item.
pub item: Item,
///Information about the last successful and failed transactions update for the Item.
pub status: ItemStatusNullable,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///An optional object to filter `/auth/get` results.
pub options: Option<AuthGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthGetRequestOptions {
/**A list of `account_ids` to retrieve for the Item.
Note: An error will be returned if a provided `account_id` is not associated with the Item.*/
pub account_ids: Option<Vec<String>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthGetResponse {
///The `accounts` for which numbers are being retrieved.
pub accounts: Vec<AccountBase>,
///An object containing identifying numbers used for making electronic transfers to and from the `accounts`. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by any `accounts` for which data has been requested, the array for that type will be empty.
pub numbers: AuthGetNumbers,
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthGetNumbers {
///An array of ACH numbers identifying accounts.
pub ach: Vec<NumbersACH>,
///An array of EFT numbers identifying accounts.
pub eft: Vec<NumbersEFT>,
///An array of IBAN numbers identifying accounts.
pub international: Vec<NumbersInternational>,
///An array of BACS numbers identifying accounts.
pub bacs: Vec<NumbersBACS>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///An optional object to be used with the request. If specified, `options` must not be `null`.
pub options: Option<TransactionsGetRequestOptions>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
pub start_date: String,
///The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.
pub end_date: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsGetRequestOptions {
/**A list of `account_ids` to retrieve for the Item
Note: An error will be returned if a provided `account_id` is not associated with the Item.*/
pub account_ids: Option<Vec<String>>,
///The number of transactions to fetch.
pub count: Option<i64>,
///The number of transactions to skip. The default value is 0.
pub offset: Option<i64>,
///Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager.
pub include_original_description: Option<bool>,
///Include the `personal_finance_category` object in the response. This feature is currently in beta – to request access, contact transactions-feedback@plaid.com.
pub include_personal_finance_category_beta: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsGetResponse {
///An array containing the `accounts` associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the `account_id` field.
pub accounts: Vec<AccountBase>,
///An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the `count` parameter.
pub transactions: Vec<Transaction>,
///The total number of transactions available within the date range specified. If `total_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter.
pub total_transactions: i64,
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsRefreshRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsRefreshResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsRecurringGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**A list of `account_ids` to retrieve for the Item
Note: An error will be returned if a provided `account_id` is not associated with the Item.*/
pub account_ids: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsRecurringGetResponse {
///An array of depository transaction streams.
pub inflow_streams: Vec<TransactionStream>,
///An array of expense transaction streams.
pub outflow_streams: Vec<TransactionStream>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsSyncRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update.
If omitted, the entire history of updates will be returned, starting with the first-added transactions on the item.
Note: The upper-bound length of this cursor is 256 characters of base64.*/
pub cursor: Option<String>,
///The number of transaction updates to fetch.
pub count: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsSyncResponse {
///Transactions that have been added to the item since `cursor` ordered by ascending last modified time.
pub added: Vec<Transaction>,
///Transactions that have been modified on the item since `cursor` ordered by ascending last modified time.
pub modified: Vec<Transaction>,
///Transactions that have been removed from the item since `cursor` ordered by ascending last modified time.
pub removed: Vec<RemovedTransaction>,
///Cursor used for fetching any future updates after the latest update provided in this response.
pub next_cursor: String,
///Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with `cursor` set to `next_cursor`.
pub has_more: bool,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The total number of Institutions to return.
pub count: i64,
///The number of Institutions to skip.
pub offset: i64,
/**Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied.
*/
pub country_codes: Vec<CountryCode>,
///An optional object to filter `/institutions/get` results.
pub options: Option<InstitutionsGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetRequestOptions {
///Filter the Institutions based on which products they support.
pub products: Option<Vec<Products>>,
///Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are not comprehensive; failure to match a given routing number to an institution does not mean that the institution is unsupported by Plaid.
pub routing_numbers: Option<Vec<String>>,
///Limit results to institutions with or without OAuth login flows.
pub oauth: Option<bool>,
/**When `true`, return the institution's homepage URL, logo and primary brand color.
Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.*/
pub include_optional_metadata: Option<bool>,
///When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
pub include_auth_metadata: Option<bool>,
///When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
pub include_payment_initiation_metadata: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetResponse {
///A list of Plaid institutions
pub institutions: Vec<Institution>,
///The total number of institutions available via this endpoint
pub total: i64,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsSearchRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The search query. Institutions with names matching the query are returned
pub query: String,
///Filter the Institutions based on whether they support all products listed in `products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array.
pub products: Option<Vec<Products>>,
/**Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied.
*/
pub country_codes: Vec<CountryCode>,
///An optional object to filter `/institutions/search` results.
pub options: Option<InstitutionsSearchRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsSearchRequestOptions {
///Limit results to institutions with or without OAuth login flows.
pub oauth: Option<bool>,
///When true, return the institution's homepage URL, logo and primary brand color.
pub include_optional_metadata: Option<bool>,
///When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
pub include_auth_metadata: Option<bool>,
///When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
pub include_payment_initiation_metadata: Option<bool>,
///Additional options that will be used to filter institutions by various Payment Initiation configurations.
pub payment_initiation: InstitutionsSearchPaymentInitiationOptions,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsSearchPaymentInitiationOptions {
///A unique ID identifying the payment
pub payment_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsSearchResponse {
///An array of institutions matching the search criteria
pub institutions: Vec<Institution>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetByIdRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the institution to get details about
pub institution_id: String,
/**Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied.
*/
pub country_codes: Vec<CountryCode>,
///Specifies optional parameters for `/institutions/get_by_id`. If provided, must not be `null`.
pub options: Option<InstitutionsGetByIdRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetByIdRequestOptions {
/**When `true`, return an institution's logo, brand color, and URL. When available, the bank's logo is returned as a base64 encoded 152x152 PNG, the brand color is in hexadecimal format. The default value is `false`.
Note that Plaid does not own any of the logos shared by the API and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.*/
pub include_optional_metadata: Option<bool>,
///If `true`, the response will include status information about the institution. Default value is `false`.
pub include_status: Option<bool>,
///When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
pub include_auth_metadata: Option<bool>,
///When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
pub include_payment_initiation_metadata: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsGetByIdResponse {
///Details relating to a specific financial institution
pub institution: Institution,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemRemoveRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemRemoveResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///An optional object to filter `/accounts/get` results.
pub options: Option<AccountsGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountsGetRequestOptions {
///An array of `account_ids` to retrieve for the Account.
pub account_ids: Option<Vec<String>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountsGetResponse {
/**An array of financial institution accounts associated with the Item.
If `/accounts/balance/get` was called, each account will include real-time balance information.*/
pub accounts: Vec<AccountBase>,
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CategoriesGetRequest {}
#[derive(Debug, Serialize, Deserialize)]
pub struct CategoriesGetResponse {
///An array of all of the transaction categories used by Plaid.
pub categories: Vec<Category>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxOverridePassword(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxOverrideUsername(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxProcessorTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the institution the Item will be associated with
pub institution_id: String,
///An optional set of options to be used when configuring the Item. If specified, must not be `null`.
pub options: Option<SandboxProcessorTokenCreateRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxProcessorTokenCreateRequestOptions {
///Test username to use for the creation of the Sandbox Item. Default value is `user_good`.
pub override_username: SandboxOverrideUsername,
///Test password to use for the creation of the Sandbox Item. Default value is `pass_good`.
pub override_password: SandboxOverridePassword,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxProcessorTokenCreateResponse {
///A processor token that can be used to call the `/processor/` endpoints.
pub processor_token: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxPublicTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the institution the Item will be associated with
pub institution_id: String,
///The products to initially pull for the Item. May be any products that the specified `institution_id` supports. This array may not be empty.
pub initial_products: Vec<Products>,
///An optional set of options to be used when configuring the Item. If specified, must not be `null`.
pub options: Option<SandboxPublicTokenCreateRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxPublicTokenCreateRequestOptions {
///Specify a webhook to associate with the new Item.
pub webhook: Option<String>,
///Test username to use for the creation of the Sandbox Item. Default value is `user_good`.
pub override_username: SandboxOverrideUsername,
///Test password to use for the creation of the Sandbox Item. Default value is `pass_good`.
pub override_password: SandboxOverridePassword,
///An optional set of parameters corresponding to transactions options.
pub transactions: Option<SandboxPublicTokenCreateRequestOptionsTransactions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxPublicTokenCreateRequestOptionsTransactions {
///The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
pub start_date: Option<String>,
///The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
pub end_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxPublicTokenCreateResponse {
///A public token that can be exchanged for an access token using `/item/public_token/exchange`
pub public_token: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemFireWebhookRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
/**The following values for `webhook_code` are supported:
* `DEFAULT_UPDATE`
* `NEW_ACCOUNTS_AVAILABLE`*/
pub webhook_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemFireWebhookResponse {
///Value is `true` if the test` webhook_code` was successfully fired.
pub webhook_fired: bool,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountsBalanceGetRequest {
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///An optional object to filter `/accounts/balance/get` results.
pub options: Option<AccountsBalanceGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountsBalanceGetRequestOptions {
/**A list of `account_ids` to retrieve for the Item. The default value is `null`.
Note: An error will be returned if a provided `account_id` is not associated with the Item.*/
pub account_ids: Option<Vec<String>>,
/**Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the oldest acceptable balance when making a request to `/accounts/balance/get`.
If the balance that is pulled for `ins_128026` (Capital One) is older than the given timestamp, an `INVALID_REQUEST` error with the code of `LAST_UPDATED_DATETIME_OUT_OF_RANGE` will be returned with the most recent timestamp for the requested account contained in the response.
This field is only used when the institution is `ins_128026` (Capital One), in which case a value must be provided or an `INVALID_REQUEST` error with the code of `INVALID_FIELD` will be returned. For all other institutions, this field is ignored.*/
pub min_last_updated_datetime: Option<MinLastUpdatedDatetime>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct MinLastUpdatedDatetime(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct IdentityGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///An optional object to filter `/identity/get` results.
pub options: Option<IdentityGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IdentityGetRequestOptions {
/**A list of `account_ids` to retrieve for the Item.
Note: An error will be returned if a provided `account_id` is not associated with the Item.*/
pub account_ids: Option<Vec<String>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IdentityGetResponse {
///The accounts for which Identity data has been requested
pub accounts: Vec<AccountIdentity>,
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorAuthGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
pub processor_token: ProcessorToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorAuthGetResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
///An object containing identifying numbers used for making electronic transfers to and from the `account`. The identifying number type (ACH, EFT, IBAN, or BACS) used will depend on the country of the account. An account may have more than one number type. If a particular identifying number type is not used by the `account` for which auth data has been requested, a null value will be returned.
pub numbers: ProcessorNumber,
///A single account at a financial institution.
pub account: AccountBase,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorBankTransferCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**A random key provided by the client, per unique bank transfer. Maximum of 50 characters.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.*/
pub idempotency_key: BankTransferIdempotencyKey,
///The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
pub processor_token: ProcessorToken,
#[serde(rename = "type")]
///The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: BankTransferType,
///The network or rails used for the transfer. Valid options are `ach`, `same-day-ach`, or `wire`.
pub network: BankTransferNetwork,
///The amount of the bank transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: BankTransferAmount,
///The currency of the transfer amount – should be set to "USD".
pub iso_currency_code: String,
///The transfer description. Maximum of 10 characters.
pub description: String,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: Option<ACHClass>,
///The legal name and other information for the account holder.
pub user: BankTransferUser,
///An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.
pub custom_tag: Option<String>,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: BankTransferMetadata,
///Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified.
pub origination_account_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorBankTransferCreateResponse {
///Represents a bank transfer within the Bank Transfers API.
pub bank_transfer: BankTransfer,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorNumber {
///Identifying information for transferring money to or from a US account via ACH or wire transfer.
pub ach: NumbersACHNullable,
///Identifying information for transferring money to or from a Canadian bank account via EFT.
pub eft: NumbersEFTNullable,
///Identifying information for transferring money to or from an international bank account via wire transfer.
pub international: NumbersInternationalNullable,
///Identifying information for transferring money to or from a UK bank account via BACS.
pub bacs: NumbersBACSNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorIdentityGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
pub processor_token: ProcessorToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorIdentityGetResponse {
///Identity information about an account
pub account: AccountIdentity,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorBalanceGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The processor token obtained from the Plaid integration partner. Processor tokens are in the format: `processor-<environment>-<identifier>`
pub processor_token: ProcessorToken,
///An optional object to filter `/processor/balance/get` results.
pub options: Option<ProcessorBalanceGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorBalanceGetRequestOptions {
/**Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the oldest acceptable balance when making a request to `/accounts/balance/get`.
If the balance that is pulled for `ins_128026` (Capital One) is older than the given timestamp, an `INVALID_REQUEST` error with the code of `LAST_UPDATED_DATETIME_OUT_OF_RANGE` will be returned with the most recent timestamp for the requested account contained in the response.
This field is only used when the institution is `ins_128026` (Capital One), in which case a value must be provided or an `INVALID_REQUEST` error with the code of `INVALID_FIELD` will be returned. For all other institutions, this field is ignored.*/
pub min_last_updated_datetime: Option<MinLastUpdatedDatetime>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorBalanceGetResponse {
///A single account at a financial institution.
pub account: AccountBase,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemWebhookUpdateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The new webhook URL to associate with the Item.
pub webhook: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemWebhookUpdateResponse {
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemAccessTokenInvalidateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemAccessTokenInvalidateResponse {
///The access token associated with the Item data is being requested for.
pub new_access_token: AccessToken,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WebhookVerificationKeyGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The key ID ( `kid` ) from the JWT header.
pub key_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WebhookVerificationKeyGetResponse {
///A JSON Web Key (JWK) that can be used in conjunction with [JWT libraries](https://jwt.io/#libraries-io) to verify Plaid webhooks
pub key: JWKPublicKey,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct JWKPublicKey {
///The alg member identifies the cryptographic algorithm family used with the key.
pub alg: String,
///The crv member identifies the cryptographic curve used with the key.
pub crv: String,
///The kid (Key ID) member can be used to match a specific key. This can be used, for instance, to choose among a set of keys within the JWK during key rollover.
pub kid: String,
///The kty (key type) parameter identifies the cryptographic algorithm family used with the key, such as RSA or EC.
pub kty: String,
#[serde(rename = "use")]
///The use (public key use) parameter identifies the intended use of the public key.
pub use_: String,
///The x member contains the x coordinate for the elliptic curve point.
pub x: String,
///The y member contains the y coordinate for the elliptic curve point.
pub y: String,
///The timestamp when the key was created, in Unix time.
pub created_at: i64,
///The timestamp when the key expired, in Unix time.
pub expired_at: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///An optional object to filter `/liabilities/get` results. If provided, `options` cannot be null.
pub options: Option<LiabilitiesGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesGetRequestOptions {
/**A list of accounts to retrieve for the Item.
An error will be returned if a provided `account_id` is not associated with the Item*/
pub account_ids: Option<Vec<String>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesGetResponse {
///An array of accounts associated with the Item
pub accounts: Vec<AccountBase>,
///Metadata about the Item.
pub item: Item,
///An object containing liability accounts
pub liabilities: LiabilitiesObject,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The name of the recipient
pub name: String,
///The International Bank Account Number (IBAN) for the recipient. If BACS data is not provided, an IBAN is required.
pub iban: Option<String>,
///An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
pub bacs: RecipientBACSNullable,
///The optional address of the payment recipient. This object is not currently required to make payments from UK institutions and should not be populated, though may be necessary for future European expansion.
pub address: PaymentInitiationAddress,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientCreateResponse {
///A unique ID identifying the recipient
pub recipient_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentReverseResponse {
///A unique ID identifying the refund
pub refund_id: String,
/**The status of the refund.
`PROCESSING`: The refund is currently being processed. The refund will automatically exit this state when processing is complete.
`INITIATED`: The refund has been successfully initiated.
`EXECUTED`: Indicates that the refund has been successfully executed.
`FAILED`: The refund has failed to be executed. This error is retryable once the root cause is resolved.*/
pub status: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the recipient
pub recipient_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientGetResponse(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipient {
///The ID of the recipient.
pub recipient_id: String,
///The name of the recipient.
pub name: String,
///The optional address of the payment recipient. This object is not currently required to make payments from UK institutions and should not be populated, though may be necessary for future European expansion.
pub address: PaymentInitiationAddress,
///The International Bank Account Number (IBAN) for the recipient.
pub iban: Option<String>,
///An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
pub bacs: RecipientBACSNullable,
///The EMI (E-Money Institution) recipient that this recipient is associated with, if any. This EMI recipient is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
pub emi_recipient_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRecipientListResponse {
///An array of payment recipients created for Payment Initiation
pub recipients: Vec<PaymentInitiationRecipient>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the recipient the payment is for.
pub recipient_id: String,
///A reference for the payment. This must be an alphanumeric string with at most 18 characters and must not contain any special characters (since not all institutions support them).
pub reference: String,
///The amount and currency of a payment
pub amount: PaymentAmount,
///The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.
pub schedule: Option<ExternalPaymentScheduleRequest>,
///Additional payment options
pub options: ExternalPaymentOptions,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentReverseRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the payment to reverse
pub payment_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentCreateResponse {
///A unique ID identifying the payment
pub payment_id: String,
/**For a payment returned by this endpoint, there is only one possible value:
`PAYMENT_STATUS_INPUT_NEEDED`: The initial phase of the payment*/
pub status: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemResetLoginRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemResetLoginResponse {
///`true` if the call succeeded
pub reset_login: bool,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemSetVerificationStatusRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `account_id` of the account whose verification status is to be modified
pub account_id: String,
///The verification status to set the account to.
pub verification_status: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxItemSetVerificationStatusResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemPublicTokenExchangeRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Your `public_token`, obtained from the Link `onSuccess` callback or `/sandbox/item/public_token/create`.
pub public_token: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemPublicTokenExchangeResponse {
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `item_id` value of the Item associated with the returned `access_token`
pub item_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemPublicTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemPublicTokenCreateResponse {
///A `public_token` for the particular Item corresponding to the specified `access_token`
pub public_token: String,
///
pub expiration: Option<String>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The `payment_id` returned from `/payment_initiation/payment/create`.
pub payment_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentGetResponse(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPayment {
///The ID of the payment. Like all Plaid identifiers, the `payment_id` is case sensitive.
pub payment_id: String,
///The amount and currency of a payment
pub amount: PaymentAmount,
/**The status of the payment.
`PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.
`PAYMENT_STATUS_INITIATED`: The payment has been successfully authorised and accepted by the financial institution but has not been executed.
`PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.
`PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.
`PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.
`PAYMENT_STATUS_AUTHORISING`: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.
`PAYMENT_STATUS_CANCELLED`: The payment was cancelled during authorisation.
`PAYMENT_STATUS_EXECUTED`: The payment has been successfully initiated and is considered complete.
`PAYMENT_STATUS_ESTABLISHED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.
`PAYMENT_STATUS_REJECTED`: The payment was rejected by the financial institution.
Deprecated:
These statuses will be removed in a future release.
`PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
`PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.
`PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.*/
pub status: PaymentInitiationPaymentStatus,
///The ID of the recipient
pub recipient_id: String,
///A reference for the payment.
pub reference: String,
///The value of the reference sent to the bank after adjustment to pass bank validation rules.
pub adjusted_reference: Option<String>,
///The date and time of the last time the `status` was updated, in IS0 8601 format
pub last_status_update: String,
///The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.
pub schedule: ExternalPaymentScheduleGet,
///Details about external payment refund
pub refund_details: ExternalPaymentRefundDetails,
///An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
pub bacs: SenderBACSNullable,
///The International Bank Account Number (IBAN) for the sender, if specified in the `/payment_initiation/payment/create` call.
pub iban: Option<String>,
///Initiated refunds associated with the payment.
pub initiated_refunds: Option<Vec<PaymentInitiationRefund>>,
///The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
pub wallet_id: Option<String>,
/**Payment scheme. If not specified - the default in the region will be used (e.g. `SEPA_CREDIT_TRANSFER` for EU). Using unsupported values will result in a failed payment.
`FASTER_PAYMENTS`: Enables payments to move quickly between UK bank accounts. Default value in the UK.
`SEPA_CREDIT_TRANSFER`: The standard payment to a beneficiary within the SEPA area.
`SEPA_CREDIT_TRANSFER_INSTANT`: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.*/
pub scheme: PaymentScheme,
/**Payment scheme. If not specified - the default in the region will be used (e.g. `SEPA_CREDIT_TRANSFER` for EU). Using unsupported values will result in a failed payment.
`FASTER_PAYMENTS`: Enables payments to move quickly between UK bank accounts. Default value in the UK.
`SEPA_CREDIT_TRANSFER`: The standard payment to a beneficiary within the SEPA area.
`SEPA_CREDIT_TRANSFER_INSTANT`: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.*/
pub adjusted_scheme: PaymentScheme,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationRefund {
///The ID of the refund. Like all Plaid identifiers, the `refund_id` is case sensitive.
pub refund_id: String,
///The amount and currency of a payment
pub amount: PaymentAmount,
/**The status of the refund.
`PROCESSING`: The refund is currently being processed. The refund will automatically exit this state when processing is complete.
`INITIATED`: The refund has been successfully initiated.
`EXECUTED`: Indicates that the refund has been successfully executed.
`FAILED`: The refund has failed to be executed. This error is retryable once the root cause is resolved.*/
pub status: String,
///The date and time of the last time the `status` was updated, in IS0 8601 format
pub last_status_update: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The `payment_id` returned from `/payment_initiation/payment/create`.
pub payment_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentTokenCreateResponse {
///A `payment_token` that can be provided to Link initialization to enter the payment initiation flow
pub payment_token: String,
///The date and time at which the token will expire, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. A `payment_token` expires after 15 minutes.
pub payment_token_expiration_time: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The maximum number of payments to return. If `count` is not specified, a maximum of 10 payments will be returned, beginning with the most recent payment before the cursor (if specified).
pub count: Option<i64>,
///A string in RFC 3339 format (i.e. "2019-12-06T22:35:49Z"). Only payments created before the cursor will be returned.
pub cursor: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationPaymentListResponse {
///An array of payments that have been created, associated with the given `client_id`.
pub payments: Vec<PaymentInitiationPayment>,
///The value that, when used as the optional `cursor` parameter to `/payment_initiation/payment/list`, will return the next unreturned payment as its first payment.
pub next_cursor: Option<String>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///An array of access tokens corresponding to the Items that will be included in the report. The `assets` product must have been initialized for the Items during link; the Assets product cannot be added after initialization.
pub access_tokens: Vec<AccessToken>,
///The maximum integer number of days of history to include in the Asset Report. If using Fannie Mae Day 1 Certainty, `days_requested` must be at least 61 for new originations or at least 31 for refinancings.
pub days_requested: i64,
///An optional object to filter `/asset_report/create` results. If provided, must be non-`null`. The optional `user` object is required for the report to be eligible for Fannie Mae's Day 1 Certainty program.
pub options: Option<AssetReportCreateRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportCreateRequestOptions {
///Client-generated identifier, which can be used by lenders to track loan applications.
pub client_report_id: Option<String>,
///URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.
pub webhook: Option<String>,
///The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
pub user: Option<AssetReportUser>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportCreateResponse {
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
pub asset_report_id: AssetReportId,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRefreshRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The `asset_report_token` returned by the original call to `/asset_report/create`
pub asset_report_token: AssetReportRefreshAssetReportToken,
///The maximum number of days of history to include in the Asset Report. Must be an integer. If not specified, the value from the original call to `/asset_report/create` will be used.
pub days_requested: Option<i64>,
///An optional object to filter `/asset_report/refresh` results. If provided, cannot be `null`. If not specified, the `options` from the original call to `/asset_report/create` will be used.
pub options: Option<AssetReportRefreshRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRefreshRequestOptions {
///Client-generated identifier, which can be used by lenders to track loan applications.
pub client_report_id: Option<String>,
///URL to which Plaid will send Assets webhooks, for example when the requested Asset Report is ready.
pub webhook: Option<String>,
///The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
pub user: Option<AssetReportUser>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRefreshResponse {
///A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
pub asset_report_id: AssetReportId,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRemoveRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRemoveResponse {
///`true` if the Asset Report was successfully removed.
pub removed: bool,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportFilterRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///The accounts to exclude from the Asset Report, identified by `account_id`.
pub account_ids_to_exclude: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportFilterResponse {
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
pub asset_report_id: AssetReportId,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///`true` if you would like to retrieve the Asset Report with Insights, `false` otherwise. This field defaults to `false` if omitted.
pub include_insights: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportGetResponse {
///An object representing an Asset Report
pub report: AssetReport,
///If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing
pub warnings: Vec<Warning>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportPDFGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportPDFGetResponse(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportAuditCopyCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A token that can be provided to endpoints such as `/asset_report/get` or `/asset_report/pdf/get` to fetch or update an Asset Report.
pub asset_report_token: AssetReportToken,
///The `auditor_id` of the third party with whom you would like to share the Asset Report.
pub auditor_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportAuditCopyCreateResponse {
///A token that can be shared with a third party auditor to allow them to obtain access to the Asset Report. This token should be stored securely.
pub audit_copy_token: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportAuditCopyRemoveRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The `audit_copy_token` granting access to the Audit Copy you would like to revoke.
pub audit_copy_token: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportAuditCopyRemoveResponse {
///`true` if the Audit Copy was successfully removed.
pub removed: bool,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsHoldingsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///An optional object to filter `/investments/holdings/get` results. If provided, must not be `null`.
pub options: Option<InvestmentHoldingsGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentHoldingsGetRequestOptions {
///An array of `account_id`s to retrieve for the Item. An error will be returned if a provided `account_id` is not associated with the Item.
pub account_ids: Option<Vec<String>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsHoldingsGetResponse {
///The accounts associated with the Item
pub accounts: Vec<AccountBase>,
///The holdings belonging to investment accounts associated with the Item. Details of the securities in the holdings are provided in the `securities` field.
pub holdings: Vec<Holding>,
///Objects describing the securities held in the accounts associated with the Item.
pub securities: Vec<Security>,
///Metadata about the Item.
pub item: Item,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsTransactionsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The earliest date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
pub start_date: String,
///The most recent date for which to fetch transaction history. Dates should be formatted as YYYY-MM-DD.
pub end_date: String,
///An optional object to filter `/investments/transactions/get` results. If provided, must be non-`null`.
pub options: Option<InvestmentsTransactionsGetRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsTransactionsGetRequestOptions {
///An array of `account_ids` to retrieve for the Item.
pub account_ids: Option<Vec<String>>,
/**The number of transactions to fetch.
*/
pub count: Option<i64>,
///The number of transactions to skip when fetching transaction history
pub offset: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsTransactionsGetResponse {
///Metadata about the Item.
pub item: Item,
///The accounts for which transaction history is being fetched.
pub accounts: Vec<AccountBase>,
///All securities for which there is a corresponding transaction being fetched.
pub securities: Vec<Security>,
///The transactions being fetched
pub investment_transactions: Vec<InvestmentTransaction>,
///The total number of transactions available within the date range specified. If `total_investment_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched via manipulating the `offset` parameter.'
pub total_investment_transactions: i64,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `account_id` value obtained from the `onSuccess` callback in Link
pub account_id: String,
///The processor you are integrating with.
pub processor: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorTokenCreateResponse {
///The `processor_token` that can then be used by the Plaid partner to make API requests
pub processor_token: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorStripeBankAccountTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `account_id` value obtained from the `onSuccess` callback in Link
pub account_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorStripeBankAccountTokenCreateResponse {
///A token that can be sent to Stripe for use in making API calls to Plaid
pub stripe_bank_account_token: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorApexProcessorTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `account_id` value obtained from the `onSuccess` callback in Link
pub account_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Access token for the target Item, typically provided in the Import Item response.
pub target_access_token: String,
///Plaid Account ID that specifies the target bank account. This account will become the recipient for a user's direct deposit.
pub target_account_id: String,
///ISO-3166-1 alpha-2 country code standard.
pub country_code: Option<String>,
///Options to configure the `/deposit_switch/create` request. If provided, cannot be `null`.
pub options: Option<DepositSwitchCreateRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchCreateRequestOptions {
/**The URL registered to receive webhooks when the status of a deposit switch request has changed.
*/
pub webhook: Option<String>,
///An array of access tokens corresponding to transaction items to use when attempting to match the user to their Payroll Provider. These tokens must be created by the same client id as the one creating the switch, and have access to the transactions product.
pub transaction_item_access_tokens: Option<Vec<AccessToken>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchCreateResponse {
///ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch.
pub deposit_switch_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemImportRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Array of product strings
pub products: Vec<Products>,
///Object of user ID and auth token pair, permitting Plaid to aggregate a user’s accounts
pub user_auth: ItemImportRequestUserAuth,
///An optional object to configure `/item/import` request.
pub options: Option<ItemImportRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemImportRequestOptions {
/**Specifies a webhook URL to associate with an Item. Plaid fires a webhook if credentials fail.
*/
pub webhook: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemImportRequestUserAuth {
///Opaque user identifier
pub user_id: String,
///Authorization token Plaid will use to aggregate this user’s accounts
pub auth_token: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemImportResponse {
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the deposit switch
pub deposit_switch_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchTokenCreateResponse {
///Deposit switch token, used to initialize Link for the Deposit Switch product
pub deposit_switch_token: String,
///Expiration time of the token, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
pub deposit_switch_token_expiration_time: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///A `link_token` from a previous invocation of `/link/token/create`
pub link_token: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display "This Application" instead.
pub client_name: String,
/**The language that Link should be displayed in.
Supported languages are:
- English (`'en'`)
- French (`'fr'`)
- Spanish (`'es'`)
- Dutch (`'nl'`)
- German(`'de'`)
When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied.*/
pub language: String,
/**Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. Supported country codes are: `US`, `CA`, `DE`, `ES`, `FR`, `GB`, `IE`, `NL`. For a complete mapping of supported products by country, see https://plaid.com/global/.
If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. To gain access to European institutions in the Production environment, [file a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access) via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow.
If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`. If both `country_codes` and a Link customization are used, the value in `country_codes` may override the value in the customization.
If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`.*/
pub country_codes: Vec<CountryCode>,
///An object specifying information about the end user who will be linking their account.
pub user: LinkTokenCreateRequestUser,
/**List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted; required otherwise.
`balance` is *not* a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized.
Only institutions that support *all* requested products will be shown in Link; to maximize the number of institutions listed, it is recommended to initialize Link with the minimal product set required for your use case. Additional products can be added after Link initialization by calling the relevant endpoints. For details and exceptions, see [Choosing when to initialize products](https://plaid.com/docs/link/best-practices/#choosing-when-to-initialize-products).
Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if `auth` is specified as a product, even though these institutions do not contain `auth` in their product array.
In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`.*/
pub products: Option<Vec<Products>>,
///The destination URL to which any webhooks should be sent.
pub webhook: Option<String>,
///The `access_token` associated with the Item to update, used when updating or modifying an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link as part of the Payment Initiation (UK and Europe) flow.
pub access_token: Option<String>,
///The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the `default` customization will be used. When using a Link customization, the language in the customization must match the language selected via the `language` parameter, and the countries in the customization should match the country codes selected via `country_codes`.
pub link_customization_name: Option<String>,
///A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The `redirect_uri` should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use `*` as a wildcard character, e.g. `https://*.example.com/oauth.html`. If `android_package_name` is specified, this field should be left blank. Note that any redirect URI must also be added to the Allowed redirect URIs list in the [developer dashboard](https://dashboard.plaid.com/team/api).
pub redirect_uri: Option<String>,
///The name of your app's Android package. Required if using the `link_token` to initialize Link on Android. When creating a `link_token` for initializing Link on other platforms, this field must be left blank. Any package name specified here must also be added to the Allowed Android package names setting on the [developer dashboard](https://dashboard.plaid.com/team/api).
pub android_package_name: Option<String>,
/**By default, Link will provide limited account filtering: it will only display Institutions that are compatible with all products supplied in the `products` parameter of `/link/token/create`, and, if `auth` is specified in the `products` array, will also filter out accounts other than `checking` and `savings` accounts on the Account Select pane. You can further limit the accounts shown in Link by using `account_filters` to specify the account subtypes to be shown in Link. Only the specified subtypes will be shown. This filtering applies to both the Account Select view (if enabled) and the Institution Select view. Institutions that do not support the selected subtypes will be omitted from Link. To indicate that all subtypes should be shown, use the value `"all"`. If the `account_filters` filter is used, any account type for which a filter is not specified will be entirely omitted from Link. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
For institutions using OAuth, the filter will not affect the list of accounts shown by the bank in the OAuth window.
*/
pub account_filters: Option<LinkTokenAccountFilters>,
///Configuration parameters for EU flows
pub eu_config: Option<LinkTokenEUConfig>,
///Used for certain Europe-only configurations, as well as certain legacy use cases in other regions.
pub institution_id: Option<String>,
///Specifies options for initializing Link for use with the Payment Initiation (Europe) product. This field is required if `payment_initiation` is included in the `products` array.
pub payment_initiation: Option<LinkTokenCreateRequestPaymentInitiation>,
///Specifies options for initializing Link for use with the Deposit Switch (beta) product. This field is required if `deposit_switch` is included in the `products` array.
pub deposit_switch: Option<LinkTokenCreateRequestDepositSwitch>,
///Specifies options for initializing Link for use with the Income (beta) product. This field is required if `income_verification` is included in the `products` array.
pub income_verification: Option<LinkTokenCreateRequestIncomeVerification>,
///Specifies options for initializing Link for use with the Auth product. This field is currently only required if using the Flexible Auth product (currently in closed beta).
pub auth: Option<LinkTokenCreateRequestAuth>,
///Specifies options for initializing Link for use with the Transfer product.
pub transfer: Option<LinkTokenCreateRequestTransfer>,
///Specifies options for initializing Link for [update mode](https://plaid.com/docs/link/update-mode).
pub update: Option<LinkTokenCreateRequestUpdate>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenAccountFilters {
///A filter to apply to `depository`-type accounts
pub depository: Option<DepositoryFilter>,
///A filter to apply to `credit`-type accounts
pub credit: Option<CreditFilter>,
///A filter to apply to `loan`-type accounts
pub loan: Option<LoanFilter>,
///A filter to apply to `investment`-type accounts (or `brokerage`-type acconunts for API versions 2018-05-22 and earlier).
pub investment: Option<InvestmentFilter>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenEUConfig {
///If `true`, open Link without an initial UI. Defaults to `false`.
pub headless: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestPaymentInitiation {
///The `payment_id` provided by the `/payment_initiation/payment/create` endpoint.
pub payment_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestDepositSwitch {
///The `deposit_switch_id` provided by the `/deposit_switch/create` endpoint.
pub deposit_switch_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestTransfer {
///The `id` returned by the `/transfer/intent/create` endpoint.
pub intent_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestAuth {
///The optional Auth flow to use. Currently only used to enable Flexible Auth.
pub flow_type: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestUser {
///A unique ID representing the end user. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`. It is currently used as a means of searching logs for the given user in the Plaid Dashboard.
pub client_user_id: String,
///The user's full legal name. This is an optional field used in the [returning user experience](https://plaid.com/docs/link/returning-user) to associate Items to the user.
pub legal_name: Option<String>,
///The user's phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. This field is optional, but required to enable the [returning user experience](https://plaid.com/docs/link/returning-user).
pub phone_number: Option<String>,
/**The date and time the phone number was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`). This field is optional, but required to enable any [returning user experience](https://plaid.com/docs/link/returning-user).
Only pass a verification time for a phone number that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.
Example: `2020-01-01T00:00:00Z`
*/
pub phone_number_verified_time: Option<String>,
///The user's email address. This field is optional, but required to enable the [pre-authenticated returning user flow](https://plaid.com/docs/link/returning-user/#enabling-the-returning-user-experience).
pub email_address: Option<String>,
/**The date and time the email address was verified in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDThh:mm:ssZ`). This is an optional field used in the [returning user experience](https://plaid.com/docs/link/returning-user).
Only pass a verification time for an email address that you have verified. If you have performed verification but don’t have the time, you may supply a signal value of the start of the UNIX epoch.
Example: `2020-01-01T00:00:00Z`*/
pub email_address_verified_time: Option<String>,
///To be provided in the format "ddd-dd-dddd". This field is optional and will support not-yet-implemented functionality for new products.
pub ssn: Option<String>,
///To be provided in the format "yyyy-mm-dd". This field is optional and will support not-yet-implemented functionality for new products.
pub date_of_birth: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestUpdate {
///If `true`, enables [update mode with Account Select](https://plaid.com/docs/link/update-mode/#using-update-mode-to-request-new-accounts).
pub account_selection_enabled: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestAccountSubtypes {
///A filter to apply to `depository`-type accounts
pub depository: Option<LinkTokenCreateDepositoryFilter>,
///A filter to apply to `credit`-type accounts
pub credit: Option<LinkTokenCreateCreditFilter>,
///A filter to apply to `loan`-type accounts
pub loan: Option<LinkTokenCreateLoanFilter>,
///A filter to apply to `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier).
pub investment: Option<LinkTokenCreateInvestmentFilter>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateDepositoryFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: Option<DepositoryAccountSubtypes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateCreditFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: Option<CreditAccountSubtypes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateLoanFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: Option<LoanAccountSubtypes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateInvestmentFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: Option<InvestmentAccountSubtypes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenGetResponse {
///A `link_token`, which can be supplied to Link in order to initialize it and receive a `public_token`, which can be exchanged for an `access_token`.
pub link_token: String,
///The creation timestamp for the `link_token`, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
pub created_at: Option<String>,
///The expiration timestamp for the `link_token`, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
pub expiration: Option<String>,
///An object specifying the arguments originally provided to the `/link/token/create` call.
pub metadata: LinkTokenGetMetadataResponse,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenGetMetadataResponse {
///The `products` specified in the `/link/token/create` call.
pub initial_products: Vec<Products>,
///The `webhook` specified in the `/link/token/create` call.
pub webhook: Option<String>,
///The `country_codes` specified in the `/link/token/create` call.
pub country_codes: Vec<CountryCode>,
///The `language` specified in the `/link/token/create` call.
pub language: Option<String>,
/**The `account_filters` specified in the original call to `/link/token/create`.
*/
pub account_filters: Option<AccountFiltersResponse>,
///The `redirect_uri` specified in the `/link/token/create` call.
pub redirect_uri: Option<String>,
///The `client_name` specified in the `/link/token/create` call.
pub client_name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateResponse {
///A `link_token`, which can be supplied to Link in order to initialize it and receive a `public_token`, which can be exchanged for an `access_token`.
pub link_token: String,
///The expiration date for the `link_token`, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format. A `link_token` created to generate a `public_token` that will be exchanged for a new `access_token` expires after 4 hours. A `link_token` created for an existing Item (such as when updating an existing `access_token` by launching Link in update mode) expires after 30 minutes.
pub expiration: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Item {
///The Plaid Item ID. The `item_id` is always unique; linking the same account at the same institution twice will result in two Items with different `item_id` values. Like all Plaid identifiers, the `item_id` is case-sensitive.
pub item_id: String,
///The Plaid Institution ID associated with the Item. Field is `null` for Items created via Same Day Micro-deposits.
pub institution_id: Option<String>,
///The URL registered to receive webhooks for the Item.
pub webhook: Option<String>,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Error,
///A list of products available for the Item that have not yet been accessed.
pub available_products: Vec<Products>,
/**A list of products that have been billed for the Item. Note - `billed_products` is populated in all environments but only requests in Production are billed.
*/
pub billed_products: Vec<Products>,
/**A list of authorized products for the Item.
*/
pub products: Option<Vec<Products>>,
/**The RFC 3339 timestamp after which the consent provided by the end user will expire. Upon consent expiration, the item will enter the `ITEM_LOGIN_REQUIRED` error state. To circumvent the `ITEM_LOGIN_REQUIRED` error and maintain continuous consent, the end user can reauthenticate via Link’s update mode in advance of the consent expiration time.
Note - This is only relevant for certain OAuth-based institutions. For all other institutions, this field will be null.
*/
pub consent_expiration_time: Option<String>,
/**Indicates whether an Item requires user interaction to be updated, which can be the case for Items with some forms of two-factor authentication.
`background` - Item can be updated in the background
`user_present_required` - Item requires user interaction to be updated*/
pub update_type: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PlaidError(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct Error {
///A broad categorization of the error. Safe for programmatic use.
pub error_type: String,
///The particular error code. Safe for programmatic use.
pub error_code: String,
///A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
pub error_message: String,
/**A user-friendly representation of the error code. `null` if the error is not related to user action.
This may change over time and is not safe for programmatic use.*/
pub display_message: Option<String>,
///A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
pub request_id: Option<String>,
/**In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.
`causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.*/
pub causes: Option<Vec<serde_json::Value>>,
///The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
pub status: Option<f64>,
///The URL of a Plaid documentation page with more information about the error
pub documentation_url: Option<String>,
///Suggested steps for resolving the error
pub suggested_action: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemStatusNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemStatusTransactions {
///[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp of the last successful transactions update for the Item. The status will update each time Plaid successfully connects with the institution, regardless of whether any new data is available in the update.
pub last_successful_update: Option<String>,
///[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp of the last failed transactions update for the Item. The status will update each time Plaid fails an attempt to connect with the institution, regardless of whether any new data is available in the update.
pub last_failed_update: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemStatusInvestments {
///[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp of the last successful investments update for the Item. The status will update each time Plaid successfully connects with the institution, regardless of whether any new data is available in the update.
pub last_successful_update: Option<String>,
///[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp of the last failed investments update for the Item. The status will update each time Plaid fails an attempt to connect with the institution, regardless of whether any new data is available in the update.
pub last_failed_update: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemStatusLastWebhook {
/**[ISO 8601](https://wikipedia.org/wiki/ISO_8601) timestamp of when the webhook was fired.
*/
pub sent_at: Option<String>,
///The last webhook code sent.
pub code_sent: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemStatus {
///Information about the last successful and failed investments update for the Item.
pub investments: ItemStatusInvestments,
///Information about the last successful and failed transactions update for the Item.
pub transactions: ItemStatusTransactions,
///Information about the last webhook fired for the Item.
pub last_webhook: ItemStatusLastWebhook,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct OverrideAccountType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountBase {
/**Plaid’s unique identifier for the account. This value will not change unless Plaid can't reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new `account_id` will be assigned to the account.
The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`.
If an account with a specific `account_id` disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.
Like all Plaid identifiers, the `account_id` is case sensitive.*/
pub account_id: String,
///A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.
pub balances: AccountBalance,
///The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
pub mask: Option<String>,
///The name of the account, either assigned by the user or by the financial institution itself
pub name: String,
///The official name of the account as given by the financial institution
pub official_name: Option<String>,
#[serde(rename = "type")]
/**`investment:` Investment account. In API versions 2018-05-22 and earlier, this type is called `brokerage` instead.
`credit:` Credit card
`depository:` Depository account
`loan:` Loan account
`brokerage`: An investment account. Used for `/assets/` endpoints only; other endpoints use `investment`.
`other:` Non-specified account type
See the [Account type schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.*/
pub type_: AccountType,
///See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.
pub subtype: AccountSubtype,
/**The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only.
`pending_automatic_verification`: The Item is pending automatic verification
`pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the two amounts.
`automatically_verified`: The Item has successfully been automatically verified
`manually_verified`: The Item has successfully been manually verified
`verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
`verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
*/
pub verification_status: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountBalance {
/**The amount of funds available to be withdrawn from the account, as determined by the financial institution.
For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.
For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.
For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution.
Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.
Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.
If `current` is `null` this field is guaranteed not to be `null`.*/
pub available: Option<f64>,
/**The total amount of funds in or owed by the account.
For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.
For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.
For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.
Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.
When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.*/
pub current: Option<f64>,
/**For `credit`-type accounts, this represents the credit limit.
For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.
In North America, this field is typically only available for `credit`-type accounts.*/
pub limit: Option<f64>,
///The ISO-4217 currency code of the balance. Always null if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the balance. Always null if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
/**Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the last time that the balance for the given account has been updated
This is currently only provided when the `min_last_updated_datetime` is passed when calling `/accounts/balance/get` for `ins_128026` (Capital One).*/
pub last_updated_datetime: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountSubtype(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersACH {
///The Plaid account ID associated with the account numbers
pub account_id: String,
/**The ACH account number for the account.
Note that when using OAuth with Chase Bank (`ins_56`), Chase will issue "tokenized" routing and account numbers, which are not the user's actual account and routing numbers. These tokenized numbers should work identically to normal account and routing numbers. The digits returned in the `mask` field will continue to reflect the actual account number, rather than the tokenized account number; for this reason, when displaying account numbers to the user to help them identify their account in your UI, always use the `mask` rather than truncating the `account` number. If a user revokes their permissions to your app, the tokenized numbers will continue to work for ACH deposits, but not withdrawals.*/
pub account: String,
///The ACH routing number for the account. If the institution is `ins_56`, this may be a tokenized routing number. For more information, see the description of the `account` field.
pub routing: String,
///The wire transfer routing number for the account, if available
pub wire_routing: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersACHNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersEFT {
///The Plaid account ID associated with the account numbers
pub account_id: String,
///The EFT account number for the account
pub account: String,
///The EFT institution number for the account
pub institution: String,
///The EFT branch number for the account
pub branch: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersEFTNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersInternational {
///The Plaid account ID associated with the account numbers
pub account_id: String,
///The International Bank Account Number (IBAN) for the account
pub iban: String,
///The Bank Identifier Code (BIC) for the account
pub bic: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersInternationalNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersBACS {
///The Plaid account ID associated with the account numbers
pub account_id: String,
///The BACS account number for the account
pub account: String,
///The BACS sort code for the account
pub sort_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct NumbersBACSNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct RecipientBACS {
///The account number of the account. Maximum of 10 characters.
pub account: Option<String>,
///The 6-character sort code of the account.
pub sort_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct RecipientBACSNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct SenderBACSNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationOptionalRestrictionBacs(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct RemovedTransaction {
///The ID of the removed transaction.
pub transaction_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct RequestID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionBase {
/**Please use the `payment_channel` field, `transaction_type` will be deprecated in the future.
`digital:` transactions that took place online.
`place:` transactions that were made at a physical location.
`special:` transactions that relate to banks, e.g. fees or deposits.
`unresolved:` transactions that do not fit into the other three types.
*/
pub transaction_type: Option<String>,
///The ID of a posted transaction's associated pending transaction, where applicable.
pub pending_transaction_id: Option<String>,
/**The ID of the category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/#categoriesget).
If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.*/
pub category_id: Option<String>,
/**A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/#categoriesget).
If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.*/
pub category: Option<Vec<String>>,
///A representation of where a transaction took place
pub location: Option<Location>,
/**Transaction information specific to inter-bank transfers. If the transaction was not an inter-bank transfer, all fields will be `null`.
If the `transactions` object was returned by a Transactions endpoint such as `/transactions/get`, the `payment_meta` key will always appear, but no data elements are guaranteed. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.*/
pub payment_meta: Option<PaymentMeta>,
///The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
pub account_owner: Option<String>,
/**The merchant name or transaction description.
If the `transactions` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.*/
pub name: Option<String>,
///The string returned by the financial institution to describe the transaction. For transactions returned by `/transactions/get`, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set `options.include_original_description` to `true`.
pub original_description: Option<String>,
///The ID of the account in which this transaction occurred.
pub account_id: String,
///The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
pub amount: f64,
///The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ).
pub date: String,
///When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
pub pending: bool,
///The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
pub transaction_id: String,
///The merchant name, as extracted by Plaid from the `name` field.
pub merchant_name: Option<String>,
///The check number of the transaction. This field is only populated for check transactions.
pub check_number: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Transaction(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct Location {
///The street address where the transaction occurred.
pub address: Option<String>,
///The city where the transaction occurred.
pub city: Option<String>,
///The region or state where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called `state`.
pub region: Option<String>,
///The postal code where the transaction occurred. In API versions 2018-05-22 and earlier, this field is called `zip`.
pub postal_code: Option<String>,
///The ISO 3166-1 alpha-2 country code where the transaction occurred.
pub country: Option<String>,
///The latitude where the transaction occurred.
pub lat: Option<f64>,
///The longitude where the transaction occurred.
pub lon: Option<f64>,
///The merchant defined store number where the transaction occurred.
pub store_number: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionStream {
///The ID of the account to which the stream belongs
pub account_id: String,
///A unique id for the stream
pub stream_id: String,
///The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).
pub category_id: String,
///A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview).
pub category: Vec<String>,
///A description of the transaction stream.
pub description: String,
///The posted date of the earliest transaction in the stream.
pub first_date: String,
///The posted date of the latest transaction in the stream.
pub last_date: String,
///describes the frequency of the transaction stream.
pub frequency: RecurringTransactionFrequency,
///An array of Plaid transaction IDs belonging to the stream, sorted by posted date.
pub transaction_ids: Vec<String>,
///Object with data pertaining to an amount on the transaction stream.
pub average_amount: TransactionStreamAmount,
///indicates whether the transaction stream is still live.
pub is_active: bool,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionStreamAmount {
///represents the numerical value of an amount.
pub amount: Option<f64>,
/**The ISO-4217 currency code of the amount. Always `null` if `unofficial_currency_code` is non-`null`.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub iso_currency_code: Option<String>,
///The unofficial currency code of the amount. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
pub unofficial_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct RecurringTransactionFrequency(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct Institution {
///Unique identifier for the institution
pub institution_id: String,
///The official name of the institution
pub name: String,
///A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return `auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the `auth_metadata` object. For more details, see [Full Auth coverage](https://plaid.com/docs/auth/coverage/).
pub products: Vec<Products>,
///A list of the country codes supported by the institution.
pub country_codes: Vec<CountryCode>,
///The URL for the institution's website
pub url: Option<String>,
///Hexadecimal representation of the primary color used by the institution
pub primary_color: Option<String>,
///Base64 encoded representation of the institution's logo
pub logo: Option<String>,
///A partial list of routing numbers associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is not comprehensive and should never be used as a complete list of routing numbers for an institution.
pub routing_numbers: Vec<String>,
///Indicates that the institution has an OAuth login flow.
pub oauth: bool,
/**The status of an institution is determined by the health of its Item logins, Transactions updates, Investments updates, Liabilities updates, Auth requests, Balance requests, Identity requests, Investments requests, and Liabilities requests. A login attempt is conducted during the initial Item add in Link. If there is not enough traffic to accurately calculate an institution's status, Plaid will return null rather than potentially inaccurate data.
Institution status is accessible in the Dashboard and via the API using the `/institutions/get_by_id` endpoint with the `include_status` option set to true. Note that institution status is not available in the Sandbox environment.
*/
pub status: InstitutionStatus,
///Metadata that captures what specific payment configurations an institution supports when making Payment Initiation requests.
pub payment_initiation_metadata: PaymentInitiationMetadata,
///Metadata that captures information about the Auth features of an institution.
pub auth_metadata: AuthMetadata,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionStatus {
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub item_logins: ProductStatus,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub transactions_updates: ProductStatus,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub auth: ProductStatus,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub identity: ProductStatus,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub investments_updates: ProductStatus,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub liabilities_updates: Option<ProductStatus>,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub liabilities: Option<ProductStatus>,
///A representation of the status health of a request type. Auth requests, Balance requests, Identity requests, Investments requests, Liabilities requests, Transactions updates, Investments updates, Liabilities updates, and Item logins each have their own status object.
pub investments: Option<ProductStatus>,
///Details of recent health incidents associated with the institution.
pub health_incidents: Option<Vec<HealthIncident>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CountryCode(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentMeta {
///The transaction reference number supplied by the financial institution.
pub reference_number: Option<String>,
///The ACH PPD ID for the payer.
pub ppd_id: Option<String>,
///For transfers, the party that is receiving the transaction.
pub payee: Option<String>,
///The party initiating a wire transfer. Will be `null` if the transaction is not a wire transfer.
pub by_order_of: Option<String>,
///For transfers, the party that is paying the transaction.
pub payer: Option<String>,
///The type of transfer, e.g. 'ACH'
pub payment_method: Option<String>,
///The name of the payment processor
pub payment_processor: Option<String>,
///The payer-supplied description of the transfer.
pub reason: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionCode(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct Category {
///An identifying number for the category. `category_id` is a Plaid-specific identifier and does not necessarily correspond to merchant category codes.
pub category_id: String,
///`place` for physical transactions or `special` for other transactions such as bank charges.
pub group: String,
///A hierarchical array of the categories to which this `category_id` belongs.
pub hierarchy: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PersonalFinanceCategory {
///A high level category that communicates the broad category of the transaction.
pub primary: String,
///Provides additional granularity to the primary categorization.
pub detailed: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccessToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccessTokenNullable(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAccessToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferAccessToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct APISecret(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct APIClientID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionsRemovedWebhook {
///`TRANSACTIONS`
pub webhook_type: String,
///`TRANSACTIONS_REMOVED`
pub webhook_code: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///An array of `transaction_ids` corresponding to the removed transactions
pub removed_transactions: Vec<String>,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DefaultUpdateWebhook {
///`TRANSACTIONS`
pub webhook_type: String,
///`DEFAULT_UPDATE`
pub webhook_code: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///The number of new transactions detected since the last time this webhook was fired.
pub new_transactions: f64,
///The `item_id` of the Item the webhook relates to.
pub item_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct HistoricalUpdateWebhook {
///`TRANSACTIONS`
pub webhook_type: String,
///`HISTORICAL_UPDATE`
pub webhook_code: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///The number of new, unfetched transactions available
pub new_transactions: f64,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InitialUpdateWebhook {
///`TRANSACTIONS`
pub webhook_type: String,
///`INITIAL_UPDATE`
pub webhook_code: String,
///The error code associated with the webhook.
pub error: Option<String>,
///The number of new, unfetched transactions available.
pub new_transactions: f64,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PhoneNumber {
///The phone number.
pub data: String,
///When `true`, identifies the phone number as the primary number on an account.
pub primary: bool,
#[serde(rename = "type")]
///The type of phone number.
pub type_: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Email {
///The email address.
pub data: String,
///When `true`, identifies the email address as the primary email on an account.
pub primary: bool,
#[serde(rename = "type")]
///The type of email account as described by the financial institution.
pub type_: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Address {
///Data about the components comprising an address.
pub data: AddressData,
///When `true`, identifies the address as the primary address on an account.
pub primary: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AddressNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct AddressDataNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct AddressData {
///The full city name
pub city: String,
/**The region or state. In API versions 2018-05-22 and earlier, this field is called `state`.
Example: `"NC"`*/
pub region: Option<String>,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: String,
///The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`.
pub postal_code: Option<String>,
///The ISO 3166-1 alpha-2 country code
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProcessorToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct HistoricalBalance {
///The date of the calculated historical balance, in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD)
pub date: String,
/**The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction.
If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.*/
pub current: f64,
///The ISO-4217 currency code of the balance. Always `null` if `unofficial_currency_code` is non-`null`.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the balance. Always `null` if `iso_currency_code` is non-`null`.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Owner {
/**A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. If the name of a business is reported, please contact Plaid Support. In the case of a joint account, Plaid will make a best effort to report the names of all account holders.
If an Item contains multiple accounts with different owner names, some institutions will report all names associated with the Item in each account's `names` array.*/
pub names: Vec<String>,
///A list of phone numbers associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
pub phone_numbers: Vec<PhoneNumber>,
///A list of email addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
pub emails: Vec<Email>,
///Data about the various addresses associated with the account by the financial institution. May be an empty array if no relevant information is returned from the financial institution.
pub addresses: Vec<Address>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct OwnerOverride {
///A list of names associated with the account by the financial institution. These should always be the names of individuals, even for business accounts. Note that the same name data will be used for all accounts associated with an Item.
pub names: Vec<String>,
///A list of phone numbers associated with the account.
pub phone_numbers: Vec<PhoneNumber>,
///A list of email addresses associated with the account.
pub emails: Vec<Email>,
///Data about the various addresses associated with the account.
pub addresses: Vec<Address>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesObject {
///The credit accounts returned.
pub credit: Option<Vec<CreditCardLiability>>,
///The mortgage accounts returned.
pub mortgage: Option<Vec<MortgageLiability>>,
///The student loan accounts returned.
pub student: Option<Vec<StudentLoan>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StudentLoan {
///The ID of the account that this liability belongs to.
pub account_id: Option<String>,
///The account number of the loan. For some institutions, this may be a masked version of the number (e.g., the last 4 digits instead of the entire number).
pub account_number: Option<String>,
///The dates on which loaned funds were disbursed or will be disbursed. These are often in the past. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub disbursement_dates: Option<Vec<String>>,
///The date when the student loan is expected to be paid off. Availability for this field is limited. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub expected_payoff_date: Option<String>,
///The guarantor of the student loan.
pub guarantor: Option<String>,
///The interest rate on the loan as a percentage.
pub interest_rate_percentage: f64,
///`true` if a payment is currently overdue. Availability for this field is limited.
pub is_overdue: Option<bool>,
///The amount of the last payment.
pub last_payment_amount: Option<f64>,
///The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub last_payment_date: Option<String>,
///The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub last_statement_issue_date: Option<String>,
///The type of loan, e.g., "Consolidation Loans".
pub loan_name: Option<String>,
///An object representing the status of the student loan
pub loan_status: StudentLoanStatus,
/**The minimum payment due for the next billing cycle. There are some exceptions:
Some institutions require a minimum payment across all loans associated with an account number. Our API presents that same minimum payment amount on each loan. The institutions that do this are: Great Lakes ( `ins_116861`), Firstmark (`ins_116295`), Commonbond Firstmark Services (`ins_116950`), Nelnet (`ins_116528`), EdFinancial Services (`ins_116304`), Granite State (`ins_116308`), and Oklahoma Student Loan Authority (`ins_116945`).
Firstmark (`ins_116295` ) and Navient (`ins_116248`) will display as $0 if there is an autopay program in effect.*/
pub minimum_payment_amount: Option<f64>,
///The due date for the next payment. The due date is `null` if a payment is not expected. A payment is not expected if `loan_status.type` is `deferment`, `in_school`, `consolidated`, `paid in full`, or `transferred`. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub next_payment_due_date: Option<String>,
/**The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
pub origination_date: Option<String>,
///The original principal balance of the loan.
pub origination_principal_amount: Option<f64>,
///The total dollar amount of the accrued interest balance. For Sallie Mae ( `ins_116944`), this amount is included in the current balance of the loan, so this field will return as `null`.
pub outstanding_interest_amount: Option<f64>,
///The relevant account number that should be used to reference this loan for payments. In the majority of cases, `payment_reference_number` will match a`ccount_number,` but in some institutions, such as Great Lakes (`ins_116861`), it will be different.
pub payment_reference_number: Option<String>,
///Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is Fedloan (`ins_116527`).
pub pslf_status: PSLFStatus,
///An object representing the repayment plan for the student loan
pub repayment_plan: StudentRepaymentPlan,
///The sequence number of the student loan. Heartland ECSI (`ins_116948`) does not make this field available.
pub sequence_number: Option<String>,
///The address of the student loan servicer. This is generally the remittance address to which payments should be sent.
pub servicer_address: ServicerAddressData,
///The year to date (YTD) interest paid. Availability for this field is limited.
pub ytd_interest_paid: Option<f64>,
///The year to date (YTD) principal paid. Availability for this field is limited.
pub ytd_principal_paid: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CreditCardLiability {
///The ID of the account that this liability belongs to.
pub account_id: Option<String>,
///The various interest rates that apply to the account.
pub aprs: Vec<APR>,
///true if a payment is currently overdue. Availability for this field is limited.
pub is_overdue: Option<bool>,
///The amount of the last payment.
pub last_payment_amount: f64,
///The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Availability for this field is limited.
pub last_payment_date: Option<String>,
///The date of the last statement. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub last_statement_issue_date: String,
///The total amount owed as of the last statement issued
pub last_statement_balance: f64,
///The minimum payment due for the next billing cycle.
pub minimum_payment_amount: f64,
///The due date for the next payment. The due date is `null` if a payment is not expected. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub next_payment_due_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct MortgageLiability {
///The ID of the account that this liability belongs to.
pub account_id: String,
///The account number of the loan.
pub account_number: String,
///The current outstanding amount charged for late payment.
pub current_late_fee: Option<f64>,
///Total amount held in escrow to pay taxes and insurance on behalf of the borrower.
pub escrow_balance: Option<f64>,
///Indicates whether the borrower has private mortgage insurance in effect.
pub has_pmi: Option<bool>,
///Indicates whether the borrower will pay a penalty for early payoff of mortgage.
pub has_prepayment_penalty: Option<bool>,
///Object containing metadata about the interest rate for the mortgage.
pub interest_rate: MortgageInterestRate,
///The amount of the last payment.
pub last_payment_amount: Option<f64>,
///The date of the last payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub last_payment_date: Option<String>,
///Description of the type of loan, for example `conventional`, `fixed`, or `variable`. This field is provided directly from the loan servicer and does not have an enumerated set of possible values.
pub loan_type_description: Option<String>,
///Full duration of mortgage as at origination (e.g. `10 year`).
pub loan_term: Option<String>,
///Original date on which mortgage is due in full. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub maturity_date: Option<String>,
///The amount of the next payment.
pub next_monthly_payment: Option<f64>,
///The due date for the next payment. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub next_payment_due_date: Option<String>,
///The date on which the loan was initially lent. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub origination_date: Option<String>,
///The original principal balance of the mortgage.
pub origination_principal_amount: Option<f64>,
///Amount of loan (principal + interest) past due for payment.
pub past_due_amount: Option<f64>,
///Object containing fields describing property address.
pub property_address: MortgagePropertyAddress,
///The year to date (YTD) interest paid.
pub ytd_interest_paid: Option<f64>,
///The YTD principal paid.
pub ytd_principal_paid: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct MortgageInterestRate {
///Percentage value (interest rate of current mortgage, not APR) of interest payable on a loan.
pub percentage: Option<f64>,
#[serde(rename = "type")]
///The type of interest charged (fixed or variable).
pub type_: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct MortgagePropertyAddress {
///The city name.
pub city: Option<String>,
///The ISO 3166-1 alpha-2 country code.
pub country: Option<String>,
///The five or nine digit postal code.
pub postal_code: Option<String>,
///The region or state (example "NC").
pub region: Option<String>,
///The full street address (example "564 Main Street, Apt 15").
pub street: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StudentLoanStatus {
/**The date until which the loan will be in its current status. Dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
*/
pub end_date: Option<String>,
#[serde(rename = "type")]
///The status type of the student loan
pub type_: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StudentRepaymentPlan {
///The description of the repayment plan as provided by the servicer.
pub description: Option<String>,
#[serde(rename = "type")]
///The type of the repayment plan.
pub type_: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PSLFStatus {
///The estimated date borrower will have completed 120 qualifying monthly payments. Returned in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD).
pub estimated_eligibility_date: Option<String>,
///The number of qualifying payments that have been made.
pub payments_made: Option<f64>,
///The number of qualifying payments remaining.
pub payments_remaining: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ServicerAddressData {
///The full city name
pub city: Option<String>,
/**The region or state
Example: `"NC"`*/
pub region: Option<String>,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: Option<String>,
///The postal code
pub postal_code: Option<String>,
///The ISO 3166-1 alpha-2 country code
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct APR {
/**Annual Percentage Rate applied.
*/
pub apr_percentage: f64,
///The type of balance to which the APR applies.
pub apr_type: String,
///Amount of money that is subjected to the APR if a balance was carried beyond payment due date. How it is calculated can vary by card issuer. It is often calculated as an average daily balance.
pub balance_subject_to_apr: Option<f64>,
///Amount of money charged due to interest from last statement.
pub interest_charge_amount: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthMetadata {
///Metadata specifically related to which auth methods an institution supports.
pub supported_methods: AuthSupportedMethods,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthSupportedMethods {
///Indicates if instant auth is supported.
pub instant_auth: bool,
///Indicates if instant match is supported.
pub instant_match: bool,
///Indicates if automated microdeposits are supported.
pub automated_micro_deposits: bool,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationMetadata {
///Indicates whether the institution supports payments from a different country.
pub supports_international_payments: bool,
/**A mapping of currency to maximum payment amount (denominated in the smallest unit of currency) supported by the institution.
Example: `{"GBP": "10000"}`
*/
pub maximum_payment_amount: PaymentInitiationMaximumPaymentAmount,
///Indicates whether the institution supports returning refund details when initiating a payment.
pub supports_refund_details: bool,
///Metadata specifically related to valid Payment Initiation standing order configurations for the institution.
pub standing_order_metadata: PaymentInitiationStandingOrderMetadata,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationMaximumPaymentAmount {}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationStandingOrderMetadata {
///Indicates whether the institution supports closed-ended standing orders by providing an end date.
pub supports_standing_order_end_date: bool,
///This is only applicable to `MONTHLY` standing orders. Indicates whether the institution supports negative integers (-1 to -5) for setting up a `MONTHLY` standing order relative to the end of the month.
pub supports_standing_order_negative_execution_days: bool,
///A list of the valid standing order intervals supported by the institution.
pub valid_standing_order_intervals: Vec<PaymentScheduleInterval>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentInitiationAddress {
///An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.
pub street: Vec<String>,
///The city where the recipient is located. Maximum of 35 characters.
pub city: String,
///The postal code where the recipient is located. Maximum of 16 characters.
pub postal_code: String,
///The ISO 3166-1 alpha-2 country code where the recipient is located.
pub country: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ExternalPaymentScheduleBase {
///The frequency interval of the payment.
pub interval: Option<PaymentScheduleInterval>,
/**The day of the interval on which to schedule the payment.
If the payment interval is weekly, `interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday).
If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.*/
pub interval_execution_day: Option<i64>,
/**A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will begin on the first `interval_execution_day` on or after the `start_date`.
If the first `interval_execution_day` on or after the start date is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make the first payment on that day, but it is not guaranteed to do so.*/
pub start_date: Option<String>,
/**A date in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will end on the last `interval_execution_day` on or before the `end_date`.
If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank *may* make a payment on that day, but it is not guaranteed to do so.*/
pub end_date: Option<String>,
///The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, this field will be `null`.
pub adjusted_start_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ExternalPaymentScheduleRequest(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentScheduleInterval(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentScheme(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct ExternalPaymentOptions {
///When `true`, Plaid will attempt to request refund details from the payee's financial institution. Support varies between financial institutions and will not always be available. If refund details could be retrieved, they will be available in the `/payment_initiation/payment/get` response.
pub request_refund_details: Option<bool>,
///The International Bank Account Number (IBAN) for the payer's account. If provided, the end user will be able to send payments only from the specified bank account.
pub iban: Option<String>,
///An optional object used to restrict the accounts used for payments. If provided, the end user will be able to send payments only from the specified bank account.
pub bacs: PaymentInitiationOptionalRestrictionBacs,
///The EMI (E-Money Institution) wallet that this payment is associated with, if any. This wallet is used as an intermediary account to enable Plaid to reconcile the settlement of funds for Payment Initiation requests.
pub wallet_id: Option<String>,
/**Payment scheme. If not specified - the default in the region will be used (e.g. `SEPA_CREDIT_TRANSFER` for EU). Using unsupported values will result in a failed payment.
`FASTER_PAYMENTS`: Enables payments to move quickly between UK bank accounts. Default value in the UK.
`SEPA_CREDIT_TRANSFER`: The standard payment to a beneficiary within the SEPA area.
`SEPA_CREDIT_TRANSFER_INSTANT`: Instant payment within the SEPA area. May involve additional fees and may not be available at some banks.*/
pub scheme: PaymentScheme,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ExternalPaymentRefundDetails {
///The name of the account holder.
pub name: String,
///The International Bank Account Number (IBAN) for the account.
pub iban: Option<String>,
///An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.
pub bacs: RecipientBACSNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ExternalPaymentScheduleGet(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct Products(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct ProductStatus {
/**This field is deprecated in favor of the `breakdown` object, which provides more granular institution health data.
`HEALTHY`: the majority of requests are successful
`DEGRADED`: only some requests are successful
`DOWN`: all requests are failing*/
pub status: String,
/**[ISO 8601](https://wikipedia.org/wiki/ISO_8601) formatted timestamp of the last status change for the institution.
*/
pub last_status_change: String,
///A detailed breakdown of the institution's performance for a request type. The values for `success`, `error_plaid`, and `error_institution` sum to 1.
pub breakdown: ProductStatusBreakdown,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProductStatusBreakdown {
///The percentage of login attempts that are successful, expressed as a decimal.
pub success: f64,
/**The percentage of logins that are failing due to an internal Plaid issue, expressed as a decimal.
*/
pub error_plaid: f64,
///The percentage of logins that are failing due to an issue in the institution's system, expressed as a decimal.
pub error_institution: f64,
///The `refresh_interval` may be `DELAYED` or `STOPPED` even when the success rate is high. This value is only returned for Transactions status breakdowns.
pub refresh_interval: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct UserCustomPassword {
///The version of the password schema to use, possible values are 1 or 2. The default value is 2. You should only specify 1 if you know it is necessary for your test suite.
pub version: Option<String>,
/**A seed, in the form of a string, that will be used to randomly generate account and transaction data, if this data is not specified using the `override_accounts` argument. If no seed is specified, the randomly generated data will be different each time.
Note that transactions data is generated relative to the Item's creation date. Different Items created on different dates with the same seed for transactions data will have different dates for the transactions. The number of days between each transaction and the Item creation will remain constant. For example, an Item created on December 15 might show a transaction on December 14. An Item created on December 20, using the same seed, would show that same transaction occurring on December 19.*/
pub seed: String,
///An array of account overrides to configure the accounts for the Item. By default, if no override is specified, transactions and account data will be randomly generated based on the account type and subtype, and other products will have fixed or empty data.
pub override_accounts: Vec<OverrideAccounts>,
///Specifies the multi-factor authentication settings to use with this test account
pub mfa: MFA,
///You may trigger a reCAPTCHA in Plaid Link in the Sandbox environment by using the recaptcha field. Possible values are `good` or `bad`. A value of `good` will result in successful Item creation and `bad` will result in a `RECAPTCHA_BAD` error to simulate a failed reCAPTCHA. Both values require the reCAPTCHA to be manually solved within Plaid Link.
pub recaptcha: String,
/**An error code to force on Item creation. Possible values are:
`"INSTITUTION_NOT_RESPONDING"`
`"INSTITUTION_NO_LONGER_SUPPORTED"`
`"INVALID_CREDENTIALS"`
`"INVALID_MFA"`
`"ITEM_LOCKED"`
`"ITEM_LOGIN_REQUIRED"`
`"ITEM_NOT_SUPPORTED"`
`"INVALID_LINK_TOKEN"`
`"MFA_NOT_SUPPORTED"`
`"NO_ACCOUNTS"`
`"PLAID_ERROR"`
`"PRODUCTS_NOT_SUPPORTED"`
`"USER_SETUP_REQUIRED"`*/
pub force_error: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct MFA {
#[serde(rename = "type")]
/**Possible values are `device`, `selections`, or `questions`.
If value is `device`, the MFA answer is `1234`.
If value is `selections`, the MFA answer is always the first option.
If value is `questions`, the MFA answer is `answer_<i>_<j>` for the j-th question in the i-th round, starting from 0. For example, the answer to the first question in the second round is `answer_1_0`.*/
pub type_: String,
///Number of rounds of questions. Required if value of `type` is `questions`.
pub question_rounds: f64,
///Number of questions per round. Required if value of `type` is `questions`. If value of type is `selections`, default value is 2.
pub questions_per_round: f64,
///Number of rounds of selections, used if `type` is `selections`. Defaults to 1.
pub selection_rounds: f64,
/**Number of available answers per question, used if `type` is `selection`. Defaults to 2.
*/
pub selections_per_question: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct OverrideAccounts {
#[serde(rename = "type")]
/**`investment:` Investment account.
`credit:` Credit card
`depository:` Depository account
`loan:` Loan account
`payroll:` Payroll account
`other:` Non-specified account type
See the [Account type schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full listing of account types and corresponding subtypes.*/
pub type_: OverrideAccountType,
///See the [Account type schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.
pub subtype: AccountSubtype,
/**If provided, the account will start with this amount as the current balance.
*/
pub starting_balance: f64,
///If provided, the account will always have this amount as its available balance, regardless of current balance or changes in transactions over time.
pub force_available_balance: f64,
///ISO-4217 currency code. If provided, the account will be denominated in the given currency. Transactions will also be in this currency by default.
pub currency: String,
///Allows specifying the metadata of the test account
pub meta: Meta,
///Account and bank identifier number data used to configure the test account. All values are optional.
pub numbers: Numbers,
///Specify the list of transactions on the account.
pub transactions: Vec<TransactionOverride>,
///Specify the holdings on the account.
pub holdings: Option<HoldingsOverride>,
///Specify the list of investments transactions on the account.
pub investment_transactions: Option<Investments_TransactionsOverride>,
///Data about the owner or owners of an account. Any fields not specified will be filled in with default Sandbox information.
pub identity: OwnerOverride,
///Used to configure Sandbox test data for the Liabilities product
pub liability: LiabilityOverride,
///The `inflow_model` allows you to foo a test account that receives regular income or make regular payments on a loan. Any transactions generated by the `inflow_model` will appear in addition to randomly generated test data or transactions specified by `override_accounts`.
pub inflow_model: InflowModel,
///Specify payroll data on the account.
pub income: Option<IncomeOverride>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Meta {
///The account's name
pub name: String,
///The account's official name
pub official_name: String,
///The account's limit
pub limit: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Numbers {
///Will be used for the account number.
pub account: Option<String>,
///Must be a valid ACH routing number.
pub ach_routing: Option<String>,
///Must be a valid wire transfer routing number.
pub ach_wire_routing: Option<String>,
///EFT institution number. Must be specified alongside `eft_branch`.
pub eft_institution: Option<String>,
///EFT branch number. Must be specified alongside `eft_institution`.
pub eft_branch: Option<String>,
///Bank identifier code (BIC). Must be specified alongside `international_iban`.
pub international_bic: Option<String>,
///International bank account number (IBAN). If no account number is specified via `account`, will also be used as the account number by default. Must be specified alongside `international_bic`.
pub international_iban: Option<String>,
///BACS sort code
pub bacs_sort_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionOverride {
///The date of the transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Transactions in Sandbox will move from pending to posted once their transaction date has been reached. If a `date_transacted` is not provided by the institution, a transaction date may be available in the [`authorized_date`](https://plaid.com/docs/api/products/#transactions-get-response-transactions-authorized-date) field.
pub date_transacted: String,
///The date the transaction posted, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Posted dates in the past or present will result in posted transactions; posted dates in the future will result in pending transactions.
pub date_posted: String,
///The transaction amount. Can be negative.
pub amount: f64,
///The transaction description.
pub description: String,
///The ISO-4217 format currency code for the transaction.
pub currency: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SecurityOverride {
///12-character ISIN, a globally unique securities identifier.
pub isin: Option<String>,
///9-character CUSIP, an identifier assigned to North American securities.
pub cusip: Option<String>,
///7-character SEDOL, an identifier assigned to securities in the UK.
pub sedol: Option<String>,
///A descriptive name for the security, suitable for display.
pub name: Option<String>,
///The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
pub ticker_symbol: Option<String>,
///Either a valid `iso_currency_code` or `unofficial_currency_code`
pub currency: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct HoldingsOverride {
///The last price given by the institution for this security
pub institution_price: f64,
///The date at which `institution_price` was current. Must be formatted as an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date.
pub institution_price_as_of: Option<String>,
///The average original value of the holding. Multiple cost basis values for the same security purchased at different prices are not supported.
pub cost_basis: Option<f64>,
///The total quantity of the asset held, as reported by the financial institution.
pub quantity: f64,
///Either a valid `iso_currency_code` or `unofficial_currency_code`
pub currency: String,
///Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (`ticker_symbol`, `cusip`, `isin`, or `sedol`) are required.
pub security: SecurityOverride,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Investments_TransactionsOverride {
///Posting date for the transaction. Must be formatted as an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date.
pub date: String,
///The institution's description of the transaction.
pub name: String,
///The number of units of the security involved in this transaction. Must be positive if the type is a buy and negative if the type is a sell.
pub quantity: f64,
///The price of the security at which this transaction occurred.
pub price: f64,
///The combined value of all fees applied to this transaction.
pub fees: Option<f64>,
#[serde(rename = "type")]
/**The type of the investment transaction. Possible values are:
`buy`: Buying an investment
`sell`: Selling an investment
`cash`: Activity that modifies a cash position
`fee`: A fee on the account
`transfer`: Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer*/
pub type_: String,
///Either a valid `iso_currency_code` or `unofficial_currency_code`
pub currency: String,
///Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (`ticker_symbol`, `cusip`, `isin`, or `sedol`) are required.
pub security: Option<SecurityOverride>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilityOverride {
#[serde(rename = "type")]
///The type of the liability object, either `credit` or `student`. Mortgages are not currently supported in the custom Sandbox.
pub type_: String,
///The purchase APR percentage value. For simplicity, this is the only interest rate used to calculate interest charges. Can only be set if `type` is `credit`.
pub purchase_apr: f64,
///The cash APR percentage value. Can only be set if `type` is `credit`.
pub cash_apr: f64,
///The balance transfer APR percentage value. Can only be set if `type` is `credit`. Can only be set if `type` is `credit`.
pub balance_transfer_apr: f64,
///The special APR percentage value. Can only be set if `type` is `credit`.
pub special_apr: f64,
///Override the `last_payment_amount` field. Can only be set if `type` is `credit`.
pub last_payment_amount: f64,
///Override the `minimum_payment_amount` field. Can only be set if `type` is `credit` or `student`.
pub minimum_payment_amount: f64,
///Override the `is_overdue` field
pub is_overdue: bool,
///The date on which the loan was initially lent, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format. Can only be set if `type` is `student`.
pub origination_date: String,
///The original loan principal. Can only be set if `type` is `student`.
pub principal: f64,
///The interest rate on the loan as a percentage. Can only be set if `type` is `student`.
pub nominal_apr: f64,
///If set, interest capitalization begins at the given number of months after loan origination. By default interest is never capitalized. Can only be set if `type` is `student`.
pub interest_capitalization_grace_period_months: f64,
///Student loan repayment information used to configure Sandbox test data for the Liabilities product
pub repayment_model: StudentLoanRepaymentModel,
///Override the `expected_payoff_date` field. Can only be set if `type` is `student`.
pub expected_payoff_date: String,
///Override the `guarantor` field. Can only be set if `type` is `student`.
pub guarantor: String,
///Override the `is_federal` field. Can only be set if `type` is `student`.
pub is_federal: bool,
///Override the `loan_name` field. Can only be set if `type` is `student`.
pub loan_name: String,
///An object representing the status of the student loan
pub loan_status: StudentLoanStatus,
///Override the `payment_reference_number` field. Can only be set if `type` is `student`.
pub payment_reference_number: String,
///Information about the student's eligibility in the Public Service Loan Forgiveness program. This is only returned if the institution is Fedloan (`ins_116527`).
pub pslf_status: PSLFStatus,
///Override the `repayment_plan.description` field. Can only be set if `type` is `student`.
pub repayment_plan_description: String,
///Override the `repayment_plan.type` field. Can only be set if `type` is `student`. Possible values are: `"extended graduated"`, `"extended standard"`, `"graduated"`, `"income-contingent repayment"`, `"income-based repayment"`, `"interest only"`, `"other"`, `"pay as you earn"`, `"revised pay as you earn"`, or `"standard"`.
pub repayment_plan_type: String,
///Override the `sequence_number` field. Can only be set if `type` is `student`.
pub sequence_number: String,
///A physical mailing address.
pub servicer_address: Address,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StudentLoanRepaymentModel {
#[serde(rename = "type")]
///The only currently supported value for this field is `standard`.
pub type_: String,
///Configures the number of months before repayment starts.
pub non_repayment_months: f64,
///Configures the number of months of repayments before the loan is paid off.
pub repayment_months: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InflowModel {
#[serde(rename = "type")]
/**Inflow foo. One of the following:
`none`: No income
`monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month.
`monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month.
Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.*/
pub type_: String,
///Amount of income per month. This value is required if `type` is `monthly-income`.
pub income_amount: f64,
///Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
pub payment_day_of_month: f64,
///The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
pub transaction_name: String,
///Number between 1 and 28, or `last` meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`.
pub statement_day_of_month: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeOverride {
///A list of paystubs associated with the account.
pub paystubs: Option<Vec<PaystubOverride>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubOverride {
///The employer on the paystub.
pub employer: Option<PaystubOverrideEmployer>,
///The employee on the paystub.
pub employee: Option<PaystubOverrideEmployee>,
///
pub income_breakdown: Option<Vec<IncomeBreakdown>>,
///Details about the pay period.
pub pay_period_details: Option<PayPeriodDetails>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubOverrideEmployer {
///The name of the employer.
pub name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubOverrideEmployee {
///The name of the employee.
pub name: Option<String>,
///The address of the employee.
pub address: Option<PaystubOverrideEmployeeAddress>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubOverrideEmployeeAddress {
///The full city name.
pub city: Option<String>,
/**The region or state
Example: `"NC"`*/
pub region: Option<String>,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: Option<String>,
///5 digit postal code.
pub postal_code: Option<String>,
///The country of the address.
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemId(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AutomaticallyVerifiedWebhook {
///`AUTH`
pub webhook_type: String,
///`AUTOMATICALLY_VERIFIED`
pub webhook_code: String,
///The `account_id` of the account associated with the webhook
pub account_id: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct JWTHeader {
///
pub id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct VerificationExpiredWebhook {
///`AUTH`
pub webhook_type: String,
///`VERIFICATION_EXPIRED`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///The `account_id` of the account associated with the webhook
pub account_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WebhookUpdateAcknowledgedWebhook {
///`ITEM`
pub webhook_type: String,
///`WEBHOOK_UPDATE_ACKNOWLEDGED`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///The new webhook URL
pub new_webhook_url: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PendingExpirationWebhook {
///`ITEM`
pub webhook_type: String,
///`PENDING_EXPIRATION`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///The date and time at which the Item's access consent will expire, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format
pub consent_expiration_time: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemErrorWebhook {
///`ITEM`
pub webhook_type: String,
///`ERROR`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: PlaidError,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemProductReadyWebhook {
///`INCOME`
pub webhook_type: String,
///`PRODUCT_READY`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Recaptcha_RequiredError {
///RECAPTCHA_ERROR
pub error_type: String,
///RECAPTCHA_REQUIRED
pub error_code: String,
///
pub display_message: String,
///400
pub http_code: String,
///Your user will be prompted to solve a Google reCAPTCHA challenge in the Link Recaptcha pane. If they solve the challenge successfully, the user's request is resubmitted and they are directed to the next Item creation step.
pub link_user_experience: String,
///Plaid's fraud system detects abusive traffic and considers a variety of parameters throughout Item creation requests. When a request is considered risky or possibly fraudulent, Link presents a reCAPTCHA for the user to solve.
pub common_causes: String,
/**Link will automatically guide your user through reCAPTCHA verification. As a general rule, we recommend instrumenting basic fraud monitoring to detect and protect your website from spam and abuse.
If your user cannot verify their session, please submit a Support ticket with the following identifiers: `link_session_id` or `request_id`*/
pub troubleshooting_steps: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransfersEventsUpdateWebhook {
///`BANK_TRANSFERS`
pub webhook_type: String,
///`BANK_TRANSFERS_EVENTS_UPDATE`
pub webhook_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentsDefaultUpdateWebhook {
///`INVESTMENTS_TRANSACTIONS`
pub webhook_type: String,
///`DEFAULT_UPDATE`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///The number of new transactions reported since the last time this webhook was fired.
pub new_investments_transactions: f64,
///The number of canceled transactions reported since the last time this webhook was fired.
pub canceled_investments_transactions: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct HoldingsDefaultUpdateWebhook {
///`HOLDINGS`
pub webhook_type: String,
///`DEFAULT_UPDATE`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///The number of new holdings reported since the last time this webhook was fired.
pub new_holdings: f64,
///The number of updated holdings reported since the last time this webhook was fired.
pub updated_holdings: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesDefaultUpdateWebhook {
///`LIABILITIES`
pub webhook_type: String,
///`DEFAULT_UPDATE`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: PlaidError,
///An array of `account_id`'s for accounts that contain new liabilities.'
pub account_ids_with_new_liabilities: Vec<String>,
/**An object with keys of `account_id`'s that are mapped to their respective liabilities fields that changed.
Example: `{ "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58": ["past_amount_due"] }`
*/
pub account_ids_with_updated_liabilities: LiabilitiesAccountIdsWithUpdatedLiabilities,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LiabilitiesAccountIdsWithUpdatedLiabilities {}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetsProductReadyWebhook {
///`ASSETS`
pub webhook_type: String,
///`PRODUCT_READY`
pub webhook_code: String,
///The `asset_report_id` that can be provided to `/asset_report/get` to retrieve the Asset Report.
pub asset_report_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetsErrorWebhook {
///`ASSETS`
pub webhook_type: String,
///`ERROR`
pub webhook_code: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: PlaidError,
///The ID associated with the Asset Report.
pub asset_report_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Cause {
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: PlaidError,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Warning {
///The warning type, which will always be `ASSET_REPORT_WARNING`
pub warning_type: String,
///The warning code identifies a specific kind of warning. Currently, the only possible warning code is `OWNERS_UNAVAILABLE`, which indicates that account-owner information is not available.
pub warning_code: String,
///An error object and associated `item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.
pub cause: Cause,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentAmount {
///The ISO-4217 currency code of the payment. For standing orders, `"GBP"` must be used.
pub currency: String,
///The amount of the payment. Must contain at most two digits of precision e.g. `1.23`. Minimum accepted value is `1`.
pub value: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportUser {
///An identifier you determine and submit for the user.
pub client_user_id: Option<String>,
///The user's first name. Required for the Fannie Mae Day 1 Certainty™ program.
pub first_name: Option<String>,
///The user's middle name
pub middle_name: Option<String>,
///The user's last name. Required for the Fannie Mae Day 1 Certainty™ program.
pub last_name: Option<String>,
/**The user's Social Security Number. Required for the Fannie Mae Day 1 Certainty™ program.
Format: "ddd-dd-dddd"*/
pub ssn: Option<String>,
///The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14151234567". Phone numbers provided in other formats will be parsed on a best-effort basis.
pub phone_number: Option<String>,
///The user's email address.
pub email: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportId(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportRefreshAssetReportToken(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneCurrencyCodeList {
///Plaid supports all ISO 4217 currency codes.
pub iso_currency_code: String,
///List of unofficial currency codes
pub unofficial_currency_code: UnofficialCurrencyCodeList,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct UnofficialCurrencyCodeList(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneAccountType {
///An account type holding cash, in which funds are deposited. Supported products for `depository` accounts are: Auth (`checking` and `savings` types only), Balance, Transactions, Identity, Payment Initiation, and Assets.
pub depository: DepositoryAccount,
///A credit card type account. Supported products for `credit` accounts are: Balance, Transactions, Identity, and Liabilities.
pub credit: CreditAccount,
///A loan type account. Supported products for `loan` accounts are: Balance, Liabilities, and Transactions.
pub loan: LoanAccount,
///An investment account. Supported products for `investment` accounts are: Balance and Investments. In API versions 2018-05-22 and earlier, this type is called `brokerage`.
pub investment: InvestmentAccountSubtypeStandalone,
///Other or unknown account type. Supported products for `other` accounts are: Balance, Transactions, Identity, and Assets.
pub other: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositoryAccount(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct CreditAccount(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct LoanAccount(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentAccountSubtypeStandalone(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReport {
///A unique ID identifying an Asset Report. Like all Plaid identifiers, this ID is case sensitive.
pub asset_report_id: AssetReportId,
///An identifier you determine and submit for the Asset Report.
pub client_report_id: Option<String>,
///The date and time when the Asset Report was created, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (e.g. "2018-04-12T03:32:11Z").
pub date_generated: String,
///The duration of transaction history you requested
pub days_requested: f64,
///The user object allows you to provide additional information about the user to be appended to the Asset Report. All fields are optional. The `first_name`, `last_name`, and `ssn` fields are required if you would like the Report to be eligible for Fannie Mae’s Day 1 Certainty™ program.
pub user: AssetReportUser,
///Data returned by Plaid about each of the Items included in the Asset Report.
pub items: Vec<AssetReportItem>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportItem {
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///The full financial institution name associated with the Item.
pub institution_name: String,
///The id of the financial institution associated with the Item.
pub institution_id: String,
///The date and time when this Item’s data was last retrieved from the financial institution, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
pub date_last_updated: String,
///Data about each of the accounts open on the Item.
pub accounts: Vec<AccountAssets>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaymentStatusUpdateWebhook {
///`PAYMENT_INITIATION`
pub webhook_type: String,
///`PAYMENT_STATUS_UPDATE`
pub webhook_code: String,
///The `payment_id` for the payment being updated
pub payment_id: String,
/**The status of the payment.
`PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.
`PAYMENT_STATUS_INITIATED`: The payment has been successfully authorised and accepted by the financial institution but has not been executed.
`PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.
`PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.
`PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.
`PAYMENT_STATUS_AUTHORISING`: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.
`PAYMENT_STATUS_CANCELLED`: The payment was cancelled during authorisation.
`PAYMENT_STATUS_EXECUTED`: The payment has been successfully initiated and is considered complete.
`PAYMENT_STATUS_ESTABLISHED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.
`PAYMENT_STATUS_REJECTED`: The payment was rejected by the financial institution.
Deprecated:
These statuses will be removed in a future release.
`PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
`PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.
`PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.*/
pub new_payment_status: PaymentInitiationPaymentStatus,
/**The status of the payment.
`PAYMENT_STATUS_INPUT_NEEDED`: This is the initial state of all payments. It indicates that the payment is waiting on user input to continue processing. A payment may re-enter this state later on if further input is needed.
`PAYMENT_STATUS_INITIATED`: The payment has been successfully authorised and accepted by the financial institution but has not been executed.
`PAYMENT_STATUS_INSUFFICIENT_FUNDS`: The payment has failed due to insufficient funds.
`PAYMENT_STATUS_FAILED`: The payment has failed to be initiated. This error is retryable once the root cause is resolved.
`PAYMENT_STATUS_BLOCKED`: The payment has been blocked. This is a retryable error.
`PAYMENT_STATUS_AUTHORISING`: The payment is currently being processed. The payment will automatically exit this state when the financial institution has authorised the transaction.
`PAYMENT_STATUS_CANCELLED`: The payment was cancelled during authorisation.
`PAYMENT_STATUS_EXECUTED`: The payment has been successfully initiated and is considered complete.
`PAYMENT_STATUS_ESTABLISHED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.
`PAYMENT_STATUS_REJECTED`: The payment was rejected by the financial institution.
Deprecated:
These statuses will be removed in a future release.
`PAYMENT_STATUS_UNKNOWN`: The payment status is unknown.
`PAYMENT_STATUS_PROCESSING`: The payment is currently being processed. The payment will automatically exit this state when processing is complete.
`PAYMENT_STATUS_COMPLETED`: Indicates that the standing order has been successfully established. This state is only used for standing orders.*/
pub old_payment_status: PaymentInitiationPaymentStatus,
///The original value of the reference when creating the payment.
pub original_reference: Option<String>,
///The value of the reference sent to the bank after adjustment to pass bank validation rules.
pub adjusted_reference: Option<String>,
///The original value of the `start_date` provided during the creation of a standing order. If the payment is not a standing order, this field will be `null`.
pub original_start_date: Option<String>,
///The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, or if the payment is not a standing order, this field will be `null`.
pub adjusted_start_date: Option<String>,
///The timestamp of the update, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `"2017-09-14T14:42:19.350Z"`
pub timestamp: String,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Holding {
///The Plaid `account_id` associated with the holding.
pub account_id: String,
///The Plaid `security_id` associated with the holding.
pub security_id: String,
///The last price given by the institution for this security.
pub institution_price: f64,
///The date at which `institution_price` was current.
pub institution_price_as_of: Option<String>,
///The value of the holding, as reported by the institution.
pub institution_value: f64,
///The cost basis of the holding.
pub cost_basis: Option<f64>,
///The total quantity of the asset held, as reported by the financial institution. If the security is an option, `quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.
pub quantity: f64,
///The ISO-4217 currency code of the holding. Always `null` if `unofficial_currency_code` is non-`null`.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
*/
pub unofficial_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Security {
///A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the `security_id` is case sensitive.
pub security_id: String,
///12-character ISIN, a globally unique securities identifier.
pub isin: Option<String>,
///9-character CUSIP, an identifier assigned to North American securities.
pub cusip: Option<String>,
///7-character SEDOL, an identifier assigned to securities in the UK.
pub sedol: Option<String>,
///An identifier given to the security by the institution
pub institution_security_id: Option<String>,
///If `institution_security_id` is present, this field indicates the Plaid `institution_id` of the institution to whom the identifier belongs.
pub institution_id: Option<String>,
///In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.
pub proxy_security_id: Option<String>,
///A descriptive name for the security, suitable for display.
pub name: Option<String>,
///The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
pub ticker_symbol: Option<String>,
///Indicates that a security is a highly liquid asset and can be treated like cash.
pub is_cash_equivalent: Option<bool>,
#[serde(rename = "type")]
/**The security type of the holding. Valid security types are:
`cash`: Cash, currency, and money market funds
`derivative`: Options, warrants, and other derivative instruments
`equity`: Domestic and foreign equities
`etf`: Multi-asset exchange-traded investment funds
`fixed income`: Bonds and certificates of deposit (CDs)
`loan`: Loans and loan receivables.
`mutual fund`: Open- and closed-end vehicles pooling funds of multiple investors.
`other`: Unknown or other investment types*/
pub type_: Option<String>,
///Price of the security at the close of the previous trading session. `null` for non-public securities. If the security is a foreign currency or a cryptocurrency this field will be updated daily and will be priced in USD.
pub close_price: Option<f64>,
///Date for which `close_price` is accurate. Always `null` if `close_price` is `null`.
pub close_price_as_of: Option<String>,
///The ISO-4217 currency code of the price given. Always `null` if `unofficial_currency_code` is non-`null`.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the security. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentTransaction {
///The ID of the Investment transaction, unique across all Plaid transactions. Like all Plaid identifiers, the `investment_transaction_id` is case sensitive.
pub investment_transaction_id: String,
///A legacy field formerly used internally by Plaid to identify certain canceled transactions.
pub cancel_transaction_id: Option<String>,
///The `account_id` of the account against which this transaction posted.
pub account_id: String,
///The `security_id` to which this transaction is related.
pub security_id: Option<String>,
///The [ISO 8601](https://wikipedia.org/wiki/ISO_8601) posting date for the transaction.
pub date: String,
///The institution’s description of the transaction.
pub name: String,
///The number of units of the security involved in this transaction.
pub quantity: f64,
///The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.
pub amount: f64,
///The price of the security at which this transaction occurred.
pub price: f64,
///The combined value of all fees applied to this transaction
pub fees: Option<f64>,
#[serde(rename = "type")]
/**Value is one of the following:
`buy`: Buying an investment
`sell`: Selling an investment
`cancel`: A cancellation of a pending transaction
`cash`: Activity that modifies a cash position
`fee`: A fee on the account
`transfer`: Activity which modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).*/
pub type_: String,
///For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](https://plaid.com/docs/api/accounts/#investment-transaction-types-schema).
pub subtype: String,
///The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-`null`.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionType {
///Buying an investment
pub buy: StandaloneInvestmentTransactionBuyType,
///Selling an investment
pub sell: StandaloneInvestmentTransactionSellType,
///A cancellation of a pending transaction
pub cancel: String,
///Activity that modifies a cash position
pub cash: StandaloneInvestmentTransactionCashType,
///Fees on the account, e.g. commission, bookkeeping, options-related.
pub fee: StandaloneInvestmentTransactionFeeType,
///Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
pub transfer: StandaloneInvestmentTransactionTransferType,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionBuyType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionCashType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionFeeType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionSellType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct StandaloneInvestmentTransactionTransferType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountSubtypes(pub Vec<AccountSubtype>);
#[derive(Debug, Serialize, Deserialize)]
pub struct UserPermissionRevokedWebhook {
///`ITEM`
pub webhook_type: String,
///`USER_PERMISSION_REVOKED`
pub webhook_code: String,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: ItemId,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the deposit switch
pub deposit_switch_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchGetResponse {
///The ID of the deposit switch.
pub deposit_switch_id: String,
///The ID of the bank account the direct deposit was switched to.
pub target_account_id: Option<String>,
///The ID of the Item the direct deposit was switched to.
pub target_item_id: Option<String>,
/**
The state, or status, of the deposit switch.
- `initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request.
- `processing` – The deposit switch request has been submitted and is being processed.
- `completed` – The user's employer has fulfilled the deposit switch request.
- `error` – There was an error processing the deposit switch request.*/
pub state: String,
/**The method used to make the deposit switch.
- `instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account.
- `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch.
- `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'*/
pub switch_method: Option<String>,
///When `true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed.
pub account_has_multiple_allocations: Option<bool>,
///When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed.
pub is_allocated_remainder: Option<bool>,
///The percentage of direct deposit allocated to the target account. Always `null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true.
pub percent_allocated: Option<f64>,
///The dollar amount of direct deposit allocated to the target account. Always `null` if the target account is not allocated an amount or if the deposit switch has not been completed.
pub amount_allocated: Option<f64>,
///The name of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
pub employer_name: Option<String>,
///The ID of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
pub employer_id: Option<String>,
///The name of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
pub institution_name: Option<String>,
///The ID of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
pub institution_id: Option<String>,
/**[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was created.
*/
pub date_created: String,
/**[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always `null` if the deposit switch has not been completed.
*/
pub date_completed: Option<String>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchStateUpdateWebhook {
///`"DEPOSIT_SWITCH"`
pub webhook_type: Option<String>,
///`"SWITCH_STATE_UPDATE"`
pub webhook_code: Option<String>,
/**
The state, or status, of the deposit switch.
`initialized`: The deposit switch has been initialized with the user entering the information required to submit the deposit switch request.
`processing`: The deposit switch request has been submitted and is being processed.
`completed`: The user's employer has fulfilled and completed the deposit switch request.
`error`: There was an error processing the deposit switch request.
For more information, see the [Deposit Switch API reference](/docs/deposit-switch/reference#deposit_switchget).*/
pub state: Option<String>,
///The ID of the deposit switch.
pub deposit_switch_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportAuditCopyGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The `audit_copy_token` granting access to the Audit Copy you would like to get.
pub audit_copy_token: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a transfer.
pub transfer_id: TransferID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a bank transfer.
pub bank_transfer_id: BankTransferID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferGetResponse {
///Represents a transfer within the Transfers API.
pub transfer: Transfer,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferGetResponse {
///Represents a bank transfer within the Bank Transfers API.
pub bank_transfer: BankTransfer,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepID(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct Transfer {
///Plaid’s unique identifier for a transfer.
pub id: TransferID,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The account ID that should be credited/debited for this transfer.
pub account_id: String,
#[serde(rename = "type")]
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: TransferType,
///The legal name and other information for the account holder.
pub user: TransferUserInResponse,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
///The description of the transfer.
pub description: String,
///The datetime when this transfer was created. This will be of the form `2006-01-02T15:04:05Z`
pub created: String,
///The status of the transfer.
pub status: TransferStatus,
/**The status of the sweep for the transfer.
`unswept`: The transfer hasn't been swept yet.
`swept`: The transfer was swept to the sweep account.
`reverse_swept`: The transfer was reversed, funds were pulled back or pushed back to the sweep account.
`null`: The transfer will never be swept (e.g. if the transfer is cancelled or reversed before being swept)*/
pub sweep_status: TransferSweepStatus,
///The network or rails used for the transfer. Valid options are `ach` or `same-day-ach`.
pub network: TransferNetwork,
///When `true`, you can still cancel this transfer.
pub cancellable: bool,
///The failure reason if the event type for a transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: TransferFailure,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: TransferMetadata,
///Plaid’s unique identifier for the origination account that was used for this transfer.
pub origination_account_id: String,
///Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either `GUARANTEED` or `NOT_GUARANTEED` indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the `guarantee_decision_rationale` field. Refer to the `code` field in `guarantee_decision_rationale` for details.
pub guarantee_decision: TransferAuthorizationGuaranteeDecision,
///The rationale for Plaid's decision to not guarantee a transfer. Will be `null` unless `guarantee_decision` is `NOT_GUARANTEED`.
pub guarantee_decision_rationale: TransferAuthorizationGuaranteeDecisionRationale,
///The currency of the transfer amount, e.g. "USD"
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransfer {
///Plaid’s unique identifier for a bank transfer.
pub id: BankTransferID,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The account ID that should be credited/debited for this bank transfer.
pub account_id: String,
#[serde(rename = "type")]
///The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: BankTransferType,
///The legal name and other information for the account holder.
pub user: BankTransferUser,
///The amount of the bank transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: BankTransferAmount,
///The currency of the transfer amount, e.g. "USD"
pub iso_currency_code: String,
///The description of the transfer.
pub description: String,
///The datetime when this bank transfer was created. This will be of the form `2006-01-02T15:04:05Z`
pub created: String,
///The status of the transfer.
pub status: BankTransferStatus,
///The network or rails used for the transfer. Valid options are `ach`, `same-day-ach`, or `wire`.
pub network: BankTransferNetwork,
///When `true`, you can still cancel this bank transfer.
pub cancellable: bool,
///The failure reason if the type of this transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: BankTransferFailure,
///A string containing the custom tag provided by the client in the create request. Will be null if not provided.
pub custom_tag: Option<String>,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: BankTransferMetadata,
///Plaid’s unique identifier for the origination account that was used for this transfer.
pub origination_account_id: String,
///Indicates the direction of the transfer: `outbound` for API-initiated transfers, or `inbound` for payments received by the FBO account.
pub direction: BankTransferDirection,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ACHClass(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAmount(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepAmount(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentGetFailureReason {
///A broad categorization of the error.
pub error_type: Option<String>,
/**A code representing the reason for a failed transfer intent (i.e., an API error or the authorization being declined).
For a full listing of bank transfer errors, see [Bank Transfers errors](https://plaid.com/docs/errors/bank-transfers/).*/
pub error_code: Option<String>,
///A human-readable description of the code associated with a failed transfer intent.
pub error_message: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentCreateMode(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferAmount(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferCreateIdempotencyKey(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferIdempotencyKey(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferUserInRequest {
///The user's legal name.
pub legal_name: String,
///The user's phone number.
pub phone_number: Option<String>,
///The user's email address.
pub email_address: Option<String>,
///The address associated with the account holder.
pub address: Option<TransferUserAddressInRequest>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferUserInResponse {
///The user's legal name.
pub legal_name: String,
///The user's phone number.
pub phone_number: Option<String>,
///The user's email address.
pub email_address: Option<String>,
///The address associated with the account holder.
pub address: TransferUserAddressInResponse,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferUserAddressInRequest {
///The street number and name (i.e., "100 Market St.").
pub street: Option<String>,
///Ex. "San Francisco"
pub city: Option<String>,
///The state or province (e.g., "California").
pub region: Option<String>,
///The postal code (e.g., "94103").
pub postal_code: Option<String>,
///A two-letter country code (e.g., "US").
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferUserAddressInResponse {
///The street number and name (i.e., "100 Market St.").
pub street: Option<String>,
///Ex. "San Francisco"
pub city: Option<String>,
///The state or province (e.g., "California").
pub region: Option<String>,
///The postal code (e.g., "94103").
pub postal_code: Option<String>,
///A two-letter country code (e.g., "US").
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferUser {
///The account holder’s full legal name. If the transfer `ach_class` is `ccd`, this should be the business name of the account holder.
pub legal_name: String,
///The account holder’s email.
pub email_address: Option<String>,
///The account holder's routing number. This field is only used in response data. Do not provide this field when making requests.
pub routing_number: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationDecisionRationale {
/**A code representing the rationale for permitting or declining the proposed transfer. Possible values are:
`NSF` – Transaction likely to result in a return due to insufficient funds.
`RISK` - Transaction is high-risk.
`MANUALLY_VERIFIED_ITEM` – Item created via same-day micro deposits, limited information available. Plaid can only offer `permitted` as a transaction decision.
`LOGIN_REQUIRED` – Unable to collect the account information required for an authorization decision due to Item staleness. Can be rectified using Link update mode.
`ERROR` – Unable to collect the account information required for an authorization decision due to an error.*/
pub code: String,
///A human-readable description of the code associated with a permitted transfer or transfer decline.
pub description: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationGuaranteeDecision(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationGuaranteeDecisionRationale {
/**A code representing the reason Plaid declined to guarantee this transfer:
`RETURN_BANK`: The risk of a bank-initiated return (for example, an R01/NSF) is too high to guarantee this transfer.
`RETURN_CUSTOMER`: The risk of a customer-initiated return (for example, a R10/Unauthorized) is too high to guarantee this transfer.
`GUARANTEE_LIMIT_REACHED`: This transfer is low-risk, but Guaranteed ACH has exhausted an internal limit on the number or rate of guarantees that applies to this transfer.
`RISK_ESTIMATE_UNAVAILABLE`: A risk estimate is unavailable for this Item.*/
pub code: String,
///A human-readable description of why the transfer cannot be guaranteed.
pub description: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationProposedTransfer {
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The Plaid `account_id` for the account that will be debited or credited.
pub account_id: String,
#[serde(rename = "type")]
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: TransferType,
///The legal name and other information for the account holder.
pub user: TransferUserInResponse,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
///The network or rails used for the transfer.
pub network: String,
///Plaid's unique identifier for the origination account that was used for this transfer.
pub origination_account_id: String,
///The currency of the transfer amount. The default value is "USD".
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationDevice {
///The IP address of the device being used to initiate the authorization.
pub ip_address: Option<String>,
///The user agent of the device being used to initiate the authorization.
pub user_agent: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferMetadata {}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferMetadata {}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepStatus(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferNetwork(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferNetwork(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferFailure {
///The ACH return code, e.g. `R01`. A return code will be provided if and only if the transfer status is `reversed`. For a full listing of ACH return codes, see [Transfer errors](https://plaid.com/docs/errors/transfer/#ach-return-codes).
pub ach_return_code: Option<String>,
///A human-readable description of the reason for the failure or reversal.
pub description: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferFailure {
///The ACH return code, e.g. `R01`. A return code will be provided if and only if the transfer status is `reversed`. For a full listing of ACH return codes, see [Bank Transfers errors](https://plaid.com/docs/errors/bank-transfers/#ach-return-codes).
pub ach_return_code: Option<String>,
///A human-readable description of the reason for the failure or reversal.
pub description: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The Plaid `access_token` for the account that will be debited or credited.
pub access_token: TransferAccessToken,
///The Plaid `account_id` for the account that will be debited or credited.
pub account_id: String,
#[serde(rename = "type")]
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: TransferType,
///The network or rails used for the transfer. Valid options are `ach` or `same-day-ach`.
pub network: TransferNetwork,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The legal name and other information for the account holder.
pub user: TransferUserInRequest,
///Information about the device being used to initiate the authorization.
pub device: Option<TransferAuthorizationDevice>,
///Plaid's unique identifier for the origination account for this authorization. If not specified, the default account will be used.
pub origination_account_id: Option<String>,
///The currency of the transfer amount. The default value is "USD".
pub iso_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**Deprecated. `authorization_id` is now for used idempotency instead.
A random key provided by the client, per unique transfer. Maximum of 50 characters.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single transfer is created.*/
pub idempotency_key: Option<TransferCreateIdempotencyKey>,
///The Plaid `access_token` for the account that will be debited or credited.
pub access_token: TransferAccessToken,
///The Plaid `account_id` for the account that will be debited or credited.
pub account_id: String,
///Plaid’s unique identifier for a transfer authorization. This parameter also serves the purpose of acting as an idempotency identifier.
pub authorization_id: String,
#[serde(rename = "type")]
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: TransferType,
///The network or rails used for the transfer. Valid options are `ach` or `same-day-ach`.
pub network: TransferNetwork,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
///The transfer description. Maximum of 10 characters.
pub description: String,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The legal name and other information for the account holder.
pub user: TransferUserInRequest,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: TransferMetadata,
///Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.
pub origination_account_id: Option<String>,
///The currency of the transfer amount. The default value is "USD".
pub iso_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**A random key provided by the client, per unique bank transfer. Maximum of 50 characters.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. For example, if a request to create a bank transfer fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that only a single bank transfer is created.*/
pub idempotency_key: BankTransferIdempotencyKey,
///The Plaid `access_token` for the account that will be debited or credited.
pub access_token: BankTransferAccessToken,
///The Plaid `account_id` for the account that will be debited or credited.
pub account_id: String,
#[serde(rename = "type")]
///The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub type_: BankTransferType,
///The network or rails used for the transfer. Valid options are `ach`, `same-day-ach`, or `wire`.
pub network: BankTransferNetwork,
///The amount of the bank transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: BankTransferAmount,
///The currency of the transfer amount – should be set to "USD".
pub iso_currency_code: String,
///The transfer description. Maximum of 10 characters.
pub description: String,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: Option<ACHClass>,
///The legal name and other information for the account holder.
pub user: BankTransferUser,
///An arbitrary string provided by the client for storage with the bank transfer. May be up to 100 characters.
pub custom_tag: Option<String>,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: BankTransferMetadata,
///Plaid’s unique identifier for the origination account for this transfer. If you have more than one origination account, this value must be specified. Otherwise, this field should be left blank.
pub origination_account_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorizationCreateResponse {
///Contains the authorization decision for a proposed transfer
pub authorization: TransferAuthorization,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferAuthorization {
///Plaid’s unique identifier for a transfer authorization.
pub id: TransferAuthorizationID,
///The datetime representing when the authorization was created, in the format `2006-01-02T15:04:05Z`.
pub created: String,
/**
A decision regarding the proposed transfer.
`approved` – The proposed transfer has received the end user's consent and has been approved for processing. Plaid has also reviewed the proposed transfer and has approved it for processing.
`permitted` – Plaid was unable to fetch the information required to approve or decline the proposed transfer. You may proceed with the transfer, but further review is recommended. Plaid is awaiting further instructions from the client.
`declined` – Plaid reviewed the proposed transfer and declined processing. Refer to the `code` field in the `decision_rationale` object for details.*/
pub decision: String,
///The rationale for Plaid's decision regarding a proposed transfer. Will be null for `approved` decisions.
pub decision_rationale: TransferAuthorizationDecisionRationale,
///Indicates whether the transfer is guaranteed by Plaid (Guaranteed ACH customers only). This field will contain either `GUARANTEED` or `NOT_GUARANTEED` indicating whether Plaid will guarantee the transfer. If the transfer is not guaranteed, additional information will be provided in the `guarantee_decision_rationale` field. Refer to the `code` field in `guarantee_decision_rationale` for details.
pub guarantee_decision: TransferAuthorizationGuaranteeDecision,
///The rationale for Plaid's decision to not guarantee a transfer. Will be `null` unless `guarantee_decision` is `NOT_GUARANTEED`.
pub guarantee_decision_rationale: TransferAuthorizationGuaranteeDecisionRationale,
///Details regarding the proposed transfer.
pub proposed_transfer: TransferAuthorizationProposedTransfer,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferCreateResponse {
///Represents a transfer within the Transfers API.
pub transfer: Transfer,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferCreateResponse {
///Represents a bank transfer within the Bank Transfers API.
pub bank_transfer: BankTransfer,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub start_date: Option<String>,
///The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub end_date: Option<String>,
///The maximum number of transfers to return.
pub count: Option<i64>,
///The number of transfers to skip before returning results.
pub offset: Option<i64>,
///Filter transfers to only those originated through the specified origination account.
pub origination_account_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub start_date: Option<String>,
///The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub end_date: Option<String>,
///The maximum number of bank transfers to return.
pub count: Option<i64>,
///The number of bank transfers to skip before returning results.
pub offset: Option<i64>,
///Filter bank transfers to only those originated through the specified origination account.
pub origination_account_id: Option<String>,
///Indicates the direction of the transfer: `outbound` for API-initiated transfers, or `inbound` for payments received by the FBO account.
pub direction: BankTransferDirection,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferListResponse {
///
pub transfers: Vec<Transfer>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferListResponse {
///
pub bank_transfers: Vec<BankTransfer>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferDirection(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferCancelRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a transfer.
pub transfer_id: TransferID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferCancelRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a bank transfer.
pub bank_transfer_id: BankTransferID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferCancelResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferCancelResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEventListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub start_date: Option<String>,
///The end datetime of transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub end_date: Option<String>,
///Plaid’s unique identifier for a transfer.
pub transfer_id: Option<String>,
///The account ID to get events for all transactions to/from an account.
pub account_id: Option<String>,
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into your origination account; a `credit` indicates a transfer of money out of your origination account.
pub transfer_type: Option<String>,
///Filter events by event type.
pub event_types: Option<Vec<TransferEventType>>,
///Plaid’s unique identifier for a sweep.
pub sweep_id: Option<String>,
///The maximum number of transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned.
pub count: Option<i64>,
///The offset into the list of transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned.
pub offset: Option<i64>,
///The origination account ID to get events for transfers from a specific origination account.
pub origination_account_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEventListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub start_date: Option<String>,
///The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)
pub end_date: Option<String>,
///Plaid’s unique identifier for a bank transfer.
pub bank_transfer_id: Option<String>,
///The account ID to get events for all transactions to/from an account.
pub account_id: Option<String>,
///The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into your origination account; a `credit` indicates a transfer of money out of your origination account.
pub bank_transfer_type: Option<String>,
///Filter events by event type.
pub event_types: Option<Vec<BankTransferEventType>>,
///The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned.
pub count: Option<i64>,
///The offset into the list of bank transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned.
pub offset: Option<i64>,
///The origination account ID to get events for transfers from a specific origination account.
pub origination_account_id: Option<String>,
/**Indicates the direction of the transfer: `outbound`: for API-initiated transfers
`inbound`: for payments received by the FBO account.*/
pub direction: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEventType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEventType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEvent {
///Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
pub event_id: i64,
///The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`.
pub timestamp: String,
/**The type of event that this transfer represents.
`pending`: A new transfer was created; it is in the pending state.
`cancelled`: The transfer was cancelled by the client.
`failed`: The transfer failed, no funds were moved.
`posted`: The transfer has been successfully submitted to the payment network.
`reversed`: A posted transfer was reversed.
`swept`: The transfer was swept to / from the sweep account.
`reverse_swept`: Due to the transfer reversing, funds were pulled from or pushed back to the sweep account.*/
pub event_type: TransferEventType,
///The account ID associated with the transfer.
pub account_id: String,
///Plaid’s unique identifier for a transfer.
pub transfer_id: TransferID,
///The ID of the origination account that this balance belongs to.
pub origination_account_id: Option<String>,
///The type of transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub transfer_type: TransferType,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub transfer_amount: TransferAmount,
///The failure reason if the event type for a transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: TransferFailure,
///Plaid’s unique identifier for a sweep.
pub sweep_id: TransferSweepID,
///A signed amount of how much was `swept` or `reverse_swept` (decimal string with two digits of precision e.g. "-5.50").
pub sweep_amount: TransferSweepAmount,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEvent {
///Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
pub event_id: i64,
///The datetime when this event occurred. This will be of the form `2006-01-02T15:04:05Z`.
pub timestamp: String,
/**The type of event that this bank transfer represents.
`pending`: A new transfer was created; it is in the pending state.
`cancelled`: The transfer was cancelled by the client.
`failed`: The transfer failed, no funds were moved.
`posted`: The transfer has been successfully submitted to the payment network.
`reversed`: A posted transfer was reversed.*/
pub event_type: BankTransferEventType,
///The account ID associated with the bank transfer.
pub account_id: String,
///Plaid’s unique identifier for a bank transfer.
pub bank_transfer_id: BankTransferID,
///The ID of the origination account that this balance belongs to.
pub origination_account_id: Option<String>,
///The type of bank transfer. This will be either `debit` or `credit`. A `debit` indicates a transfer of money into the origination account; a `credit` indicates a transfer of money out of the origination account.
pub bank_transfer_type: BankTransferType,
///The bank transfer amount.
pub bank_transfer_amount: String,
///The currency of the bank transfer amount.
pub bank_transfer_iso_currency_code: String,
///The failure reason if the type of this transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: BankTransferFailure,
///Indicates the direction of the transfer: `outbound` for API-initiated transfers, or `inbound` for payments received by the FBO account.
pub direction: BankTransferDirection,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEventListResponse {
///
pub transfer_events: Vec<TransferEvent>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEventListResponse {
///
pub bank_transfer_events: Vec<BankTransferEvent>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEventSyncRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The latest (largest) `event_id` fetched via the sync endpoint, or 0 initially.
pub after_id: i64,
///The maximum number of bank transfer events to return.
pub count: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEventSyncRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The latest (largest) `event_id` fetched via the sync endpoint, or 0 initially.
pub after_id: i64,
///The maximum number of transfer events to return.
pub count: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferEventSyncResponse {
///
pub bank_transfer_events: Vec<BankTransferEvent>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferEventSyncResponse {
///
pub transfer_events: Vec<TransferEvent>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferSweepGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Identifier of the sweep.
pub sweep_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a sweep.
pub sweep_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferSweepGetResponse {
///BankTransferSweep describes a sweep transfer.
pub sweep: BankTransferSweep,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepGetResponse {
/**Describes a sweep of funds to / from the sweep account.
A sweep is associated with many sweep events (events of type `swept` or `reverse_swept`) which can be retrieved by invoking the `/transfer/event/list` endpoint with the corresponding `sweep_id`.
`swept` events occur when the transfer amount is credited or debited from your sweep account, depending on the `type` of the transfer. `reverse_swept` events occur when a transfer is reversed and Plaid undoes the credit or debit.
The total sum of the `swept` and `reverse_swept` events is equal to the `amount` of the sweep Plaid creates and matches the amount of the entry on your sweep account ledger.*/
pub sweep: TransferSweep,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferSweepListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///If multiple origination accounts are available, `origination_account_id` must be used to specify the account that the sweeps belong to.
pub origination_account_id: Option<String>,
///The start datetime of sweeps to return (RFC 3339 format).
pub start_time: Option<String>,
///The end datetime of sweeps to return (RFC 3339 format).
pub end_time: Option<String>,
///The maximum number of sweeps to return.
pub count: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of sweeps to return (RFC 3339 format).
pub start_date: Option<String>,
///The end datetime of sweeps to return (RFC 3339 format).
pub end_date: Option<String>,
///The maximum number of sweeps to return.
pub count: Option<i64>,
///The number of sweeps to skip before returning results.
pub offset: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweepListResponse {
///
pub sweeps: Vec<TransferSweep>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferSweepListResponse {
///
pub sweeps: Vec<BankTransferSweep>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferSweep {
///Identifier of the sweep.
pub id: String,
///The datetime when the sweep occurred, in RFC 3339 format.
pub created_at: String,
///The amount of the sweep.
pub amount: String,
///The currency of the sweep, e.g. "USD".
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferSweep {
///Identifier of the sweep.
pub id: String,
///The datetime when the sweep occurred, in RFC 3339 format.
pub created: String,
/**Signed decimal amount of the sweep as it appears on your sweep account ledger (e.g. "-10.00")
If amount is not present, the sweep was net-settled to zero and outstanding debits and credits between the sweep account and Plaid are balanced.*/
pub amount: String,
///The currency of the sweep, e.g. "USD".
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SimulatedTransferSweep {}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferBalanceGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///If multiple origination accounts are available, `origination_account_id` must be used to specify the account for which balance will be returned.
pub origination_account_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferBalanceGetResponse {
///Information about the balance of a bank transfer
pub balance: BankTransferBalance,
///The ID of the origination account that this balance belongs to.
pub origination_account_id: Option<String>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferBalance {
///The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts.
pub available: String,
///The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.
pub transactable: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferMigrateAccountRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The user's account number.
pub account_number: String,
///The user's routing number.
pub routing_number: String,
///The type of the bank account (`checking` or `savings`).
pub account_type: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankTransferMigrateAccountResponse {
///The Plaid `access_token` for the newly created Item.
pub access_token: String,
///The Plaid `account_id` for the newly created Item.
pub account_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepaymentListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The start datetime of repayments to return (RFC 3339 format).
pub start_date: Option<String>,
///The end datetime of repayments to return (RFC 3339 format).
pub end_date: Option<String>,
///The maximum number of repayments to return.
pub count: Option<i64>,
///The number of repayments to skip before returning results.
pub offset: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepaymentListResponse {
///
pub repayments: Vec<TransferRepayment>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepayment {
///Identifier of the repayment.
pub repayment_id: String,
///The datetime when the repayment occurred, in RFC 3339 format.
pub created: String,
///Decimal amount of the repayment as it appears on your account ledger.
pub amount: String,
///The currency of the repayment, e.g. "USD".
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepaymentReturnListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Identifier of the repayment to query.
pub repayment_id: String,
///The maximum number of repayments to return.
pub count: Option<i64>,
///The number of repayments to skip before returning results.
pub offset: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepaymentReturnListResponse {
///
pub repayment_returns: Vec<TransferRepaymentReturn>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferRepaymentReturn {
///The unique identifier of the guaranteed transfer that was returned.
pub transfer_id: String,
///The unique identifier of the corresponding `reversed` transfer event.
pub event_id: i64,
///The value of the returned transfer.
pub amount: String,
///The currency of the repayment, e.g. "USD".
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: APIClientID,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: APISecret,
///The Plaid `account_id` for the account that will be debited or credited.
pub account_id: Option<String>,
/**The direction of the flow of transfer funds.
- `PAYMENT` – Transfers funds from an end user's account to your business account.
- `DISBURSEMENT` – Transfers funds from your business account to an end user's account.*/
pub mode: TransferIntentCreateMode,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
///A description for the underlying transfer. Maximum of 8 characters.
pub description: String,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.
pub origination_account_id: Option<String>,
///The legal name and other information for the account holder.
pub user: TransferUserInRequest,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: TransferMetadata,
///The currency of the transfer amount, e.g. "USD"
pub iso_currency_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentCreate {
///Plaid's unique identifier for the transfer intent object.
pub id: String,
///The datetime the transfer was created. This will be of the form `2006-01-02T15:04:05Z`.
pub created: String,
/**The status of the transfer intent.
- `PENDING` – The transfer intent is pending.
- `SUCCEEDED` – The transfer intent was successfully created.
- `FAILED` – The transfer intent was unable to be created.*/
pub status: String,
///The Plaid `account_id` for the account that will be debited or credited. Returned only if `account_id` was set on intent creation.
pub account_id: Option<String>,
///Plaid’s unique identifier for the origination account for the intent. If not provided, the default account will be used.
pub origination_account_id: String,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
/**The direction of the flow of transfer funds.
- `PAYMENT` – Transfers funds from an end user's account to your business account.
- `DISBURSEMENT` – Transfers funds from your business account to an end user's account.*/
pub mode: TransferIntentCreateMode,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The legal name and other information for the account holder.
pub user: TransferUserInResponse,
///A description for the underlying transfer. Maximum of 8 characters.
pub description: String,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: TransferMetadata,
///The currency of the transfer amount, e.g. "USD"
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentCreateResponse {
///Represents a transfer intent within Transfer UI.
pub transfer_intent: TransferIntentCreate,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: APIClientID,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: APISecret,
///Plaid's unique identifier for a transfer intent object.
pub transfer_intent_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentGet {
///Plaid's unique identifier for a transfer intent object.
pub id: String,
///The datetime the transfer was created. This will be of the form `2006-01-02T15:04:05Z`.
pub created: String,
/**The status of the transfer intent.
- `PENDING` – The transfer intent is pending.
- `SUCCEEDED` – The transfer intent was successfully created.
- `FAILED` – The transfer intent was unable to be created.*/
pub status: String,
///Plaid's unique identifier for the transfer created through the UI. Returned only if the transfer was successfully created. Null value otherwise.
pub transfer_id: Option<String>,
///The reason for a failed transfer intent. Returned only if the transfer intent status is `failed`. Null otherwise.
pub failure_reason: TransferIntentGetFailureReason,
/**
A decision regarding the proposed transfer.
`APPROVED` – The proposed transfer has received the end user's consent and has been approved for processing. Plaid has also reviewed the proposed transfer and has approved it for processing.
`PERMITTED` – Plaid was unable to fetch the information required to approve or decline the proposed transfer. You may proceed with the transfer, but further review is recommended. Plaid is awaiting further instructions from the client.
`DECLINED` – Plaid reviewed the proposed transfer and declined processing. Refer to the `code` field in the `decision_rationale` object for details. Null value otherwise.*/
pub authorization_decision: Option<String>,
///The rationale for Plaid's decision regarding a proposed transfer. Will be null for `approved` decisions.
pub authorization_decision_rationale: TransferAuthorizationDecisionRationale,
///The Plaid `account_id` for the account that will be debited or credited. Returned only if `account_id` was set on intent creation.
pub account_id: Option<String>,
///Plaid’s unique identifier for the origination account used for the transfer.
pub origination_account_id: String,
///The amount of the transfer (decimal string with two digits of precision e.g. "10.00").
pub amount: TransferAmount,
/**The direction of the flow of transfer funds.
- `PAYMENT` – Transfers funds from an end user's account to your business account.
- `DISBURSEMENT` – Transfers funds from your business account to an end user's account.*/
pub mode: TransferIntentCreateMode,
/**Specifies the use case of the transfer. Required for transfers on an ACH network. In Sandbox, only `ccd`, `ppd`, or `web` can be used.
`"arc"` - Accounts Receivable Entry
`"cbr`" - Cross Border Entry
`"ccd"` - Corporate Credit or Debit - fund transfer between two corporate bank accounts
`"cie"` - Customer Initiated Entry
`"cor"` - Automated Notification of Change
`"ctx"` - Corporate Trade Exchange
`"iat"` - International
`"mte"` - Machine Transfer Entry
`"pbr"` - Cross Border Entry
`"pop"` - Point-of-Purchase Entry
`"pos"` - Point-of-Sale Entry
`"ppd"` - Prearranged Payment or Deposit - the transfer is part of a pre-existing relationship with a consumer, eg. bill payment
`"rck"` - Re-presented Check Entry
`"tel"` - Telephone-Initiated Entry
`"web"` - Internet-Initiated Entry - debits from a consumer’s account where their authorization is obtained over the Internet*/
pub ach_class: ACHClass,
///The legal name and other information for the account holder.
pub user: TransferUserInResponse,
///A description for the underlying transfer. Maximum of 8 characters.
pub description: String,
/**The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:
- The JSON values must be Strings (no nested JSON objects allowed)
- Only ASCII characters may be used
- Maximum of 50 key/value pairs
- Maximum key length of 40 characters
- Maximum value length of 500 characters
*/
pub metadata: TransferMetadata,
///The currency of the transfer amount, e.g. "USD"
pub iso_currency_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransferIntentGetResponse {
///Represents a transfer intent within Transfer UI.
pub transfer_intent: TransferIntentGet,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxBankTransferSimulateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a bank transfer.
pub bank_transfer_id: BankTransferID,
/**The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`.
An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:
`pending` --> `failed`
`pending` --> `posted`
`posted` --> `reversed`
*/
pub event_type: String,
///The failure reason if the type of this transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: BankTransferFailure,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferSimulateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Plaid’s unique identifier for a transfer.
pub transfer_id: TransferID,
/**The asynchronous event to be simulated. May be: `posted`, `failed`, or `reversed`.
An error will be returned if the event type is incompatible with the current transfer status. Compatible status --> event type transitions include:
`pending` --> `failed`
`pending` --> `posted`
`posted` --> `reversed`
*/
pub event_type: String,
///The failure reason if the event type for a transfer is `"failed"` or `"reversed"`. Null value otherwise.
pub failure_reason: TransferFailure,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferSweepSimulateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxBankTransferSimulateResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferSimulateResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferSweepSimulateResponse {
/**A sweep returned from the `/sandbox/transfer/sweep/simulate` endpoint.
Can be null if there are no transfers to include in a sweep.*/
pub sweep: Option<SimulatedTransferSweep>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferRepaymentSimulateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxTransferRepaymentSimulateResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountFiltersResponse {
///A filter to apply to `depository`-type accounts
pub depository: Option<DepositoryFilter>,
///A filter to apply to `credit`-type accounts
pub credit: Option<CreditFilter>,
///A filter to apply to `loan`-type accounts
pub loan: Option<LoanFilter>,
///A filter to apply to `investment`-type accounts (or `brokerage`-type acconunts for API versions 2018-05-22 and earlier).
pub investment: Option<InvestmentFilter>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InstitutionsSearchAccountFilter {
///
pub loan: Option<Vec<AccountSubtype>>,
///
pub depository: Option<Vec<AccountSubtype>>,
///
pub credit: Option<Vec<AccountSubtype>>,
///
pub investment: Option<Vec<AccountSubtype>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountIdentity(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountAssets(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositoryFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: DepositoryAccountSubtypes,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct CreditFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: CreditAccountSubtypes,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct LoanFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: LoanAccountSubtypes,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentFilter {
///An array of account subtypes to display in Link. If not specified, all account subtypes will be shown. For a full list of valid types and subtypes, see the [Account schema](https://plaid.com/docs/api/accounts#account-type-schema).
pub account_subtypes: InvestmentAccountSubtypes,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositoryAccountSubtypes(pub Vec<DepositoryAccountSubtype>);
#[derive(Debug, Serialize, Deserialize)]
pub struct CreditAccountSubtypes(pub Vec<CreditAccountSubtype>);
#[derive(Debug, Serialize, Deserialize)]
pub struct LoanAccountSubtypes(pub Vec<LoanAccountSubtype>);
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentAccountSubtypes(pub Vec<InvestmentAccountSubtype>);
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositoryAccountSubtype(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct CreditAccountSubtype(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct LoanAccountSubtype(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct InvestmentAccountSubtype(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct EmployersSearchRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The employer name to be searched for.
pub query: String,
///The Plaid products the returned employers should support. Currently, this field must be set to `"deposit_switch"`.
pub products: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmployersSearchResponse {
///A list of employers matching the search criteria.
pub employers: Vec<Employer>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Employer {
///Plaid's unique identifier for the employer.
pub employer_id: String,
///The name of the employer
pub name: String,
///Data about the components comprising an address.
pub address: AddressDataNullable,
///A number from 0 to 1 indicating Plaid's level of confidence in the pairing between the employer and the institution (not yet implemented).
pub confidence_score: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.
pub webhook: String,
///The ID of a precheck created with `/income/verification/precheck`. Will be used to improve conversion of the income verification flow.
pub precheck_id: Option<String>,
///Optional arguments for `/income/verification/create`
pub options: Option<IncomeVerificationCreateRequestOptions>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationCreateRequestOptions {
///An array of access tokens corresponding to the Items that will be cross-referenced with the product data. Plaid will attempt to correlate transaction history from these Items with data from the user's paystub, such as date and amount. The `verification` status of the paystub as returned by `/income/verification/paystubs/get` will indicate if the verification status was successful, or, if not, why it failed. If the `transactions` product was not initialized for the Items during Link, it will be initialized after this Link session.
pub access_tokens: Option<Vec<AccessToken>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationCreateResponse {
///ID of the verification. This ID is persisted throughout the lifetime of the verification.
pub income_verification_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Information about the user whose eligibility is being evaluated.
pub user: IncomeVerificationPrecheckUser,
///Information about the end user's employer
pub employer: IncomeVerificationPrecheckEmployer,
///
pub transactions_access_token: Option<serde_json::Value>,
///An array of access tokens corresponding to Items belonging to the user whose eligibility is being checked. Note that if the Items specified here are not already initialized with `transactions`, providing them in this field will cause these Items to be initialized with (and billed for) the Transactions product.
pub transactions_access_tokens: Option<Vec<AccessToken>>,
///Data about military info in the income verification precheck.
pub us_military_info: IncomeVerificationPrecheckMilitaryInfo,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckEmployer {
///The employer's name
pub name: Option<String>,
///The address of the employer
pub address: IncomeVerificationPrecheckEmployerAddress,
///The employer's tax id
pub tax_id: Option<String>,
///The URL for the employer's public website
pub url: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckEmployerAddress {}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckEmployerAddressData {
///The full city name
pub city: Option<String>,
/**The region or state. In API versions 2018-05-22 and earlier, this field is called `state`.
Example: `"NC"`*/
pub region: Option<String>,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: Option<String>,
///The postal code. In API versions 2018-05-22 and earlier, this field is called `zip`.
pub postal_code: Option<String>,
///The ISO 3166-1 alpha-2 country code
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckMilitaryInfo {
///Is the user currently active duty in the US military
pub is_active_duty: Option<bool>,
///If the user is currently serving in the US military, the branch of the military they are serving in
pub branch: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckUser {
///The user's first name
pub first_name: Option<String>,
///The user's last name
pub last_name: Option<String>,
///The user's email address
pub email_address: Option<String>,
///Data about the components comprising an address.
pub home_address: SignalAddressData,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckResponse {
///ID of the precheck. Provide this value when calling `/link/token/create` in order to optimize Link conversion.
pub precheck_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
/**The confidence that Plaid can support the user in the digital income verification flow instead of requiring a manual paystub upload. One of the following:
`"HIGH"`: It is very likely that this user can use the digital income verification flow.
"`LOW`": It is unlikely that this user can use the digital income verification flow.
`"UNKNOWN"`: It was not possible to determine if the user is supportable with the information passed.*/
pub confidence: IncomeVerificationPrecheckConfidence,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPrecheckConfidence(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct LinkTokenCreateRequestIncomeVerification {
///The `income_verification_id` of the verification instance, as provided by `/income/verification/create`.
pub income_verification_id: Option<String>,
///The `asset_report_id` of an asset report associated with the user, as provided by `/asset_report/create`. Providing an `asset_report_id` is optional and can be used to verify the user through a streamlined flow. If provided, the bank linking flow will be skipped.
pub asset_report_id: Option<String>,
///The ID of a precheck created with `/income/verification/precheck`. Will be used to improve conversion of the income verification flow by streamlining the Link interface presented to the end user.
pub precheck_id: Option<String>,
///An array of access tokens corresponding to the Items that will be cross-referenced with the product data. If the `transactions` product was not initialized for the Items during link, it will be initialized after this Link session.
pub access_tokens: Option<Vec<AccessToken>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationStatusWebhook {
///`"INCOME"`
pub webhook_type: String,
///`income_verification`
pub webhook_code: String,
///The `income_verification_id` of the verification instance whose status is being reported.
pub income_verification_id: String,
///The Item ID associated with the verification.
pub item_id: String,
/**`VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/income/verification/paystubs/get` endpoint and check the document metadata to see which documents were successfully parsed.
`VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.
`VERIFICATION_STATUS_PENDING_APPROVAL`: The income verification has been sent to the user for review.*/
pub verification_status: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationSummaryGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationSummaryGetResponse {
///A list of income summaries.
pub income_summaries: Vec<IncomeSummary>,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationRefreshRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationRefreshResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
/**The verification refresh status. One of the following:
`"VERIFICATION_REFRESH_STATUS_USER_PRESENCE_REQUIRED"` User presence is required to refresh an income verification.
`"VERIFICATION_REFRESH_SUCCESSFUL"` The income verification refresh was successful.
`"VERIFICATION_REFRESH_NOT_FOUND"` No new data was found after the income verification refresh.*/
pub verification_refresh_status: VerificationRefreshStatus,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeSummary {
///The name of the employer, as reported on the paystub.
pub employer_name: EmployerIncomeSummaryFieldString,
///The name of the employee, as reported on the paystub.
pub employee_name: EmployeeIncomeSummaryFieldString,
///Year-to-date pre-tax earnings, as reported on the paystub.
pub ytd_gross_income: YTDGrossIncomeSummaryFieldNumber,
///Year-to-date earnings after any tax withholdings, benefit payments or deductions, as reported on the paystub.
pub ytd_net_income: YTDNetIncomeSummaryFieldNumber,
///The frequency of the pay period.
pub pay_frequency: PayFrequency,
///The employee's estimated annual salary, as derived from information reported on the paystub.
pub projected_wage: ProjectedIncomeSummaryFieldNumber,
///Information about the matched direct deposit transaction used to verify a user's payroll information.
pub verified_transaction: TransactionData,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TransactionData {
///The description of the transaction.
pub description: String,
///The amount of the transaction.
pub amount: f64,
///The date of the transaction, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
pub date: String,
///A unique identifier for the end user's account.
pub account_id: String,
///A unique identifier for the transaction.
pub transaction_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeSummaryFieldString {
///The value of the field.
pub value: String,
/**The verification status. One of the following:
`"VERIFIED"`: The information was successfully verified.
`"UNVERIFIED"`: The verification has not yet been performed.
`"NEEDS_INFO"`: The verification was attempted but could not be completed due to missing information.
"`UNABLE_TO_VERIFY`": The verification was performed and the information could not be verified.
`"UNKNOWN"`: The verification status is unknown.*/
pub verification_status: VerificationStatus,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmployerIncomeSummaryFieldString(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct EmployeeIncomeSummaryFieldString(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeSummaryFieldNumber {
///The value of the field.
pub value: f64,
/**The verification status. One of the following:
`"VERIFIED"`: The information was successfully verified.
`"UNVERIFIED"`: The verification has not yet been performed.
`"NEEDS_INFO"`: The verification was attempted but could not be completed due to missing information.
"`UNABLE_TO_VERIFY`": The verification was performed and the information could not be verified.
`"UNKNOWN"`: The verification status is unknown.*/
pub verification_status: VerificationStatus,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct YTDGrossIncomeSummaryFieldNumber(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct YTDNetIncomeSummaryFieldNumber(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct ProjectedIncomeSummaryFieldNumber(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct PayFrequency {
///The frequency of the pay period.
pub value: PayFrequencyValue,
/**The verification status. One of the following:
`"VERIFIED"`: The information was successfully verified.
`"UNVERIFIED"`: The verification has not yet been performed.
`"NEEDS_INFO"`: The verification was attempted but could not be completed due to missing information.
"`UNABLE_TO_VERIFY`": The verification was performed and the information could not be verified.
`"UNKNOWN"`: The verification status is unknown.*/
pub verification_status: VerificationStatus,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PayFrequencyValue(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct VerificationStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct VerificationRefreshStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPaystubGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification for which to get paystub information.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPaystubGetResponse {
///An object representing data extracted from the end user's paystub.
pub paystub: Paystub,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPaystubsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification for which to get paystub information.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationPaystubsGetResponse {
///Metadata for an income document.
pub document_metadata: Option<Vec<DocumentMetadata>>,
///
pub paystubs: Vec<Paystub>,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DocumentMetadata {
///The name of the document.
pub name: Option<String>,
///The processing status of the document.
pub status: Option<String>,
///An identifier of the document that is also present in the paystub response.
pub doc_id: Option<String>,
/**The type of document.
`DOCUMENT_TYPE_PAYSTUB`: A paystub.
`DOCUMENT_TYPE_BANK_STATEMENT`: A bank statement.
`DOCUMENT_TYPE_US_TAX_W2`: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee.
`DOCUMENT_TYPE_US_MILITARY_ERAS`: An electronic Retirement Account Statement (eRAS) issued by the US military.
`DOCUMENT_TYPE_US_MILITARY_LES`: A Leave and Earnings Statement (LES) issued by the US military.
`DOCUMENT_TYPE_US_MILITARY_CLES`: A Civilian Leave and Earnings Statment (CLES) issued by the US military.
`DOCUMENT_TYPE_GIG`: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type.
`DOCUMENT_TYPE_NONE`: Used to indicate that there is no underlying document for the data.
`UNKNOWN`: Document type could not be determined.*/
pub doc_type: Option<DocType>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DocType(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct Paystub {
///An object with the deduction information found on a paystub.
pub deductions: Deductions,
///An identifier of the document referenced by the document metadata.
pub doc_id: String,
///An object representing both a breakdown of earnings on a paystub and the total earnings.
pub earnings: Earnings,
///Data about the employee.
pub employee: Employee,
///Information about the employer on the paystub
pub employer: PaystubEmployer,
///An object representing employment details found on a paystub.
pub employment_details: Option<EmploymentDetails>,
///An object representing information about the net pay amount on the paystub.
pub net_pay: NetPay,
///Details about the pay period.
pub pay_period_details: PayPeriodDetails,
///An object representing details that can be found on the paystub.
pub paystub_details: Option<PaystubDetails>,
///
pub income_breakdown: Option<Vec<IncomeBreakdown>>,
///The amount of income earned year to date, as based on paystub data.
pub ytd_earnings: Option<PaystubYTDDetails>,
///An object containing details on the paystub's verification status. This object will only be populated if the [`income_verification.access_tokens`](/docs/api/tokens/#link-token-create-request-income-verification-access-tokens) parameter was provided during the `/link/token/create` call or if a problem was detected with the information supplied by the user; otherwise it will be `null`.
pub verification: PaystubVerification,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Deductions {
///
pub subtotals: Option<Vec<Total>>,
///
pub breakdown: Vec<DeductionsBreakdown>,
///
pub totals: Option<Vec<Total>>,
///An object representing the total deductions for the pay period
pub total: DeductionsTotal,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DeductionsBreakdown {
///Raw amount of the deduction
pub current_amount: Option<f64>,
///Description of the deduction line item
pub description: Option<String>,
///The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///The year-to-date amount of the deduction
pub ytd_amount: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DeductionsTotal {
///Raw amount of the deduction
pub current_amount: Option<f64>,
///The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///The year-to-date total amount of the deductions
pub ytd_amount: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Total {
///Commonly used term to describe the line item.
pub canonical_description: TotalCanonicalDescription,
///Text of the line item as printed on the paystub.
pub description: Option<String>,
///An object representing a monetary amount.
pub current_pay: Option<Pay>,
///An object representing a monetary amount.
pub ytd_pay: Option<Pay>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TotalCanonicalDescription(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct Pay {
///A numerical amount of a specific currency.
pub amount: Option<f64>,
///Currency code, e.g. USD
pub currency: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Earnings {
///
pub subtotals: Option<Vec<EarningsTotal>>,
///
pub totals: Option<Vec<EarningsTotal>>,
///
pub breakdown: Option<Vec<EarningsBreakdown>>,
///An object representing both the current pay period and year to date amount for an earning category.
pub total: Option<EarningsTotal>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EarningsBreakdown {
///Commonly used term to describe the earning line item.
pub canonical_description: EarningsBreakdownCanonicalDescription,
///Raw amount of the earning line item.
pub current_amount: Option<f64>,
///Description of the earning line item.
pub description: Option<String>,
///Number of hours applicable for this earning.
pub hours: Option<f64>,
///The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
///Hourly rate applicable for this earning.
pub rate: Option<f64>,
/**The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///The year-to-date amount of the deduction.
pub ytd_amount: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EarningsBreakdownCanonicalDescription(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct EarningsTotal {
///Total amount of the earnings for this pay period
pub current_amount: Option<f64>,
///An object representing a monetary amount.
pub current_pay: Option<Pay>,
///An object representing a monetary amount.
pub ytd_pay: Option<Pay>,
///Total number of hours worked for this pay period
pub hours: Option<f64>,
///The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the security. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///The total year-to-date amount of the earnings
pub ytd_amount: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmploymentDetails {
///An object representing a monetary amount.
pub annual_salary: Option<Pay>,
///Date on which the employee was hired, in the YYYY-MM-DD format.
pub hire_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct NetPay {
///Raw amount of the net pay for the pay period
pub current_amount: Option<f64>,
///Description of the net pay
pub description: Option<String>,
///The ISO-4217 currency code of the net pay. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
/**The unofficial currency code associated with the net pay. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///The year-to-date amount of the net pay
pub ytd_amount: Option<f64>,
///An object representing both the current pay period and year to date amount for a category.
pub total: Option<Total>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubDetails {
///Beginning date of the pay period on the paystub in the 'YYYY-MM-DD' format.
pub pay_period_start_date: Option<String>,
///Ending date of the pay period on the paystub in the 'YYYY-MM-DD' format.
pub pay_period_end_date: Option<String>,
///Pay date on the paystub in the 'YYYY-MM-DD' format.
pub pay_date: Option<String>,
///The name of the payroll provider that generated the paystub, e.g. ADP
pub paystub_provider: Option<String>,
///The frequency at which the employee is paid. Possible values: `MONTHLY`, `BI-WEEKLY`, `WEEKLY`, `SEMI-MONTHLY`.
pub pay_frequency: PaystubPayFrequency,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubPayFrequency(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeBreakdown {
#[serde(rename = "type")]
/**The type of income. Possible values include:
`"regular"`: regular income
`"overtime"`: overtime income
`"bonus"`: bonus income*/
pub type_: IncomeBreakdownType,
///The hourly rate at which the income is paid.
pub rate: Option<f64>,
///The number of hours logged for this income for this pay period.
pub hours: Option<f64>,
///The total pay for this pay period.
pub total: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeBreakdownType(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct Employee {
///Address on the paystub
pub address: PaystubAddress,
///The name of the employee.
pub name: Option<String>,
///Marital status of the employee - either `single` or `married`.
pub marital_status: Option<String>,
///Taxpayer ID of the individual receiving the paystub.
pub taxpayer_id: Option<TaxpayerID>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct TaxpayerID {
///Type of ID, e.g. 'SSN'
pub id_type: Option<String>,
///ID mask; i.e. last 4 digits of the taxpayer ID
pub id_mask: Option<String>,
///Last 4 digits of unique number of ID.
pub last_4_digits: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubEmployer {
///Address on the paystub
pub address: Option<PaystubAddress>,
///The name of the employer on the paystub.
pub name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubAddress {
///The full city name.
pub city: Option<String>,
///The ISO 3166-1 alpha-2 country code.
pub country: Option<String>,
///The postal code of the address.
pub postal_code: Option<String>,
/**The region or state
Example: `"NC"`*/
pub region: Option<String>,
///The full street address.
pub street: Option<String>,
///Street address line 1.
pub line1: Option<String>,
///Street address line 2.
pub line2: Option<String>,
/**The region or state
Example: `"NC"`*/
pub state_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PayPeriodDetails {
///The amount of the paycheck.
pub check_amount: Option<f64>,
///
pub distribution_breakdown: Option<Vec<DistributionBreakdown>>,
///The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd".
pub end_date: Option<String>,
///Total earnings before tax/deductions.
pub gross_earnings: Option<f64>,
///The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
pub pay_date: Option<String>,
///The frequency at which an individual is paid.
pub pay_frequency: Option<String>,
///The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd").
pub pay_day: Option<String>,
///The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd".
pub start_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DistributionBreakdown {
///Name of the account for the given distribution.
pub account_name: Option<String>,
///The name of the bank that the payment is being deposited to.
pub bank_name: Option<String>,
///The amount distributed to this account.
pub current_amount: Option<f64>,
///The ISO-4217 currency code of the net pay. Always `null` if `unofficial_currency_code` is non-null.
pub iso_currency_code: Option<String>,
///The last 2-4 alphanumeric characters of an account's official account number.
pub mask: Option<String>,
#[serde(rename = "type")]
///Type of the account that the paystub was sent to (e.g. 'checking').
pub type_: Option<String>,
/**The unofficial currency code associated with the net pay. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.*/
pub unofficial_currency_code: Option<String>,
///An object representing a monetary amount.
pub current_pay: Option<Pay>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubDeduction {
#[serde(rename = "type")]
///The description of the deduction, as provided on the paystub. For example: `"401(k)"`, `"FICA MED TAX"`.
pub type_: Option<String>,
///`true` if the deduction is pre-tax; `false` otherwise.
pub is_pretax: Option<bool>,
///The amount of the deduction.
pub total: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubYTDDetails {
///Year-to-date gross earnings.
pub gross_earnings: Option<f64>,
///Year-to-date net (take home) earnings.
pub net_earnings: Option<f64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubVerification {
///Derived verification status.
pub verification_status: PaystubVerificationStatus,
///
pub verification_attributes: Vec<VerificationAttribute>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PaystubVerificationStatus(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct VerificationAttribute {
#[serde(rename = "type")]
///Message indicating the reason as to why the verification failed
pub type_: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationDocumentsDownloadRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
///The document ID to download. If passed, a single document will be returned in the resulting zip file, rather than all document
pub document_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationTaxformsGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification.
pub income_verification_id: Option<String>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationTaxformsGetResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: Option<RequestID>,
///
pub document_metadata: Vec<DocumentMetadata>,
///A list of forms.
pub taxforms: Vec<Taxform>,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct Taxform {
///An identifier of the document referenced by the document metadata.
pub doc_id: Option<String>,
///The type of tax document. Currently, the only supported value is `w2`.
pub document_type: String,
///W2 is an object that represents income data taken from a W2 tax document.
pub w2: Option<W2>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct W2 {
///Information about the employer on the paystub
pub employer: Option<PaystubEmployer>,
///Data about the employee.
pub employee: Option<Employee>,
///The tax year of the W2 document.
pub tax_year: Option<String>,
///An employee identification number or EIN.
pub employer_id_number: Option<String>,
///Wages from tips and other compensation.
pub wages_tips_other_comp: Option<String>,
///Federal income tax withheld for the tax year.
pub federal_income_tax_withheld: Option<String>,
///Wages from social security.
pub social_security_wages: Option<String>,
///Social security tax withheld for the tax year.
pub social_security_tax_withheld: Option<String>,
///Wages and tips from medicare.
pub medicare_wages_and_tips: Option<String>,
///Medicare tax withheld for the tax year.
pub medicare_tax_withheld: Option<String>,
///Tips from social security.
pub social_security_tips: Option<String>,
///Allocated tips.
pub allocated_tips: Option<String>,
///Contents from box 9 on the W2.
pub box_9: Option<String>,
///Dependent care benefits.
pub dependent_care_benefits: Option<String>,
///Nonqualified plans.
pub nonqualified_plans: Option<String>,
///
pub box_12: Option<Vec<W2Box12>>,
///Statutory employee.
pub statutory_employee: Option<String>,
///Retirement plan.
pub retirement_plan: Option<String>,
///Third party sick pay.
pub third_party_sick_pay: Option<String>,
///Other.
pub other: Option<String>,
///
pub state_and_local_wages: Option<Vec<W2StateAndLocalWages>>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct W2Box12 {
///W2 Box 12 code.
pub code: Option<String>,
///W2 Box 12 amount.
pub amount: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct W2StateAndLocalWages {
///State associated with the wage.
pub state: Option<String>,
///State identification number of the employer.
pub employer_state_id_number: Option<String>,
///Wages and tips from the specified state.
pub state_wages_tips: Option<String>,
///Income tax from the specified state.
pub state_income_tax: Option<String>,
///Wages and tips from the locality.
pub local_wages_tips: Option<String>,
///Income tax from the locality.
pub local_income_tax: Option<String>,
///Name of the locality.
pub locality_name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncomeVerificationWebhookStatus {
///
pub id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmploymentVerificationGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmploymentVerificationGetResponse {
///A list of employment verification summaries.
pub employments: Vec<EmploymentVerification>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmploymentVerification {
///Current employment status.
pub status: EmploymentVerificationStatus,
///Start of employment in ISO 8601 format (YYYY-MM-DD).
pub start_date: Option<String>,
///End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD).
pub end_date: Option<String>,
///An object containing employer data.
pub employer: Option<EmployerVerification>,
///Current title of employee.
pub title: Option<String>,
///An object containing a set of ids related to an employee
pub platform_ids: Option<PlatformIds>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct EmploymentVerificationStatus(pub Option<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct EmployerVerification {
///Name of employer.
pub name: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct PlatformIds {
///The ID of an employee as given by their employer
pub employee_id: Option<String>,
///The ID of an employee as given by their payroll
pub payroll_id: Option<String>,
///The ID of the position of the employee
pub position_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AssetReportTransaction(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct HealthIncident {
///The start date of the incident, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `"2020-10-30T15:26:48Z"`.
pub start_date: String,
///The end date of the incident, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `"2020-10-30T15:26:48Z"`.
pub end_date: Option<String>,
///The title of the incident
pub title: String,
///Updates on the health incident.
pub incident_updates: Vec<IncidentUpdate>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct IncidentUpdate {
///The content of the update.
pub description: Option<String>,
///The status of the incident.
pub status: Option<String>,
///The date when the update was published, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `"2020-10-30T15:26:48Z"`.
pub updated_date: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchAltCreateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The deposit switch destination account
pub target_account: DepositSwitchTargetAccount,
///The deposit switch target user
pub target_user: DepositSwitchTargetUser,
///Options to configure the `/deposit_switch/create` request. If provided, cannot be `null`.
pub options: Option<DepositSwitchCreateRequestOptions>,
///ISO-3166-1 alpha-2 country code standard.
pub country_code: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchAltCreateResponse {
///ID of the deposit switch. This ID is persisted throughout the lifetime of the deposit switch.
pub deposit_switch_id: String,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchTargetAccount {
///Account number for deposit switch destination
pub account_number: String,
///Routing number for deposit switch destination
pub routing_number: String,
///The name of the deposit switch destination account, as it will be displayed to the end user in the Deposit Switch interface. It is not required to match the name used in online banking.
pub account_name: String,
///The account subtype of the account, either `checking` or `savings`.
pub account_subtype: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchTargetUser {
///The given name (first name) of the user.
pub given_name: String,
///The family name (last name) of the user.
pub family_name: String,
///The phone number of the user. The endpoint can accept a variety of phone number formats, including E.164.
pub phone: String,
///The email address of the user.
pub email: String,
///The user's address.
pub address: Option<DepositSwitchAddressData>,
///The taxpayer ID of the user, generally their SSN, EIN, or TIN.
pub tax_payer_id: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct DepositSwitchAddressData {
///The full city name
pub city: String,
/**The region or state
Example: `"NC"`*/
pub region: String,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: String,
///The postal code
pub postal_code: String,
///The ISO 3166-1 alpha-2 country code
pub country: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxBankTransferFireWebhookRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The URL to which the webhook should be sent.
pub webhook: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxBankTransferFireWebhookResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ApplicationID(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct Application {
///This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.
pub application_id: ApplicationID,
///The name of the application
pub name: String,
///The date this application was linked in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.
pub created_at: Option<String>,
///The date this application was granted production access at Plaid in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.
pub join_date: String,
///A URL that links to the application logo image.
pub logo_url: Option<String>,
///The URL for the application's website
pub application_url: Option<String>,
///A string provided by the connected app stating why they use their respective enabled products.
pub reason_for_access: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ApplicationGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: APIClientID,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: APISecret,
///This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.
pub application_id: ApplicationID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ApplicationGetResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
///Metadata about the application
pub application: Application,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ProductAccess {
///Allow access to statements. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub statements: Option<bool>,
///Allow access to the Identity product (name, email, phone, address). Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub identity: Option<bool>,
///Allow access to account number details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub auth: Option<bool>,
///Allow access to transaction details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub transactions: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountAccess {
///The unique account identifier for this account. This value must match that returned by the data access API for this account.
pub unique_id: String,
///Allow the application to see this account (and associated details, including balance) in the list of accounts If unset, defaults to `true`.
pub authorized: Option<bool>,
///Allow the application to access specific products on this account
pub account_product_access: AccountProductAccessNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountProductAccessNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountProductAccess {
///Allow the application to access account data. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub account_data: Option<bool>,
///Allow the application to access bank statements. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub statements: Option<bool>,
///Allow the application to access tax documents. Only used by certain partners. If relevant to the partner and unset, defaults to `true`.
pub tax_documents: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ScopesNullable(pub Option<serde_json::Value>);
#[derive(Debug, Serialize, Deserialize)]
pub struct Scopes {
///The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed.
pub product_access: Option<ProductAccess>,
///
pub accounts: Option<Vec<AccountAccess>>,
///Allow access to newly opened accounts as they are opened. If unset, defaults to `true`.
pub new_accounts: Option<bool>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct RequestedScopes {
///Enumerates the account subtypes that the application wishes for the user to be able to select from. For more details refer to Plaid documentation on account filters.
pub account_filters: Option<AccountFilter>,
/**The application requires that accounts be limited to a specific cardinality.
`MULTI_SELECT`: indicates that the user should be allowed to pick multiple accounts.
`SINGLE_SELECT`: indicates that the user should be allowed to pick only a single account.
`ALL`: indicates that the user must share all of their accounts and should not be given the opportunity to de-select*/
pub account_selection_cardinality: AccountSelectionCardinality,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ScopesState(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct ScopesContext(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemApplicationScopesUpdateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.
pub application_id: ApplicationID,
///The scopes object
pub scopes: Scopes,
///When scopes are updated during enrollment, this field must be populated with the state sent to the partner in the OAuth Login URI. This field is required when the context is `ENROLLMENT`.
pub state: Option<ScopesState>,
///An indicator for when scopes are being updated. When scopes are updated via enrollment (i.e. OAuth), the partner must send `ENROLLMENT`. When scopes are updated in a post-enrollment view, the partner must send `PORTAL`.
pub context: ScopesContext,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemApplicationScopesUpdateResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemApplicationListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessTokenNullable,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemApplicationListResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: Option<RequestID>,
///A list of connected applications.
pub applications: Vec<ConnectedApplication>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ConnectedApplication {
///This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect.
pub application_id: ApplicationID,
///The name of the application
pub name: String,
///A URL that links to the application logo image (will be deprecated in the future, please use logo_url).
pub logo: Option<String>,
///A URL that links to the application logo image.
pub logo_url: Option<String>,
///The URL for the application's website
pub application_url: Option<String>,
///A string provided by the connected app stating why they use their respective enabled products.
pub reason_for_access: Option<String>,
///The date this application was linked in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.
pub created_at: String,
///The date this application was granted production access at Plaid in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format in UTC.
pub join_date: String,
///(Deprecated) A list of enums representing the data collected and products enabled for this connected application.
pub product_data_types: Vec<String>,
///The scopes object
pub scopes: ScopesNullable,
///Scope of required and optional account features or content from a ConnectedApplication.
pub requested_scopes: Option<RequestedScopes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountSelectionCardinality(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountFilter {
///A list of account subtypes to be filtered.
pub depository: Option<AccountFilterSubtypes>,
///A list of account subtypes to be filtered.
pub credit: Option<AccountFilterSubtypes>,
///A list of account subtypes to be filtered.
pub loan: Option<AccountFilterSubtypes>,
///A list of account subtypes to be filtered.
pub investment: Option<AccountFilterSubtypes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct AccountFilterSubtypes(pub Vec<String>);
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxIncomeFireWebhookRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the verification.
pub income_verification_id: String,
///The Item ID associated with the verification.
pub item_id: String,
///The URL to which the webhook should be sent.
pub webhook: String,
/**`VERIFICATION_STATUS_PROCESSING_COMPLETE`: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the `/income/verification/paystubs/get` endpoint and check the document metadata to see which documents were successfully parsed.
`VERIFICATION_STATUS_PROCESSING_FAILED`: A failure occurred when attempting to process the verification documentation.
`VERIFICATION_STATUS_PENDING_APPROVAL`: The income verification has been sent to the user for review.*/
pub verification_status: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxIncomeFireWebhookResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct ItemApplicationListUserAuth {
///Account username.
pub user_id: Option<String>,
///Account username hashed by FI.
pub fi_username_hash: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalEvaluateRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The access token associated with the Item data is being requested for.
pub access_token: AccessToken,
///The `account_id` of the account whose verification status is to be modified
pub account_id: String,
///The unique ID that you would like to use to refer to this transaction. For your convenience mapping your internal data, you could use your internal ID/identifier for this transaction. The max length for this field is 36 characters.
pub client_transaction_id: String,
///The transaction amount, in USD (e.g. `102.05`)
pub amount: f64,
///`true` if the end user is present while initiating the ACH transfer and the endpoint is being called; `false` otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).
pub user_present: Option<bool>,
///A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple Items. The max length for this field is 36 characters.
pub client_user_id: Option<String>,
///Details about the end user initiating the transaction (i.e., the account holder).
pub user: Option<SignalUser>,
///Details about the end user's device
pub device: Option<SignalDevice>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalUser {
///The user's legal name
pub name: SignalPersonName,
///The user's phone number, in E.164 format: +{countrycode}{number}. For example: "+14151234567"
pub phone_number: Option<String>,
///The user's email address.
pub email_address: Option<String>,
///Data about the components comprising an address.
pub address: SignalAddressData,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalPersonName {
///The user's name prefix (e.g. "Mr.")
pub prefix: Option<String>,
///The user's given name. If the user has a one-word name, it should be provided in this field.
pub given_name: Option<String>,
///The user's middle name
pub middle_name: Option<String>,
///The user's family name / surname
pub family_name: Option<String>,
///The user's name suffix (e.g. "II")
pub suffix: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalAddressData {
///The full city name
pub city: Option<String>,
/**The region or state
Example: `"NC"`*/
pub region: Option<String>,
/**The full street address
Example: `"564 Main Street, APT 15"`*/
pub street: Option<String>,
///The postal code
pub postal_code: Option<String>,
///The ISO 3166-1 alpha-2 country code
pub country: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalDevice {
///The IP address of the device that initiated the transaction
pub ip_address: Option<String>,
///The user agent of the device that initiated the transaction (e.g. "Mozilla/5.0")
pub user_agent: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalEvaluateResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
///Risk scoring details broken down by risk category.
pub scores: SignalScores,
/**The core attributes object contains additional data that can be used to assess the ACH return risk. Examples of data include:
`days_since_first_plaid_connection`: The number of days since the first time the Item was connected to an application via Plaid
`plaid_connections_count_7d`: The number of times the Item has been connected to applications via Plaid over the past 7 days
`plaid_connections_count_30d`: The number of times the Item has been connected to applications via Plaid over the past 30 days
`total_plaid_connections_count`: The number of times the Item has been connected to applications via Plaid
`is_savings_or_money_market_account`: Indicates whether the ACH transaction funding account is a savings/money market account
For the full list and detailed documentation of core attributes available, or to request that core attributes not be returned, contact Sales or your Plaid account manager*/
pub core_attributes: Option<SignalEvaluateCoreAttributes>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalScores {
///The object contains a risk score and a risk tier that evaluate the transaction return risk of an unauthorized debit. Common return codes in this category include: "R05", "R07", "R10", "R11", "R29". These returns typically have a return time frame of up to 60 calendar days. During this period, the customer of financial institutions can dispute a transaction as unauthorized.
pub customer_initiated_return_risk: Option<CustomerInitiatedReturnRisk>,
///The object contains a risk score and a risk tier that evaluate the transaction return risk because an account is overdrawn or because an ineligible account is used. Common return codes in this category include: "R01", "R02", "R03", "R04", "R06", "R08", "R09", "R13", "R16", "R17", "R20", "R23". These returns have a turnaround time of 2 banking days.
pub bank_initiated_return_risk: Option<BankInitiatedReturnRisk>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalScore(pub i64);
#[derive(Debug, Serialize, Deserialize)]
pub struct CustomerInitiatedRiskTier(pub i64);
#[derive(Debug, Serialize, Deserialize)]
pub struct CustomerInitiatedReturnRisk {
///A score from 0-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
pub score: SignalScore,
/**A tier corresponding to the projected likelihood that the transaction, if initiated, will be subject to a return.
In the `customer_initiated_return_risk` object, there are five risk tiers corresponding to the scores:
1: Predicted customer-initiated return incidence rate between 0.00% - 0.02%
2: Predicted customer-initiated return incidence rate between 0.02% - 0.05%
3: Predicted customer-initiated return incidence rate between 0.05% - 0.1%
4: Predicted customer-initiated return incidence rate between 0.1% - 0.5%
5: Predicted customer-initiated return incidence rate greater than 0.5%
*/
pub risk_tier: CustomerInitiatedRiskTier,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct BankInitiatedRiskTier(pub i64);
#[derive(Debug, Serialize, Deserialize)]
pub struct BankInitiatedReturnRisk {
///A score from 0-99 that indicates the transaction return risk: a higher risk score suggests a higher return likelihood.
pub score: SignalScore,
/**In the `bank_initiated_return_risk` object, there are eight risk tiers corresponding to the scores:
1: Predicted bank-initiated return incidence rate between 0.0% - 0.5%
2: Predicted bank-initiated return incidence rate between 0.5% - 1.5%
3: Predicted bank-initiated return incidence rate between 1.5% - 3%
4: Predicted bank-initiated return incidence rate between 3% - 5%
5: Predicted bank-initiated return incidence rate between 5% - 10%
6: Predicted bank-initiated return incidence rate between 10% - 15%
7: Predicted bank-initiated return incidence rate between 15% and 50%
8: Predicted bank-initiated return incidence rate greater than 50%
*/
pub risk_tier: BankInitiatedRiskTier,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalEvaluateCoreAttributes {
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 7 days from the account that will be debited.
pub unauthorized_transactions_count_7d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 30 days from the account that will be debited.
pub unauthorized_transactions_count_30d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 60 days from the account that will be debited.
pub unauthorized_transactions_count_60d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to unauthorized transactions over the past 90 days from the account that will be debited.
pub unauthorized_transactions_count_90d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 7 days from the account that will be debited.
pub nsf_overdraft_transactions_count_7d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 30 days from the account that will be debited.
pub nsf_overdraft_transactions_count_30d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 60 days from the account that will be debited.
pub nsf_overdraft_transactions_count_60d: Option<i64>,
///We parse and analyze historical transaction metadata to identify the number of possible past returns due to non-sufficient funds/overdrafts over the past 90 days from the account that will be debited.
pub nsf_overdraft_transactions_count_90d: Option<i64>,
///The number of days since the first time the Item was connected to an application via Plaid
pub days_since_first_plaid_connection: Option<i64>,
///The number of times the Item has been connected to applications via Plaid over the past 7 days
pub plaid_connections_count_7d: Option<i64>,
///The number of times the Item has been connected to applications via Plaid over the past 30 days
pub plaid_connections_count_30d: Option<i64>,
///The total number of times the Item has been connected to applications via Plaid
pub total_plaid_connections_count: Option<i64>,
///Indicates if the ACH transaction funding account is a savings/money market account
pub is_savings_or_money_market_account: Option<bool>,
///The total credit (inflow) transaction amount over the past 10 days from the account that will be debited
pub total_credit_transactions_amount_10d: Option<f64>,
///The total debit (outflow) transaction amount over the past 10 days from the account that will be debited
pub total_debit_transactions_amount_10d: Option<f64>,
///The 50th percentile of all credit (inflow) transaction amounts over the past 28 days from the account that will be debited
pub p50_credit_transactions_amount_28d: Option<f64>,
///The 50th percentile of all debit (outflow) transaction amounts over the past 28 days from the account that will be debited
pub p50_debit_transactions_amount_28d: Option<f64>,
///The 95th percentile of all credit (inflow) transaction amounts over the past 28 days from the account that will be debited
pub p95_credit_transactions_amount_28d: Option<f64>,
///The 95th percentile of all debit (outflow) transaction amounts over the past 28 days from the account that will be debited
pub p95_debit_transactions_amount_28d: Option<f64>,
///The number of days within the past 90 days when the account that will be debited had a negative end-of-day available balance
pub days_with_negative_balance_count_90d: Option<i64>,
///The 90th percentile of the end-of-day available balance over the past 30 days of the account that will be debited
pub p90_eod_balance_30d: Option<f64>,
///The 90th percentile of the end-of-day available balance over the past 60 days of the account that will be debited
pub p90_eod_balance_60d: Option<f64>,
///The 90th percentile of the end-of-day available balance over the past 90 days of the account that will be debited
pub p90_eod_balance_90d: Option<f64>,
///The 10th percentile of the end-of-day available balance over the past 30 days of the account that will be debited
pub p10_eod_balance_30d: Option<f64>,
///The 10th percentile of the end-of-day available balance over the past 60 days of the account that will be debited
pub p10_eod_balance_60d: Option<f64>,
///The 10th percentile of the end-of-day available balance over the past 90 days of the account that will be debited
pub p10_eod_balance_90d: Option<f64>,
///Available balance, as of the `balance_last_updated` time. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.
pub available_balance: Option<f64>,
///Current balance, as of the `balance_last_updated` time. The current balance is the total amount of funds in the account.
pub current_balance: Option<f64>,
///Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DDTHH:mm:ssZ) indicating the last time that the balance for the given account has been updated.
pub balance_last_updated: Option<String>,
///The number of times the account's phone numbers on file have changed over the past 28 days
pub phone_change_count_28d: Option<i64>,
///The number of times the account's phone numbers on file have changed over the past 90 days
pub phone_change_count_90d: Option<i64>,
///The number of times the account's email addresses on file have changed over the past 28 days
pub email_change_count_28d: Option<i64>,
///The number of times the account's email addresses on file have changed over the past 90 days
pub email_change_count_90d: Option<i64>,
///The number of times the account's addresses on file have changed over the past 28 days
pub address_change_count_28d: Option<i64>,
///The number of times the account's addresses on file have changed over the past 90 days
pub address_change_count_90d: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalDecisionReportRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Must be the same as the `client_transaction_id` supplied when calling `/signal/evaluate`
pub client_transaction_id: String,
///`true` if the ACH transaction was initiated, `false` otherwise.
pub initiated: bool,
///The actual number of days (hold time) since the ACH debit transaction that you wait before making funds available to your customers. The holding time could affect the ACH return rate. For example, use 0 if you make funds available to your customers instantly or the same day following the debit transaction, or 1 if you make funds available the next day following the debit initialization.
pub days_funds_on_hold: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalDecisionReportResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalReturnReportRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///Must be the same as the `client_transaction_id` supplied when calling `/signal/evaluate`
pub client_transaction_id: String,
///Must be a valid ACH return code (e.g. "R01")
pub return_code: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SignalReturnReportResponse {
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxOauthSelectAccountsRequest {
///
pub oauth_state_id: String,
///
pub accounts: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct SandboxOauthSelectAccountsResponse {}
#[derive(Debug, Serialize, Deserialize)]
pub struct NewAccountsAvailableWebhook {
///`ITEM`
pub webhook_type: Option<String>,
///`NEW_ACCOUNTS_AVAILABLE`
pub webhook_code: Option<String>,
///The `item_id` of the Item associated with this webhook, warning, or error
pub item_id: Option<ItemId>,
///We use standard HTTP response codes for success and failure notifications, and our errors are further classified by `error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. Error fields will be `null` if no error has occurred.
pub error: Option<PlaidError>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletGetRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the e-wallet
pub wallet_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletGetResponse {
///A unique ID identifying the e-wallet
pub wallet_id: String,
///An object representing the e-wallet balance
pub balance: WalletBalance,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletBalance {
///The ISO-4217 currency code of the balance
pub iso_currency_code: String,
///The total amount of funds in the account
pub current: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionExecuteRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
/**A random key provided by the client, per unique wallet transaction. Maximum of 128 characters.
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. If a request to execute a wallet transaction fails due to a network connection error, then after a minimum delay of one minute, you can retry the request with the same idempotency key to guarantee that only a single wallet transaction is created. If the request was successfully processed, it will prevent any transaction that uses the same idempotency key, and was received within 24 hours of the first request, from being processed.*/
pub idempotency_key: WalletTransactionIdempotencyKey,
///The ID of the e-wallet to debit from
pub wallet_id: String,
///An object representing the e-wallet transaction's counterparty
pub counterparty: WalletTransactionCounterparty,
///The amount and currency of a transaction
pub amount: WalletTransactionAmount,
///A reference for the transaction. This must be an alphanumeric string with at most 18 characters and must not contain any special characters or spaces.
pub reference: String,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionIdempotencyKey(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionCounterparty {
///The name of the counterparty
pub name: String,
///The counterparty's bank account numbers
pub numbers: WalletTransactionCounterpartyNumbers,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionCounterpartyNumbers {
///The account number and sort code of the counterparty's account
pub bacs: WalletTransactionCounterpartyBACS,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionCounterpartyBACS(pub serde_json::Value);
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionAmount {
///The ISO-4217 currency code of the transaction. Currently, only `"GBP"` is supported.
pub iso_currency_code: String,
///The amount of the transaction. Must contain at most two digits of precision e.g. `1.23`.
pub value: f64,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionExecuteResponse {
///A unique ID identifying the transaction
pub transaction_id: String,
/**The status of the transaction.
`INITIATED`: This is the initial state of all transactions. It indicates that the transaction has been initiated and is currently being processed.
`EXECUTED`: The transaction has been successfully executed.
`FAILED`: The transaction failed to process successfully. This is a terminal status.
`BLOCKED`: The transaction has been blocked for violating compliance rules. This is a terminal status.*/
pub status: WalletTransactionStatus,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionStatus(pub String);
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionsListRequest {
///Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
pub client_id: Option<APIClientID>,
///Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
pub secret: Option<APISecret>,
///The ID of the e-wallet to fetch transactions from
pub wallet_id: String,
///A base64 value representing the latest transaction that has already been requested. Set this to `next_cursor` received from the previous `/wallet/transactions/list` request. If provided, the response will only contain transactions created before that transaction. If omitted, the response will contain transactions starting from the most recent, and in descending order by the `created_at` time.
pub cursor: Option<String>,
///The number of transactions to fetch
pub count: Option<i64>,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransactionsListResponse {
///An array of transactions of an e-wallet, associated with the given `wallet_id`
pub transactions: Vec<WalletTransaction>,
///Cursor used for fetching transactions created before the latest transaction provided in this response
pub next_cursor: Option<String>,
///A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
pub request_id: RequestID,
}
#[derive(Debug, Serialize, Deserialize)]
pub struct WalletTransaction {
///A unique ID identifying the transaction
pub transaction_id: String,
///A reference for the transaction
pub reference: String,
#[serde(rename = "type")]
///The type of of the transaction. Currently, only `"PAYOUT"` is supported.
pub type_: String,
///The amount and currency of a transaction
pub amount: WalletTransactionAmount,
///An object representing the e-wallet transaction's counterparty
pub counterparty: WalletTransactionCounterparty,
/**The status of the transaction.
`INITIATED`: This is the initial state of all transactions. It indicates that the transaction has been initiated and is currently being processed.
`EXECUTED`: The transaction has been successfully executed.
`FAILED`: The transaction failed to process successfully. This is a terminal status.
`BLOCKED`: The transaction has been blocked for violating compliance rules. This is a terminal status.*/
pub status: WalletTransactionStatus,
///Timestamp when the transaction was created, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
pub created_at: String,
}