मुख्य सामग्री पर जाएं
POST
curl
Didit का Cancel a Bank Link endpoint उस बैंक लिंक को समाप्त करता है जिसे व्यक्ति ने पूरा नहीं किया है, इसलिए उसका url और token काम करना बंद कर देते हैं। इसका उपयोग तब करें जब आपका उपयोगकर्ता प्रवाह छोड़ देता है या आप उसी उपयोगकर्ता के लिए नया लिंक बनाते हैं। पूरा हो चुके लिंक को रद्द करने से कुछ नहीं बदलता और 200 के साथ लिंक अपरिवर्तित लौटता है। पहुँच रोकने के लिए निरस्त करें का उपयोग करें।

प्राधिकरण

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

पथ पैरामीटर

id
string<uuid>
आवश्यक

लिंक की आईडी।

प्रतिक्रिया

लिंक, जो अब cancelled है, या यदि वह पहले से अंतिम स्थिति में था तो अपरिवर्तित।

एक व्यक्ति के लिए 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