Developers API & Widget
API Reference
JA

リソース

MyBankMatch

Wealthreader ライセンスに紐づくお客様自身の銀行の受取人確認(VoP)を使用して、IBAN が指定された名義人のものかどうかを確認します。

製品は検証段階です。 対応銀行を順次追加しています。接続時にお客様の銀行が一覧に表示されない場合は、サポートで金融機関名を記載したチケットを作成してください。こちらで有効化します。通常は 24 時間ほどかかります。

接続の準備

  1. 製品 MY_BANK_MATCH を含み、利用可能なクォータがある有効なライセンスを用意します。
  2. 認証済みのセッションと該当するライセンスで 顧客エリア · MyBankMatch を開きます。
  3. Connect bank をクリックし、Wealthreader がホストするウィンドウで認証を完了します。トークン化された接続はお客様の api_key に関連付けられます。銀行のトークンはブラウザーに渡されず、クエリ パラメーターでもありません。
  4. 顧客エリアで状態を更新します。銀行から再認証を求められた場合は、Reconnect を使用します。パネルでは、IBAN/名義の明示的なテストと、マスクされた最近の照会も確認できます。

発行元は、1 回限りの署名付きリンクと、ブラウザーに紐づく継続情報を使用します。リンクの有効期限が切れた場合や継続情報が失われた場合は、顧客エリアから新しいリンクを要求してください。

バックエンドから照会を送信する

POST https://api.wealthreader.com/my-bank-match/
Content-Type: application/x-www-form-urlencoded
パラメーター 必須 仕様
api_key はい MY_BANK_MATCH を含み、利用可能なクォータがある有効なライセンスの 16 進数 8 文字のキー。バックエンドで保管してください。
iban はい SEPA 加盟国の IBAN。空白は削除されて大文字に変換され、国ごとの桁数と mod-97 チェックが検証されます。
name はい 名義人の名前。空でなく、有効な UTF-8 で、制御文字を含まず、最大 140 文字。前後の空白は除去され、空白は正規化されます。

JSON は送信せず、X-API-Key も使用しません。キーは、/entities/ と同様に、フォーム エンコードされた本文の一部です。

curl --request POST 'https://api.wealthreader.com/my-bank-match/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'api_key=<SU_API_KEY>' \
  --data-urlencode 'iban=ES9321005707250200257112' \
  --data-urlencode 'name=Wealthreader S.L.'

<SU_API_KEY> はプレースホルダーであり、使用できるキーではありません。IBAN と名前は受け入れテストのリクエストを示すための例です。ここでは、これらが特定の判定結果を返すことは確認していません。この照会は課金対象になる場合があります。画面の自動更新として実行しないでください。

MyBankMatch は銀行の判定結果を返します。その応答を、ローカルでの名前の類似度計算に置き換えることはありません。また、支払指図の作成、承認、実行も行いません。

応答の解釈

HTTP 200 は製品の結果が得られたことを示すものであり、名前が一致したことを必ずしも意味しません。success を確認してから payload.result を確認してください。

部分一致の例(名前と SESSION は架空の値です):

{
  "success": true,
  "payload": {
    "result": "PARTIAL_MATCH",
    "suggested_name": "TITULAR DE EJEMPLO S.L."
  },
  "statistics": {
    "SESSION": "0000000000000000",
    "execution_time": 0.42,
    "warnings": []
  }
}

statistics.SESSION は診断用にこの照会を識別し、execution_time は秒単位で表されます。正常な応答には error オブジェクトは含まれず、銀行接続のトークンも返されません。

payload.result 意味 追加フィールド 課金
MATCH 銀行は、名前が名義人と一致すると判断しています。 なし。 あり、0.10 EUR。
PARTIAL_MATCH 銀行が部分一致(CLOSE_MATCH)を返します。 suggested_name:銀行から通知された実際の名前であり、ローカルで生成された候補ではありません。 あり、0.10 EUR。
NO_MATCH 銀行は、名前が一致しないと示しています。 なし。 あり、0.10 EUR。
NOT_CONFIGURED ライセンスにまだ銀行が紐づいていません。 setup_url。 なし。
REAUTH_REQUIRED 接続の再認証が必要です。 setup_url と reason_code(2xxx 系の整数)。 なし。
NOT_POSSIBLE 利用可能な判定結果を取得できませんでした。NO_MATCH と同じ意味ではありません。 reason(技術的な識別子)。 なし。

部分一致の場合は、入力された名前と suggested_name を別々に表示してください。前者を黙って置き換えないでください。HTML で表示する場合は、テキストとしてエスケープしてください。

NOT_CONFIGURED と REAUTH_REQUIRED の設定 URL は次のとおりです。

https://www.wealthreader.com/clients/#my-bank-match

たとえば、再認証時には次の payload が返されることがあります。

{
  "result": "REAUTH_REQUIRED",
  "setup_url": "https://www.wealthreader.com/clients/#my-bank-match",
  "reason_code": 2000
}

reason_code は 2000 から 2999 までの整数でなければなりません。たとえば、2000 は認証情報のエラーを示します。検証を際限なく繰り返すのではなく、顧客エリアから再接続してください。

NOT_POSSIBLE は、一時的な利用不能、銀行からの無効な応答、利用可能な支払人 IBAN の欠如、またはアダプターが利用できないことが原因で発生する場合があります。reason は診断用に保持してください。ただし、これらのケースを名義の確認や不一致の結果として扱わないでください。

検証、クォータ、エラー

検証エラーやライセンス エラーは、success: false、payload、error.code、error.message、および statistics(SESSION・所要時間・警告を含む)という通常の形式に従います。制御された検証では HTTP 400 が返されます。メッセージには診断情報が含まれる場合があるため、安定した識別子として使用しないでください。

error.code 理由
4000 無効な IBAN:形式、未対応の国、長さ、またはチェック ディジット。
4001 無効な名前:空、形式、または長さ。
2 メソッドまたは api_key が正しくない、ライセンスが非アクティブ、製品が許可されていない、またはクォータを使い切った。
1 可用性または永続化に関する内部エラー。

入力エラーや結論の出ない結果では、課金対象の照会のクォータは消費されません。クォータは、銀行が MATCH、PARTIAL_MATCH、NO_MATCH のいずれかを返したときに消費されます。同時に行われた別の呼び出しによってクォータが使い切られた場合は、結果を正常として確定するのではなく、上限エラーが返されます。

このメソッドには冪等キーも無料の再試行の保証もありません。 タイムアウト、ネットワーク障害、または解釈できない本文により応答を受け取れなかった場合、結果とクォータの消費状況がアプリケーション側で不明になることがあります。同じ照会を自動的に再送信しないでください。顧客エリアの履歴を確認し、その試行について確認が必要な場合はサポートにお問い合わせください。

この 0.10 EUR の料金は、仕様上の 3 つの確定的な結果にのみ適用されます。照会ごとの課金モードと、検証済みの紐づけセッションの除外は実装済みですが、事前のスキーマと、オペレーターによる課金クエリの有効化・確認が必要です。このページはそのデプロイを証明するものではありません。認証情報/製品の標準計算からセッションを除外できるのは、検証済みのサーバー側の紐づけのみです。ブラウザーの operation_id だけでは不十分です。その出所がない期限切れ、未監査、または過去の試行は自動的には免除されず、その他の無料のカウンター効果も保証されません。

このバージョンの制限事項

  • 検証には、Santander 個人向けサービスとのお客様自身のトークン化された接続を使用します。実際の銀行との互換性はまだ検証されておらず、このページの公開によって商用での提供が保証されるものではありません。
  • ホストされたフローは、認証情報と OTP/プッシュ チャレンジ、認証方法の選択、限定的なラスター QR に対応しています。スクリプト、OAuth、CAPTCHA、または複数契約のチャレンジは実装されておらず、安全にエラーになります。顧客エリアから新しいリンクを要求できます。
  • パネルを使用するには認証済みのセッションが必要です。状態の読み込み、銀行のウィンドウからの復帰、履歴の更新では、銀行に検証は送信されません。課金対象となる可能性のある照会を行うのは、フォームを明示的に送信した場合のみです。
  • api_key はお客様のサーバーで保管し、認証情報、銀行トークン、フルネームを不要な連携ログに記録しないでください。サポートへの問い合わせには SESSION を使用し、判定結果、エラー、設定状態を区別してください。
最終更新