> ## 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 Buat Bank Link: Hubungkan atau Perbarui Bank

> Endpoint Create a Bank Link Didit memulai satu run Bank Link di server Anda dan mengembalikan url halaman yang di-hosting untuk menghubungkan bank.

Endpoint Create a Bank Link dari Didit memulai satu proses Bank Link di server Anda untuk menghubungkan bank atau memperbarui koneksi, lalu mengembalikan `url` yang di-hosting.
Setiap kolom memiliki nilai default, sehingga permintaan paling sederhana adalah `{}` ditambah kolom yang Anda inginkan.
Simpan `id` yang dikembalikan terkait dengan pengguna Anda, dan konfirmasi hasilnya sendiri melalui [Ambil bank link](https://docs.didit.me/id/standalone-apis/bank-link-get.md) atau webhook `bank.link.completed`.
Lihat [panduan cepat](https://docs.didit.me/id/core-technology/bank-verification/quickstart.md) dan [Bank Link](https://docs.didit.me/id/core-technology/bank-verification/bank-link.md).


## OpenAPI

````yaml id/openapi-25.json POST /v3/bank/links/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, koneksi, akun, saldo, transaksi, institusi, dan cakupan. Data
      bank tersedia untuk aplikasi sandbox. Panggilan dari aplikasi produksi
      mengembalikan `404` hingga akses live diumumkan. Tidak ada biaya yang
      dikenakan di sandbox. Panggilan yang dibuat dengan kunci API memerlukan
      kunci yang memiliki izin Bank data (`bank-data`): baca untuk operasi baca,
      tulis untuk operasi yang mengubah sesuatu. Pemeriksaan akun adalah
      pengecualian: memerlukan akses tulis ke sesi, atau akses penuh, dan bukan
      izin Bank data. Bank data bukan bagian dari akses penuh: kunci akses penuh
      ditolak, dan panggilan menjawab `403 bank_data_access_denied` hingga Anda
      membuat kunci yang memiliki izin tersebut. Data bank mentah (akun, saldo,
      transaksi, dan umpan perubahan) juga menolak permintaan yang tidak
      menyertakan kunci API.


      Setiap penolakan di bawah `/v3/bank/` kecuali milik pemeriksaan akun
      memiliki badan JSON yang sama (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Jalur yang bukan operasi, ID yang bukan
      UUID, atau sub-resource yang tidak dikenal menjawab `404 not_found` untuk
      semua metode, dan kesalahan tak terduga apa pun menjawab `500
      internal_error` dengan `request_id`. Jika Bank data tidak tersedia, setiap
      operasi menjawab `404` standar platform, sama seperti rute yang tidak
      dikenal.
paths:
  /v3/bank/links/:
    post:
      tags:
        - Bank Data
      summary: Buat tautan bank
      description: >-
        Membuat Tautan Bank: satu kali menjalankan alur ketika seseorang
        menghubungkan bank, atau memperbarui koneksi. Arahkan orang tersebut ke
        `url`. `client_token` untuk Tautan Bank tertanam milik Didit, yang belum
        dirilis: buka `url` hari ini. Tautan yang selesai menghasilkan koneksi.


        Permintaan terkecil adalah `{}` ditambah apa yang Anda inginkan.
        Default: `mode` connect, `access` one_time, `data` accounts only,
        `history_days` 90, `ownership.compare` none, `segment` any, `duplicates`
        reuse, `allow_one_time_fallback` false, dan untuk akses berkelanjutan
        sebuah persetujuan selama yang diizinkan bank.


        Respons memuat kuotasi: harga dikunci pada tautan dan ditagihkan sesuai
        kuotasi. Kunci API tidak pernah sampai ke browser atau aplikasi: hanya
        `url` yang sampai.


        Konfirmasi hasilnya sendiri dengan `get_link` atau webhook
        `bank.link.completed`; jangan pernah memercayai id tautan yang dikirim
        browser. Riwayat: kirim `history_from` atau `history_days`, jangan
        keduanya. Jika bank mengizinkan, akses berkelanjutan tetap berfungsi
        hingga persetujuan berakhir; tanggal sebenarnya ada pada setiap koneksi.


        Memerlukan kunci API dengan izin Data bank (`bank-data`): izin tulis
        untuk operasi ini, yang mengubah sesuatu. Kunci dengan akses penuh tidak
        mencakupnya: berikan secara eksplisit saat Anda membuat kunci, atau
        panggilan akan mengembalikan respons `403 bank_data_access_denied`.
      operationId: createBankLink
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankLinkCreateRequest'
            example:
              mode: connect
              access: ongoing
              country: ESP
              segment: business
              data:
                - accounts
                - balances
                - transactions
              history_from: '2026-01-01'
              consent_days: 180
              ownership:
                compare: none
              end_user:
                reference: client-7731
                email: ana@example.com
              redirect_url: https://app.example.com/bank/return
              allowed_origins:
                - https://app.example.com
              language: es
              vendor_data: client-7731
      responses:
        '201':
          description: Tautan dibuat.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Ongoing business connection:
                  summary: Akses berkelanjutan untuk akun bisnis di Spanyol
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: created
                    url: https://verify.didit.me/bank/link/example-link-token
                    client_token: example-client-token
                    expires_at: '2026-11-21T13:00:00Z'
                    connection_id: null
                    check_id: null
                    reused: false
                    error: null
                    quote:
                      id: 7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43
                      lines:
                        - meter: bank_data_connection_month
                          unit: connection_month
                          price_usd: '0.9000'
                      fallback_lines: null
                      total_usd: '0.9000'
                      valid_until: '2026-11-21T13:00:00Z'
                      scopes:
                        - accounts
                        - balances
                        - transactions
                    vendor_data: client-7731
        '400':
          description: >-
            Permintaan ditolak sebelum layar apa pun ditampilkan. `field`
            menunjukkan apa yang perlu diperbaiki: `invalid_request` untuk nilai
            di luar rentangnya atau kombinasi yang tidak diizinkan, serta kode
            yang lebih spesifik seperti yang ditampilkan di sini.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Bank cannot keep access open:
                  summary: Bank tidak dapat mempertahankan akses tetap terbuka
                  value:
                    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
                History window ambiguous:
                  summary: Rentang riwayat ambigu
                  value:
                    code: history_window_ambiguous
                    message: Send history_from or history_days, not both.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: history_from
                    next_action: null
                    retry_after: null
                Redirect URL not registered:
                  summary: URL pengalihan tidak terdaftar
                  value:
                    code: redirect_url_not_registered
                    message: >-
                      This redirect_url is not one of the return addresses
                      registered for your application. Addresses are matched
                      exactly (scheme, host, port, path and query); in sandbox a
                      plain http localhost address needs no registration. Send a
                      registered address, or leave redirect_url out (automatic
                      return to your page is then not promised).
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: redirect_url
                    next_action: null
                    retry_after: null
                Segment not available:
                  summary: Segmen tidak tersedia
                  value:
                    code: segment_not_available
                    message: >-
                      This bank does not offer this kind of account through Bank
                      Link.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: segment
                    next_action: null
                    retry_after: null
                Window not available:
                  summary: Jendela tidak tersedia
                  value:
                    code: window_not_available
                    message: This bank cannot deliver the requested history window.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: history_from
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Permintaan tidak valid
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: expires_in
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: >-
            Saldo tidak cukup untuk menutupi harga yang ditawarkan. Isi saldo,
            lalu coba lagi.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Insufficient credits:
                  summary: Kredit tidak mencukupi
                  value:
                    code: insufficient_credits
                    message: The balance cannot cover the quoted price.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: top_up_balance
                    retry_after: null
        '403':
          description: >-
            Ditolak: kontrak Anda tidak memiliki tarif untuk negara ini, atau
            kunci tidak memiliki izin Bank data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                No contract rate:
                  summary: Tidak ada tarif kontrak
                  value:
                    code: contract_rate_missing
                    message: Your contract has no rate for bank data in this country.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
                Bank data not allowed:
                  summary: Data bank tidak diizinkan
                  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
        '404':
          description: Sumber daya tidak ada dalam aplikasi dan lingkungan ini.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Tidak ditemukan
                  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
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl -X POST 'https://verification.didit.me/v3/bank/links/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{
                "mode": "connect",
                "access": "ongoing",
                "country": "ESP",
                "segment": "business",
                "data": [
                  "accounts",
                  "balances",
                  "transactions"
                ],
                "history_from": "2026-01-01",
                "consent_days": 180,
                "ownership": {
                  "compare": "none"
                },
                "end_user": {
                  "reference": "client-7731",
                  "email": "ana@example.com"
                },
                "redirect_url": "https://app.example.com/bank/return",
                "allowed_origins": [
                  "https://app.example.com"
                ],
                "language": "es",
                "vendor_data": "client-7731"
              }'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.create_link(
                mode="connect",
                access="ongoing",
                country="ESP",
                segment="business",
                data=["accounts", "balances", "transactions"],
                history_from="2026-01-01",
                consent_days=180,
                ownership={
                    "compare": "none",
                },
                end_user={
                    "reference": "client-7731",
                    "email": "ana@example.com",
                },
                redirect_url="https://app.example.com/bank/return",
                allowed_origins=["https://app.example.com"],
                language="es",
                vendor_data="client-7731",
            )
            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.createLink({
              mode: "connect",
              access: "ongoing",
              country: "ESP",
              segment: "business",
              data: ["accounts", "balances", "transactions"],
              history_from: "2026-01-01",
              consent_days: 180,
              ownership: {
                compare: "none",
              },
              end_user: {
                reference: "client-7731",
                email: "ana@example.com",
              },
              redirect_url: "https://app.example.com/bank/return",
              allowed_origins: ["https://app.example.com"],
              language: "es",
              vendor_data: "client-7731",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{\n\tBody: didit.BankLinkCreateRequest{\n\t\tMode:        didit.Some(didit.BankLinkCreateRequestMode(\"connect\")),\n\t\tAccess:      didit.Some(didit.BankLinkCreateRequestAccess(\"ongoing\")),\n\t\tCountry:     didit.String(\"ESP\"),\n\t\tSegment:     didit.Some(didit.BankLinkCreateRequestSegment(\"business\")),\n\t\tData:        didit.Some([]didit.BankLinkCreateRequestData{\"accounts\", \"balances\", \"transactions\"}),\n\t\tHistoryFrom: didit.String(\"2026-01-01\"),\n\t\tConsentDays: didit.Int(180),\n\t\tOwnership: didit.Some(didit.BankLinkOwnershipRequest{\n\t\t\tCompare: didit.Some(didit.BankLinkOwnershipRequestCompare(\"none\")),\n\t\t}),\n\t\tEndUser: didit.Some(didit.BankLinkEndUser{\n\t\t\tReference: didit.String(\"client-7731\"),\n\t\t\tEmail:     didit.String(\"ana@example.com\"),\n\t\t}),\n\t\tRedirectURL:    didit.String(\"https://app.example.com/bank/return\"),\n\t\tAllowedOrigins: didit.Some([]string{\"https://app.example.com\"}),\n\t\tLanguage:       didit.String(\"es\"),\n\t\tVendorData:     didit.String(\"client-7731\"),\n\t},\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.time.LocalDate;

            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.BankLinkCreateRequest;

            import me.didit.types.BankLinkEndUser;

            import me.didit.types.BankLinkOwnershipRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().createLink(BankLinkCreateRequest.builder()
                    .mode(BankLinkCreateRequest.Mode.of("connect"))
                    .access(BankLinkCreateRequest.Access.of("ongoing"))
                    .country("ESP")
                    .segment(BankLinkCreateRequest.Segment.of("business"))
                    .data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
                    .historyFrom(LocalDate.parse("2026-01-01"))
                    .consentDays(180L)
                    .ownership(BankLinkOwnershipRequest.builder()
                            .compare(BankLinkOwnershipRequest.Compare.of("none"))
                            .build())
                    .endUser(BankLinkEndUser.builder()
                            .reference("client-7731")
                            .email("ana@example.com")
                            .build())
                    .redirectUrl("https://app.example.com/bank/return")
                    .allowedOrigins(List.of("https://app.example.com"))
                    .language("es")
                    .vendorData("client-7731")
                    .build());
            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->createLink([
                'mode' => 'connect',
                'access' => 'ongoing',
                'country' => 'ESP',
                'segment' => 'business',
                'data' => ['accounts', 'balances', 'transactions'],
                'history_from' => '2026-01-01',
                'consent_days' => 180,
                'ownership' => [
                    'compare' => 'none',
                ],
                'end_user' => [
                    'reference' => 'client-7731',
                    'email' => 'ana@example.com',
                ],
                'redirect_url' => 'https://app.example.com/bank/return',
                'allowed_origins' => ['https://app.example.com'],
                'language' => 'es',
                'vendor_data' => 'client-7731',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.create_link(
              mode: "connect",
              access: "ongoing",
              country: "ESP",
              segment: "business",
              data: ["accounts", "balances", "transactions"],
              history_from: "2026-01-01",
              consent_days: 180,
              ownership: {
                compare: "none",
              },
              end_user: {
                reference: "client-7731",
                email: "ana@example.com",
              },
              redirect_url: "https://app.example.com/bank/return",
              allowed_origins: ["https://app.example.com"],
              language: "es",
              vendor_data: "client-7731"
            )
            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.CreateLinkAsync(new
            BankLinkCreateRequest

            {
                Mode = new BankLinkCreateRequestMode("connect"),
                Access = new BankLinkCreateRequestAccess("ongoing"),
                Country = "ESP",
                Segment = new BankLinkCreateRequestSegment("business"),
                Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
                HistoryFrom = "2026-01-01",
                ConsentDays = 180,
                Ownership = new BankLinkOwnershipRequest
                {
                    Compare = new BankLinkOwnershipRequestCompare("none"),
                },
                EndUser = new BankLinkEndUser
                {
                    Reference = "client-7731",
                    Email = "ana@example.com",
                },
                RedirectUrl = "https://app.example.com/bank/return",
                AllowedOrigins = new string[] { "https://app.example.com" },
                Language = "es",
                VendorData = "client-7731",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Kunci opsional untuk keamanan saat mencoba lagi yang Anda pilih untuk
        satu operasi, hingga 255 karakter (UUID juga dapat digunakan).
        Permintaan yang diulang dengan kunci, endpoint, query, dan body yang
        sama akan dijawab dengan respons pertama, dengan status dan body yang
        sama, dan tidak dijalankan dan tidak ditagih lagi. Kunci yang sama
        dengan endpoint, query, atau body lain akan mengembalikan `409`
        `idempotency_key_reused`, dan selama permintaan pertama masih berjalan,
        akan mengembalikan `409` `idempotency_key_in_progress` dengan
        `Retry-After`. Permintaan yang gagal (`4xx` atau `5xx` apa pun) tidak
        disimpan, sehingga Anda dapat mengirimkannya lagi dengan kunci yang
        sama. Kunci menjadi milik aplikasi Anda, baik Anda memanggil dengan
        kunci API maupun dengan token akses. Lihat [Coba lagi dan
        idempotensi](/id/integration/api-errors#coba-lagi-dan-idempotensi).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankLinkCreateRequest:
      type: object
      description: >-
        Buat Tautan Bank. Permintaan terkecil adalah `{}` ditambah apa yang Anda
        inginkan: setiap kolom memiliki nilai default.
      properties:
        mode:
          type: string
          enum:
            - connect
            - renew
          description: >-
            `connect` (default) membuat koneksi baru. `renew` memerlukan
            `connection_id` dan menggunakan ulang pengaturan koneksi tersebut.
          default: connect
        connection_id:
          type: string
          description: 'Koneksi yang akan diperbarui. Hanya dengan `mode: renew`.'
          format: uuid
        access:
          type: string
          enum:
            - one_time
            - ongoing
          description: >-
            `one_time` (default) membaca data sekali. `ongoing` menjaga akses
            tetap terbuka hingga persetujuan berakhir atau seseorang
            menghentikannya. Dengan `institution_id` diisi, bank yang tidak
            dapat mempertahankan akses terbuka merespons `400
            ongoing_access_not_available` sebelum menampilkan layar apa pun.
            Tanpa itu, pemilih bank hanya mencantumkan bank yang dapat.
          default: one_time
        country:
          type: string
          description: >-
            Opsional. Tanpa ini, orang tersebut memilih di antara negara yang
            diaktifkan oleh aplikasi Anda. Harus berupa negara yang dilayani
            Bank Link; negara lain, termasuk `ZZZ`, menghasilkan `400
            invalid_request` dengan `field: country`. Badan permintaan yang
            kosong tetap valid.
          pattern: ^[A-Z]{3}$
        institution_id:
          type: string
          description: >-
            Bank opsional untuk dipilih terlebih dahulu, dari
            `list_institutions`. Melewati pemilih.
          maxLength: 64
        segment:
          type: string
          enum:
            - personal
            - business
            - any
          description: >-
            Menyaring pemilih dan memberi tahu bank login mana yang harus dibuka
            jika bank memisahkan login. Default `any`.
          default: any
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: >-
            Apa yang akan dibaca. `accounts` selalu disertakan: nama, jenis,
            mata uang, pengidentifikasi, dan nama pemegang rekening jika
            dibagikan oleh bank. Default `["accounts"]`.
          default:
            - accounts
          maxItems: 3
        history_days:
          type: integer
          description: >-
            Jumlah hari riwayat transaksi yang diminta, 1 sampai 365, default
            90. Bank mungkin mengirimkan lebih sedikit: setiap akun melaporkan
            apa yang berhasil dikirimkannya di `history_coverage`. Tidak dapat
            dikirim bersama `history_from`.
          minimum: 1
          maximum: 365
          default: 90
        history_from:
          type: string
          description: >-
            Tanggal mulai riwayat yang diminta, sebagai pengganti
            `history_days`. Tidak dapat dikirim bersama `history_days`: keduanya
            sekaligus dijawab dengan `400 history_window_ambiguous`. Tanggal
            yang lebih dari 365 hari lalu, atau tanggal di masa depan, dijawab
            dengan `400 window_not_available`.
          format: date
        extended_history:
          type: string
          enum:
            - standard
            - allow_extra_auth
          description: >-
            `allow_extra_auth` memungkinkan bank yang meminta konfirmasi
            tambahan membuka riwayat yang lebih lama.
          default: standard
        consent_days:
          type: integer
          description: >-
            Hanya untuk ongoing. Berapa hari meminta bank agar akses tetap
            terbuka, 1 atau lebih. Default: periode terpanjang yang diizinkan
            bank. Koneksi melaporkan tanggal yang benar-benar diberikan bank di
            `consent.expires_at`. Dengan `access: one_time`, respons adalah `400
            invalid_request` dengan `field: consent_days`.
          minimum: 1
          maximum: 32767
        ownership:
          $ref: '#/components/schemas/BankLinkOwnershipRequest'
        end_user:
          $ref: '#/components/schemas/BankLinkEndUser'
        redirect_url:
          type: string
          description: >-
            Ke mana browser diarahkan di akhir, dengan `link_id`, `status`, dan
            `state` yang ditandatangani (hanya untuk ditampilkan: webhook dan
            `get_link` adalah sumber yang otoritatif). Dalam aplikasi sandbox,
            alamat `http` biasa berupa `localhost`, `127.0.0.1` atau `[::1]`
            (port dan path apa pun, tanpa kredensial, tanpa fragmen) tidak
            memerlukan pendaftaran. Alamat lain akan menjawab `400
            redirect_url_not_registered`: pendaftaran alamat lain belum
            tersedia. Tanpa `redirect_url`, orang tersebut menyelesaikan proses
            di halaman hasil milik Didit sendiri.
          format: uri
          maxLength: 2048
        allowed_origins:
          type: array
          items:
            type: string
            format: uri
          description: >-
            Diterima tetapi belum digunakan saat ini: disediakan untuk Bank Link
            tertanam milik Didit, yang belum dirilis. Origin HTTPS, hingga 50.
          maxItems: 50
        language:
          type: string
          description: >-
            Kode bahasa opsional seperti `es` atau `pt-BR`. Jika tidak diisi,
            digunakan bahasa peramban.
          pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
          maxLength: 16
        vendor_data:
          type: string
          description: Referensi Anda sendiri, dikembalikan pada tautan dan koneksi.
          maxLength: 255
        expires_in:
          type: integer
          description: >-
            Masa berlaku tautan dalam detik, 300 hingga 86400. Nilai default:
            3600.
          minimum: 300
          maximum: 86400
          default: 3600
        duplicates:
          type: string
          enum:
            - reuse
            - allow
          description: >-
            `reuse` (default) menyelesaikan tautan yang mengarah ke akun yang
            sudah Anda bagikan sebagai pembaruan atas koneksi tersebut. `allow`
            membuat koneksi kedua yang independen.
          default: reuse
        allow_one_time_fallback:
          type: boolean
          description: >-
            Dengan `ongoing`, memungkinkan orang tersebut melanjutkan dengan
            pembacaan sekali di bank yang tidak dapat mempertahankan akses
            terbuka, setelah mengonfirmasi akses yang berkurang di layar bank.
            Penawaran harga menunjukkan biayanya. Hanya dengan `access:
            ongoing`: dengan akses sekali baca, responsnya `400 invalid_request`
            dengan `field: allow_one_time_fallback`.
          default: false
        accept_reduced_grant:
          type: boolean
          description: >-
            Jika bank atau orang tersebut memberikan izin lebih sedikit daripada
            yang Anda minta, selesaikan tautan dan hanya tagih cakupan yang
            diberikan. Jika tidak, tautan berakhir `failed` dengan
            `reduced_grant` dan tidak ada yang ditagih.
          default: false
        sandbox:
          type: object
          description: >-
            Khusus aplikasi sandbox: memilih pelanggan Didit Test Bank.
            Diabaikan di aplikasi produksi.
          properties:
            persona:
              type: string
              enum:
                - personal_basic
                - business_multi
                - long_history
                - pending
                - sparse_fields
                - no_ongoing
              description: >-
                Nasabah Test Bank: `personal_basic` (satu rekening giro, 60
                mutasi), `business_multi` (tiga rekening yang dimiliki sebuah
                perusahaan), `long_history` (satu rekening dengan 400 hari dan
                1,400 mutasi; pembacaan mengembalikan 365 hari terakhir, jadi
                atur `history_days` ke 365), `pending` (menyertakan transaksi
                yang tertunda), `sparse_fields` (tanpa tanggal valuta, tanpa
                IBAN pihak lawan, tanpa referensi bank) atau `no_ongoing` (bank
                yang hanya mengizinkan akses satu kali: gunakan
                `allow_one_time_fallback`).
            switches:
              type: array
              items:
                type: string
                enum:
                  - partial_grant
                  - renewal_other_login
                  - expired_cursor
                  - webhook_twice
                  - midnight_booking
                  - blocked_popup
                  - bank_app_return
              description: >-
                Diterima dan disediakan untuk simulator sandbox: nilainya tidak
                mengubah apa pun saat ini.
    BankLink:
      type: object
      description: >-
        Satu proses Bank Link untuk satu pengguna: menghubungkan bank, atau
        memperbarui koneksi. Konfirmasi tautan sendiri dengan `get_link`: jangan
        pernah percaya pada id yang dikirim browser.
      properties:
        id:
          type: string
          description: ID tautan.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            Status tautan. `completed`, `cancelled`, `expired`, dan `failed`
            bersifat final.
        url:
          type: string
          description: >-
            Halaman yang di-hosting tempat orang tersebut akan diarahkan. Hanya
            dikembalikan saat tautan dibuat; `null` pada pembacaan berikutnya,
            karena token tidak disimpan.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            Token untuk Bank Link tersemat milik Didit, yang belum dirilis: buka
            `url` sekarang. Hanya dikembalikan saat tautan dibuat. Bernilai
            `null` pada pembacaan berikutnya. Token ini hanya untuk satu tujuan
            dan berumur pendek. Tidak memuat data pribadi. Jangan pernah dicatat
            dalam log.
          nullable: true
        expires_at:
          type: string
          description: Kapan tautan yang belum ditukarkan berhenti berfungsi.
          format: date-time
        connection_id:
          type: string
          description: >-
            Koneksi yang dibuat atau diperbarui oleh tautan ini, setelah
            `status` bernilai `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            Hasil kepemilikan dari tautan ini, jika meminta `ownership.compare`
            selain `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `true` ketika tautan selesai sebagai pembaruan koneksi yang sudah
            ada karena orang tersebut sudah membagikan akun yang persis sama
            (`duplicates: reuse`). Tidak ada biaya yang ditagih dua kali.
        error:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Alasan tautan gagal, saat `status` bernilai `failed`. Jika tidak,
            `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: Referensi Anda dari permintaan.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    BankDataError:
      type: object
      description: Isi kesalahan dari setiap operasi Bank data. Setiap kolom selalu ada.
      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: >-
            Kode error yang dapat dibaca mesin. Tentukan percabangan berdasarkan
            kode ini, jangan berdasarkan `message`.
        message:
          type: string
          description: >-
            Penjelasan dalam bahasa sederhana untuk pengembang. Redaksinya dapat
            berubah; jangan diurai.
        request_id:
          type: string
          description: ID permintaan ini. Sertakan ID ini saat menghubungi dukungan.
        field:
          type: string
          description: >-
            Kolom permintaan yang perlu diperbaiki, jika error berkaitan dengan
            satu kolom. Jika tidak, bernilai `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: >-
            Apa langkah berikutnya, agar klien dapat bertindak tanpa menebak.
            `null` jika tidak ada langkah berikutnya yang standar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Detik untuk menunggu sebelum mencoba lagi. Diisi pada error batas
            laju dan error sementara; jika tidak, `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
    BankLinkOwnershipRequest:
      type: object
      description: >-
        Perbandingan opsional antara pemegang rekening dengan orang atau
        perusahaan.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
          description: >-
            Apa yang dibandingkan dengan pemilik rekening. `none` (default)
            tidak memberikan hasil dan tidak memerlukan referensi. `person`
            memerlukan `reference_identity` atau `session_id`. `business`
            memerlukan `business` atau `business_session_id`. Kirim tepat satu
            referensi dari jenis yang ingin Anda bandingkan, dan tidak ada
            referensi jika menggunakan `none`.
          default: none
        match:
          type: string
          enum:
            - any_holder
            - all_holders
          description: >-
            Apakah satu pemegang hak hukum atau setiap pemegang hak hukum harus
            cocok. Perwakilan tidak pernah dihitung.
          default: any_holder
        reference_identity:
          type: object
          description: >-
            Nilai yang Anda kirimkan untuk dibandingkan dengan pemegang
            rekening. Tidak dapat dikirim bersama `session_id`.
          properties:
            full_name:
              type: string
              maxLength: 255
            date_of_birth:
              type: string
              format: date
            address:
              type: string
              maxLength: 500
            phone:
              type: string
              maxLength: 64
            email:
              type: string
              maxLength: 255
        session_id:
          type: string
          description: >-
            Sesi verifikasi Didit yang telah selesai dari orang yang akan
            dibandingkan. Tidak dapat dikirim bersama `reference_identity`.
          format: uuid
        business:
          type: object
          description: Perusahaan yang akan dibandingkan dengan pemegang rekening.
          properties:
            legal_name:
              type: string
              maxLength: 255
            registration_id:
              type: string
              maxLength: 128
          required:
            - legal_name
        business_session_id:
          type: string
          description: >-
            Verifikasi bisnis Didit sebagai pembanding. Tidak dapat dikirim
            bersama `business`.
          format: uuid
    BankLinkEndUser:
      type: object
      description: Orang atau perusahaan yang menghubungkan rekening.
      properties:
        reference:
          type: string
          description: >-
            Id Anda sendiri untuk orang atau perusahaan. Dapat dicari dengan
            `end_user_reference`, dan digunakan untuk mengenali koneksi
            berulang.
          maxLength: 255
        email:
          type: string
          description: >-
            Opsional. Jika rute bank memerlukan alamat terverifikasi untuk orang
            tersebut dan Anda tidak mengirimkannya, Bank Link akan memintanya
            kepada orang tersebut. Tidak pernah digunakan untuk pemasaran.
          format: email
          maxLength: 254
    BankLinkError:
      type: object
      description: >-
        Alasan tautan berakhir dengan status `failed`. Tidak ada yang
        dipublikasikan atau ditagih.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            Alasan tautan gagal. Tautan yang gagal bukan kesalahan HTTP: tautan
            memiliki `status: failed` dan objek ini. Tautan perpanjangan yang
            koneksinya berubah sementara itu bernilai `renewal_not_needed` atau
            `renewal_window_expired`.
        message:
          type: string
          description: Penjelasan dalam bahasa sederhana untuk pengembang.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Dengan `duplicate_conflict`: id koneksi aktif yang tumpang tindih.
            Perpanjang salah satunya, atau buat tautan lagi dengan `duplicates:
            allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        Harga tautan, yang dikunci saat tautan dibuat. Tagihan yang dikenakan
        mengikuti penawaran harga. Pembacaan tidak pernah ditagih.
      properties:
        id:
          type: string
          description: ID penawaran.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: Baris yang ditagihkan oleh tautan ini, untuk cakupan yang diminta.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            Biaya yang akan dikenakan untuk pembacaan sekali pakai, hanya jika
            tautan dibuat dengan `allow_one_time_fallback`. Nilai ini
            ditampilkan pada respons pembuatan dan bernilai `null` jika tidak.
            Pembacaan sekali pakai dengan data bisa lebih mahal daripada biaya
            akses berkelanjutan untuk satu bulan pertama.
        total_usd:
          type: string
          description: >-
            Total `lines` dalam USD. Total hanya bisa turun: dengan hibah yang
            dikurangi, atau saat orang tersebut memilih negara dengan harga
            lebih rendah.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            Penawaran harga dikunci ke tautan dan berlaku selama masa berlaku
            tautan, sehingga sama dengan `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Cakupan data menentukan harga penawaran.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    RateLimitBudgetError:
      type: object
      description: >-
        Hanya dikembalikan untuk penolakan anggaran batas laju middleware.
        Kesalahan 429 lainnya, termasuk konflik idempotensi dan batas khusus
        endpoint, tidak menjamin bidang metadata ini.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Pesan penolakan anggaran yang sudah ada dan mudah dibaca manusia.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referensi dukungan (tidak transparan): RL- diikuti 32 karakter
            heksadesimal UUID huruf kecil.
        limit:
          type: integer
          description: >-
            Anggaran untuk cakupan yang terlampaui; sama dengan
            X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Sisa anggaran, dibatasi hingga nol; sama dengan
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Waktu reset jendela dalam detik Unix; sama dengan X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durasi jendela tetap dalam detik, bukan sisa waktu tunggu. Patuhi
            Retry-After sebelum mencoba lagi.
      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
    BankLinkQuoteLine:
      type: object
      description: Satu baris harga dalam sebuah penawaran.
      properties:
        meter:
          type: string
          description: >-
            Apa yang ditagih, misalnya `bank_data_connection_month`,
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            Apa yang dimaksud dengan satu unit, misalnya `connection_month` atau
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            Harga satu unit dalam USD, string desimal dengan 4 desimal. Jumlah
            dalam contoh bersifat ilustratif; harga untuk suatu negara
            ditampilkan di halaman harga.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  responses:
    Unauthorized:
      description: Tidak diotorisasi
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Kunci API Tidak Valid
              value:
                detail: Invalid API Key.
    RateLimitedWrite:
      description: >-
        Batas tulis bersama sebesar 300 permintaan per menit per kunci API telah
        terlampaui. Patuhi `Retry-After` sebelum mencoba lagi.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          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
      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'
    BankDataInternalError:
      description: >-
        Terjadi kesalahan di sisi Didit. Setiap error tak terduga di bawah
        `/v3/bank/` dijawab dalam format error Bank, tidak pernah berupa halaman
        HTML: sebutkan `request_id` saat menghubungi dukungan.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Kesalahan tak terduga
              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: >-
        Detik untuk menunggu, dibulatkan ke atas ke jendela berikutnya. Tersedia
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Cakupan yang anggarannya terlampaui. Tersedia pada penolakan anggaran
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Anggaran untuk cakupan yang terlampaui; sama dengan batas pada body.
        Hadir pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Sisa anggaran, dibatasi hingga nol; sama dengan remaining pada body. Ada
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Waktu reset dalam detik Unix; sama dengan reset di body. Tersedia pada
        penolakan anggaran middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat dibatasi:
        tanpa akses, baca, atau tulis per sumber daya, dibatasi untuk beberapa
        alur kerja atau untuk sesi yang disetujui, ke daftar alamat IP tertentu,
        dan ke tanggal kedaluwarsa. 401 berarti kunci salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirim, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan berasal
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status yang diizinkan untuk kunci
        tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF
        sebagai null, dan kunci tanpa akses tulis sesi menerima tautan dan token
        sesi sebagai null. Lihat https://docs.didit.me/console/api-keys.

````

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