Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Account limits

List account limits

List available limits on the account.

Refer to the Account limits guide for more information.

get/v1/accounts/{accountId}/limits

Path parameters

accountIdnumber required
Example:123456

Account ID

Response

OK

max_credit_limitnumber

Maximum credit amount approved for this account.

available_total_installment_creditnumber

Amount available for installments in the credit account.

available_withdrawal_creditnumber

Amount available for withdrawal in the credit account.

available_savings_account_limitnumber

Available limit of the savings account.

total_overdraft_limitnumber

Maximum limit for over draft spending on the account.

total_installment_credit_limitnumber

Amount limit for installments in the credit account.

total_credit_limitnumber

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

percentage_over_limitnumber

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

available_monthly_creditnumber

Monthly amount available in the credit account.

available_credit_limitnumber

Initial available credit limit of the account.

monthly_credit_limitnumber

Monthly credit limit amount on the account.

held_fundsnumber

Funds held or blocked on the account.

additional_fundsnumber

Additional funds that can be used when needed to supplement credit limit, held funds, or other funds.

withdrawal_credit_limitnumber

Amount limit for withdrawal in credit programs.

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

{
  "max_credit_limit": 800.01,
  "available_total_installment_credit": 1000.31,
  "available_withdrawal_credit": 500.01,
  "available_savings_account_limit": 10.11,
  "total_overdraft_limit": 345.61,
  "total_installment_credit_limit": 145.78,
  "total_credit_limit": 15.51,
  "percentage_over_limit": 15.5,
  "available_monthly_credit": 10000.31,
  "available_credit_limit": 712.02,
  "monthly_credit_limit": 324.82,
  "held_funds": 50.01,
  "additional_funds": 100.5,
  "withdrawal_credit_limit": 10.34,
  "currency_code": "BRL",
  "currency_numeric_code": "986"
}