Langsung ke konten utama
GET
curl
Endpoint Get a Bank Connection dari Didit mengembalikan satu koneksi beserta statusnya, tanggal persetujuan, status sinkronisasi, ringkasan rekening, dan biayanya. sync.initial_status menunjukkan kapan data pertama dapat dibaca, consent.expires_at menunjukkan kapan Anda perlu memperbarui persetujuan, dan sync.budgets menunjukkan berapa kali penyegaran data masih diizinkan oleh bank. Lihat Koneksi.

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.

Parameter Path

id
string<uuid>
wajib

ID koneksi.

Respons

Koneksi.

Izin dari orang tersebut agar aplikasi Anda dapat membaca data satu bank. Perpanjangan mempertahankan ID koneksi dan semua ID akun. Koneksi yang dihapus hanya mengembalikan id, status, status_reason, created_at dan erasure. Semua kolom lain tidak ada, dan tidak ada data bank, orang, atau akun yang tersisa di dalamnya.

id
string<uuid>
wajib

ID koneksi.

status
enum<string>
wajib

pending: sinkronisasi pertama sedang berjalan. active: persetujuan berlaku. renewal_required: persetujuan berakhir atau bank meminta orang tersebut masuk kembali; data dapat dibaca sebagaimana terakhir disinkronkan dan tidak ada biaya. paused: saldo terlalu rendah untuk bulan tersebut. revoked: akses dihentikan oleh orang tersebut, bank, atau Anda. deleted: hanya id, status, status_reason, created_at dan erasure yang tersisa. failed: sinkronisasi pertama tidak pernah berhasil.

Opsi yang tersedia:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
wajib

Alasan koneksi berada dalam status ini. paused_by_customer dicadangkan. Pada koneksi deleted: deleted_by_customer, consent_lapsed, retention_elapsed atau application_deleted.

Opsi yang tersedia:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
wajib

Diisi setelah delete_connection; jika tidak, null.

created_at
string<date-time>
wajib
environment
enum<string>
Opsi yang tersedia:
live,
sandbox
access
enum<string>
Opsi yang tersedia:
one_time,
ongoing
institution
object

Bank untuk koneksi atau tautan tersebut.

segment
enum<string> | null
Opsi yang tersedia:
personal,
business,
null
data
enum<string>[]

Cakupan yang diterima orang tersebut.

Opsi yang tersedia:
accounts,
balances,
transactions

Persetujuan orang tersebut untuk koneksi ini.

sync
object

Status sinkronisasi sebuah koneksi.

accounts
object[]

Ringkasan setiap akun dalam koneksi. Baca akun lengkap dengan get_account.

ownership
object

Perbandingan opsional antara pemegang rekening dengan orang atau perusahaan.

end_user
object
manage_url
string<uri> | null

Halaman akses milik orang tersebut. Bernilai null sampai halaman akses tersedia.

billing
object

Berapa biaya koneksi ini. Sandbox tidak pernah dikenakan biaya.

possible_duplicate_of
string<uuid> | null

Diisi ketika koneksi ini mungkin menduplikasi koneksi aktif lain, tetapi tidak ada end_user.reference yang memungkinkan kecocokan tertentu.

vendor_data
string | null
updated_at
string<date-time>
Terakhir diubah pada 22 November 2026