get https://jp-api-staging.getmoneytree.com/link/institutions.json
金融機関一覧
必要なOAuthスコープ
無し
Moneytree上の金融機関の一覧を返すAPIです。登録可能の金融機関のみならず、様々な状況の金融機関が返されます(たとえば、メンテナンス中、かつて存在していた合併した銀行など)ので、status
やstatus_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_required | 0 電子証明書を使わない 1 両方(使うケースとそうでないケース) 2 電子証明書が必須 | Yes |
login_url | 金融機関側でログインできるURL | Yes |
guidance_url | 金融機関の登録のし方を案内するURL(MT側が用意する場合もあって、金融機関側に用意される場合もある) | Yes |
billing_group | 一定期間内に更新することに制限がある金融サービスには、1以上の数字がセットされ返されます。制限のないものはnullが返されます。 それぞれの値に対する更新間隔については、ご担当する営業までお問い合わせください。 | Yes |
Available Institution Statuses
Status Value | Description |
---|---|
active | アクティブで、データが取得できる状況 |
inactive | 非アクティブな状況。 原因はstatus reasonを参照のこと。 |
Inactive Status Reasons | Description |
---|---|
maintenance | 金融機関はアクティブな状況だが、メンテナンス中のため一時的に非アクティブな状況にしている。 |
unavailable | 金融機関はアクティブな状況だが、長時間利用できない状態になっている。 |
unsupported | マネーツリーで対応していない金融機関だが、将来的に対応する予定もしくは考えがある。 |
wont_support | マネーツリーで対応していない金融機関で、何かの理由で非対応にしている。 |
legacy | かつて対応していたが、もう存在しない金融機関のため非対応。例:合併したJAバンク、信用金庫。 |
test | テスト専用ですので、一般のお客様に表示しないべきの金融機関。 |