cursor, लेन-देन संबंधी डेटा पढ़ने के लिए page_token)।
राशियाँ अलग ISO 4217 currency के साथ दशमलव स्ट्रिंग के रूप में दी जाती हैं, तिथियाँ ISO 8601 में होती हैं, और देश ISO alpha-3 में होते हैं।
डेटा पढ़ने पर कभी बिलिंग नहीं होती।
खाते
GET /v3/bank/connections/{id}/accounts/ किसी कनेक्शन के सभी खाते सूचीबद्ध करता है, और GET /v3/bank/accounts/{account_id}/ एक खाता लौटाता है।
जब कोई व्यक्ति वही बैंक खाता दोबारा जोड़ता है, तो उस खाते को पहचानने के लिए
account_ref का उपयोग करें, और एक ही कनेक्शन के भीतर हर चीज़ के लिए id का उपयोग करें।
बैलेंस
GET /v3/bank/accounts/{account_id}/balances/ प्रकार-सहित बैलेंस उनकी संदर्भ तिथियों के साथ लौटाता है।
type का मान booked, available या expected होता है, और जहाँ बैंक ISO 20022 कोड देता है, वहाँ iso_type उसे दर्शाता है।
लेन-देन
GET /v3/bank/accounts/{account_id}/transactions/ एक तिथि सीमा पढ़ता है।
यह date_from और date_to लेता है (बैंक द्वारा दर्ज कैलेंडर तिथियाँ, दोनों शामिल), status (booked या pending, डिफ़ॉल्ट रूप से दोनों), limit (अधिकतम 500) और page_token।
यह effective_date के अनुसार घटते क्रम में, फिर id के अनुसार क्रमबद्ध करता है।
idDidit का है, और इसे पहली बार देखे जाने पर संग्रहीत किया जाता है। एक ही लेन-देन हर रीड, सिंक और नवीनीकरण में अपना id बनाए रखता है।identity_qualityबताता है कि यह गारंटी कितनी मज़बूत है।bank_referenceऔरroute_idस्थिर हैं।derivedका अर्थ है कि लेन-देन का मिलान उसकी सामग्री से किया गया था, इसलिए बैंक के सुधार में एकremovedऔर एकaddedदिखाई दे सकता है।statusbookedयाpendingहोता है। लंबित लेन-देन का अपना id होता है। जब बैंक उसे दर्ज करता है, तो दर्ज लेन-देनaddedके रूप में आता है और लंबित वालाreason: pending_bookedके साथremovedके रूप में आता है।pending_idकेवल तभी सेट होता है जब बैंक दोनों को जोड़ता है।amountsigned होता है: ऋणात्मक का अर्थ है पैसा बाहर गया।directionवही चिह्न दोहराता है।bank_referenceबैंक की प्रविष्टि का अपरिवर्तनीय संदर्भ है, और जहाँ बैंक इसे नहीं देता वहाँnullहोता है। Didit इसे कभी स्वयं नहीं बनाता।categoryDidit का अपना वर्गीकरण है, जब कोई लागू होता हो।- बैंक द्वारा दर्ज लेन-देन में किया गया सुधार
modifiedहोता है। उलटफेर एक नया लेन-देन होता है, और जब बैंक उसे जोड़ता है तोreverses_idके साथ।
जो फ़ील्ड बैंक नहीं भेजता, वे null होते हैं
हर फ़ील्ड जिसे बैंक नहीं भेजता, वहnull होता है।
संस्थान transaction_fields में वे फ़ील्ड सूचीबद्ध करता है जिन्हें भेजने के लिए वह जाना जाता है, साथ में pending_transactions, pending_linkage, balance_types और history_days_max भी, ताकि प्रोडक्शन में कोई भी कमी अचानक न पकड़े।
कम डेटा भेजने वाले बैंक के विरुद्ध अपना कोड परखने के लिए सैंडबॉक्स में sparse_fields टेस्ट ग्राहक का उपयोग करें।
तिथि सीमा की पेजिंग
has_more true होने तक page_token के साथ पढ़ना जारी रखें।
यह टोकन एक घंटे के लिए रीड का स्नैपशॉट स्थिर रखता है: पहले पेज के बाद जोड़ी गई पंक्तियाँ उसमें नहीं होतीं, हर पंक्ति अपनी वर्तमान स्थिति में दी जाती है, और पेजिंग के दौरान हटाई गई पंक्ति बाद के पेजों से बाहर हो जाती है और बदलाव फ़ीड में दिखती है।
समाप्त हो चुका टोकन 410 page_expired लौटाता है: मूल क्वेरी से रीड दोबारा शुरू करें।
परिवर्तन फ़ीड
GET /v3/bank/connections/{id}/transactions/sync/ कनेक्शन के सभी खातों में, cursor के बाद से जो कुछ बदला है, वह लौटाता है।
- खाली cursor सभी मौजूदा लेन-देन को
addedके रूप मेंreset: trueके साथ लौटाता है। अपनी प्रति को इसके साथ बदल दें, उसमें जोड़ें नहीं। - जब तक
has_moretrue है,page_tokenके साथ पेजिंग जारी रखें।next_cursorको केवलhas_more: falseवाले रिस्पॉन्स के बाद ही सहेजें, और यदि बीच में पेजिंग विफल हो जाए, तो अपने सहेजे गए cursor से फिर से शुरू करें। - cursor अपारदर्शी होता है और कनेक्शन तथा एनवायरनमेंट से बंधा होता है। परिवर्तन लॉग 90 दिनों तक पुनः चलाने योग्य रहता है। इससे पुराना cursor
bootstrap: trueके साथ410 cursor_expiredलौटाता है: खाली cursor से फिर से शुरू करें और अपनी प्रति बदल दें। removed[].reasonइनमें से कोई एक होता है:pending_booked,pending_expired,bank_removedयाaccess_removed।
हेडर
दोनों ट्रांज़ैक्शन रीडX-RateLimit-* हेडर लौटाते हैं (प्रति एप्लिकेशन प्रति मिनट 600 रीड और 300 राइट), और इससे अधिक होने पर 429 के साथ Retry-After लौटता है। इसके अलावा X-Bank-Last-Synced-At भी लौटता है।
API की सीमाएँ और बैंक की अपनी डेटा फ़ेच करने की सीमाएँ अलग चीज़ें हैं: देखें मांग पर बैंक डेटा रीफ़्रेश करें.