https://verification.didit.me/v3/ です。他のスタンドアロンAPIと同様に、アプリケーションのAPIキーを x-api-key ヘッダーで指定して認証します。
すべての書き込みリクエストは Idempotency-Key を受け付けます。
リストは limit(既定値は100、最大500)を受け付け、cursor で続きを取得します。ただし取引の読み取りは例外です。期間指定の読み取りは page_token で続きを取得し、変更フィードは永続的な cursor を受け取り、ページの続きを page_token で取得します。
読み取りが課金されることはありません。
エラーには code、message、request_id、field、next_action、retry_after が含まれます。処理の分岐は code の値で行ってください。
口座確認以外のすべての操作には、Bank data権限を持つAPIキーが必要です。フルアクセスにはこの権限は含まれません。
口座確認では、この権限は使用しません。セッションへの書き込みアクセス権を持つAPIキー、またはフルアクセスのAPIキーが必要です。
Bank dataはサンドボックスのアプリケーションでご利用いただけます。本番環境のアプリケーションからの呼び出しは、本番環境へのアクセスが発表されるまで 404 を返します。サンドボックスでは一切課金されません。
リンク
リンクを作成
POST /v3/bank/links/リンクを取得
GET /v3/bank/links/{id}/リンクをキャンセル
POST /v3/bank/links/{id}/cancel/接続
接続一覧
GET /v3/bank/connections/接続の取得
GET /v3/bank/connections/{id}/更新
POST /v3/bank/connections/{id}/refresh/有効期限の延長
POST /v3/bank/connections/{id}/renew/取り消し
POST /v3/bank/connections/{id}/revoke/削除
DELETE /v3/bank/connections/{id}/同期実行一覧
GET /v3/bank/connections/{id}/sync-runs/同期実行の取得
GET /v3/bank/connections/{id}/sync-runs/{sync_id}/口座、残高、取引
口座の一覧取得
GET /v3/bank/connections/{id}/accounts/口座の取得
GET /v3/bank/accounts/{account_id}/残高の取得
GET /v3/bank/accounts/{account_id}/balances/取引の一覧取得
GET /v3/bank/accounts/{account_id}/transactions/取引の変更フィード
GET /v3/bank/connections/{id}/transactions/sync/金融機関と対応範囲
金融機関の一覧
GET /v3/bank/institutions/金融機関の取得
GET /v3/bank/institutions/{id}/対応範囲の取得
GET /v3/bank/coverage/口座確認
POST /v3/bank/account-check/ガイド
サーバー向けSDK
7つのサーバー向けSDKでは、bankリソースの下に以下の操作が用意されています。各メソッド名は操作名にちなんで付けられており、create_link、get_connection、sync_transactionsなどがあります。