मुख्य सामग्री पर जाएं
POST
curl
Didit का Create a Bank Link endpoint आपके सर्वर पर Bank Link का एक रन शुरू करता है, ताकि कोई बैंक कनेक्ट किया जा सके या मौजूदा कनेक्शन नवीनीकृत किया जा सके, और होस्टेड url लौटाता है। हर फ़ील्ड का एक डिफ़ॉल्ट मान होता है, इसलिए सबसे छोटा अनुरोध {} होता है, जिसमें आप चाहें तो और फ़ील्ड जोड़ सकते हैं। लौटाए गए id को अपने उपयोगकर्ता के साथ सहेजकर रखें और परिणाम की पुष्टि स्वयं करें, इसके लिए बैंक लिंक प्राप्त करें या bank.link.completed webhook का उपयोग करें। क्विकस्टार्ट और Bank Link देखें।

प्राधिकरण

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।

हेडर

Idempotency-Key
string

एक ऑपरेशन के लिए आपके द्वारा चुनी गई वैकल्पिक पुनः प्रयास-सुरक्षा कुंजी, जो अधिकतम 255 अक्षरों की हो सकती है (UUID उपयोग की जा सकती है)। वही कुंजी, endpoint, क्वेरी और बॉडी के साथ दोहराया गया अनुरोध पहले वाले रिस्पॉन्स से ही उत्तर पाता है, वही स्टेटस और वही बॉडी, और दूसरी बार न कोई प्रक्रिया चलती है न कोई शुल्क लगता है। वही कुंजी किसी दूसरे endpoint, क्वेरी या बॉडी के साथ भेजने पर 409 idempotency_key_reused रिस्पॉन्स मिलता है, और जब पहला अनुरोध अभी भी चल रहा हो, तब Retry-After के साथ 409 idempotency_key_in_progress मिलता है। विफल अनुरोध (कोई भी 4xx या 5xx) सहेजा नहीं जाता, इसलिए आप उसी कुंजी के साथ उसे दोबारा भेज सकते हैं। कुंजियाँ आपके एप्लिकेशन की होती हैं, चाहे आप API कुंजी से कॉल करें या एक्सेस टोकन से। देखें पुनः प्रयास और आइडेम्पोटेंसी।

Required string length: 1 - 255

बॉडी

application/json

बैंक लिंक बनाएँ। सबसे छोटा अनुरोध {} है; इसके साथ जो चाहिए वह भेजें। हर फ़ील्ड का एक डिफ़ॉल्ट होता है।

mode
enum<string>
डिफ़ॉल्ट:connect

connect (डिफ़ॉल्ट) नया कनेक्शन बनाता है। renew के लिए connection_id चाहिए और वह उस कनेक्शन की सेटिंग्स दोबारा उपयोग करता है।

उपलब्ध विकल्प:
connect,
renew
connection_id
string<uuid>

नवीनीकृत किया जाने वाला कनेक्शन। केवल mode: renew के साथ।

access
enum<string>
डिफ़ॉल्ट:one_time

one_time (डिफ़ॉल्ट) डेटा एक बार पढ़ता है। ongoing सहमति समाप्त होने या किसी के रोकने तक पहुँच खुली रखता है। institution_id सेट होने पर, जो बैंक पहुँच खुली नहीं रख सकता, वह किसी भी स्क्रीन के दिखने से पहले 400 ongoing_access_not_available लौटाता है। इसके बिना, बैंक चुनने वाली सूची में केवल वही बैंक दिखते हैं जो ऐसा कर सकते हैं।

उपलब्ध विकल्प:
one_time,
ongoing
country
string

वैकल्पिक। इसके बिना व्यक्ति उन देशों में से चुनता है जिन्हें आपके एप्लिकेशन ने सक्षम किया है। यह ऐसा देश होना चाहिए जिसे Bank Link सेवा देता है; कोई भी अन्य, ZZZ सहित, 400 invalid_request लौटाता है, जिसमें field: country होता है। खाली अनुरोध बॉडी मान्य रहती है।

Pattern: ^[A-Z]{3}$
institution_id
string

वैकल्पिक बैंक, जिसे list_institutions से पहले से चुना जा सके। चयन स्क्रीन छोड़ देता है।

Maximum string length: 64
segment
enum<string>
डिफ़ॉल्ट:any

पिकर को फ़िल्टर करता है और जहाँ बैंक लॉगिन अलग करता है, वहाँ बताता है कि कौन-सा लॉगिन खोलना है। डिफ़ॉल्ट any।

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

क्या पढ़ना है। accounts हमेशा शामिल होता है: नाम, प्रकार, मुद्रा, पहचानकर्ता और जहाँ बैंक इसे साझा करता है, वहाँ धारक का नाम। डिफ़ॉल्ट ["accounts"] है।

Maximum array length: 3
उपलब्ध विकल्प:
accounts,
balances,
transactions
history_days
integer
डिफ़ॉल्ट:90

अनुरोध करने के लिए लेन-देन इतिहास के दिन, 1 से 365, डिफ़ॉल्ट 90। बैंक इससे कम दे सकता है: हर खाता history_coverage में बताता है कि उसने वास्तव में कितना दिया। इसे history_from के साथ नहीं भेजा जा सकता।

आवश्यक सीमा: 1 <= x <= 365
history_from
string<date>

history_days की जगह वह इतिहास का प्रारंभ दिनांक जो माँगना है। इसे history_days के साथ नहीं भेजा जा सकता: दोनों एक साथ भेजने पर 400 history_window_ambiguous मिलता है। 365 दिन से पुरानी, या भविष्य की तारीख 400 window_not_available देती है।

extended_history
enum<string>
डिफ़ॉल्ट:standard

allow_extra_auth उस बैंक को, जो एक और पुष्टि माँगता है, पुराना इतिहास जारी करने देता है।

उपलब्ध विकल्प:
standard,
allow_extra_auth

केवल Ongoing के लिए। बैंक से कितने दिनों तक पहुँच खुली रखने का अनुरोध करना है, 1 या अधिक। डिफ़ॉल्ट: बैंक जितनी लंबी अवधि की अनुमति देता है। कनेक्शन वास्तविक स्वीकृत तिथि consent.expires_at में बताता है। access: one_time के साथ यह 400 invalid_request लौटाता है, जिसमें field: consent_days होता है।

आवश्यक सीमा: 1 <= x <= 32767
ownership
object

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

end_user
object

वह व्यक्ति या कंपनी जो खाते को कनेक्ट करती है।

redirect_url
string<uri>

अंत में ब्राउज़र कहाँ जाता है, साथ में link_id, status और हस्ताक्षरित state (केवल प्रदर्शन के लिए; webhook और get_link ही आधिकारिक हैं)। सैंडबॉक्स एप्लिकेशन में localhost, 127.0.0.1 या [::1] का सादा http पता (कोई भी पोर्ट और पथ, बिना क्रेडेंशियल और बिना फ़्रैगमेंट) पंजीकरण की आवश्यकता नहीं रखता। कोई अन्य पता 400 redirect_url_not_registered लौटाता है: अन्य पते पंजीकृत करने की सुविधा अभी उपलब्ध नहीं है। redirect_url के बिना व्यक्ति Didit के अपने परिणाम पृष्ठ पर समाप्त करता है।

Maximum string length: 2048
allowed_origins
string<uri>[]

स्वीकृत है, लेकिन अभी इसका उपयोग नहीं होता: यह Didit के एम्बेडेड Bank Link के लिए आरक्षित है, जो अभी जारी नहीं हुआ है। HTTPS ओरिजिन, अधिकतम 50।

Maximum array length: 50
language
string

वैकल्पिक भाषा कोड, जैसे es या pt-BR। नहीं दिया तो ब्राउज़र की भाषा।

Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
vendor_data
string

आपका अपना संदर्भ, जो लिंक और कनेक्शन पर लौटाया जाता है।

Maximum string length: 255
expires_in
integer
डिफ़ॉल्ट:3600

लिंक का जीवनकाल सेकंड में, 300 से 86400 तक। डिफ़ॉल्ट 3600।

आवश्यक सीमा: 300 <= x <= 86400
duplicates
enum<string>
डिफ़ॉल्ट:reuse

reuse (डिफ़ॉल्ट) उस लिंक को पूरा करता है जो उन खातों से जुड़ता है जिन्हें आप पहले से साझा करते हैं, और इसे उस कनेक्शन के नवीनीकरण के रूप में गिना जाता है। allow एक स्वतंत्र दूसरा कनेक्शन बनाता है।

उपलब्ध विकल्प:
reuse,
allow
allow_one_time_fallback
boolean
डिफ़ॉल्ट:false

ongoing के साथ, यह व्यक्ति को उस बैंक में एक बार पढ़ना जारी रखने देता है जो पहुँच खुली नहीं रख सकता, बशर्ते वह बैंक की अपनी स्क्रीन पर कम हुई पहुँच की पुष्टि कर दे। कोट बताता है कि इसकी लागत कितनी है। केवल access: ongoing के साथ: एक बार की पहुँच के साथ यह 400 invalid_request लौटाता है और field: allow_one_time_fallback आता है।

accept_reduced_grant
boolean
डिफ़ॉल्ट:false

जब बैंक या व्यक्ति आपके माँगे गए दायरे से कम अनुमति दे, तो लिंक पूरा करें और केवल दी गई अनुमतियों का शुल्क लें। अन्यथा लिंक reduced_grant के साथ failed पर समाप्त होता है और कोई शुल्क नहीं लिया जाता।

sandbox
object

केवल सैंडबॉक्स एप्लिकेशन के लिए: Didit Test Bank का ग्राहक चुनता है। लाइव एप्लिकेशन में इसे अनदेखा किया जाता है।

प्रतिक्रिया

लिंक बनाया गया।

एक व्यक्ति के लिए Bank Link का एक रन: बैंक कनेक्ट करना, या कनेक्शन नवीनीकृत करना। get_link से लिंक की पुष्टि स्वयं करें: ब्राउज़र से भेजे गए ID पर कभी भरोसा न करें।

id
string<uuid>
आवश्यक

लिंक का पहचानकर्ता।

mode
enum<string>
आवश्यक
उपलब्ध विकल्प:
connect,
renew
access
enum<string>
आवश्यक
उपलब्ध विकल्प:
one_time,
ongoing
status
enum<string>
आवश्यक

लिंक की स्थिति। completed, cancelled, expired और failed अंतिम हैं।

उपलब्ध विकल्प:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
आवश्यक

वह होस्टेड पेज जिस पर व्यक्ति को भेजना है। यह केवल लिंक बनाते समय लौटाया जाता है; बाद की रीड में यह null होता है, क्योंकि टोकन संग्रहीत नहीं किया जाता।

client_token
string | null
आवश्यक

Didit के एम्बेडेड Bank Link का टोकन, जो अभी जारी नहीं हुआ है: आज url खोलें। यह केवल लिंक बनाते समय लौटाया जाता है; बाद की रीड पर null। इसका उद्देश्य एक है और यह कम समय के लिए वैध है। इसमें कोई व्यक्तिगत डेटा नहीं होता। इसे कभी लॉग न करें।

expires_at
string<date-time>
आवश्यक

जो लिंक अभी तक उपयोग नहीं हुआ है, वह कब काम करना बंद कर देता है।

connection_id
string<uuid> | null
आवश्यक

वह कनेक्शन जिसे इस लिंक ने बनाया या नवीनीकृत किया है, जब status completed हो जाए।

check_id
string<uuid> | null
आवश्यक

इस लिंक का स्वामित्व परिणाम, जब उसने ownership.compare के लिए none से भिन्न कोई मान माँगा हो।

reused
boolean
आवश्यक

true तब होता है जब लिंक एक मौजूदा कनेक्शन के नवीनीकरण के रूप में पूरा हुआ, क्योंकि व्यक्ति पहले से ठीक ये ही खाते साझा करता है (duplicates: reuse)। कोई शुल्क दोबारा नहीं लगता।

error
object | null
आवश्यक

लिंक विफल होने का कारण, जब status failed हो। अन्यथा null।

quote
object
आवश्यक

लिंक की कीमत, जो उसके बनने के समय तय हो जाती है। चार्ज की गई कीमत कोट की होती है। रीड कभी बिल नहीं होते।

vendor_data
string | null
आवश्यक

अनुरोध से आपका संदर्भ।

अंतिम संशोधन 22 नवंबर 2026