個人口座

get https://jp-api-staging.getmoneytree.com/link/accounts.json

📘
必要なOAuthスコープ: accounts_read

銀行口座、クレジットカード、デジタルマネーなど、すべての個人口座のリストを取得できます。

Responses

Response body

object

accounts

array of objects

required

accounts*

object

int64

required

マネーツリーが付与した口座ID。

account_group

int64

required

アカウントが属してるグループ。アカウントグループは金融機関のサイトでは１ユーザとして表示される。

account_subtype

string

required

length ≤ 255

口座の具体的な種類。

savings checking chochiku term_deposit term_deposit_builder term_deposit_shikumi zaikei card_loan debit_card tax_payment_reserve_deposit credit_card loan_installment home_loan stored_value

currency

string

required

ISO4217に基づく通貨のコード。

institution_entity_key

string

required

length ≤ 255

アカウントが属する金融機関（institution）のentity key（上記のIDの代わりに、これを利用してください。）金融機関の合併などで、アカウントのinstitution_entity_keyが変わることがあるため、APIを読み取ったたびに新しい値があれば格納した方がいい。

institution_account_name

string

required

length ≤ 255

金融機関（institution）の口座名。例）積立貯金。

institution_account_number

string | null

required

口座の「口座番号」のようなもの。
仕様（桁数や英数字など）は金融機関ごとの仕様になり、金融機関の都合によって予告なく変更されたりする場合もありますのでご注意ください。
また、クレジットカード等の場合、金融機関側の仕様にて番号が一部または全部マスキングされている場合もあります。

nickname

string

required

length ≤ 255

マネーツリー内でユーザーが口座につけた名称。ユーザーがニックニームを個別に付けていない場合、institution_account_nameと同じ値が返却されます。

branch_name

string | null

required

金融機関の口座の支店。
例）「本店」、「原宿支店」、「３０９」
金融機関によって返されるデータが異なりますので、ご注意ください。
あくまでもこちらの値は表示用に用意しており、自動処理に使わないでください。
また、この情報がない場合、nullは可能です。

branch_code

string | null

required

支店番号。該当しない場合nullが返される。

current_balance

number | null

required

アカウント残高（last_aggregated_success時点）。

current_balance_in_base

number | null

required

アカウント残高の円換算額。金融サービスが外貨の換算額を提供している場合は、その換算額を保管し、このフィールドで返されます。対応していない場合は、Moneytreeが利用している換算レートで計算します。

attributes

object

required

アカウントの追加カスタム属性です。個々の属性は、金融機関から取得可能なデータによって、存在する場合もあれば、存在しない場合もあります。

reserved_attributes

object

required

特定のLINKクライアントのための特別な追加属性。
このパラメータは、クライアントがこの機能を構成していない場合、完全に欠落する; これは公式のLINK共通仕様の一部であってはならない。

Has additional fields

aggregation_state

string

required

length between 0 and 255

最新のデータの取得状況。値と意味は下記参照。

success running error

aggregation_status

string

required

length between 0 and 255

最新のデータの取得状況。"aggregation_state"より詳細な内容。値と意味はこちらを参照。
より詳細な説明は、aggregation_statusの一覧ガイドを参照してください。

success running.auth running.data running.intelligence suspended.missing-answer.auth.security suspended.missing-answer.auth.otp suspended.missing-answer.auth.captcha suspended.missing-answer.auth.puzzle inactive auth.creds.security.invalid auth.creds.otp.invalid auth.creds.captcha.invalid auth.creds.puzzle.invalid auth.creds.certificate.required guest.intervention.required auth.creds.invalid auth.creds.locked.temporary auth.creds.locked.permanent error.permanent error.temporary error.session error.network error.service.unavailable error.unsupported unknown

last_aggregated_at

date-time

required

データを取得した前回時刻

last_aggregated_success

date-time | null

required

データを正常に取得できた前回時刻

created_at

date-time

required

マネーツリーに登録された時刻。

updated_at

date-time

required

最終更新時刻（マネーツリーやユーザーによる変更等により更新されます）

400

APIに対して行われたリクエストが無効である場合に返されます。
これは通常、送信されたデータが検証を通過しなかったことが原因です。

401

有効なアクセストークンを持っていない場合に返されます。

403

持っているアクセストークンが有効であるものの、本APIで必要とされるスコープが付与されていない時に返却されます。

429

アプリケーションが多くのリクエストを送信し、レート制限を受けている場合に返されます。
APIレート制限は何か、どのように対処するのか？もご覧ください。

500

原因不明の内部サーバーエラーが発生した場合に返されます。

503

Moneytreeサービスがメンテナンス中の場合に返されます。

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://jp-api-staging.getmoneytree.com/link/accounts.json?page=1&per_page=500' \
3
     --header 'accept: application/json'

Choose an example:

application/json

200OK