---
updatedAt: 2026-03-25T12:34:22.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# Get related accounts

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

Refer to the [Related accounts](doc:accounts-overview#related-accounts) section in the Accounts guide for more information.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Balances and limits",
    "version": "1.0.0",
    "description": "recover the description with the PM",
    "contact": {
      "name": "API Support"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/balances-limits",
      "description": "Sandbox API server for testing"
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Account access token. Tokens can expire quickly, which can result in an \"Unauthorized\" error.",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "RelatedAccountResponse": {
        "type": "object",
        "description": "Related account response.",
        "properties": {
          "account_id": {
            "description": "Account ID.",
            "type": "integer",
            "example": 259875469
          },
          "parent_account_id": {
            "description": "Parent Account ID.",
            "type": "integer",
            "example": 259875000
          },
          "program_id": {
            "description": "Program ID.",
            "type": "integer",
            "example": 1111
          },
          "available_credit_limit": {
            "description": "Initial available credit limit of the account.",
            "type": "number",
            "example": 712.02
          },
          "available_savings_account_limit": {
            "description": "Available limit of the savings account.",
            "type": "number",
            "example": 2700.34
          },
          "available_withdrawal_credit": {
            "description": "Amount available for withdrawal in the credit account.",
            "type": "number",
            "example": 500
          },
          "held_funds": {
            "description": "Funds held on the account. Usually, but not always, this occurs due to a legal action.",
            "type": "number",
            "example": 50
          },
          "max_credit_limit": {
            "description": "Maximum credit amount approved for this account. This value can not be lower than `total_credit_limit`.",
            "type": "number",
            "example": 800
          },
          "total_credit_limit": {
            "description": "Total credit limit amount as set by the user. This can be any value up to the `max_credit_limit`.",
            "type": "number",
            "example": 15.5
          },
          "withdrawal_credit_limit": {
            "description": "Amount limit for withdrawal in credit programs.",
            "type": "number",
            "example": 10.34
          },
          "total_overdraft_limit": {
            "description": "Maximum limit amount for over draft spending on the account.",
            "type": "number",
            "example": 340.6
          },
          "percentage_over_limit": {
            "description": "Percentage of the maximum credit limit (`max_credit_limit`) made available for purchases over the credit limit on the account.",
            "type": "number",
            "example": 15.5
          },
          "total_installment_credit_limit": {
            "description": "Amount limit for installments in the credit account.",
            "type": "number",
            "example": 145.78
          },
          "available_total_installment_credit": {
            "description": "Available amount for installments in the credit account.",
            "type": "number",
            "example": 120
          },
          "currency_code": {
            "description": "ISO-4217 alphabetic code (3 characters) for transaction currency.",
            "type": "string",
            "example": "BRL"
          },
          "currency_numeric_code": {
            "description": "ISO-4217 numeric code (3 digits) for transaction currency.",
            "type": "string",
            "example": "986"
          }
        }
      },
      "RelatedAccountsResponse": {
        "type": "object",
        "properties": {
          "account_id": {
            "description": "Account ID.",
            "type": "integer",
            "example": 259875469
          },
          "program_id": {
            "description": "Program ID.",
            "type": "integer",
            "example": 1111
          },
          "available_credit_limit": {
            "description": "Initial available credit limit of the account.",
            "type": "number",
            "example": 712.02
          },
          "available_savings_account_limit": {
            "description": "Available limit of the savings account.",
            "type": "number",
            "example": 2700.34
          },
          "available_withdrawal_credit": {
            "description": "Amount available for withdrawal in the credit account.",
            "type": "number",
            "example": 500
          },
          "held_funds": {
            "description": "Funds held on the account. Usually, but not always, this occurs due to a legal action.",
            "type": "number",
            "example": 50
          },
          "max_credit_limit": {
            "description": "Maximum credit amount approved for this account. This value can not be lower than `total_credit_limit`.",
            "type": "number",
            "example": 800
          },
          "total_credit_limit": {
            "description": "Total credit limit amount as set by the user. This can be any value up to the `max_credit_limit`.",
            "type": "number",
            "example": 15.5
          },
          "withdrawal_credit_limit": {
            "description": "Amount limit for withdrawal in credit programs.",
            "type": "number",
            "example": 10.34
          },
          "total_overdraft_limit": {
            "description": "Maximum limit amount for over draft spending on the account.",
            "type": "number",
            "example": 340.6
          },
          "percentage_over_limit": {
            "description": "Percentage of the maximum credit limit (`max_credit_limit`) made available for purchases over the credit limit on the account.",
            "type": "number",
            "example": 15.5
          },
          "total_installment_credit_limit": {
            "description": "Amount limit for installments in the credit account.",
            "type": "number",
            "example": 145.78
          },
          "available_total_installment_credit": {
            "description": "Available amount for installments in the credit account.",
            "type": "number",
            "example": 120
          },
          "currency_code": {
            "description": "ISO-4217 alphabetic code (3 characters) for transaction currency.",
            "type": "string",
            "example": "BRL"
          },
          "currency_numeric_code": {
            "description": "ISO-4217 numeric code (3 digits) for transaction currency.",
            "type": "string",
            "example": "986"
          },
          "related_accounts": {
            "type": "array",
            "description": "Return related account",
            "items": {
              "$ref": "#/components/schemas/RelatedAccountResponse"
            }
          }
        }
      },
      "ErrorModel": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Message that describes the error.",
            "example": "An Internal Server Error found, please contact the administrator"
          },
          "code": {
            "type": "string",
            "description": "Code that identifies the error type.",
            "example": "EBLS9999"
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDetails"
            }
          }
        }
      },
      "ErrorDetails": {
        "type": "object",
        "properties": {
          "location": {
            "description": "Location describes the attribute when the error is present",
            "type": "string",
            "example": "payload.attribute"
          },
          "message": {
            "type": "string",
            "description": "Message that describes the error detail",
            "example": "attribute is null"
          }
        }
      }
    },
    "examples": {
      "headerValidationError": {
        "value": {
          "message": "Some required headers are missing",
          "code": "WBLS0001"
        }
      },
      "invalidAccountIdError": {
        "value": {
          "message": "Invalid account id",
          "code": "WBLS0004"
        }
      },
      "accountNotFoundError": {
        "value": {
          "message": "Account not found",
          "code": "WBLS0006"
        }
      },
      "genericSystemError": {
        "value": {
          "message": "Internal error found, please contact the administrator",
          "code": "EBLS9999"
        }
      },
      "relatedAccountsNotFound": {
        "description": "Account isn't a parent example.",
        "value": {
          "account_id": 259875469,
          "program_id": 1111,
          "available_credit_limit": 712.02,
          "available_savings_account_limit": 2700.34,
          "available_withdrawal_credit": 500,
          "held_funds": 50,
          "max_credit_limit": 800,
          "total_credit_limit": 15.5,
          "withdrawal_credit_limit": 10.34,
          "total_overdraft_limit": 340.6,
          "percentage_over_limit": 15.5,
          "related_accounts": []
        }
      },
      "relatedAccountFound": {
        "description": "Account result example",
        "value": {
          "account_id": 259875469,
          "program_id": 1111,
          "available_credit_limit": 712.02,
          "available_savings_account_limit": 2700.34,
          "available_withdrawal_credit": 500,
          "held_funds": 50,
          "max_credit_limit": 800,
          "total_credit_limit": 15.5,
          "withdrawal_credit_limit": 10.34,
          "total_overdraft_limit": 340.6,
          "percentage_over_limit": 15.5,
          "related_accounts": [
            {
              "account_id": 55668877,
              "program_id": 1111,
              "available_credit_limit": 712.02,
              "available_savings_account_limit": 2700.34,
              "available_withdrawal_credit": 500,
              "held_funds": 50,
              "max_credit_limit": 800,
              "total_credit_limit": 15.5,
              "withdrawal_credit_limit": 10.34,
              "total_overdraft_limit": 340.6,
              "percentage_over_limit": 15.5
            }
          ]
        }
      }
    }
  },
  "tags": [
    {
      "name": "Related accounts",
      "description": "Endpoints to manage related accounts."
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "paths": {
    "/v1/accounts/{accountId}/related-accounts-limits": {
      "get": {
        "operationId": "get-v1-accounts-limits-related-accounts",
        "summary": "Get related accounts",
        "description": "Get balances and limits of all related accounts given the main account ID. \n\nRefer to the [Related accounts](https://developers.pismo.io/pismo-docs/docs/accounts-overview#related-accounts) section in the Accounts guide for more information.\n",
        "tags": [
          "Related accounts"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "description": "Account ID",
            "schema": {
              "type": "number",
              "example": 9999999
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RelatedAccountsResponse"
                },
                "examples": {
                  "related accounts found": {
                    "$ref": "#/components/examples/relatedAccountFound"
                  },
                  "related accounts not found": {
                    "$ref": "#/components/examples/relatedAccountsNotFound"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                },
                "examples": {
                  "header validation error": {
                    "$ref": "#/components/examples/headerValidationError"
                  },
                  "invalid account id error": {
                    "$ref": "#/components/examples/invalidAccountIdError"
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                },
                "examples": {
                  "main account not found": {
                    "$ref": "#/components/examples/accountNotFoundError"
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorModel"
                },
                "examples": {
                  "system error": {
                    "$ref": "#/components/examples/genericSystemError"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```