> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# बैंक कनेक्शन सूची API: स्थिति और सहमति से फ़िल्टर करें

> Didit का List Bank Connections endpoint स्थिति, पहुँच, बैंक, देश, आपके संदर्भों और सहमति समाप्ति तिथि से फ़िल्टर करके आपके बैंक कनेक्शन लौटाता है।

Didit का List Bank Connections endpoint आपके कनेक्शन लौटाता है, जिन्हें स्थिति, पहुँच, बैंक, देश, आपके अपने संदर्भ और सहमति की समाप्ति तिथि के अनुसार फ़िल्टर किया जाता है।
नवीनीकरण की ज़रूरत वाली सहमतियाँ खोजने के लिए `consent_expires_before` का उपयोग करें, और किसी एक ग्राहक के कनेक्शन खोजने के लिए `end_user_reference` का उपयोग करें।
सूची `cursor` के साथ पृष्ठांकित होती है।


## OpenAPI

````yaml hi/openapi-25.json GET /v3/bank/connections/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: पहचान सत्यापन API। x-api-key हेडर से प्रमाणित करें।
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, कनेक्शन, खाते, बैलेंस, लेन-देन, संस्थान और कवरेज। बैंक डेटा
      सैंडबॉक्स एप्लिकेशन के लिए उपलब्ध है। किसी लाइव एप्लिकेशन की कॉल तब तक
      `404` लौटाती हैं जब तक लाइव पहुँच की घोषणा नहीं होती। सैंडबॉक्स में कोई
      शुल्क नहीं लिया जाता। API कुंजी से की गई कॉल के लिए ऐसी कुंजी चाहिए जिसमें
      बैंक डेटा अनुमति (`bank-data`) हो: पढ़ने के लिए read, और कुछ बदलने वाली
      संक्रियाओं के लिए write। खाता जाँच अपवाद है: इसके लिए सत्रों के लिए write
      पहुँच, या पूर्ण पहुँच चाहिए, बैंक डेटा अनुमति नहीं। बैंक डेटा पूर्ण पहुँच
      में शामिल नहीं है: पूर्ण पहुँच वाली कुंजी अस्वीकार की जाती है, और कॉल `403
      bank_data_access_denied` लौटाती है, जब तक आप ऐसी कुंजी नहीं बनाते जिसमें
      यह अनुमति हो। कच्चा बैंक डेटा (खाते, बैलेंस, लेन-देन और बदलाव फ़ीड) भी ऐसे
      अनुरोध को अस्वीकार करता है जिसमें API कुंजी न हो।


      `/v3/bank/` के अंतर्गत खाता जाँच के अलावा हर अस्वीकृति का एक ही JSON बॉडी
      होती है (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`)। ऐसा पथ जो कोई संक्रिया नहीं है, ऐसा ID जो UUID नहीं है, या
      कोई अज्ञात उप-संसाधन हर मेथड के लिए `404 not_found` लौटाता है, और कोई भी
      अनपेक्षित त्रुटि `request_id` के साथ `500 internal_error` लौटाती है। जहाँ
      बैंक डेटा उपलब्ध नहीं है, वहाँ हर संक्रिया प्लेटफ़ॉर्म का मानक `404`
      लौटाती है, ठीक वैसे ही जैसे कोई अज्ञात रूट लौटाता है।
paths:
  /v3/bank/connections/:
    get:
      tags:
        - Bank Data
      summary: बैंक कनेक्शन की सूची लें
      description: >-
        यह आपके एप्लिकेशन के कनेक्शनों की सूची देता है, सबसे नया पहले, कर्सर
        पेजिनेशन के साथ। सभी फ़िल्टर आपके एप्लिकेशन और एनवायरनमेंट के भीतर लागू
        होते हैं।


        इसके लिए बैंक डेटा अनुमति (`bank-data`) वाली API कुंजी चाहिए, जिसमें इस
        ऑपरेशन के लिए पढ़ने (read) की अनुमति हो। पूर्ण पहुँच वाली कुंजी में यह
        अनुमति शामिल नहीं होती: API कुंजी बनाते समय इसे स्पष्ट रूप से दें, नहीं
        तो कॉल `403 bank_data_access_denied` लौटाती है।


        इस सूची में `sync.budgets` केवल वे बजट दिखाता है जो पहले से मौजूद हैं;
        `GET /v3/bank/connections/{id}/` आज के बजट खोलता है।
      operationId: listBankConnections
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - active
              - renewal_required
              - paused
              - revoked
              - deleted
              - failed
          description: केवल इस स्टेटस वाले कनेक्शन।
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: केवल यह एक्सेस मोड।
        - name: institution_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: केवल यह बैंक।
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: केवल इस देश के बैंक।
        - name: vendor_data
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: केवल वे कनेक्शन जिनमें यह `vendor_data` है।
        - name: end_user_reference
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: केवल वे कनेक्शन जिनमें यह `end_user.reference` है।
        - name: consent_expires_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            केवल वे कनेक्शन जिनकी सहमति इस समय से पहले समाप्त होती है, उदाहरण के
            लिए नवीनीकरण लिंक भेजने के लिए।
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: केवल इस समय के बाद बनाए गए कनेक्शन।
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: पेज का आकार, 1 से 500। डिफ़ॉल्ट 100।
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: अपारदर्शी कर्सर, पिछले पेज के `next_cursor` से।
      responses:
        '200':
          description: कनेक्शनों का एक पेज।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnectionList'
              examples:
                Page:
                  summary: एक कनेक्शन
                  value:
                    items:
                      - id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                        environment: live
                        access: ongoing
                        status: active
                        status_reason: null
                        institution:
                          id: es-banco-norte
                          name: Banco Norte
                          country: ESP
                          logo_url: https://static.example.com/banks/es-banco-norte.png
                        segment: business
                        data:
                          - accounts
                          - balances
                          - transactions
                        consent:
                          status: granted
                          version: 1
                          granted_at: '2026-11-21T12:04:11Z'
                          expires_at: '2027-05-20T12:04:11Z'
                          days_granted: 180
                          renewed_count: 0
                          scopes_requested:
                            - accounts
                            - balances
                            - transactions
                          scopes_granted:
                            - accounts
                            - balances
                            - transactions
                          accounts_granted:
                            - a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                            - c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                          renewal_action: bank_auth
                          renew_by: '2027-05-20T12:04:11Z'
                          reconfirm_by: null
                          renewable_until: null
                          retain_until: null
                          ended_at: null
                          ended_by: null
                        sync:
                          status: ok
                          initial_status: succeeded
                          initial_complete: true
                          history_complete: true
                          last_synced_at: '2026-11-21T12:04:40Z'
                          next_sync_at: '2026-11-22T06:00:00Z'
                          budgets:
                            - scope: connection
                              resource: all
                              limit: 4
                              remaining: 3
                              resets_at: '2026-11-22T00:00:00Z'
                          last_error: null
                          frequency_per_day: 1
                          live_syncs_left_today: 3
                        accounts:
                          - id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                            name: Cuenta negocio
                            type: current
                            usage: business
                            currency: EUR
                            iban_last4: '1332'
                            status: open
                          - id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                            name: Cuenta de ahorro
                            type: savings
                            usage: business
                            currency: EUR
                            iban_last4: '7708'
                            status: open
                        ownership:
                          compare: none
                          match: null
                          check_id: null
                          result: null
                        end_user:
                          reference: client-7731
                        manage_url: null
                        billing:
                          unit: connection_month
                          price_usd: '0.9000'
                          billed_through: '2026-11-30'
                        possible_duplicate_of: null
                        erasure: null
                        vendor_data: client-7731
                        created_at: '2026-11-21T12:03:02Z'
                        updated_at: '2026-11-21T12:04:40Z'
                    next_cursor: null
        '400':
          description: कोई पैरामीटर अमान्य है।
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: अमान्य कर्सर
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: अमान्य अनुरोध
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: limit
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/connections/?status=active&country=ESP&limit=50'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.list_connections()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.bank.listConnections();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.ListConnections(ctx, didit.BankListConnectionsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.bank().listConnections();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->bank->listConnections();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.list_connections
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.Bank.ListConnectionsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankConnectionList:
      type: object
      description: कनेक्शनों का एक पेज।
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankConnection'
        next_cursor:
          type: string
          description: अगले पेज के लिए `cursor` के रूप में पास करें। आख़िरी पेज पर `null`।
          nullable: true
      required:
        - items
        - next_cursor
    BankDataError:
      type: object
      description: Bank data के हर ऑपरेशन का एरर बॉडी। हर फ़ील्ड हमेशा मौजूद रहता है।
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            मशीन-पठनीय त्रुटि कोड। शर्त इसी के आधार पर लिखें, कभी `message` के
            आधार पर नहीं।
        message:
          type: string
          description: >-
            डेवलपर के लिए सरल भाषा में स्पष्टीकरण। शब्द बदल सकते हैं; इसे पार्स
            न करें।
        request_id:
          type: string
          description: इस अनुरोध का पहचानकर्ता। सहायता से संपर्क करते समय इसे उद्धृत करें।
        field:
          type: string
          description: >-
            वह अनुरोध फ़ील्ड जिसे सुधारना है, जब त्रुटि किसी एक फ़ील्ड के बारे
            में हो। अन्यथा `null`।
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            आगे क्या करना है, ताकि क्लाइंट अनुमान लगाए बिना कार्रवाई कर सके। कोई
            मानक अगला चरण न होने पर `null`।
          nullable: true
        retry_after:
          type: integer
          description: >-
            पुनः प्रयास करने से पहले प्रतीक्षा के सेकंड। रेट लिमिट और अस्थायी
            त्रुटियों पर सेट होता है, अन्यथा `null`।
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankConnection:
      type: object
      description: >-
        व्यक्ति की अनुमति, जो आपके एप्लिकेशन को एक बैंक का डेटा पढ़ने देती है।
        नवीनीकरण कनेक्शन ID और हर खाता ID को बनाए रखता है। हटाया गया कनेक्शन
        केवल `id`, `status`, `status_reason`, `created_at` और `erasure` लौटाता
        है: बाकी सभी फ़ील्ड अनुपस्थित रहते हैं, और उसमें कोई बैंक, व्यक्ति या
        खाते का डेटा नहीं बचता।
      properties:
        id:
          type: string
          description: कनेक्शन का पहचानकर्ता।
          format: uuid
        environment:
          type: string
          enum:
            - live
            - sandbox
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - pending
            - active
            - renewal_required
            - paused
            - revoked
            - deleted
            - failed
          description: >-
            `pending`: पहला सिंक चल रहा है। `active`: सहमति मान्य है।
            `renewal_required`: सहमति समाप्त हो गई है या बैंक चाहता है कि
            व्यक्ति फिर से साइन इन करे; डेटा अंतिम सिंक के अनुसार पढ़ा जा सकता
            है और कोई शुल्क नहीं लगता। `paused`: महीने के लिए बैलेंस कम है।
            `revoked`: व्यक्ति, बैंक या आपके द्वारा पहुँच रोकी गई है। `deleted`:
            केवल `id`, `status`, `status_reason`, `created_at` और `erasure` बचते
            हैं। `failed`: पहला सिंक कभी सफल नहीं हुआ।
        status_reason:
          type: string
          enum:
            - 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
          description: >-
            कनेक्शन इस स्थिति में क्यों है। `paused_by_customer` आरक्षित है।
            `deleted` कनेक्शन पर: `deleted_by_customer`, `consent_lapsed`,
            `retention_elapsed` या `application_deleted`।
          nullable: true
        institution:
          $ref: '#/components/schemas/BankInstitutionSummary'
        segment:
          type: string
          enum:
            - personal
            - business
            - null
          nullable: true
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: वे स्कोप जो व्यक्ति ने स्वीकार किए।
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: कनेक्शन के हर खाते का सारांश। पूरा खाता `get_account` से पढ़ें।
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: व्यक्ति या कंपनी के लिए आपका ID।
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: व्यक्ति का अपना एक्सेस पेज। एक्सेस पेज उपलब्ध होने तक `null`।
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            तब सेट होता है जब यह कनेक्शन किसी अन्य सक्रिय कनेक्शन का दोहराव हो
            सकता है, लेकिन कोई `end_user.reference` निश्चित मिलान की अनुमति नहीं
            देता।
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: '`delete_connection` के बाद सेट होता है; अन्यथा `null`।'
        vendor_data:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - status_reason
        - created_at
        - erasure
    RateLimitBudgetError:
      type: object
      description: >-
        यह केवल रेट-लिमिट मिडलवेयर बजट अस्वीकृति के लिए लौटाया जाता है। अन्य 429
        त्रुटियाँ, जिनमें आइडेम्पोटेंसी टकराव और endpoint-विशिष्ट सीमाएँ शामिल
        हैं, इन मेटाडेटा फ़ील्ड्स की गारंटी नहीं देतीं।
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: मौजूदा मानव-पठनीय बजट अस्वीकृति संदेश।
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            अपारदर्शी सहायता संदर्भ: RL- के बाद 32 लोअरकेस UUID हेक्साडेसिमल
            अक्षर।
        limit:
          type: integer
          description: सीमा से अधिक हुए दायरे का बजट; यह X-RateLimit-Limit के बराबर है।
        remaining:
          type: integer
          minimum: 0
          description: शेष बजट, शून्य पर सीमित; X-RateLimit-Remaining के बराबर।
        reset:
          type: integer
          format: int64
          description: >-
            विंडो रीसेट का समय Unix सेकंड में; यह X-RateLimit-Reset के बराबर
            होता है।
        window_seconds:
          type: integer
          description: >-
            फ़िक्स्ड-विंडो की अवधि सेकंड में, शेष प्रतीक्षा समय नहीं। दोबारा
            प्रयास करने से पहले Retry-After का पालन करें।
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankInstitutionSummary:
      type: object
      description: वह बैंक जिसके लिए कनेक्शन या लिंक है।
      properties:
        id:
          type: string
          description: >-
            Didit द्वारा बैंक का पहचानकर्ता, एक स्थिर slug। इसे `institution_id`
            के रूप में उपयोग करें।
          example: es-banco-norte
        name:
          type: string
          description: बैंक का नाम।
          example: Banco Norte
        country:
          type: string
          description: बैंक का देश, ISO 3166-1 alpha-3।
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: बैंक का लोगो, या `null`।
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: इस कनेक्शन के लिए व्यक्ति की सहमति।
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` तब तक रहता है जब तक बैंक पुष्टि नहीं करता कि
            सहमति समाप्त कर दी गई है, उसके बाद यह `revoked` हो जाता है।
            `revocation_failed` को स्वचालित रूप से दोबारा प्रयास किया जाता है।
            निरसन का अनुरोध करते ही बैंक से डेटा लाना तुरंत रोक दिया जाता है।
        version:
          type: integer
          description: सहमति का संस्करण। नवीनीकरण उसी कनेक्शन पर अगला संस्करण बनाता है।
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            बैंक की सहमति कब समाप्त होती है। यह बैंक तय करता है, `consent_days`
            तक।
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: सहमति की अवधि दिनों में, जैसी बैंक ने दी है।
          nullable: true
        renewed_count:
          type: integer
          description: सहमति कितनी बार नवीनीकृत हुई।
        scopes_requested:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        scopes_granted:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        accounts_granted:
          type: array
          items:
            type: string
            format: uuid
          description: व्यक्ति जिन खातों को साझा करता है, उनके ID।
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            नवीनीकरण कैसे होता है: `reconfirm` वह तरीका है जिसमें व्यक्ति Didit
            की स्क्रीन पर बैंक साइन-इन के बिना पुष्टि करता है, जहाँ बैंक और देश
            के नियम इसकी अनुमति देते हैं। `bank_auth` बैंक साइन-इन है।
          nullable: true
        renew_by:
          type: string
          description: >-
            सहमति की समाप्ति: बिना अंतराल के जारी रखने के लिए इससे पहले नवीनीकृत
            करें।
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            तब सेट होता है जब `renewal_action` `reconfirm` हो: पुनः पुष्टि करने
            का आखिरी समय।
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            वह अंतिम क्षण जब सहमति समाप्त होने के बाद भी वही कनेक्शन फिर से
            सक्रिय किया जा सकता है। इसके बाद व्यक्ति को फिर से कनेक्ट करना होगा।
            यह `retain_until` के बराबर है।
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            पहुँच समाप्त होने पर सेट होता है: संग्रहीत डेटा कितने समय तक पढ़ने
            योग्य रहेगा, यह आपके एप्लिकेशन की रिटेंशन सेटिंग से तय होता है।
          format: date-time
          nullable: true
        ended_at:
          type: string
          format: date-time
          nullable: true
        ended_by:
          type: string
          enum:
            - end_user
            - bank
            - customer
            - unknown
            - null
          description: >-
            किसने पहुँच समाप्त की, यह साक्ष्य से तय होता है। जब न बैंक और न ही
            सिंक इसके बारे में कुछ बताते हैं, तब `unknown`।
          nullable: true
      required:
        - status
        - version
        - granted_at
        - expires_at
        - days_granted
        - renewed_count
        - scopes_requested
        - scopes_granted
        - accounts_granted
        - renewal_action
        - renew_by
        - reconfirm_by
        - renewable_until
        - retain_until
        - ended_at
        - ended_by
    BankConnectionSync:
      type: object
      description: कनेक्शन की सिंक स्थिति।
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            24 घंटे तक लगातार विफल प्रयासों के बाद `failing`, जिन्हें बैकऑफ़ के
            साथ दोबारा आज़माया जाता है। जो बैंक व्यक्ति से फिर से साइन इन करने
            को कहता है, वह कनेक्शन को `renewal_required` कर देता है।
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            पहले सिंक का परिणाम। `succeeded` या `partial` होने पर कनेक्शन
            `active` हो जाता है, और जब कोई भी खाता सफल न हो तब `failed`।
        initial_complete:
          type: boolean
          description: >-
            `true` केवल तब होता है जब `initial_status` `succeeded` हो: खाते,
            बैलेंस और हाल के लेन-देन पढ़े जा सकते हैं।
        history_complete:
          type: boolean
          description: >-
            `true` तब होता है जब इतिहास बैकफ़िल किसी भी कारण से समाप्त हो गया
            हो। जो अवधियाँ प्राप्त नहीं हो सकीं, वे हर खाते के
            `history_coverage.missing_ranges` में होती हैं।
        last_synced_at:
          type: string
          description: >-
            बैंक से डेटा अंतिम बार कब लाया गया था, न कि आपने उसे अंतिम बार कब
            पढ़ा था।
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            अगला स्वचालित सिंक कब निर्धारित है। स्वचालित सिंक बैंक के आधार पर
            प्रतिदिन एक से चार बार चलता है (देखें `frequency_per_day`)।
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: व्यक्ति की उपस्थिति के बिना डेटा लाने पर बैंक की सीमाएँ।
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: अंतिम सिंक त्रुटि, या `null`।
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            इस कनेक्शन के लिए स्वचालित सिंक दिन में कितनी बार चलता है, बैंक के
            अनुसार एक से चार बार के बीच। जहाँ बैंक बिना उपस्थिति के अधिक रीड की
            अनुमति देता है, वहाँ भी लाइव सिंक के लिए दिन में कम से कम दो बार
            हमेशा उपलब्ध रहते हैं।
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            बैंक की सीमा के भीतर आज कितने लाइव सिंक (`refresh_connection`) बचे
            हैं: सबसे सख़्त बजट का `remaining`। जहाँ बैंक कोई सीमा तय नहीं करता,
            वहाँ `null`। लाइव सिंक मासिक कीमत में शामिल हैं।
          nullable: true
      required:
        - status
        - initial_status
        - initial_complete
        - history_complete
        - last_synced_at
        - next_sync_at
        - budgets
        - last_error
        - frequency_per_day
        - live_syncs_left_today
    BankConnectionAccountSummary:
      type: object
      description: कनेक्शन के भीतर किसी खाते का संक्षिप्त रूप।
      properties:
        id:
          type: string
          description: >-
            खाता पहचानकर्ता। कनेक्शन के पूरे जीवनकाल में, नवीनीकरण सहित, स्थिर
            रहता है।
          format: uuid
        name:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - current
            - savings
            - card
            - loan
            - investment
            - other
        usage:
          type: string
          enum:
            - personal
            - business
            - unknown
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO 4217 मुद्रा कोड।
        iban_last4:
          type: string
          description: खाते में IBAN हो तो उसके अंतिम चार वर्ण।
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: खाताधारक की किसी व्यक्ति या कंपनी के साथ वैकल्पिक तुलना।
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: जब तुलना का अनुरोध किया गया हो, तब स्वामित्व परिणाम का पहचानकर्ता।
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            निष्कर्ष। `unknown` जब भी धारक से संबंधित साक्ष्य न होने से परिणाम
            बदल सकता हो, और तब भी जब बैंक किसी धारक की जानकारी साझा न करे।
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: इस कनेक्शन का खर्च क्या है। सैंडबॉक्स पर कभी शुल्क नहीं लिया जाता।
      properties:
        unit:
          type: string
          description: बिलिंग इकाई, सतत पहुँच के लिए `connection_month`, अन्यथा `one_time`।
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            आज के महीने के मीटर के लिए आपकी कीमत, आपके एप्लिकेशन और देश के लिए,
            USD में, 4 दशमलव स्थानों वाली दशमलव स्ट्रिंग। कनेक्शन का शुल्क तभी
            लगता है जब स्वीकृत हर दायरे ने उस महीने में कम से कम एक खाते का डेटा
            प्रकाशित किया हो। एक बार वाले कनेक्शनों और सैंडबॉक्स में `null`। सतत
            पहुँच प्रति सक्रिय कनेक्शन प्रति महीने बिल होती है; वर्तमान कीमत
            मूल्य निर्धारण पेज (https://docs.didit.me/getting-started/pricing)
            पर है। उदाहरण की राशियाँ केवल दर्शाने के लिए हैं; किसी देश की कीमत
            मूल्य निर्धारण पेज पर दिखाई गई है।
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: आखिरी महीने का अंत जिसका निपटान हो चुका है।
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: आपके द्वारा माँगी गई हटाने की प्रगति।
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            हटाने के चलने के दौरान `pending`, जब कोई संग्रहीत प्रति और बैंक पर
            कोई पहुँच नहीं बचती तो `erased`, और 24 घंटे में पुष्टि न हो पाने पर
            `failed`। विफल हटाने में कनेक्शन का डेटा बंद रहता है, उसे दोबारा
            आज़माया जाता है, और Didit को सूचित किया जाता है।
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: हटाना कब पूरा हुआ। जब तक `status` `erased` नहीं होता, तब तक `null`।
      required:
        - status
        - requested_at
        - erased_at
    BankSyncBudget:
      type: object
      description: >-
        बैंक की उस सीमा का एक हिस्सा, जो व्यक्ति के मौजूद न होने पर डेटा लाने
        (fetch) पर लागू होती है।
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: वह चीज़ जिसके विरुद्ध बैंक बजट गिनता है।
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: खाता, जब `scope` `account` हो।
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            दिन में कितनी बार Didit व्यक्ति की उपस्थिति के बिना बैंक से डेटा
            प्राप्त कर सकता है, जैसा बैंक परिभाषित करता है। यह बैंक द्वारा तय की
            गई सीमा है, कोई वादा नहीं।
        remaining:
          type: integer
          description: >-
            आपके रिफ़्रेश के लिए वर्तमान विंडो में बचे फ़ेच। स्वचालित सिंक के
            लिए रखे गए रीड पहले ही घटा दिए गए हैं, और कोई स्वचालित सिंक दिन के
            अंतिम दो रीड नहीं लेता, इसलिए मांग पर किए जाने वाले दो रिफ़्रेश
            हमेशा उपलब्ध रहते हैं।
        resets_at:
          type: string
          description: जब विंडो रीसेट होती है।
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: सिंक विफल होने का कारण।
      properties:
        code:
          type: string
          description: Didit एरर कोड।
        message:
          type: string
          description: सरल भाषा में स्पष्टीकरण।
        at:
          type: string
          description: यह कब हुआ। प्रति-खाता परिणाम पर `null`।
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: अनधिकृत
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: अमान्य API कुंजी
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        API कुंजी में Bank data अनुमति (`bank-data`) नहीं है, या, लाइव एप्लिकेशन
        में कच्चे बैंक डेटा के लिए, एप्लिकेशन सेटिंग "Bank data in the API" बंद
        है। Bank data पूर्ण एक्सेस का हिस्सा नहीं है: पूर्ण एक्सेस वाली कुंजी,
        केवल अन्य संसाधनों तक सीमित कुंजी, और API कुंजी के बिना (client
        credentials से, कच्चे डेटा पर) प्रमाणित अनुरोध, सभी को इसी बॉडी के साथ
        मना किया जाता है, इसलिए कुंजी बनाएँ और उसे स्पष्ट रूप से अनुमति दें। यह
        इनकार किसी भी लुकअप से पहले होता है, इसलिए यह नहीं बताता कि ऑब्जेक्ट
        मौजूद है या नहीं।
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: बैंक डेटा की अनुमति नहीं है
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        मिडलवेयर रीड बजट पार हो गया है। पुनः प्रयास करने से पहले Retry-After का
        पालन करें।
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Didit की ओर से कुछ गड़बड़ हुई है। `/v3/bank/` के तहत कोई भी अप्रत्याशित
        त्रुटि बैंक त्रुटि संरचना में उत्तर देती है, कभी HTML पेज में नहीं:
        सहायता टीम को `request_id` बताएँ।
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: एक अनपेक्षित त्रुटि
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        प्रतीक्षा के सेकंड, जिन्हें अगली विंडो तक ऊपर की ओर राउंड किया गया है।
        मिडलवेयर बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: वह दायरा जिसका बजट पार हुआ। मिडलवेयर बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        सीमा से अधिक हुए दायरे का बजट; यह बॉडी लिमिट के बराबर है। यह middleware
        बजट अस्वीकृतियों में मौजूद होता है।
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        शेष बजट, शून्य पर सीमित; body remaining के बराबर। मिडलवेयर बजट
        अस्वीकृतियों पर मौजूद।
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        रीसेट का समय Unix सेकंड में; यह बॉडी के reset के बराबर होता है। मिडलवेयर
        बजट अस्वीकृतियों पर मौजूद होता है।
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        आपकी एप्लिकेशन की 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।

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.