メインコンテンツへスキップ
以下のレスポンスはすべて、重要なフィールドのみを含むように省略しています。 APIキーはサーバー側に保管してください。ブラウザやアプリに届くことはありません。
銀行データは、サンドボックスのアプリケーションでご利用いただけます。 本番環境のアプリケーションからの呼び出しは、本番環境での利用が発表されるまで404を返します。サンドボックスでは料金は発生しません。 このクイックスタートでは、サンドボックスのアプリケーションから、コピー&ペーストで実行できるリクエストを使って、Didit Test Bankの口座、残高、取引までを確認できます。

ステップ1: Bank data権限を付与したAPIキーを作成する

Bank dataはフルアクセスには含まれません。 アプリケーションのプライマリシークレットを含むフルアクセスのキーは、Bank dataに関するすべての呼び出しで403 bank_data_access_deniedにより拒否されます。
  1. Business Consoleで、サンドボックスアプリケーションを開き、API keysに移動します。
  2. カスタムアクセスでキーを作成し、Bank dataを追加します。読み取りにはRead、何かを作成、変更、削除する呼び出しにはWriteを設定します。
  3. キーをコピーし、エクスポートします:
すべてのリソースの一覧はAPIキーを参照してください。

ステップ2: リンクを作成する

リンクは、エンドユーザーが銀行を接続する画面を1回分実行したものです。 Test Bank向けに、継続的なリンクを作成します:
country は、エンドユーザーの銀行がある国の3文字の国コードです。省略可能です。 わかっている場合に送信すると、エンドユーザーにはその国の銀行だけが表示されます。送信しない場合は、対応している全ての国の中から選択することになります。 1回限りのアクセスにする場合は、"access": "one_time" を送信します(デフォルト)。
リンクの id は、ユーザーと紐づけて保存してください。 url と client_token は、リンクの作成時に一度だけ返されます。

ステップ3: リンクを開き、Didit Test Bankに接続する

ブラウザでurlを開くか、メールまたはチャットで本人に送ります。 本人には同意画面が表示され、Didit Test Bankを選択し、テスト用の顧客のいずれかでサインインして、共有する口座を選びます。 テスト用の顧客と、それぞれから取得できるデータはサンドボックスのページに掲載されています。 完了後に本人をお客様のサイトに戻す方法は、お客様のサイトに戻すを参照してください。 redirect_urlを指定しない場合、本人はDiditの結果ページで手続きを完了し、結果はWebhookまたは読み取りリクエストで確認できます。

ステップ4: Webhookを受信して確認する

コンソールでbank.*イベントの送信先を登録してください。他のWebhookと同様です。 エンドユーザーの操作が完了すると、link_idとconnection_idを含むbank.link.completedが届きます。その後、最初の同期でアカウントが保存されるとbank.connection.createdが届きます。 ブラウザから送られてきたリンクIDは信用しないでください。 ご自身でリンクの情報を取得して確認してください:
statusはcompleted、または最終状態のいずれかです(cancelled、expired、failed)。failedのリンクにはerror.codeが含まれます。cancelledの場合はerror: nullとなります。

ステップ5: 口座、残高、取引を読み取る

金額は10進数の文字列で、支出はマイナスの値になります。 取引のページには、まだ読み取るデータがある間next_page_tokenが含まれます。 口座、残高、取引を参照してください。

ステップ6: 変更フィードを追跡する

変更フィードは、前回の読み取り以降に変更された内容のみを返します。 カーソルを指定しない最初の読み取りでは、完全なスナップショットが返されます。これには接続が持つすべての取引が含まれ、それぞれaddedとして返され、レスポンスにはreset: trueが付きます。 最初のページにはhas_more: trueとnext_page_tokenが含まれ、この時点ではまだnext_cursorがない場合があります。has_moreがtrueの間はpage_tokenを使って読み取りを続け、has_more: falseのページ(最後のページ)のnext_cursorを保存して次回に使用してください:
reset: trueは、レスポンスが完全なスナップショットであることを意味します。レスポンスを追加するのではなく、お使いのコピーをそのレスポンスで置き換えてください。 bank.data.updatedは、同期によって新しい内容が保存されたタイミングを通知します。

ステップ7: 今すぐ同期する

継続的な接続は、自動的に同期されます。 今すぐ銀行データを読み取るには、同期をリクエストします:
銀行では、ユーザーの操作を伴わない読み取りの回数が1日あたり制限されています。 接続の sync.live_syncs_left_today と sync.budgets に、残りの回数とリセットされるタイミングが示されます。上限を超えた呼び出しには、リセット時刻とともに 429 refresh_limit_reached が返されます。 詳しくは オンデマンドで銀行データを更新する を参照してください。

ステップ8: アクセスの停止と削除

アクセスの停止と削除は、それぞれ別の呼び出しです。
削除された接続のレスポンスに含まれるのは、id、status、status_reason、created_at、erasure のみです。 詳しくは データ、同意、削除 をご覧ください。

次のステップ

最終更新日 2026年11月22日