Langsung ke konten utama
POST
curl
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 sebagai gantinya.

Otorisasi

x-api-key
string
header
wajib

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.

Header

Idempotency-Key
string

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.

Required string length: 1 - 255

Parameter Path

id
string<uuid>
wajib

Id tautan.

Respons

Tautan, yang kini berstatus cancelled, atau tidak berubah jika sudah final.

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.

id
string<uuid>
wajib

ID tautan.

mode
enum<string>
wajib
Opsi yang tersedia:
connect,
renew
access
enum<string>
wajib
Opsi yang tersedia:
one_time,
ongoing
status
enum<string>
wajib

Status tautan. completed, cancelled, expired, dan failed bersifat final.

Opsi yang tersedia:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
wajib

Halaman yang di-hosting tempat orang tersebut akan diarahkan. Hanya dikembalikan saat tautan dibuat; null pada pembacaan berikutnya, karena token tidak disimpan.

client_token
string | null
wajib

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.

expires_at
string<date-time>
wajib

Kapan tautan yang belum ditukarkan berhenti berfungsi.

connection_id
string<uuid> | null
wajib

Koneksi yang dibuat atau diperbarui oleh tautan ini, setelah status bernilai completed.

check_id
string<uuid> | null
wajib

Hasil kepemilikan dari tautan ini, jika meminta ownership.compare selain none.

reused
boolean
wajib

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
object | null
wajib

Alasan tautan gagal, saat status bernilai failed. Jika tidak, null.

quote
object
wajib

Harga tautan, yang dikunci saat tautan dibuat. Tagihan yang dikenakan mengikuti penawaran harga. Pembacaan tidak pernah ditagih.

vendor_data
string | null
wajib

Referensi Anda dari permintaan.

Terakhir diubah pada 22 November 2026