メインコンテンツへスキップ
POST
curl
Didit の「Refresh a Bank Connection」エンドポイントは、今すぐ同期するリクエストを受け付け、202 と sync_id を返します。 "wait": true を送信すると、最大25秒間待機し、同期が完了した結果を1回の呼び出しで取得できます。追加料金はかかりません。 銀行は無人でのアクセスを制限しているため、呼び出しは 429 refresh_limit_reached で応答する場合があり、その際は Retry-After が返されます。 オンデマンドで銀行データを更新するを参照してください。

承認

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
Prefer
string

wait=<seconds> は、ボディの wait: true と同様に、呼び出しを最大25秒(上限は25秒)まで保持します。

例:

"wait=25"

パスパラメータ

id
string<uuid>
必須

接続ID。

ボディ

application/json

任意。更新のリクエストボディ。

wait
boolean
デフォルト:false

true の場合、呼び出しは最大25秒間保持され、完了した同期結果とともに 200 を返します。そのため、1回のリクエストで最新データを取得できます。その時間内に銀行から応答がない場合、呼び出しは 202 を返します。その場合は、sync_id を使って get_sync_run で同期結果を取得するか、bank.sync.completed を購読してください。bank.data.updated は、同期で変更が保存された場合にのみ送信されます。ヘッダー Prefer: wait=<seconds>(最大25)も同じ動作をします。

レスポンス

同期は25秒以内に完了しました。

wait付きの更新によって返された、完了した同期。outcomeを持つ同期実行と、resultsおよびbalances_changedの口座ごとの件数です。

id
string<uuid>
必須
connection_id
string<uuid>
必須
trigger
enum<string>
必須
利用可能なオプション:
initial,
scheduled,
requested
status
enum<string>
必須
利用可能なオプション:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
必須
finished_at
string<date-time> | null
必須
results
object[]
必須

実行内容を口座およびリソースごとに示します。

error
object | null
必須

実行全体が失敗した理由。失敗していない場合は null。個々のアカウントやリソースのエラーは results にあります。

outcome
enum<string>
必須

同期がどのように終了したか。

利用可能なオプション:
succeeded,
partial,
failed
balances_changed
boolean
必須

いずれかの残高が変化したかどうか。

最終更新日 2026年11月22日