Limit Management
This page explains how to request an increase of the operation limits of an account (ChangeAccountOperationLimit), how to query the current limits (GetAccountOperationLimit) and how to follow the decision through the webhook.
Requesting a limit increase (ChangeAccountOperationLimit)
With this method, the BU adjusts the limits of the Fits transactional products associated with an account, according to the parameters and limit settings of the BU. It works similarly to GetAccountOperationLimit, which keeps the bank details of the account consistent.
Send the AccountKey or the complete bank details (Bank, BankBranch, BankAccount and BankAccountDigit). With the bank details, the system validates the account by the AccountId, the internal identifier of the account at Fits.
The OperationType field accepts any operation in the list of the Code Mapping, in the section Operation type (for example, PIX, operation 40; TED, operation 3; card withdrawal, operation 30; fee per payment order, operation 52). A value that is not in the list is rejected. After the request is sent, a limit increase request is generated and carefully reviewed by the Risk, Compliance and Finance teams.
Besides the credentials and the fields common to all requests, described in Getting Started, the request carries the fields below. Request examples are in the API Reference.
Request fields
In the Requirement column, Mandatory means the field must be sent; Optional, that it can be left out; Conditional, that it depends on another field, as described.
| Field | Requirement | Description |
|---|---|---|
| TaxNumber | Mandatory | CPF or CNPJ of the holder of the account whose limit will be changed. |
| AccountKey | Conditional | Identifier of the account whose limit will be changed. Required if the bank details are not sent. |
| Bank, BankBranch, BankAccount and BankAccountDigit | Conditional | Virtual bank details of the account (for example, bank "450", branch "0001"). Required if the AccountKey is not sent. |
| OperationLimitRequests | Mandatory | List of limit change requests. Each item carries the operation, the limit type and the desired maximum value. |
| OperationLimitRequests.OperationType | Mandatory | Operation whose limit is requested. The values are listed in the Code Mapping, in the section Operation type. A value that is not in the list is rejected. |
| OperationLimitRequests.Type | Mandatory | Limit type. The values (0 to 6) are listed in the Code Mapping, in the section Limit type. |
| OperationLimitRequests.SubType | Mandatory | Limit subtype. The values are listed in the Code Mapping, in the section Limit subtype. |
| OperationLimitRequests.MaxLimitValue | Mandatory | New maximum value (ceiling) of the requested limit, according to the type and subtype. |
| Document | Optional | Object that receives the supporting document. |
| Document.DocumentFile | Conditional | File encoded in base64. Required if Document is sent. |
| Document.DocumentFormat | Conditional | File format. The values are listed in the Code Mapping, in the section Document format. The format must match the file content, and the value 3 (TXT) is rejected in this method. Required if Document is sent. |
| Document.DocumentName | Conditional | Name of the document. Required if Document is sent. |
| Document.DocumentType | Conditional | Document type. The values are listed in the Code Mapping, in the section Document type. In this method, 21 (monthly income), for CPF, and 17 (annual revenue), for CNPJ, are accepted; any other document type is refused. Required if Document is sent. |
| Document.Description | Conditional | Description of the document. Required if Document is sent. |
| Document.DocumentKey | Optional | Unique identification number of the document. |
| Justification | Mandatory | Reason for the increase, from 0 to 7. The values are listed in the Code Mapping, in the section Limit increase justification. Each request has a single justification, sent at the root of the request. |
The supporting proof (Document) is optional. To improve the chance of approval, send the proof if possible: monthly income (type 21) for an individual account or annual revenue (type 17) for a company account.
Response fields
| Field | Description |
|---|---|
| Success | "true" or "false", as text. |
| Message | Success message. Comes at the root of the response when a single limit is changed. |
| PreviousMaxLimit | Previous maximum limit of the account. It may be null when the limit did not exist yet. |
| NewMaxValue | New maximum limit requested. |
| OperationLimitRequests | Comes in place of the four fields above when the BU is configured to request several limits: one item per limit. |
| OperationLimitRequests.Message | Success message of the item. |
| OperationLimitRequests.OperationType | Operation of the limit. |
| OperationLimitRequests.Type | Type of the limit. |
| OperationLimitRequests.SubType | Subtype of the limit. |
| OperationLimitRequests.PreviousMaxLimit | Previous maximum limit. It may be null when the limit did not exist yet. |
| OperationLimitRequests.NewMaxValue | New maximum limit requested. |
The success messages are listed in the Success Catalogue.
Error response: Success false and a message. The errors returned by this method are listed in the Error Catalogue, in the section ChangeAccountOperationLimit.
Querying the limits (GetAccountOperationLimit)
This method queries the limits of an account in the transactional products, such as Pix and TED. All Fits accounts have limits set for security and regulatory compliance. The bank fields of the request are not the SPB data of the account, but virtual data.
With the bank details, the system validates the account by the AccountId; without them, it validates the account by the CPF or CNPJ (TaxNumber).
Request fields
| Field | Requirement | Description |
|---|---|---|
| TaxNumber | Mandatory | CPF or CNPJ of the account holder. |
| AccountKey | Optional | Account identifier. |
| Bank | Conditional | Bank code (for example, "450"). Optional; if any bank detail is sent, all are required. |
| BankBranch | Conditional | Branch code (for example, "0001"). Optional; if any bank detail is sent, all are required. |
| BankAccount | Conditional | Account number (for example, "146492"). Optional; if any bank detail is sent, all are required. |
| BankAccountDigit | Conditional | Account digit (for example, "1"). Optional; if any bank detail is sent, all are required. |
| Type | Mandatory | Type of limit queried. The values (0 to 6) are listed in the Code Mapping, in the section Limit type. |
| OperationType | Mandatory | Operation queried. The values are listed in the Code Mapping, in the section Operation type (for example, 40 PIX Out, 3 TED Out, 30 card withdrawal). |
| SubType | Mandatory | Subtype queried. The values are listed in the Code Mapping, in the section Limit subtype. |
Response fields
| Field | Description |
|---|---|
| Success | "true" or "false", as text. |
| Message | Success message. |
| MinLimit | Minimum limit. |
| MaxLimit | Maximum limit. |
The success message is listed in the Success Catalogue.
Decision webhook
When the request is decided, Fits sends a webhook with Method equal to ChangeAccountOperationLimit and one of these statuses: Approved, PartiallyApproved or Denied. The webhook is sent after the analyst's decision; a limit change applied immediately does not generate this notice. With the BU parameter "Habilitar Webhook de Alteração de Limites no MongoDB" (Enable Limit Change Webhook in MongoDB) turned on, the Method is AccountOperationLimitChangeWebhook. The webhook events are in Webhooks.
Request flow
The flow below shows the path of a limit change request up to the decision.
flowchart TD
A["BU sends ChangeAccountOperationLimit"] --> Q{"Change applied immediately?"}
Q -->|Yes| R["No webhook"]
Q -->|No| B["Increase request generated"]
D["Optional proof helps approval"] -.-> B
B --> C["Review by Risk, Compliance and Finance"]
C --> W["Webhook with the decision"]
W -->|Approved| X["Approved"]
W -->|PartiallyApproved| Y["Partially approved"]
W -->|Denied| Z["Denied"]
| Field | Description |
|---|---|
| Method | ChangeAccountOperationLimit |
| BusinessUnitId | BU identifier |
| TaxNumber | CPF or CNPJ of the account holder |
| Bank, BankBranch, BankAccount and BankAccountDigit | Virtual bank details of the account, when they exist |
| Status | Approved, PartiallyApproved or Denied |
| NewMinValue | New minimum limit |
| NewMaxValue | New maximum limit |
| OperationType | Operation of the limit |
| Type | Type of the limit |
| SubType | Subtype of the limit |
| AccountKey | Account identifier. It may or may not appear, and depends on a setting made with Fits support |
Updated 11 days ago

