मुख्य सामग्री पर जाएं
POST
curl
Didit का “बैंक कनेक्शन रीफ़्रेश करें” endpoint अभी sync का अनुरोध करता है और sync_id के साथ 202 लौटाता है। 25 सेकंड तक इंतज़ार करने और एक ही कॉल में पूरा हुआ sync पाने के लिए "wait": true भेजें। इसके लिए कोई अतिरिक्त शुल्क नहीं लगता। बैंक बिना देखरेख की पहुँच को सीमित करता है, इसलिए कॉल Retry-After के साथ 429 refresh_limit_reached का जवाब दे सकती है। देखें: मांग पर बैंक डेटा रीफ़्रेश करें।

प्राधिकरण

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
Prefer
string

wait=<seconds> कॉल को अधिकतम उतने सेकंड तक रोके रखता है, जो 25 से अधिक नहीं हो सकते, जैसे बॉडी में wait: true।

उदाहरण:

"wait=25"

पथ पैरामीटर

id
string<uuid>
आवश्यक

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

बॉडी

application/json

रीफ़्रेश का वैकल्पिक अनुरोध बॉडी।

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

true होने पर कॉल अधिकतम 25 सेकंड तक रुकी रहती है और सिंक पूरा होने पर 200 के साथ जवाब देती है, ताकि एक ही अनुरोध में ताज़ा डेटा मिल जाए। यदि इतने समय में बैंक ने जवाब नहीं दिया, तो कॉल 202 देती है: sync_id का उपयोग करके get_sync_run से सिंक पढ़ें, या bank.sync.completed की सदस्यता लें। bank.data.updated तभी आता है जब सिंक में बदलाव सहेजे जाते हैं। हेडर Prefer: wait=<seconds> (अधिकतम 25) भी यही काम करता है।

प्रतिक्रिया

सिंक 25 सेकंड के भीतर पूरा हुआ।

wait के साथ रिफ़्रेश से लौटा एक पूरा हुआ सिंक: सिंक रन अपने outcome के साथ, और results तथा balances_changed में हर खाते की गिनती।

id
string<uuid>
आवश्यक
connection_id
string<uuid>
आवश्यक
trigger
enum<string>
आवश्यक
उपलब्ध विकल्प:
initial,
scheduled,
requested
status
enum<string>
आवश्यक
उपलब्ध विकल्प:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
आवश्यक
finished_at
string<date-time> | null
आवश्यक
results
object[]
आवश्यक

रन ने क्या किया, प्रति खाता और संसाधन के अनुसार।

error
object | null
आवश्यक

पूरा रन क्यों विफल हुआ। विफल न होने पर null। अलग-अलग खातों और संसाधनों की त्रुटियाँ results में होती हैं।

outcome
enum<string>
आवश्यक

सिंक कैसे समाप्त हुआ।

उपलब्ध विकल्प:
succeeded,
partial,
failed
balances_changed
boolean
आवश्यक

यह कि कोई बैलेंस बदला है या नहीं।

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