GenerateStaticPixQRCode

Overview

The GenerateStaticPixQRCode method generates static PIX QR codes:

Input Validation
Business-specific validation
Sub-object validation (recurrence, if applicable)
Processing
Static QR code generation and data return

Complete Codes and Messages

Code	Message	Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Verify required fields and data formats sent
Business Validation
`ESE0463`	Account not found	Person with TaxNumber not found in the system	Verify if the CPF/CNPJ is correct and registered
`ESE0474`	Business Unit not found	BusinessUnitId does not exist in the system	Verify if the BusinessUnitId is correct
`ISI0483`	The Identifier field can contain a maximum of 255 characters	Identifier exceeds character limit	Reduce the size of the Identifier to a maximum of 255 characters
`EXC0039`	PIX QR code with the identifier "{0}" has already been generated previously	Identifier already exists for the BusinessUnit	Use a unique Identifier or check for existing QR code
`ISI0499`	The PrincipalValue field must have a value greater than or equal to 0.01	PrincipalValue less than 0.01	Enter a value greater than or equal to 0.01
`EXC0003`	Invalid Zip Code	ZipCode with invalid format	Enter a valid Zip Code in the correct format
`EXC0054`	The original payment value exceeds the maximum allowed value	PrincipalValue exceeds configured limit	Verify BusinessUnit limits or reduce the value
Recurrence Validation (if applicable)
`EXC0001`	Unable to find the Person with the provided TaxNumber	Person not found for recurrence	Verify CPF/CNPJ of the holder
`EXC0084`	The recipient must be a Legal Entity (PJ). Please review the provided data	Recurrence only permitted for Legal Entities	Enter CNPJ of a legal entity
`EXC0033`	The initial recurrence date must be between 2 and 10 days from today. Select a valid date within this range	InitialDate outside the allowed interval	Enter a date between 2 and 10 days from today
`EXC0031`	The final date must be after the initial date	EndDate less than or equal to InitialDate	Enter an EndDate greater than InitialDate
`EXC0032`	Only one of the fields needs to be filled: FinalValue or MaximumValue	Both FinalValue and MaximumValue entered	Enter only one of the value fields
`EXC0021`	It is necessary to fill in {0}.{1} or {0}.{2}	Neither FinalValue nor MaximumValue entered	Enter FinalValue or MaximumValue
`EXC0022`	Values.{0} must be greater than 0	FinalValue or MaximumValue less than or equal to zero	Enter positive values
`EXC0105`	There is already a PIX Automatic for the Contract informed	Contract.Identifier already exists	Use a unique Identifier for the contract
Processing
`ESE1262`	The informed account does not exist	AccountHolder or Account not found	Verify account data (Bank, BankBranch, BankAccount, BankAccountDigit)
`EXC0009`	The informed business unit does not have a SPI match	MatchingBusinessUnit SPI not configured	Verify SPI configuration of the BusinessUnit
`ESE1263`	The informed PIX key was not found	PixKey not found or not active	Verify if the PIX key is registered and active
`EXC0004`	Unable to issue a static QR code for change	TransactionPurpose is PurchaseWithChange	Do not use a change purpose for a static QR code
`EXC0021`	The PIX Withdraw parameter is disabled for the informed BusinessUnit	TransactionPurpose Withdraw without configuration	Enable the PIXWithdraw parameter in the BusinessUnit
`EXC0037`	PIX withdrawal transaction type is only allowed for company accounts	PIX withdrawal with an individual (PF) person	Use a corporate account (PJ) for PIX withdrawal
`EXC0008`	Invalid transaction type	TransactionPurpose not supported	Use PurchaseOrTransfer or Withdraw
Success
`INF0013`	Method executed successfully	QR code generated successfully	QR code created with DocumentNumber returned

GenerateDynamicPixQRCode

Overview

The GenerateDynamicPixQRCode method generates dynamic PIX QR codes:

Input Validation
Business-specific validation
Sub-object validation (recurrence, if applicable)
Transactional processing
Dynamic QR code generation and data return

Complete Codes and Messages

Code	Message	Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Verify required fields and data formats sent
Business Validation
`EXC0011`	The original payment value must be greater than 0.00	PrincipalValue <= 0 (except for withdrawal)	Enter a value greater than zero
`EXC0053`	For the value informed, it is necessary to provide the payer's data	Value requires payer data but none were provided	Include PayerTaxNumber and PayerName for values that require identification
`EXC0054`	The original payment value exceeds the maximum allowed value	PrincipalValue exceeds configured limit	Verify BusinessUnit limits or reduce the value
`ESE0463`	Account not found	Person with TaxNumber not found in the system	Verify if the CPF/CNPJ is correct and registered
`ESE0474`	Business Unit not found	BusinessUnitId does not exist in the system	Verify if the BusinessUnitId is correct
`ISI0483`	The Identifier field can contain a maximum of 255 characters	Identifier exceeds character limit	Reduce the size of the Identifier to a maximum of 255 characters
`EXC0039`	PIX QR code with the identifier "{0}" has already been generated previously	Identifier already exists for the BusinessUnit	Use a unique Identifier or check for existing QR code
`RISK0005`	Unable to generate the payment	PayerTaxNumber is on the deny list (deny list)	Verify if the payer is not blocked for QR codes
`EXC0050`	Unable to complete the QR code generation	Payer or account validations failed	Verify payer data and account configurations
Recurrence Validation (if applicable)
`EXC0001`	Unable to find the Person with the provided TaxNumber	Person not found for recurrence	Verify CPF/CNPJ of the holder
`EXC0084`	The recipient must be a Legal Entity (PJ). Please review the provided data	Recurrence only permitted for Legal Entities	Enter CNPJ of a legal entity
`EXC0033`	The initial recurrence date must be between 2 and 10 days from today. Select a valid date within this range	InitialDate outside the allowed interval	Enter a date between 2 and 10 days from today
`EXC0031`	The final date must be after the initial date	EndDate less than or equal to InitialDate	Enter an EndDate greater than InitialDate
`EXC0038`	{0} is required when the Recurrence field is present	PayerTaxNumber or PayerName required for recurrence	Enter complete payer data for recurrence
`EXC0032`	Only one of the fields needs to be filled: FinalValue or MaximumValue	Both FinalValue and MaximumValue entered	Enter only one of the value fields
`EXC0021`	It is necessary to fill in {0}.{1} or {0}.{2}	Neither FinalValue nor MaximumValue entered	Enter FinalValue or MaximumValue
`EXC0022`	Values.{0} must be greater than 0	FinalValue or MaximumValue less than or equal to zero	Enter positive values
`EXC0105`	There is already a PIX Automatic for the Contract informed	Contract.Identifier already exists	Use a unique Identifier for the contract
Processing
`ESE1262`	The informed account does not exist	AccountHolder or Account not found	Verify account data (Bank, BankBranch, BankAccount, BankAccountDigit)
`ESE1264`	The business unit was not found	BusinessUnit not found during processing	Verify if the BusinessUnitId is valid
`EXC0009`	The informed business unit does not have a SPI match	MatchingBusinessUnit SPI not configured	Verify SPI configuration of the BusinessUnit
`ESE1263`	The informed PIX key was not found	PixKey not found or not active	Verify if the PIX key is registered and active
Success
`INF0013`	Method executed successfully	Dynamic QR code generated successfully	Dynamic QR code created with DocumentNumber, HashCode, and specific data returned

GenerateDynamicPixQRCodeDueDate

Overview

The GenerateDynamicPixQRCodeDueDate method generates dynamic PIX QR codes with a due date:

Input Validation
Address Validations
Business Validation
Processing
Due Date Specific Validations
Dynamic QR code generation with due date and data return

Complete Codes and Messages

Code	Message	Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Verify required fields and data formats sent
`ISI0360`	It is necessary to inform the Address field	Address not provided (required field)	Provide complete address data
Address Validations
`ESE1546`	The AddressLine field cannot be null	address.AddressLine1 empty or null	Provide complete address (street)
`ESE1547`	The State field cannot be null	address.State empty or null	Provide state/UF of the address
`ESE1548`	The CityName field cannot be null	address.City empty or null	Provide the city of the address
`ESE1549`	The ZipCode field cannot be null	address.ZipCode empty or null	Provide the ZIP code of the address
Business Validation
`EXC0011`	The original payment value must be greater than 0.00	PrincipalValue <= 0	Enter a value greater than zero
`EXC0054`	The original payment value exceeds the maximum allowed value	PrincipalValue exceeds configured limit	Verify BusinessUnit limits or reduce the value
`ESE0463`	Account not found	Person with TaxNumber not found in the system	Verify if the CPF/CNPJ is correct and registered
`ESE0474`	Business Unit not found	BusinessUnitId does not exist in the system	Verify if the BusinessUnitId is correct
`ESE1512`	Invalid expiration time	ExpirationDate < DateTime.Now	Enter a future expiration date
`ESE1513`	The QR code expiration date must be at least one day	ExpirationDate < DateTime.Now.Date.AddDays(1)	Enter an expiration date with at least 1 day of notice
`ISI0483`	The Identifier field can contain a maximum of 255 characters	Identifier exceeds character limit	Reduce the size of the Identifier to a maximum of 255 characters
`EXC0039`	PIX QR code with the identifier "{0}" has already been generated previously	Identifier already exists for the BusinessUnit	Use a unique Identifier or check for existing QR code
`EXC0003`	Invalid ZIP code	ZipCode with invalid format	Enter a valid ZIP code in the correct format
`RISK0005`	Unable to generate the payment	PayerTaxNumber is on the deny list (deny list)	Verify if the payer is not blocked for QR codes
`EXC0050`	Unable to complete the QR code generation	Payer or account validations failed	Verify payer data and account configurations
Processing
`ESE1262`	The account provided does not exist	Person, AccountHolder or Account not found	Verify account data (Bank, BankBranch, BankAccount, BankAccountDigit)
`ESE1264`	The business unit was not found	BusinessUnit not found during processing	Verify if the BusinessUnitId is valid
`EXC0009`	The informed business unit does not have a SPI match	MatchingBusinessUnit SPI not configured	Verify SPI configuration of the BusinessUnit
`ESE1263`	The informed PIX key was not found	PixKey not found or not active	Verify if the PIX key is registered and active
`ESE0092`	Configuration error {0} for the BusinessUnitId {1}	CnabConfigPixSPI configuration not found	Verify CNAB SPI configuration of the BusinessUnit
Due Date Specific Validations
`EXC0014`	The expiration date cannot be less than the due date	ExpirationDate < DueDate	Enter an expiration date after the due date
`EXC0040`	The due date cannot be less than the current date	DueDate < DateTime.Now	Enter a future due date
Success
`INF0013`	Method executed successfully	Dynamic QR code with due date generated successfully	Dynamic QR code created with DocumentNumber, ConciliationId, ExpirationDate, HashCode and specific data returned

GetPixQRCodeByIdentifier

Overview

The GetPixQRCodeByIdentifier method queries PIX QR codes by identifier or document number:

Input Validation
Parameter Validation
Business Validation
Processing
Return of complete QR code data

Complete Codes and Messages

Code	Message	Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Verify required fields and data formats sent
Parameter Validation
`INF0026`	Please enter the document number or its identifier to perform the query	Neither Identifier nor DocumentNumber provided	Enter at least one of the fields: Identifier or DocumentNumber
`INF0018`	There is no Person with the provided TaxNumber that belongs to the informed BusinessUnit	Person with TaxNumber not found in the system	Verify if the CPF/CNPJ is correct and registered
`INF0019`	QR code not found. Check the provided information	QR code not found or Identifier/DocumentNumber mismatch	Verify if the identifier or document number are correct
PIX Key Validation
`EXC0032`	No PIX key found	PixKey not found or invalid	Verify if the PIX key is registered and active
Account Validation
`EXC0005`	No data found with the provided information	Account not found for the PixKey	Verify if the account associated with the PIX key exists and is active
BusinessUnit Validation
`EXC0005`	No data found with the provided information	BusinessUnit not found	Verify if the BusinessUnitId is valid
`EXC0008`	The Business Unit does not allow this action	MatchingBusinessUnit SPI not configured	Verify SPI configuration of the BusinessUnit
`INF0020`	There is no QR code that belongs to the informed Business Unit	QR code does not belong to the requesting BusinessUnit	Verify if the QR code belongs to the informed BusinessUnit
Success
`Success = "true"`	Query executed successfully	QR code found and data returned	QR code data returned with complete information (Static or Dynamic)

ChangeDynamicPixQRCode

Overview

The ChangeDynamicPixQRCode method allows changing existing dynamic PIX QR codes with the following functionalities:

Input Validation
QR Code Validation
Property Validation
Business Validation
Processing

Complete Codes and Messages

Code	Literal Message	Error Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Verify required fields and data formats
`ESE0463`	Account not found	Person (Receiver) not found	Verify if the TaxNumber exists
`ESE0474`	Business Unit not found	BusinessUnit not found	Verify if BusinessUnitId is valid
`EXC0003`	Invalid ZIP Code	ZIP Code with invalid format	Verify ZIP code format (00000-000)
QR Code Validation
`EXC0002`	PJ PX QRCDOCEm not found by DocumentNumber	QR code not found by DocumentNumber	Verify if DocumentNumber is valid
`ESE1264`	Business unit not found during processing	BusinessUnit not found	Verify if BusinessUnitId is valid
`ESE2046`	The PIX key linked to the QR code is invalid	PIX key linked to QR code is invalid	Verify PIX key status
`ESE1262`	The informed account does not exist	Receiver Person not found	Verify if the ReceiverTaxNumber exists
`EXC0006`	The CPF/CNPJ number informed is invalid	Receiver's TaxNumber is invalid	Verify receiver's CPF/CNPJ
`EXC0007`	The receiver's name informed is invalid	Receiver's name not found	Verify receiver's data
`EXC0003`	No QR code identified for the TaxNumber {0}	QR code does not belong to the informed receiver	Verify if the QR code belongs to the TaxNumber
`ESE1548`	The CityName field cannot be null	City not informed in the address	Fill in the city in the address
`EXC0018`	The QR code to be updated is not corresponding to the method used	QR code is not of the Immediate type	Use the correct method for the type of QR code
Recurrence Validation
`EXC0031`	Recurrence not found	Recurrence informed but no automatic document exists	Verify if the recurrence exists
`EXC0078`	It is not possible to change the PayerTaxNumber field of the recurrence	Attempt to change PayerTaxNumber in recurrence	PayerTaxNumber must remain the same
`EXC0081`	The InitialDate field must be equal to or greater than the current date	InitialDate of recurrence in the past	Change InitialDate to a future date
Expiration Date Validation
`EXC0043`	The expiration date cannot be changed	Attempt to change the expiration date with a restrictive parameter	Expiration date is fixed
`EXC0044`	Expiration date invalid	Expiration date null or invalid	Enter a valid expiration date
Payer Validation
`EXC0020`	The payer's name must be informed	PayerTaxNumber informed without PayerName	Fill in PayerName when informing PayerTaxNumber
Transaction Validation (Withdrawal/Change)
`EXC0008`	Invalid transaction type	TransactionPurpose invalid	Use: PurchaseOrTransfer, PurchaseWithChange or Withdraw
`EXC0009`	Invalid change type	ChangeType invalid	Use: None or Allowed
`EXC0002`	The transaction value cannot be changed	ChangeType cannot be None for withdrawal or change	ChangeType must be None for withdrawal and change
`EXC0017`	The withdrawal or change value must be filled	TransactionValue null for withdrawal or change	Enter TransactionValue
`EXC0010`	The original payment value must be equal to 0.00	PrincipalValue != 0 for withdrawal	PrincipalValue must be 0 for withdrawal
`EXC0011`	The original payment value must be greater than 0.00	PrincipalValue <= 0 for change	PrincipalValue must be > 0 for change
`EXC0015`	The withdrawal value must be greater than 0.00	TransactionValue <= 0 for withdrawal	TransactionValue must be > 0
`EXC0016`	The change value must be greater than 0.00	TransactionValue <= 0 for change	TransactionValue must be > 0
`EXC0012`	Change type must be filled when it is withdrawal or change	TransactionChangeType invalid	Use None or Allowed
`EXC0013`	Agent modality must be filled when it is withdrawal or change	AgentModality invalid	Enter a valid modality
Parameter Validation
`ESE0092`	Configuration error {0} for the BusinessUnitId {1}	CnabConfigPixSPI parameter not configured	Configure the parameter in the BusinessUnit
`EXC0021`	The PIX withdrawal parameter is disabled for the informed BusinessUnit	PIXWithdraw disabled	Enable PIXWithdraw in the BusinessUnit
`EXC0022`	The PIX change parameter is disabled for the informed BusinessUnit	PIXChange disabled	Enable PIXChange in the BusinessUnit
Processing
`EXC0042`	Unable to update the QR code	Failure in communication with the QR code provider	Try again or check connectivity
Success
`Success = "true"`	QR code updated successfully	Update processed successfully	QR code updated (instant or scheduled)

CancelPixQRCode

Overview

The CancelPixQRCode method cancels PIX QR codes following the flow:

Input Validation
Business Validation
QR Code Search
Property Validation
Parameter and Status Validation
Event and Charge Processing

Complete Codes and Messages

Code	Literal Message	Error Scenario	Recommended Action
Input Validation
`ISE0014`	Input data is invalid. See the Validation property of the json for more details	JSON model validation failure	Correct the JSON payload according to the Validation property
Business Validation
`ESE0003`	The business unit '{0}' is invalid	BusinessUnit not found by ID	Verify if BusinessUnitId is valid and exists
`EXC0001`	Person not found with the provided data	Person not found by TaxNumber	Verify if the document is registered in the system
QR Code Validation - Search and Existence
`EXC0002`	PixQRCodeDocumentNumber not located	QR code not found by DocumentNumber (QR Code DueDate)	Verify if DocumentNumber is valid
Property Validation
`EXC0047`	No QR code identified for the BusinessUnit {0}	QR code does not belong to the informed BusinessUnit	Verify if QR code belongs to the correct BusinessUnit
`EXC0005`	It is not possible to cancel a QRCode with status {0}	QR code is not in a status that allows cancellation	QR code must have status 'Processed'
`EXC0003`	No QR code identified for the TaxNumber {0}	QR code does not belong to the informed TaxNumber	Verify if TaxNumber is the owner of the QR code
Status Validation - Duplicate Cancellation
`EXC0019`	The informed QRCode is already cancelled	QR code already has status 'Canceled'	QR code cannot be canceled again
Configuration Validation - Parameters
`ESE0092`	Configuration error {0} for the BusinessUnitId {1}	CnabConfigPixSPI parameter not configured for the BusinessUnit	Configure CnabConfigPixSPI parameter in the BusinessUnit
Recurrence Validation - Composite QR Code
`EXC0078`	It is not possible to change the PayerTaxNumber field of the recurrence	PixAutomatic not found for the recurrence of the composite QR code	Verify if recurrence exists and is valid
`EXC0082`	Invalid cancellation request. The QRCode has already been paid or confirmed	Composite QR code is liquidated or PixAutomatic is approved	Cannot cancel QR code already liquidated
`EXC0084`	Invalid cancellation request. The QRCode is already cancelled or in error	Composite QR code is already cancelled or in error	QR code has been previously processed
`EXC0083`	Invalid TaxNumber. Only the recipient is authorized to cancel this QRCode	TaxNumber of the requester is different from the TaxNumber of the recipient in the recurrence	Only the recipient can cancel the QR code