404 を返します。
一回限りのアクセスと継続的なアクセス
継続的なアクセスは、銀行がそれを許可している場合にのみ利用できます。
金融機関一覧のエンドポイントに問い合わせるか、対応状況のページをご覧ください。
銀行がアクセスを維持できない場合、その銀行は継続的なアクセスを許可していないことがエンドユーザーに通知され、別の銀行を選択する必要があります。
allow_one_time_fallback: trueを設定すると、エンドユーザーは自身の画面で制限されたアクセスを確認したうえで、一回限りの読み取りとして続行できます。その場合、接続はone_timeになります。
状態
status_reason は次のいずれかです: 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。
同意
銀行が同意の終了時期を決定します。ただし、リクエストで指定したconsent_daysが上限です。
各接続の実際の日付はconsentに表示されます:
expires_atとrenew_by:同意の終了時期です。利用を途切れさせないために、終了前に更新してください。renewable_until:同意の終了後に、同じ接続を再有効化できる最後の時点です。renewed_count、version、scopes_granted、accounts_granted:付与された内容と、更新された回数です。
更新
更新では、接続IDとすべてのアカウントIDが維持され、履歴は重複せずに引き続き記録されます。- Diditは、終了の14日前、7日前、1日前に
bank.connection.consent_expiringを送信します。 POST /v3/bank/connections/{id}/renew/を呼び出します。残りが30日を超えている間は409 renewal_not_neededを返し、consent.renewable_untilを過ぎると409 renewal_window_expiredを返します。それ以外の場合は、更新リンクとともに201を返します。
renewal_requiredになります。データは最後に同期された状態で引き続き閲覧でき、料金は発生しません。
consent.renewable_untilを過ぎると、接続はrevokedになり、status_reason: consent_lapsedが設定されます。利用者は再度接続する必要があります。
完全なフローについては、同意を更新するを参照してください。
アクセスを停止する
アクセスの停止は、削除とは異なります。
削除によって何が消えるかは、データ、同意、削除をご覧ください。
削除された接続
削除された接続で返されるのは、id、status(deleted)、status_reason、created_at、erasure のみです。
status_reason の値は、deleted_by_customer、consent_lapsed、retention_elapsed、application_deleted のいずれかです。
それ以外のフィールドは含まれません。
重複
同じend_user.referenceで、同じ銀行において既存の連携先アカウントと正確に一致するアカウントに解決される新しい認証リンクは、そのコネクションの更新として完了し(reused: true)、料金が二重に請求されることはありません。
それ以外の重複がある場合、保存や課金が行われる前に、認証リンクはfailedで終了し、duplicate_conflictとconflicts_withが返されます。
既存のコネクションを更新するか、独立した2つ目のコネクションを作成する場合は、"duplicates": "allow"を指定して認証リンクを作成し直してください。
顧客の接続を管理する
- フィルターによる一覧表示:
GET /v3/bank/connections/では、status、access、institution_id、country、vendor_data、end_user_reference、consent_expires_before、created_afterでフィルターできます。 billingオブジェクトで接続の料金を確認できます。単位、料金、すでに精算済みの月が含まれます。