メインコンテンツへスキップ
POST
curl
Didit の銀行接続取り消しエンドポイントは、銀行へのアクセスを停止し、銀行からのデータ取得はリクエストした時点で止まります。 取り消しではデータは削除されません。削除するには削除を使用してください。 同意の状態は、銀行が確認するまではrevocation_pendingと表示され、確認後はrevokedに変わります。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business Console の Developers -> API keys から取得できます。プライマリーキーはすべてのアクセス権を持ちます。名前付きキーは範囲を制限できます。リソースごとに none、read、write を指定でき、一部のワークフローや承認済みセッションに限定できます。IPアドレスのリストや有効期限も設定できます。401 はキーが誤っている、取り消されている、または期限切れであることを意味します。403 はキーが送信されていない、そのリソースまたはアクションへのアクセス権がない、またはリクエストがIPリストに含まれないアドレスから送信されたことを意味します。セッションのルートでの404 は、セッションがキーのワークフローまたはステータスの範囲外にあることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLが null で返されます。セッションの書き込み権限がないキーでは、セッションリンクとトークンが null で返されます。詳しくは https://docs.didit.me/console/api-keys を参照してください。

ヘッダー

Idempotency-Key
string

1回の操作に対して任意で指定する、再試行の安全性を確保するためのキーです。255文字まで指定でき、UUIDも使用できます。同じキー、エンドポイント、クエリ、ボディで繰り返されたリクエストには、最初のレスポンスが同じステータスと同じボディで返され、2回目は実行も課金も行われません。同じキーを別のエンドポイント、クエリ、ボディで使うと 409 idempotency_key_reused が返されます。最初のリクエストがまだ処理中の場合は、Retry-After 付きの 409 idempotency_key_in_progress が返されます。失敗したリクエスト(4xx または 5xx)は保存されないため、同じキーで再送できます。キーは、APIキーとアクセストークンのどちらで呼び出す場合でも、お使いのアプリケーションに属します。詳しくは 再試行と冪等性 を参照してください。

Required string length: 1 - 255

パスパラメータ

id
string<uuid>
必須

接続ID。

レスポンス

取り消しステータスを含む接続。

あなたのアプリケーションが1つの銀行を読み取るための本人の権限です。更新しても接続IDとすべてのアカウントIDは維持されます。削除された接続では、id、status、status_reason、created_at、erasureのみが返されます。それ以外のフィールドは存在せず、銀行、本人、アカウントのデータは一切残りません。

id
string<uuid>
必須

接続の識別子。

status
enum<string>
必須

pending: 初回の同期が実行中です。active: 同意は有効です。renewal_required: 同意が終了したか、銀行が本人に再サインインを求めています。データは最後の同期時点のまま読み取り可能で、課金は発生しません。paused: 今月の残高が不足しています。revoked: 本人、銀行、またはあなたによりアクセスが停止されました。deleted: id、status、status_reason、created_at、erasure のみが残ります。failed: 初回の同期が一度も成功していません。

利用可能なオプション:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
必須

接続がこのステータスになっている理由。paused_by_customer は予約済みです。deleted の接続の場合: deleted_by_customer、consent_lapsed、retention_elapsed、application_deleted。

利用可能なオプション:
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
必須

delete_connection の後に設定されます。それ以外の場合は null です。

created_at
string<date-time>
必須
environment
enum<string>
利用可能なオプション:
live,
sandbox
access
enum<string>
利用可能なオプション:
one_time,
ongoing
institution
object

接続またはリンクの対象となる銀行。

segment
enum<string> | null
利用可能なオプション:
personal,
business,
null
data
enum<string>[]

本人が承諾したスコープ。

利用可能なオプション:
accounts,
balances,
transactions

この接続に対する本人の同意。

sync
object

接続の同期状態です。

accounts
object[]

接続内のすべてのアカウントの概要です。アカウントの詳細は get_account で取得してください。

ownership
object

口座名義人を個人または法人と照合する、任意の照合結果です。

end_user
object
manage_url
string<uri> | null

本人のアクセスページ。アクセスページが利用可能になるまではnull。

billing
object

この接続の料金。サンドボックスは課金されません。

possible_duplicate_of
string<uuid> | null

この接続が、有効な別の接続と重複する可能性があるにもかかわらず、どの end_user.reference も特定の一致を許可しなかった場合に設定されます。

vendor_data
string | null
updated_at
string<date-time>
最終更新日 2026年11月22日