5 - Limit management
Configuration and management of PIX limits
In a security agenda, central bank “Banco Central” established limits of transactions to be configured based on defined nocturnal and diurnal hours periods.
With these requests, the client application can allow managing, configuring and updating PIX limits.
PIX limits
Get Account Operation Limit
API Method = GetAccountOperationLimit
Through this method, it is possible to consult PIX limit information regarding current configuration of an account.
In FitBank this method is not unique to PIX, as it applies to other Fit transactions that use virtual account data. Thus, in the request for this method, the bank data fields do not refer to the SPB data of the account used to operate with PIX.
Important: If the account from which the user wants to consult the limits has virtual account bank details, it must be informed in the query request (fields Bank, BankBranch, BankAccount and BankAccountDigit), so that the system validation is made by the AccountId (account's internal identifier) that each account has in FitBank.
If the account in question does not have this virtual account data, the fields Bank, BankBranch, BankAccount and BankAccountDigit must be filled as null. In this case, the system will validate the account based on the informed CPF/CNPJ (TaxNumber).
{
"Method": "GetAccountOperationLimit",
"PartnerId": 163,
"BusinessUnitId": 195,
"TaxNumber": "12345678912",
"Bank": 450,
"BankBranch": "0001",
"BankAccount": 505615,
"BankAccountDigit": 3,
"Type": 0,
"OperationType": 2,
"SubType": 0
}
Description:
| Parameter | Description | Mandatory | Type | Comments |
|---|---|---|---|---|
| Method | Method to be used | YES | STRING | - |
| PartnerId | Information provided by FitBank | YES | INT | - |
| BusinessUnitId | Information provided by FitBank | YES | INT | - |
| TaxNumber | CPF/CNPJ of the owner of the account | YES | STRING | - |
| Bank | Bank Code (Ex.: “450”). | YES | STRING | - |
| BankBranch | Bank Agency Code (Ex.: “0001”) | YES | STRING | - |
| BankAccount | Bank Account (Ex.: “146492”) | YES | STRING | - |
| BankAccountDigit | Bank Account Digit (Ex.: “1”) | YES | STRING | - |
| Type | Parameter indicating type of limit being requested | YES | INT | Daily = 0 Overnight = 3 SingleTransaction = 4 |
| OperationType | Parameter indicating type of operation which limit being requested | YES | INT | By default, fill this field as 40, referring to the PixOut operation |
| SubType | Parameter indicating subtype of limit being requested | YES | INT | Quantity = 0 (number/quantity of transactions that the account can perform) Amount = 1 (value/amount of the transactions that the account can perform) |
Change Account Operation Limit
API Method = ChangeAccountOperationLimit
PIX limit modification based on current values. Through this API method, it is possible to configure (reduce or enlarge) PIX limits of an account according to the parameters and limit configurations of the business unit.
This method follows the same logic as the GetAccountOperationLimit method, regarding information of bank details of an account.
If the account from which the user wants to change the limits has virtual account bank details, it must be informed in the query request (fields Bank, BankBranch, BankAccount and BankAccountDigit), so that the system validation is made by the AccountId (account's internal identifier) that each account has in FitBank.
If the account in question does not have this virtual account data, the fields Bank, BankBranch, BankAccount and BankAccountDigit must be filled as null. In this case, the system will validate the account based on the informed CPF/CNPJ (TaxNumber).
In PIX, by default, you can only change the payment limits (PixOut), because PIX receipts are released and have no limit.
{
"Method": "ChangeAccountOperationLimit",
"PartnerId": 30519,
"BusinessUnitId": 51138,
"TaxNumber": "84928589076",
"Bank": "450",
"BankBranch": "0001",
"BankAccount": "440246",
"BankAccountDigit": "3",
"Type": 0,
"OperationType": 40,
"SubType": 1,
"MaxLimitValue": 0,
"Justification": "Alteração de Limite",
"Document": {
"DocumentFile": "dGVzdGU=",
"DocumentFormat": 0,
"DocumentName": "Faturamento Anual",
"DocumentType": 17,
"Description": "Envio de documento",
"ExpirationDate": "12/02/2025",
"DocumentKey": "629F1244DCC245A79DB0C181D3A472CB"
}
}
Description:
| Parameter | Description | Mandatory | Type | Comments |
|---|---|---|---|---|
| Method | Method to be used | YES | STRING | - |
| PartnerId | Information provided by FitBank | YES | INT | - |
| BusinessUnitId | Information provided by FitBank | YES | INT | - |
| TaxNumber | CPF/CNPJ of who has the PIX key | YES | STRING | - |
| Bank | Bank Code (Ex.: “450”) | YES | STRING | - |
| BankBranch | Bank Agency Code (Ex.: “0001”) | YES | STRING | - |
| BankAccount | Bank Account (Ex.: “146492”) | YES | STRING | - |
| BankAccountDigit | Bank Account Digit (Ex.: “1”) | YES | STRING | - |
| Type | Parameter indicating type of limit being requested | YES | INT | Daily = 0 Overnight = 3 SingleTransaction = 4 |
| OperationType | Parameter indicating type of operation which limit being requested | YES | INT | "40" - PIXuot /"3" - TEDout /"30" -Card withdrawal |
| SubType | Parameter indicating subtype of limit being requested | YES | INT | Quantity = 0 (number/quantity of transactions that the account can perform) Amount = 1 (value/amount of the transactions that the account can perform) |
| MaxLimitValue | Maximum value to initiate a PixOut transaction based on type conditions | YES | NUMBER | - |
| Justification | The "Justification" field requires a rationale for the limit increase. | YES | STRING | - |
| Document | Object responsible for receiving the documents. | NO | OBJECT | - |
| DocumentFile | The "DocumentFile" field is responsible for receiving the file encoded in base64. | YES | STRING | - |
| DocumentFormat | The "DocumentFormat" field is responsible for identifying the format of the file. | YES | INT | 0 - PDF 1 - jpg 2 - jpeg 3 -png |
| DocumentName | The "DocumentName" field is responsible for receiving the name of the document | YES | STRNG | - |
| DocumentType | The "DocumentType" field is responsible for defining the type of document being sent. | YES | INT | Currently it is possible to send only type 17. Later it will be possible to send type 21. |
| Description | Enter a document description | YES | STRING | - |
| DocumentKey | Unique identification number of the document | YES | STRING | - |
For more information visit Limit Managament
Updated 13 days ago