मुख्य सामग्री पर जाएं
GET
curl
Didit का Get a Bank Connection endpoint एक कनेक्शन लौटाता है, जिसमें उसकी स्थिति, सहमति की तिथियाँ, सिंक स्थिति, खाता सारांश और लागत शामिल होते हैं। sync.initial_status बताता है कि पहला डेटा कब पढ़ने योग्य है, consent.expires_at बताता है कि कब नवीनीकरण करना है, और sync.budgets बताता है कि बैंक अभी कितने रिफ़्रेश की अनुमति देता है। देखें: कनेक्शन।

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, जो Business Console में Developers -> API keys से मिलती है। प्राथमिक कुंजी के पास पूर्ण पहुँच होती है। नामित कुंजी को सीमित किया जा सकता है: प्रति संसाधन कोई नहीं, read या write, कुछ वर्कफ़्लो या केवल स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि के साथ। 401 का अर्थ है कि कुंजी गलत, रद्द या समय-सीमा समाप्त है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई, कुंजी को इस संसाधन या कार्रवाई तक पहुँच नहीं है, या अनुरोध उसकी IP सूची के बाहर के पते से आया; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों के बाहर है। मीडिया पहुँच के बिना कुंजी को image, video और PDF URL null मिलते हैं, और sessions write के बिना कुंजी को सत्र लिंक और token null मिलते हैं। देखें https://docs.didit.me/console/api-keys।

पथ पैरामीटर

id
string<uuid>
आवश्यक

कनेक्शन आईडी।

प्रतिक्रिया

कनेक्शन।

व्यक्ति की अनुमति, जो आपके एप्लिकेशन को एक बैंक का डेटा पढ़ने देती है। नवीनीकरण कनेक्शन ID और हर खाता ID को बनाए रखता है। हटाया गया कनेक्शन केवल id, status, status_reason, created_at और erasure लौटाता है: बाकी सभी फ़ील्ड अनुपस्थित रहते हैं, और उसमें कोई बैंक, व्यक्ति या खाते का डेटा नहीं बचता।

id
string<uuid>
आवश्यक

कनेक्शन का पहचानकर्ता।

status
enum<string>
आवश्यक

pending: पहला सिंक चल रहा है। active: सहमति मान्य है। renewal_required: सहमति समाप्त हो गई है या बैंक चाहता है कि व्यक्ति फिर से साइन इन करे; डेटा अंतिम सिंक के अनुसार पढ़ा जा सकता है और कोई शुल्क नहीं लगता। paused: महीने के लिए बैलेंस कम है। revoked: व्यक्ति, बैंक या आपके द्वारा पहुँच रोकी गई है। deleted: केवल id, status, status_reason, created_at और erasure बचते हैं। failed: पहला सिंक कभी सफल नहीं हुआ।

उपलब्ध विकल्प:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
आवश्यक

कनेक्शन इस स्थिति में क्यों है। paused_by_customer आरक्षित है। deleted कनेक्शन पर: deleted_by_customer, consent_lapsed, retention_elapsed या application_deleted।

उपलब्ध विकल्प:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
आवश्यक

delete_connection के बाद सेट होता है; अन्यथा null।

created_at
string<date-time>
आवश्यक
environment
enum<string>
उपलब्ध विकल्प:
live,
sandbox
access
enum<string>
उपलब्ध विकल्प:
one_time,
ongoing
institution
object

वह बैंक जिसके लिए कनेक्शन या लिंक है।

segment
enum<string> | null
उपलब्ध विकल्प:
personal,
business,
null
data
enum<string>[]

वे स्कोप जो व्यक्ति ने स्वीकार किए।

उपलब्ध विकल्प:
accounts,
balances,
transactions

इस कनेक्शन के लिए व्यक्ति की सहमति।

sync
object

कनेक्शन की सिंक स्थिति।

accounts
object[]

कनेक्शन के हर खाते का सारांश। पूरा खाता get_account से पढ़ें।

ownership
object

खाताधारक की किसी व्यक्ति या कंपनी के साथ वैकल्पिक तुलना।

end_user
object
manage_url
string<uri> | null

व्यक्ति का अपना एक्सेस पेज। एक्सेस पेज उपलब्ध होने तक null।

billing
object

इस कनेक्शन का खर्च क्या है। सैंडबॉक्स पर कभी शुल्क नहीं लिया जाता।

possible_duplicate_of
string<uuid> | null

तब सेट होता है जब यह कनेक्शन किसी अन्य सक्रिय कनेक्शन का दोहराव हो सकता है, लेकिन कोई end_user.reference निश्चित मिलान की अनुमति नहीं देता।

vendor_data
string | null
updated_at
string<date-time>
अंतिम संशोधन 22 नवंबर 2026