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

# Batalkan Bank Link API: Hentikan Tautan yang Belum Selesai

> Endpoint Batalkan Bank Link dari Didit mengakhiri tautan yang belum diselesaikan pengguna, sehingga url dan token-nya tidak lagi berfungsi.

Endpoint Cancel a Bank Link dari Didit mengakhiri tautan bank yang belum diselesaikan oleh pengguna, sehingga `url` dan token-nya tidak bisa digunakan lagi.
Gunakan endpoint ini saat pengguna Anda meninggalkan alur, atau saat Anda membuat tautan baru untuk pengguna yang sama.
Membatalkan tautan yang sudah selesai tidak mengubah apa pun dan membalas `200` dengan tautan tetap seperti semula: untuk menghentikan akses, gunakan [cabut](https://docs.didit.me/id/standalone-apis/bank-connection-revoke.md) sebagai gantinya.


## OpenAPI

````yaml id/openapi-25.json POST /v3/bank/links/{id}/cancel/
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/{id}/cancel/:
    post:
      tags:
        - Bank Data
      summary: Batalkan tautan bank
      description: >-
        Membatalkan tautan yang belum selesai; URL dan token-nya berhenti
        berfungsi. Membatalkan tautan yang sudah dibatalkan, kedaluwarsa, gagal,
        atau selesai akan mengembalikan respons `200` dengan tautan tersebut
        tanpa perubahan, sehingga aman untuk diulang. Tautan yang sudah selesai
        tetap mempertahankan koneksinya.
      operationId: cancelBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Id tautan.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: >-
            Tautan, yang kini berstatus `cancelled`, atau tidak berubah jika
            sudah final.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Cancelled:
                  summary: Tautan yang dibatalkan
                  value:
                    id: 0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40
                    mode: connect
                    access: ongoing
                    status: cancelled
                    url: null
                    client_token: null
                    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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '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/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/cancel/'
            \
              -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.cancel_link(
                "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.cancelLink("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.CancelLink(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankCancelLinkParams{})\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().cancelLink("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->cancelLink('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.cancel_link("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.CancelLinkAsync("11111111-2222-3333-4444-555555555555");

            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:
    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
    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.
    BankDataAccessDenied:
      description: >-
        Kunci API tidak memiliki izin Bank data (`bank-data`), atau, untuk data
        bank mentah di aplikasi live, pengaturan aplikasi "Bank data in the API"
        dinonaktifkan. Data bank bukan bagian dari akses penuh: kunci akses
        penuh, kunci yang dibatasi pada sumber daya lain, dan permintaan yang
        diautentikasi tanpa kunci API (client credentials, untuk data mentah)
        semuanya ditolak dengan isi respons ini, jadi buat kunci dan berikan
        izin secara eksplisit. Penolakan terjadi sebelum pencarian apa pun,
        sehingga tidak memberi tahu apakah objek itu ada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            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
    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.