حساب ها

برای بازیابی لیستی از حساب های مرتبط با هر مورد مرتبط ، می توان از /Accounts /Get Endpoint استفاده کرد. Plaid فقط حساب های بانکی فعال را برمی گرداند - یعنی حسابهایی که بسته نیستند و قادر به حمل مانده هستند. برای مواردی که از صفحه انتخاب حساب به روز شده عبور کرده اند ، این نقطه پایانی فقط حساب هایی را که توسط کاربر اجازه داده شده است هنگام ایجاد اولین مورد ، باز می گردد. اگر یک کاربر پس از پیوند اولیه یک حساب جدید ایجاد کند ، می توانید این رویداد را از طریق Webhook new_accounts_available ضبط کنید و سپس از حالت بروزرسانی پیوند استفاده کنید تا درخواست کنید کاربر این حساب جدید را با شما به اشتراک بگذارد. این نقطه پایانی به جای استخراج اطلاعات تازه از موسسه ، اطلاعات ذخیره شده را بازیابی می کند. در نتیجه ، تعادل برگشتی ممکن است به روز نباشد. برای اطلاعات موجودی در Time ، استفاده/حساب ها/تعادل/به جای آن. توجه داشته باشید که برخی از اطلاعات قابل برگشت است.

زمینه ها و مثال را درخواست کنید

Client_id Plaid API شما. Client_ID مورد نیاز است و ممکن است در هدر Plaid-Client-ID یا به عنوان بخشی از بدنه درخواست ارائه شود.

راز API PLAID شما. راز مورد نیاز است و ممکن است یا در هدر مخفی Plaid یا به عنوان بخشی از بدنه درخواست ارائه شود.

زمینه های پاسخ و مثال

مجموعه ای از حسابهای موسسه مالی مرتبط با آن. اگر/حساب/مانده/دریافت فراخوانده شده باشد ، هر حساب شامل اطلاعات موجودی در زمان واقعی خواهد بود.

شناسه منحصر به فرد Plaid برای حساب. این مقدار تغییر نخواهد کرد مگر اینکه PLAID نتواند حساب را با داده های برگشتی توسط موسسه مالی آشتی دهد. این ممکن است ، به عنوان مثال ، هنگامی که نام حساب تغییر می کند رخ دهد. اگر این اتفاق بیفتد یک حساب جدید به حساب اختصاص داده می شود. در صورت حذف Access_Token و همان اعتبارنامه ای که برای تولید آن از Access_Token استفاده می شود برای تولید یک دسترسی جدید_تون در تاریخ بعدی استفاده می شود ، می تواند تغییر کند. در این حالت ، Account_Id جدید با حساب قدیمی ACCOUNT_ID متفاوت خواهد بود. اگر یک حساب با یک حساب خاص به جای تغییر ناپدید شود ، احتمالاً حساب بسته می شود. حساب های بسته توسط API Plaid بازگردانده نمی شوند. مانند همه شناسه های Plaid ، Account_id حساس به مورد است.

مجموعه ای از زمینه ها که تراز یک حساب را توصیف می کند. اطلاعات تعادل ممکن است ذخیره شود مگر اینکه شیء تعادل توسط/حساب ها/تعادل/دریافت برگردانده شود.

میزان وجوه موجود برای خارج شدن از حساب ، همانطور که توسط موسسه مالی تعیین می شود. برای حسابهای نوع اعتبار ، مانده موجود به طور معمول برابر با حد کمتر از مانده فعلی است ، کمتر از هرگونه خروج در انتظار به علاوه هرگونه جریان در انتظار. برای حسابهای نوع سپرده گذاری ، مانده موجود در دسترس با تعادل فعلی کمتر از هرگونه جریان در انتظار به علاوه هرگونه جریان در انتظار است. برای حسابهای نوع سپرده گذاری ، مانده موجود شامل حد اضافه برداشت نیست. برای حساب های نوع سرمایه گذاری (یا حساب های کارگزاری برای نسخه های API 2018-05-22 و قبل از آن) ، مانده موجود ، کل پول نقد موجود برای برداشت همانطور که توسط موسسه ارائه شده است. توجه داشته باشید که همه موسسات تعادل موجود را محاسبه نمی کنند. در صورت عدم دسترسی به تعادل موجود ، Plaid مقدار موجودی موجود در NULL را بازگرداند. تراز موجود ممکن است ذخیره شود و تضمین نمی شود که در زمان واقعی به روز باشد ، مگر اینکه مقدار آن توسط/حساب ها/مانده/دریافت برگردانده شود. اگر فعلی تهی باشد ، این زمینه تضمین می شود که تهی نباشد.

مقدار کل وجوه در حساب یا بدهکار است. برای حسابهای نوع اعتبار ، یک مانده مثبت مبلغ بدهکار را نشان می دهد. مبلغ منفی نشان دهنده وام دهنده به داشتن حساب دارنده حساب است. برای حساب های نوع وام ، مانده فعلی اصلی است که وام باقی مانده است ، به جز در مورد حساب های وام دانشجویی در سالی مای (INS_116944). برای وام های دانشجویی Sallie Mae ، مانده حساب شامل اصلی و هرگونه علاقه برجسته است. برای حساب های نوع سرمایه گذاری (یا حساب های کارگزاری برای نسخه های API 2018-05-22 و قبل از آن) ، تعادل فعلی ارزش کل دارایی است که توسط موسسه ارائه شده است. توجه داشته باشید که اطلاعات تعادل ممکن است ذخیره شود مگر اینکه مقدار آن توسط/حساب ها/مانده/GET برگردانده شود. اگر مورد برای معاملات فعال باشد ، این تراز حداقل به عنوان جدیدترین به روزرسانی معامله خواهد بود. اگر به اطلاعات تعادل Realtime نیاز دارید ، از تراز موجود مطابق/حساب ها/مانده/دریافت استفاده کنید. هنگامی که توسط/Accounts/Balance/Get بازگردید ، این قسمت ممکن است تهی باشد. هنگامی که این اتفاق می افتد ، در دسترس تضمین می شود که تهی نباشد.

برای حسابهای نوع اعتبار ، این حد اعتبار را نشان می دهد. برای حسابهای نوع سپرده گذاری ، این نشان دهنده حد اضافه برداشت از قبل است ، که برای حساب های فعلی (بررسی) در اروپا رایج است. در آمریکای شمالی ، این زمینه به طور معمول فقط برای حساب های نوع اعتبار در دسترس است.

کد ارزی غیررسمی مرتبط با تعادل. اگر ISO_CURRENCY_CODE غیر تهی باشد ، همیشه تهی است. کدهای ارزی غیررسمی برای ارزهایی که کدهای ارزی رسمی ISO ندارند ، مانند ارزهای رمزنگاری شده و ارزهای برخی کشورها استفاده می شود. برای لیست کامل پشتیبانی از غیر رسمی_currency_code s ، به طرح کد ارز مراجعه کنید.

Timestamp در فرمت ISO 8601 (YYYY-MM-DDTHH: MM: SSZ) نشان می دهد آخرین باری که مانده حساب داده شده به روز شده است ، این در حال حاضر فقط هنگامی که MIN_LAST_UPDATED_DATETIME تصویب می شود هنگام تماس/حساب/حساب/تعادل برای INS_128026026(سرمایه یک).

2-4 شخصیت الفبایی شماره شماره حساب رسمی یک حساب. توجه داشته باشید که ماسک ممکن است بین حساب های یک مورد غیرقانونی باشد ، و همچنین ممکن است با ماسک ای که بانک برای کاربر نشان می دهد مطابقت نداشته باشد.

سرمایه گذاری: حساب سرمایه گذاری. در نسخه های API 2018-05-22 و قبل از آن ، این نوع به جای آن کارگزاری نامیده می شود. اعتبار: واریز کارت اعتباری: وام حساب سپرده گذاری: حساب وام دیگر: نوع حساب غیر مشخص ، برای لیست کامل انواع حساب و زیرگروه های مربوطه ، به طرح نوع حساب مراجعه کنید.

برای لیست کامل انواع حساب و زیرگروه های مربوطه ، به طرح نوع حساب مراجعه کنید.

مقادیر احتمالی: 401A ، 401K ، 403B ، 457B ، 529 ، کارگزاری ، Cash ISA ، Exchange Crypto ، حساب پس انداز آموزش ، EBT ، سالانه ثابت ، GIC ، ترتیب بازپرداخت سلامت ، HSA ، ISA ، IRA ، LIF ، بیمه زندگی ، LIRA ، LRIF ، LRIF، LRSP ، کیف پول غیر بستری ، حساب کارگزاری غیر قابل قبول ، سایر بیمه ها ، سایر بیمه ها ، سایر سالیانه ، prif ، rdsp ، resp ، rlif ، rrif ، بازنشستگی ، برنامه تقسیم سود ، بازنشستگی ، roth ، roth 401k ، rrsp ، sep ira ،IRA ساده ، SIPP ، برنامه سهام ، برنامه پس انداز پرشور ، TFSA ، Trust ، UGMA ، UTMA ، متغیر متغیر ، کارت اعتباری ، PayPal ، CD ، چک ، پس انداز ، بازار پول ، پیش پرداخت ، خودکار ، تجارت ، تجاری ، ساخت و ساز ، مصرف کننده ، خانهعدالت ، وام ، وام مسکن ، اضافه برداشت ، خط اعتبار ، دانشجویی ، مدیریت نقدی ، Keogh ، صندوق متقابل ، مکرر ، پاداش ، سپرده ایمن ، SARSEP ، حقوق و دستمزد ، NULL

وضعیت تأیید فعلی یک مورد AUTH که از طریق میکرو سپاه خودکار یا دستی آغاز می شود. فقط برای موارد auth بازگشت. در انتظار_ automatic_erification: این مورد در انتظار تأیید خودکار در انتظار_ manual_erification است: این مورد در انتظار تأیید صحت میکرو سپاه است. موارد تا زمانی که کاربر با موفقیت دو مقدار را تأیید کند ، در این حالت باقی می مانند. به طور خودکار_ور شده: این مورد با موفقیت به صورت خودکار به صورت دستی تأیید شده است: این مورد با موفقیت تأیید شده به صورت دستی تأیید شده است. کاربران ممکن است با ارسال دوباره اطلاعات خود از طریق لینک ، دوباره امتحان کنند. Verification_failed: این مورد تأیید میکرو سپرده دستی را انجام داد زیرا کاربر تمام 3 تلاش تأیید را خسته کرده است. کاربران ممکن است با ارسال دوباره اطلاعات خود از طریق لینک ، دوباره امتحان کنند.

مقادیر احتمالی: به طور خودکار_ور شده ، در انتظار_ automatic_orification ، در انتظار_ manual_erification ، دستی_وریت شده ، تأیید_کسپر ، تأیید_فیلد

شناسه مورد Plaid. مورد_ید همیشه منحصر به فرد است. پیوند دادن به همان حساب در همان موسسه دو بار منجر به دو مورد با مقادیر مختلف مورد_ ID خواهد شد. مانند همه شناسه های Plaid ، Attem_ID حساس به مورد است.

شناسه موسسه Plaid در ارتباط با مورد. زمینه برای مواردی که از طریق میکرو سپاه همان روز ایجاد شده است تهی است.

ما از کدهای پاسخ HTTP استاندارد برای اعلان های موفقیت و خرابی استفاده می کنیم و خطاهای ما بیشتر توسط error_type طبقه بندی می شوند. به طور کلی ، 200 کد HTTP با موفقیت مطابقت دارد ، کدهای 40x برای خرابی های مربوط به توسعه دهنده یا کاربر و کدهای 50x برای مسائل مربوط به Plaid است. یک مورد با یک شیء خطای غیر تهی فقط هنگام فراخوانی /مورد /دریافت وضعیت مورد ، بخشی از پاسخ API خواهد بود. در غیر این صورت ، در صورت عدم بروز خطایی ، زمینه های خطا تهی خواهند شد. اگر خطایی رخ داده باشد ، به جای آن کد خطا بازگردانده می شود.

طبقه بندی گسترده ای از خطا. ایمن برای استفاده برنامه ای.

مقادیر احتمالی: نامعتبر - نامعتبر ، نامعتبر ، نامعتبر ، invalid_input ، مؤسسه ، rate_limit_exusted ، api_error ، item_error ، asset_report_error ، recaptcha_error ، oauth ، paymed_error ، bank_transfer_error ، infinion_ereverification_ereror ، microdeposits_error ، microdeposits_ererror ، microdepositosition_ererrorification_error ،

یک نمایشگر سازگار با توسعه دهنده کد خطا. این ممکن است با گذشت زمان تغییر کند و برای استفاده برنامه ای بی خطر نیست.

بازنمایی کاربر پسند از کد خطا. اگر خطا مربوط به عمل کاربر نباشد ، تهی کنید. این ممکن است با گذشت زمان تغییر کند و برای استفاده برنامه ای بی خطر نیست.

یک شناسه منحصر به فرد که درخواست را شناسایی می کند ، برای اهداف عیب یابی استفاده می شود. این زمینه در خطاهای ارائه شده توسط Webhooks حذف می شود.

در محصول دارایی ، یک درخواست می تواند به بیش از یک مورد مربوط شود. اگر خطایی برای چنین درخواستی برگردانده شود ، در صورت وجود هرگونه شناسایی ، علل آرایه ای از خطاهای حاوی خرابی این خطاها را در سطح مورد فردی باز می گرداند. علل فقط برای Error_Type Asset_Report_error ارائه می شود. علل همچنین در داخل خطایی که در یک شیء هشدار دهنده قرار دارد ، جمع نمی شوند.

کد وضعیت HTTP مرتبط با خطا. این تنها در بدنه پاسخ بازگردانده می شود که اطلاعات خطا از طریق یک وب وب ارائه شود.

لیستی از محصولات موجود برای کالایی که هنوز به آن دسترسی پیدا نکرده اند. محتوای این آرایه با صورتحساب_پرودیست ها منحصر به فرد خواهد بود.

مقادیر احتمالی: دارایی ، نویسنده ، تعادل ، هویت ، سرمایه گذاری ، بدهی ، پرداخت_بیها ، هویت_وریزاسیون ، معاملات ، اعتبار_دتیلز ، درآمد ، درآمد_وریشن ، سپرده ، standing_orders ، انتقال ، اشتغال ، تکرار شده_ transactions

لیستی از محصولاتی که برای این کالا صورتحساب شده است. محتوای این آرایه با محصولات موجود به صورت متقابل منحصر به فرد خواهد بود. توجه داشته باشید - صورتحساب_پروود در همه محیط ها جمع می شود اما فقط درخواست های تولید صورتحساب می شود. همچنین توجه داشته باشید که محصولاتی که به جای مبنای پرداخت در هر مورد ، مانند تعادل ، به صورت پرداخت در هر صورت صورتحساب می شوند ، در اینجا ظاهر نمی شوند.

مقادیر احتمالی: دارایی ، نویسنده ، تعادل ، هویت ، سرمایه گذاری ، بدهی ، پرداخت_بیها ، هویت_وریزاسیون ، معاملات ، اعتبار_دتیلز ، درآمد ، درآمد_وریشن ، سپرده ، standing_orders ، انتقال ، اشتغال ، تکرار شده_ transactions

لیستی از محصولات مجاز برای مورد.

مقادیر احتمالی: دارایی ، نویسنده ، تعادل ، هویت ، سرمایه گذاری ، بدهی ، پرداخت_بیها ، هویت_وریزاسیون ، معاملات ، اعتبار_دتیلز ، درآمد ، درآمد_وریشن ، سپرده ، standing_orders ، انتقال ، اشتغال ، تکرار شده_ transactions

بتا: لیستی از محصولاتی که مجموعه رضایت نامه را برای این مورد طی کرده اند. فقط برای کسانی که در بتا فعال شده اند.

مقادیر احتمالی: دارایی ، نویسنده ، تعادل ، هویت ، سرمایه گذاری ، بدهی ، پرداخت_بیها ، هویت_وریزاسیون ، معاملات ، اعتبار_دتیلز ، درآمد ، درآمد_وریشن ، سپرده ، standing_orders ، انتقال ، اشتغال ، تکرار شده_ transactions

جدول زمانی RFC 3339 پس از آن رضایت ارائه شده توسط کاربر نهایی منقضی می شود. پس از انقضاء رضایت ، مورد در حالت خطای مورد_ login_required وارد می شود. برای دور زدن خطای مورد_ login_required و حفظ رضایت مداوم ، کاربر نهایی می تواند قبل از زمان انقضا رضایت از طریق حالت به روزرسانی پیوند مجدداً تأیید شود. توجه - این فقط برای برخی از موسسات مبتنی بر OAuth مرتبط است. برای همه موسسات دیگر ، این زمینه تهی خواهد بود.

نشان می دهد که آیا یک مورد نیاز به به روزرسانی کاربر دارد ، که می تواند در مورد مواردی با برخی از اشکال تأیید اعتبار دو عاملی باشد. پس زمینه - مورد را می توان در پس زمینه user_present_required به روز کرد - مورد نیاز به تعامل کاربر دارد تا به روز شود

یک شناسه منحصر به فرد برای درخواست ، که می تواند برای عیب یابی استفاده شود. این شناسه ، مانند همه شناسه های Plaid ، حساس به مورد است.