Langsung ke konten utama
POST
curl
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 atau webhook bank.link.completed. Lihat panduan cepat dan Bank Link.

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

Body

application/json

Buat Tautan Bank. Permintaan terkecil adalah {} ditambah apa yang Anda inginkan: setiap kolom memiliki nilai default.

mode
enum<string>
default:connect

connect (default) membuat koneksi baru. renew memerlukan connection_id dan menggunakan ulang pengaturan koneksi tersebut.

Opsi yang tersedia:
connect,
renew
connection_id
string<uuid>

Koneksi yang akan diperbarui. Hanya dengan mode: renew.

access
enum<string>
default:one_time

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.

Opsi yang tersedia:
one_time,
ongoing
country
string

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
string

Bank opsional untuk dipilih terlebih dahulu, dari list_institutions. Melewati pemilih.

Maximum string length: 64
segment
enum<string>
default:any

Menyaring pemilih dan memberi tahu bank login mana yang harus dibuka jika bank memisahkan login. Default any.

Opsi yang tersedia:
personal,
business,
any
data
enum<string>[]

Apa yang akan dibaca. accounts selalu disertakan: nama, jenis, mata uang, pengidentifikasi, dan nama pemegang rekening jika dibagikan oleh bank. Default ["accounts"].

Maximum array length: 3
Opsi yang tersedia:
accounts,
balances,
transactions
history_days
integer
default:90

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.

Rentang yang diperlukan: 1 <= x <= 365
history_from
string<date>

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.

extended_history
enum<string>
default:standard

allow_extra_auth memungkinkan bank yang meminta konfirmasi tambahan membuka riwayat yang lebih lama.

Opsi yang tersedia:
standard,
allow_extra_auth

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.

Rentang yang diperlukan: 1 <= x <= 32767
ownership
object

Perbandingan opsional antara pemegang rekening dengan orang atau perusahaan.

end_user
object

Orang atau perusahaan yang menghubungkan rekening.

redirect_url
string<uri>

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.

Maximum string length: 2048
allowed_origins
string<uri>[]

Diterima tetapi belum digunakan saat ini: disediakan untuk Bank Link tertanam milik Didit, yang belum dirilis. Origin HTTPS, hingga 50.

Maximum array length: 50
language
string

Kode bahasa opsional seperti es atau pt-BR. Jika tidak diisi, digunakan bahasa peramban.

Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
vendor_data
string

Referensi Anda sendiri, dikembalikan pada tautan dan koneksi.

Maximum string length: 255
expires_in
integer
default:3600

Masa berlaku tautan dalam detik, 300 hingga 86400. Nilai default: 3600.

Rentang yang diperlukan: 300 <= x <= 86400
duplicates
enum<string>
default:reuse

reuse (default) menyelesaikan tautan yang mengarah ke akun yang sudah Anda bagikan sebagai pembaruan atas koneksi tersebut. allow membuat koneksi kedua yang independen.

Opsi yang tersedia:
reuse,
allow
allow_one_time_fallback
boolean
default:false

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.

accept_reduced_grant
boolean
default:false

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.

sandbox
object

Khusus aplikasi sandbox: memilih pelanggan Didit Test Bank. Diabaikan di aplikasi produksi.

Respons

Tautan dibuat.

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