> ## 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.

# Bank Transactions Change Feed API: Added, Modified, Removed

> Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: added, modified and removed.

Didit's Sync Transactions endpoint returns what changed in a connection's transactions since a cursor: `added`, `modified` and `removed`.
An empty cursor returns everything with `reset: true`.
Store `next_cursor` only after a response with `has_more: false`.
See [Continuous bank feed for accounting](https://docs.didit.me/use-cases/bank-data-for-accounting.md).


## OpenAPI

````yaml openapi-25.json GET /v3/bank/connections/{id}/transactions/sync/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: Identity verification API. Authenticate with x-api-key header.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, connections, accounts, balances, transactions, institutions and
      coverage. Bank data is available for sandbox applications. A live
      application's calls answer `404` until live access is announced. Nothing
      is charged in sandbox. A call made with an API key needs a key that
      carries the Bank data permission (`bank-data`): read for reads, write for
      operations that change something. The account check is the exception: it
      needs write access to sessions, or full access, and not the Bank data
      permission. Bank data is not part of full access: a full-access key is
      refused, and the call answers `403 bank_data_access_denied` until you
      create a key that carries the permission. Raw bank data (accounts,
      balances, transactions and the change feed) also refuses a request that
      carries no API key.


      Every refusal under `/v3/bank/` except the account check's has the same
      JSON body (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). A path that is not an operation, an id that is not a UUID
      or an unknown sub-resource answers `404 not_found` for every method, and
      any unexpected error answers `500 internal_error` with a `request_id`.
      Where Bank data is not available, every operation answers the platform's
      standard `404`, exactly as an unknown route does.
paths:
  /v3/bank/connections/{id}/transactions/sync/:
    get:
      tags:
        - Bank Data
      summary: Sync transactions (change feed)
      description: >-
        Returns what changed in a connection's transactions since a `cursor`:
        `added`, `modified` and `removed` (with a `reason`), across all its
        accounts. An empty cursor returns every current transaction as `added`
        and sets `reset: true`: replace your copy with it instead of adding to
        it.


        The first read is a true snapshot. A first read (no cursor, or the read
        after `reset`) returns every transaction the connection had when the
        read started, each exactly once as `added`, in its current state, even
        if a sync runs while you page. Changes made while you were paging arrive
        in the next read from `next_cursor`: a transaction you already received
        comes again as `modified`, and a new one as `added`. Apply `modified` as
        an upsert by `id`, and ignore a `removed` id you do not have. All pages
        of one read reflect the same point in time. Keep paging with
        `page_token` while `has_more` is `true`, and store `next_cursor` only
        after a response with `has_more: false`. If paging fails midway, restart
        from the cursor you had stored.


        The change log is replayable for 90 days. An older cursor answers `410
        cursor_expired` with `bootstrap: true`: start again from an empty
        cursor. Stored history is never aged out while the connection exists. A
        booked pending transaction appears in `added` and the pending one in
        `removed` with `reason: pending_booked`. Webhook `bank.data.updated`
        tells you when to call.


        Needs an API key with the Bank data permission (`bank-data`): read for
        this operation. A key with full access does not include it: grant it
        explicitly when you create the key, or the call answers `403
        bank_data_access_denied`. A sandbox application reads its Test Bank data
        with the key alone. A request without an API key (client credentials) is
        refused on raw data with the same `403`.
      operationId: syncBankTransactions
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The connection id.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            The `next_cursor` you stored. Empty or omitted starts from the
            beginning.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Page size, 1 to 500. Default 100.
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: Continues the same read while `has_more` is `true`.
      responses:
        '200':
          description: A page of changes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransactionChanges'
              examples:
                Changes:
                  summary: A pending transaction booked, and a new one added
                  value:
                    added:
                      - id: 8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-19'
                        value_date: '2026-11-20'
                        transaction_date: null
                        effective_date: '2026-11-19'
                        amount: '-1210.00'
                        currency: EUR
                        direction: debit
                        description: RECIBO SEGURIDAD SOCIAL
                        counterparty:
                          name: ENTIDAD PUBLICA DE EJEMPLO
                          iban: ES0000000000000000005766
                          bic: null
                        remittance:
                          unstructured:
                            - RECIBO SEGURIDAD SOCIAL 10/2026
                          structured: null
                          reference: '0028123456789'
                        bank_transaction_code: PMNT-RDDT-ESDD
                        bank_reference: '2026111900012345'
                        identity_quality: bank_reference
                        end_to_end_id: NOTPROVIDED
                        mandate_id: ES-SS-000123
                        creditor_id: ES00ZZZ00000000
                        merchant_category_code: null
                        exchange: null
                        balance_after: '18250.34'
                        category: taxes_and_social_security
                        first_seen_at: '2026-11-20T06:00:12Z'
                        updated_at: '2026-11-20T06:00:12Z'
                    modified: []
                    removed:
                      - id: e5b1f8a3-0d47-4c92-a6e0-7f3c2d9b1845
                        reason: pending_booked
                    has_more: false
                    next_page_token: null
                    next_cursor: cur_01HZX9K4M2W7B3T8
                    reset: false
                Bootstrap:
                  summary: Read from an empty cursor
                  value:
                    added:
                      - id: 8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-19'
                        value_date: '2026-11-20'
                        transaction_date: null
                        effective_date: '2026-11-19'
                        amount: '-1210.00'
                        currency: EUR
                        direction: debit
                        description: RECIBO SEGURIDAD SOCIAL
                        counterparty:
                          name: ENTIDAD PUBLICA DE EJEMPLO
                          iban: ES0000000000000000005766
                          bic: null
                        remittance:
                          unstructured:
                            - RECIBO SEGURIDAD SOCIAL 10/2026
                          structured: null
                          reference: '0028123456789'
                        bank_transaction_code: PMNT-RDDT-ESDD
                        bank_reference: '2026111900012345'
                        identity_quality: bank_reference
                        end_to_end_id: NOTPROVIDED
                        mandate_id: ES-SS-000123
                        creditor_id: ES00ZZZ00000000
                        merchant_category_code: null
                        exchange: null
                        balance_after: '18250.34'
                        category: taxes_and_social_security
                        first_seen_at: '2026-11-20T06:00:12Z'
                        updated_at: '2026-11-20T06:00:12Z'
                      - id: 2c9e7a05-6b14-4d38-8f2a-b3d51e0c9a67
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-18'
                        value_date: '2026-11-18'
                        transaction_date: null
                        effective_date: '2026-11-18'
                        amount: '3450.00'
                        currency: EUR
                        direction: credit
                        description: TRANSFERENCIA FACTURA 2026-0418
                        counterparty:
                          name: CLIENTE DE EJEMPLO SL
                          iban: ES0000000000000000007891
                          bic: null
                        remittance:
                          unstructured:
                            - FRA 2026-0418
                          structured: null
                          reference: null
                        bank_transaction_code: PMNT-RCDT-ESCT
                        bank_reference: '2026111800009876'
                        identity_quality: bank_reference
                        end_to_end_id: 2026-0418
                        mandate_id: null
                        creditor_id: null
                        merchant_category_code: null
                        exchange: null
                        balance_after: '19460.34'
                        category: income
                        first_seen_at: '2026-11-19T06:00:10Z'
                        updated_at: '2026-11-19T06:00:10Z'
                    modified: []
                    removed: []
                    has_more: false
                    next_page_token: null
                    next_cursor: cur_01HZX9K4M2W7B3T8
                    reset: true
          headers:
            Cache-Control:
              description: '`no-store`.'
              schema:
                type: string
        '400':
          description: >-
            The cursor or page token is not valid, or a parameter is out of
            range. `field` names it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Invalid cursor
                  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
                Token for another read:
                  summary: Token for another read
                  value:
                    code: page_token_mismatch
                    message: >-
                      The page token belongs to a different read. Restart with
                      the same filters.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Invalid request
                  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'
        '404':
          description: The resource does not exist in this application and environment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Not found
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '409':
          description: >-
            The connection has no readable data: it was deleted, or its
            retention ended (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Not active
                  value:
                    code: connection_not_active
                    message: This connection is not active.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: create_link
                    retry_after: null
        '410':
          description: >-
            The cursor is older than the 90 days the change log is kept, or the
            page token expired. For `cursor_expired` the body carries
            `bootstrap: true`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataCursorError'
              examples:
                Cursor expired:
                  summary: Start again from an empty cursor
                  value:
                    code: cursor_expired
                    message: >-
                      The cursor is older than the change log. Read again from
                      an empty cursor.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: restart_from_cursor
                    retry_after: null
                    bootstrap: true
                Page expired:
                  summary: Restart the read from the last stored cursor
                  value:
                    code: page_expired
                    message: The page token expired. Restart the read.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: restart_read
                    retry_after: null
        '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/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/transactions/sync/?cursor=cur_01HZX9K4M2W7B3T8'
            \
              -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.sync_transactions(
                "11111111-2222-3333-4444-555555555555",
            )
            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.syncTransactions("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.SyncTransactions(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankSyncTransactionsParams{})\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().syncTransactions("11111111-2222-3333-4444-555555555555");

            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->syncTransactions('11111111-2222-3333-4444-555555555555');

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


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.bank.sync_transactions("11111111-2222-3333-4444-555555555555")

            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.SyncTransactionsAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankTransactionChanges:
      type: object
      description: >-
        Changes of a connection's transactions since a cursor. An empty cursor
        returns every current transaction as `added`. All pages of one read
        reflect the same snapshot; changes that arrive meanwhile come in the
        next read.
      properties:
        added:
          type: array
          items:
            $ref: '#/components/schemas/BankTransaction'
          description: >-
            Transactions to add. On a first read (no cursor, or after `reset`)
            this is every transaction the connection had when the read started,
            each exactly once and in its current state, even if a sync runs
            while you page. In later reads it holds the transactions that are
            new since your cursor, and the booked transaction that replaces a
            pending one.
        modified:
          type: array
          items:
            $ref: '#/components/schemas/BankTransaction'
          description: >-
            Transactions that changed since your cursor, in their current state.
            Apply each as an upsert by `id`: a transaction you already received
            while paging the first read comes again here if it changed
            meanwhile, and a bank correction arrives here too.
        removed:
          type: array
          items:
            $ref: '#/components/schemas/BankRemovedTransaction'
          description: >-
            Transactions that no longer exist, with a `reason`. Ignore an `id`
            you do not have: a transaction that was removed while you paged a
            first read was still delivered once as `added` and arrives here in
            the next read.
        has_more:
          type: boolean
          description: >-
            `true` while there are more pages. Store `next_cursor` only after a
            response with `has_more: false`; if paging fails midway, restart
            from the cursor you had stored.
        next_page_token:
          type: string
          description: Continues this read while `has_more` is `true`.
          nullable: true
        next_cursor:
          type: string
          description: >-
            The durable checkpoint of the feed, returned only on the last page.
            Opaque and bound to the application, environment and connection.
            Replayable for 90 days. On a first read it marks the moment the read
            started, so what changed meanwhile arrives in the next read.
          nullable: true
        reset:
          type: boolean
          description: >-
            `true` on every bootstrap, which is every read from an empty cursor:
            replace your copy with the result instead of adding to it.
      required:
        - added
        - modified
        - removed
        - has_more
        - next_page_token
        - next_cursor
        - reset
    BankDataError:
      type: object
      description: Error body of every Bank data operation. Every field is always present.
      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: Machine-readable error code. Branch on this, never on `message`.
        message:
          type: string
          description: >-
            Plain-language explanation for a developer. The wording can change;
            do not parse it.
        request_id:
          type: string
          description: Identifier of this request. Quote it when you contact support.
        field:
          type: string
          description: >-
            The request field to correct, when the error is about one field.
            Otherwise `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: >-
            What to do next, so a client can act without guessing. `null` when
            there is no standard next step.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Seconds to wait before retrying. Set on rate-limit and temporary
            errors, otherwise `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
    BankDataCursorError:
      allOf:
        - $ref: '#/components/schemas/BankDataError'
        - type: object
          properties:
            bootstrap:
              type: boolean
              description: >-
                Present with `cursor_expired`, always `true`: start again from
                an empty `cursor` and replace your stored copy with the result.
      description: >-
        Body of a `410` answer of the change feed. With `cursor_expired` it
        carries `bootstrap: true`: read the feed again from an empty cursor, and
        replace your copy of the connection's transactions with that result
        instead of adding to it. With `page_expired` there is no `bootstrap`:
        restart from the last cursor you stored.
    BankTransaction:
      type: object
      description: >-
        One movement of an account. Any field the bank does not send is `null`;
        the institution capabilities list which fields a bank is known to send.
      properties:
        id:
          type: string
          description: >-
            Didit's id, opaque and stored at first sight. The same movement
            keeps its id across reads, syncs and renewals. `identity_quality`
            says how strong that guarantee is.
          format: uuid
        account_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - booked
            - pending
          description: >-
            A pending transaction has its own id. When the bank books it, the
            booked transaction carries `pending_id` where the bank links them,
            and the pending one appears in `removed` with `reason:
            pending_booked`.
        pending_id:
          type: string
          description: >-
            The pending transaction this one replaced. Set only when the bank
            links them, never guessed.
          format: uuid
          nullable: true
        reverses_id:
          type: string
          description: >-
            The transaction this one reverses, when the bank links them. A
            reversal is a new transaction.
          format: uuid
          nullable: true
        booking_date:
          type: string
          format: date
          nullable: true
        value_date:
          type: string
          format: date
          nullable: true
        transaction_date:
          type: string
          format: date
          nullable: true
        effective_date:
          type: string
          description: >-
            The date the date filters use, as the bank reports it in its own
            time zone with nothing converted: for a booked transaction its
            booking date, else its value date, else the date it was first seen;
            for a pending one its transaction date, else the date it was first
            seen.
          format: date
        amount:
          type: string
          description: Signed amount as a decimal string. Negative is money out.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO 4217 currency code.
        direction:
          type: string
          enum:
            - credit
            - debit
          description: Repeats the sign of `amount`.
        description:
          type: string
          nullable: true
        counterparty:
          $ref: '#/components/schemas/BankTransactionCounterparty'
        remittance:
          $ref: '#/components/schemas/BankTransactionRemittance'
        bank_transaction_code:
          type: string
          nullable: true
        bank_reference:
          type: string
          description: >-
            The bank's immutable entry reference where it provides one. `null`
            otherwise, never invented.
          nullable: true
        identity_quality:
          type: string
          enum:
            - bank_reference
            - route_id
            - derived
          description: >-
            How `id` was matched. `bank_reference` and `route_id` are stable.
            `derived` is matched by content: it is stable while the bank keeps
            reporting the entry unchanged, and a correction by the bank can then
            appear as one `removed` and one `added`.
        end_to_end_id:
          type: string
          nullable: true
        mandate_id:
          type: string
          nullable: true
        creditor_id:
          type: string
          nullable: true
        merchant_category_code:
          type: string
          nullable: true
        exchange:
          type: object
          nullable: true
          description: Currency exchange details where the bank gives them.
          properties:
            source_amount:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
            source_currency:
              type: string
              nullable: true
            rate:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
        balance_after:
          type: string
          description: Balance after the transaction where the bank gives it.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        category:
          type: string
          description: Didit's own category, when one applies.
          nullable: true
        first_seen_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - account_id
        - status
        - pending_id
        - reverses_id
        - booking_date
        - value_date
        - transaction_date
        - effective_date
        - amount
        - currency
        - direction
        - description
        - counterparty
        - remittance
        - bank_transaction_code
        - bank_reference
        - identity_quality
        - end_to_end_id
        - mandate_id
        - creditor_id
        - merchant_category_code
        - exchange
        - balance_after
        - category
        - first_seen_at
        - updated_at
    BankRemovedTransaction:
      type: object
      properties:
        id:
          type: string
          description: The id of the transaction that is no longer current.
          format: uuid
        reason:
          type: string
          enum:
            - pending_booked
            - pending_expired
            - bank_removed
            - access_removed
          description: >-
            `pending_booked`: the bank booked it, and the booked transaction is
            in `added`. `pending_expired`: a pending transaction the bank
            stopped reporting. `bank_removed`: the bank removed it.
            `access_removed`: the account left the consent.
      required:
        - id
        - reason
    RateLimitBudgetError:
      type: object
      description: >-
        Returned only for a rate-limit middleware budget refusal. Other 429
        errors, including idempotency conflicts and endpoint-specific caps, do
        not promise these metadata fields.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Existing human-readable budget refusal message.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Opaque support reference: RL- followed by 32 lowercase UUID
            hexadecimal characters.
        limit:
          type: integer
          description: Budget for the exceeded scope; equals X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Remaining budget, clamped to zero; equals X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Window reset time in Unix seconds; equals X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Fixed-window duration in seconds, not the remaining wait. Honor
            Retry-After before retrying.
      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
    BankTransactionCounterparty:
      type: object
      properties:
        name:
          type: string
          nullable: true
        iban:
          type: string
          nullable: true
        bic:
          type: string
          nullable: true
      required:
        - name
        - iban
        - bic
    BankTransactionRemittance:
      type: object
      properties:
        unstructured:
          type: array
          items:
            type: string
        structured:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
      required:
        - unstructured
        - structured
        - reference
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Invalid API Key
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        The API key does not carry the Bank data permission (`bank-data`), or,
        for raw bank data in a live application, the application setting "Bank
        data in the API" is off. Bank data is not part of full access: a
        full-access key, a key restricted to other resources and a request
        authenticated without an API key (client credentials, on raw data) are
        all refused with this body, so create a key and grant it explicitly. The
        refusal comes before any lookup, so it says nothing about whether an
        object exists.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Bank data not allowed
              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: Middleware read budget exceeded. Honor Retry-After before retrying.
      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: >-
        Something went wrong on Didit's side. Any unexpected error under
        `/v3/bank/` answers in the Bank error shape, never an HTML page: quote
        `request_id` to support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: An unexpected error
              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: >-
        Seconds to wait, rounded up to the next window. Present on middleware
        budget refusals.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        The scope whose budget was exceeded. Present on middleware budget
        refusals.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Budget for the exceeded scope; equals body limit. Present on middleware
        budget refusals.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Remaining budget, clamped to zero; equals body remaining. Present on
        middleware budget refusals.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Reset time in Unix seconds; equals body reset. Present on middleware
        budget refusals.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your application's API key, from Developers -> API keys in the Business
        Console. The primary key has full access. A named key can be scoped:
        none, read or write per resource, limited to some workflows or to
        approved sessions, to a list of IP addresses, and to an expiry date. 401
        means the key is wrong, revoked or expired; 403 means no key was sent,
        the key has no access to this resource or action, or the request came
        from an address outside its IP list; 404 on a session route means the
        session is outside the key's workflows or statuses. A key without media
        access receives image, video and PDF URLs as null, and a key without
        sessions write receives session links and tokens as null. See
        https://docs.didit.me/console/api-keys.

````

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