Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Related accounts

Get related accounts

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

Refer to the Related accounts section in the Accounts guide for more information.

get/v1/accounts/{accountId}/related-accounts-limits

Path parameters

accountIdnumber required
Example:9999999

Account ID

Response

OK

account_idinteger

Account ID.

program_idinteger

Program ID.

available_credit_limitnumber

Initial available credit limit of the account.

available_savings_account_limitnumber

Available limit of the savings account.

available_withdrawal_creditnumber

Amount available for withdrawal in the credit account.

held_fundsnumber

Funds held on the account. Usually, but not always, this occurs due to a legal action.

max_credit_limitnumber

Maximum credit amount approved for this account. This value can not be lower than total_credit_limit.

total_credit_limitnumber

Total credit limit amount as set by the user. This can be any value up to the max_credit_limit.

withdrawal_credit_limitnumber

Amount limit for withdrawal in credit programs.

total_overdraft_limitnumber

Maximum limit amount for over draft spending on the account.

percentage_over_limitnumber

Percentage of the maximum credit limit (max_credit_limit) made available for purchases over the credit limit on the account.

total_installment_credit_limitnumber

Amount limit for installments in the credit account.

available_total_installment_creditnumber

Available amount for installments in the credit account.

currency_codestring

ISO-4217 alphabetic code (3 characters) for transaction currency.

currency_numeric_codestring

ISO-4217 numeric code (3 digits) for transaction currency.

Example response

{
  "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,
  "total_installment_credit_limit": 145.78,
  "available_total_installment_credit": 120,
  "currency_code": "BRL",
  "currency_numeric_code": "986",
  "related_accounts": [
    {
      "account_id": 259875469,
      "parent_account_id": 259875000,
      "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,
      "total_installment_credit_limit": 145.78,
      "available_total_installment_credit": 120,
      "currency_code": "BRL",
      "currency_numeric_code": "986"
    }
  ]
}