v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Account limits

Update account limits

Update account limits for a specific account. This endpoint triggers validation against the global program limit configured in the Configure program limit endpoint.

This endpoint generates the Account limit changed event.

Refer to the Account limits guide for more information.

patch/v1/accounts/{accountId}/limits

Path parameters

accountIdnumber required

Example:123456

Account ID

Headers

x-tenantstring required

Example:org-123

Tenant ID

Request body

max_credit_limitnumber

Maximum credit amount approved for this account. This value must not be less than the total_credit_limit or the program’s minimum credit limit parameter, and must not exceed the program’s maximum credit limit parameter. The ledger stores and reports this amount using the exact number of decimal places provided in the request payload.

total_credit_limitnumber

Total credit limit as set by the user. This can be any value up to the max_credit_limit. The ledger stores and reports the amount using the same number of decimal places as supplied in the request payload.

total_overdraft_limitnumber

Maximum limit amount for overdraft spending on the account. The ledger stores and reports the amount using the same number of decimal places as supplied in the request payload.

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 on this credit account. This value must not exceed the program’s maximum credit limit parameter. The ledger stores and reports this amount using the exact number of decimal places provided in the request payload.

Example request

{
  "max_credit_limit": 800.01,
  "total_credit_limit": 15.51,
  "total_overdraft_limit": 340.61,
  "percentage_over_limit": 15.5,
  "total_installment_credit_limit": 145.78
}

Response

No Content