---
title: "Get related accounts"
method: GET
path: "/v1/accounts/{accountId}/related-accounts-limits"
tags: ["Related accounts"]
---

# Get related accounts

`GET /v1/accounts/{accountId}/related-accounts-limits`

Get balances and limits of all related accounts given the main account ID. 

Refer to the [Related accounts](https://developers.pismo.io/pismo-docs/docs/accounts-overview#related-accounts) section in the Accounts guide for more information.

## Path parameters

- `accountId` number, required

## Response `200`

OK

- RelatedAccountsResponse
  - `account_id` integer — Account ID.
  - `program_id` integer — Program ID.
  - `available_credit_limit` number — Initial available credit limit of the account.
  - `available_savings_account_limit` number — Available limit of the savings account.
  - `available_withdrawal_credit` number — Amount available for withdrawal in the credit account.
  - `held_funds` number — Funds held on the account. Usually, but not always, this occurs due to a legal action.
  - `max_credit_limit` number — Maximum credit amount approved for this account. This value can not be lower than `total_credit_limit`.
  - `total_credit_limit` number — Total credit limit amount as set by the user. This can be any value up to the `max_credit_limit`.
  - `withdrawal_credit_limit` number — Amount limit for withdrawal in credit programs.
  - `total_overdraft_limit` number — Maximum limit amount for over draft spending on the account.
  - `percentage_over_limit` number — Percentage of the maximum credit limit (`max_credit_limit`) made available for purchases over the credit limit on the account.
  - `total_installment_credit_limit` number — Amount limit for installments in the credit account.
  - `available_total_installment_credit` number — Available amount for installments in the credit account.
  - `currency_code` string — ISO-4217 alphabetic code (3 characters) for transaction currency.
  - `currency_numeric_code` string — ISO-4217 numeric code (3 digits) for transaction currency.
  - `related_accounts` RelatedAccountResponse[] — Return related account
    - `account_id` integer — Account ID.
    - `parent_account_id` integer — Parent Account ID.
    - `program_id` integer — Program ID.
    - `available_credit_limit` number — Initial available credit limit of the account.
    - `available_savings_account_limit` number — Available limit of the savings account.
    - `available_withdrawal_credit` number — Amount available for withdrawal in the credit account.
    - `held_funds` number — Funds held on the account. Usually, but not always, this occurs due to a legal action.
    - `max_credit_limit` number — Maximum credit amount approved for this account. This value can not be lower than `total_credit_limit`.
    - `total_credit_limit` number — Total credit limit amount as set by the user. This can be any value up to the `max_credit_limit`.
    - `withdrawal_credit_limit` number — Amount limit for withdrawal in credit programs.
    - `total_overdraft_limit` number — Maximum limit amount for over draft spending on the account.
    - `percentage_over_limit` number — Percentage of the maximum credit limit (`max_credit_limit`) made available for purchases over the credit limit on the account.
    - `total_installment_credit_limit` number — Amount limit for installments in the credit account.
    - `available_total_installment_credit` number — Available amount for installments in the credit account.
    - `currency_code` string — ISO-4217 alphabetic code (3 characters) for transaction currency.
    - `currency_numeric_code` string — ISO-4217 numeric code (3 digits) for transaction currency.

## Other responses

- `400` — Bad request
- `404` — Not found.
- `500` — Internal server error.

---

[API](https://skmtc.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/revisions/935b62e16de4/schema)
