金融機関一覧

📘

必要なOAuthスコープ

無し

Moneytree上の金融機関の一覧を返すAPIです。登録可能の金融機関のみならず、様々な状況の金融機関が返されます(たとえば、メンテナンス中、かつて存在していた合併した銀行など)ので、statusstatus_reasonの属性をチェックしながら本APIを消費してください。

また、このAPIはお客様ごとのAPIではなく、システム上のAPIになりますので、ご利用になるaccess_tokenは異なります。こちらで認証方法をご確認ください:

https://docs.link.getmoneytree.com/reference/post-oauth-token

📘

since の利用について

レスポンスデータが大きいため、Institutionsデータは毎回全て取得するのではなく、可能限りsinceを利用し、差分を取得するように実装してください。

Field Definitions

フィルド名説明Null可否
id
【DEPRECATED】
金融機関(Institution)のユニークなID。
【DEPRECATED】
No
entity_key金融機関(Institution)のユニークなID。上記のidを利用しないでください。idは環境(開発・本番)によって異なるため。No
institution_type金融機関の種類。
利用可能な値はbank, credit_card, stored_value, point, corporate, stock.

bank = 銀行の個人
credit_card = 個人のクレジットカード
stored_value = 電子マネー
point = ポイントカード
corporate = 銀行の法人口座、法人カード
stock = 証券

(※ 将来的に追加される可能性があります。)
No
display_name金融機関のローカライズ名Yes
display_name_reading日本語を指定した場合は金融機関カナが表示される。日本語以外の場合はdisplay_nameと同じ値となる。Yes
statusデータを取得できる状況にあるかYes
status_reason非アクティブな状況の原因。ステータスとその意味は下記を参照のこと。Yes
certificate_required0 電子証明書を使わない
1 両方(使うケースとそうでないケース)
2 電子証明書が必須
Yes
login_url金融機関側でログインできるURLYes
guidance_url金融機関の登録のし方を案内するURL(MT側が用意する場合もあって、金融機関側に用意される場合もある)Yes
billing_group一定期間内に更新することに制限がある金融サービスには、1以上の数字がセットされ返されます。制限のないものはnullが返されます。

それぞれの値に対する更新間隔については、ご担当する営業までお問い合わせください。
Yes

Available Institution Statuses

Status ValueDescription
activeアクティブで、データが取得できる状況
inactive非アクティブな状況。
原因はstatus reasonを参照のこと。
Inactive Status ReasonsDescription
maintenance金融機関はアクティブな状況だが、メンテナンス中のため一時的に非アクティブな状況にしている。
unavailable金融機関はアクティブな状況だが、長時間利用できない状態になっている。
unsupportedマネーツリーで対応していない金融機関だが、将来的に対応する予定もしくは考えがある。
wont_supportマネーツリーで対応していない金融機関で、何かの理由で非対応にしている。
legacyかつて対応していたが、もう存在しない金融機関のため非対応。例:合併したJAバンク、信用金庫。
testテスト専用ですので、一般のお客様に表示しないべきの金融機関。
Language
Click Try It! to start a request and see the response here!