GeneratePixOut

Overview

The GeneratePixOut method executes validations for PIX payments in multiple layers:

Input Validation
PIX Key Validation
Business Validation
Transactional Processing

Complete Codes and Messages

Code	Literal Message	Error Scenario	Recommended Action
Input Validation
`ISE0014`	ISE0014 - Input data is invalid. See the Validation property of the json for more details.	JSON model validation failure	Correct JSON payload
`ISE0052`	ISE0052 - Please enter a valid payment date	Payment date in the past	Enter current or future date
`ISE0043`	ISE0043 - Invalid Identifier	Identifier not provided	Provide valid Identifier
`ISE0243`	ISE0243 - Recipient account must be the same as the sender.	Transfer to different TaxNumber when blocked	Verify transfer blocking rule
`ISI0227`	ISI0227 - Transfer with the identifier "{0}" has already been generated previously.	Duplicate Identifier	Use a unique Identifier
PIX Key Validation
`ISI0479`	ISI0479 - The attribute {0} is invalid for the type {1}	Invalid PIX key format for the type	Correct PIX key format
`ISI0440`	ISI0440 - The attribute {0} is invalid	Unrecognized PIX key format	Verify PIX key type and format
`ISI0495`	Invalid {0} size	PIX key empty or invalid size	Enter a valid PIX key
Business Validation
`ISE0048`	ISE0048 - Invalid transfer destination	ToName or ToTaxNumber not provided	Provide recipient's data
`ISI0613`	ISI0613 - It is necessary to provide the ToName property	ToName field is required	Provide recipient's name
`ISI0559`	ISI0559 - It is necessary to provide the ToTaxNumber property	ToTaxNumber field is required	Provide recipient's CPF/CNPJ
`ISI0614`	ISI0614 - It is necessary to provide the ToBankAccount property	ToBankAccount field is required	Provide recipient's bank account
`ISI0615`	ISI0615 - It is necessary to provide the ToBankAccountDigit property	ToBankAccountDigit field is required	Provide recipient's bank account digit
`ISI0616`	ISI0616 - It is necessary to provide the AccountType property	AccountType field is required	Provide recipient's account type
`EXC0055`	The PIX must have a valid monetary value	Value with more than 2 decimal places	Enter a value with up to 2 decimal places
PIX Type Validation
`EXC0006`	Banking information not provided or incomplete	Banking information not provided for Manual type	Provide complete banking information
`EXC0008`	PIX key not provided for this type {0} of payment	PIX key not provided for type PixKey	Provide a valid PIX key
`EXC0001`	EXC0001 - Invalid key of type {0}, verify.	Invalid PIX key for QR Code types	Verify PIX key format
`EXC0040`	SearchProtocol not provided for this type {0} of payment	SearchProtocol not provided	Provide a valid SearchProtocol
`EXC0046`	There is already a PixOut generated with the provided SearchProtocol	SearchProtocol already used	Use a new, unique SearchProtocol
Banking Validation
`EXC0001`	It is necessary to provide the ToBank or ToISPB field	ToBank and ToISPB not provided	Provide bank code or ISPB
`EXC0057`	The sum between the BankAccount and BankAccountDigit fields must be 1 to 20 digits	Bank account with invalid size	Adjust account to 1-20 digits
`EXC0063`	ISPB not found for the bank with code: {0}	Bank without configured ISPB	Verify bank configuration
Success
`INF0004`	PIX payment request received successfully.	PIX processed successfully	Transaction initiated successfully

CancelPixOut

Overview

The CancelPixOut method executes validations for PIX cancellation in multiple layers:

Input Validation
Business Validation
Transactional Processing
Status and Permission Validation

Complete Codes and Messages

Code	Literal Message	Error Scenario	Recommended Action
Input Validation
`ISE0014`	ISE0014 - Input data is invalid. See the Validation property of the json for more details.	JSON model validation failure	Correct JSON payload
Business Validation
`ESE0003`	ESE0003 - The business unit '{0}' is invalid.	BusinessUnit not found	Verify valid BusinessUnitId
`EXC0001`	EXC0001 - Person not found with the provided data.	Person not found by TaxNumber	Verify CPF/CNPJ informado
Transactional Validation
`DISP0070`	Transaction not found. Verify the provided information and try again.	PixOut not found or banking information divergent	Verify transaction data
`DISP0071`	It is not possible to cancel a transaction with the status {0}.	PIX status does not allow cancellation	Verify current transaction status
Status Validation
`EXC0019`	It is not possible to request the cancellation of a PIX that is already cancelled.	PIX already cancelled previously	Verify transaction status
`EXC0056`	It is not possible to request the cancellation of a PIX that is already in processing in the SPI.	PIX in processing in SPI	Wait for processing completion
Success
`INF0014`	PIX payment cancellation request received successfully.	Cancellation processed successfully	Cancellation initiated successfully

Cancellation Conditions

PIX Status	Can Cancel	Action Executed
Created	Yes	Direct Cancellation
CanBeRegister	Yes	Direct Cancellation
Registered	No	`EXC0056` - In processing
Settled	No	`EXC0019` - Already settled
Canceled	No	`EXC0019` - Already cancelled
Error	No	`DISP0071` - Invalid status

With Entry: Cancels postings and updates to PreCanceled
Without Entry: Cancels directly and updates to Canceled

GenerateRefundPixIn

Overview

The GenerateRefundPixIn method processes PIX refunds received with complete validations in multiple layers:
Main Flow:

Input Validation
Mapping and Transformation
Business Validation
Configuration and Infrastructure
Account Structure
Validation of the Original PIX
Value and Deadline Rules

Complete Codes and Messages

Code	Literal Message	Error Scenario	Recommended Action
Input Validation
`ISE0014`	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
Mapping and Transformation
`ISE0062`	ISE0062 - DocumentNumber invalid.	DocumentNumber does not correspond to valid PIX	Verify if DocumentNumber exists
`ISE0048`	ISE0048 - Invalid transfer destination	Recipient's data diverges from the original PIX	Validate recipient's original data
`ISE0032`	ISE0032 - It is not possible to perform a transfer to a user not registered in our system.	Payer not found	Verify payer's registration
Business Validation
`ISI0227`	ISI0227 - Transfer with the identifier "{0}" has already been generated previously.	Duplicate Identifier	Use a unique Identifier
Configuration and Infrastructure
`ESE0023`	ESE0023 - Transfer value must be greater than R$ 0	Invalid value ≤ 0	Enter a positive value
`ESE0092`	ESE0092 - Configuration error {0} for the BusinessUnitId {1}	PIX SPI configuration not found	Configure CnabConfigPixSPI parameter
`EXC0058`	EXC0058 - PIX service unavailable. Try again later.	Continuous execution is inactive	Wait for service availability
`ESE0007`	ESE0007 - No tax found for the business unit '{0}' and the type of operation '{1}'.	Tax not configured	Configure tax for RefundPixIn
Account Structure
`EXC0001`	EXC0001 - No account enabled for SPI type.	Matching business unit not found for SPI	Configure matching for SPI
`ASE0002`	ASE0002 - No account holder registered for the document '{0}' of the person informed.	Account holder not found	Verify account holder registration
`ASE0003`	ASE0003 - No account registered for the account holder '{0}' and the business unit '{1}' informed.	SPI account not found	Verify SPI account or matching
`SQL0013`	SQL0013 - Origin account is blocked.	Account limited for transferring to third-party	Use a non-limited account or same holder
Original PIX Validation
`EXC0006`	EXC0006 - Unable to find the PIX informed	PIX not found by DocumentNumber	Verify if PIX exists
`EXC0008`	EXC0008 - The recipient informed does not correspond to the PIX	Recipient's data does not match	Validate recipient's banking data
`EXC0007`	EXC0007 - The payer informed does not correspond to the PIX	Payer's data does not match	Validate payer's banking data
`EXC0014`	EXC0014 - Business unit is not consistent with the original receipt.	Incompatible business unit	Use the same BU as the original PIX
`EXC0027`	EXC0027 - The Identifier informed does not correspond to the DocumentNumber	Identifier and DocumentNumber inconsistent	Verify data consistency
Value and Deadline Rules
`EXC0001`	EXC0001 - Refund value is less than or equal to zero	Invalid refund value	Enter a positive value
`EXC0002`	EXC0002 - Total refund value is greater than the original PIX value	Refund value exceeds original	Verify previous refunds
`EXC0003`	EXC0003 - Payment date exceeds the 90-day deadline	Deadline exceeded	PIX beyond the return deadline
`EXC0004`	EXC0004 - The refund value is greater than the original PIX value	Individual refund value exceeds PIX	Use a refund value ≤ original

GetPixOutByDate

Overview

The GetPixOutByDate method queries PIX payments by period and has rigorous validations:

Input Validation
Business Validations
Transaction Query
Data Processing and Formatting

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
Business Validations
`EXC0024`	There is no person with the TaxNumber informed that belongs to the BusinessUnit informed.	TaxNumber not found in the BusinessUnit	Verify if the TaxNumber is correct and belongs to the BusinessUnit
`EXC0027`	Unable to find the AccountHolder.	AccountHolder not found for the person	Verify if the person has a registered account
`EXC0028`	Unable to find a Business Unit.	MatchingBusinessUnit not found for SPI	Verify if the BusinessUnit is enabled for PIX
`EXC0059`	No account registered for the holder in the business unit '{0}' informed, please enter the correct data.	Account not found with banking data	Verify banking data (Bank, Bank Branch, Account, Digit)
`EXC0034`	The date(s) informed cannot be null.	StartDate or EndDate null	Enter start and end dates
`EXC0023`	Invalid date range - The end date cannot be less than the start date.	EndDate less than StartDate	Correct the query period
`EXC0025`	The page size must be greater than zero.	PageSize ≤ 0	Enter a PageSize greater than zero
`EXC0026`	The Index provided must be greater than or equal to zero.	PageIndex < 0	Enter a PageIndex ≥ 0
Processing
`EXC0035`	No PIX payments found for this date range	No PIX payment found in the period	Verify the period or expand the query
`EXC0048`	EXC0048 - Unable to find a Bank for the payer with the Code {0}.	Bank not found by code	Verify the bank code in the database
Success
`INF0013`	Method executed successfully.	Query executed successfully	Data returned correctly

GetPixInByDate

Overview

The GetPixInByDate method queries PIX payments received by period:

Input Validation
Business Unit and SPI Account Validation
Holder and Account Validation
PIX Payment Query
Paginated Data Return

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
`ISE0085`	It is necessary to enter a valid initial and final date	Initial or final date not provided or invalid	Enter valid dates in the StartDate and EndDate fields
`ISE0303`	The page size must be greater than zero and the index must be greater than or equal to zero	PageSize ≤ 0 or PageIndex < 0	Enter a PageSize > 0 and PageIndex ≥ 0
Business Validation
`ESE0474`	Business Unit not found	BusinessUnitId does not exist in the system	Verify if the BusinessUnitId is correct
`ESE1312`	Account not enabled to operate in the SPI system	Business Unit does not have SPI configuration	Verify SPI account configuration
`EXC0002`	Unable to find the Person with the TaxNumber informed	CPF/CNPJ not found in the system	Verify if the TaxNumber is correct
`ESE0270`	Unable to find an AccountHolder with the Id {0} and BusinessUnit {1}	Person does not have an AccountHolder in the BusinessUnit	Verify if the person has an account in the informed unit
`EXC0059`	No account registered for the holder in the business unit '{0}' informed, please enter the correct data.	Account with specific banking data not found	Verify banking data (Bank, Bank Branch, Account, Digit)
Processing
`EXC0061`	No PIX payments received for this date range	No PIX payment found in the period	Verify the period or expand the date range
Success
`INF0013`	Method executed successfully.	Query executed successfully	Data returned correctly

GetPixOutById

Overview

The GetPixOutById method queries a specific PIX sent by ID:

Input Validation
Business Validation
PIX Payment Transaction Query
Transaction Data Return

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
Business Validation
`EXC0024`	There is no person with the TaxNumber informed that belongs to the BusinessUnit informed.	TaxNumber not found in the BusinessUnit	Verify if the TaxNumber is correct and belongs to the BusinessUnit
`EXC0027`	Unable to find the AccountHolder.	AccountHolder not found for the person	Verify if the person has a registered account
`EXC0028`	Unable to find a Business Unit.	MatchingBusinessUnit not found for SPI	Verify if the BusinessUnit is enabled for PIX
`EXC0029`	Unable to locate the account.	Account not found for the AccountHolder in the BusinessUnit SPI	Verify if there is a registered SPI account for the holder in the business unit
`EXC0058`	Must provide a valid DocumentNumber or Identifier.	Neither DocumentNumber nor Identifier was provided in the request	Provide at least one of the fields: DocumentNumber or Identifier
`EXC0059`	No account registered for the holder in the business unit '{0}' informed, please enter the correct data.	Account not found with banking data	Verify banking data (Bank, Bank Branch, Account, Digit)
Processing
`EXC0033`	No PIX payment found with the provided ID	PixOut not found by specific ID	Verify if the transaction ID is correct
`EXC0048`	EXC0048 - Unable to find a Bank for the payer with the Code {0}.	Bank not found by code	Verify the bank code in the database
Success
`INF0013`	Method executed successfully.	Query executed successfully	Transaction data returned correctly

GetPixInById

Overview

The GetPixInById method queries a specific PIX received by different identifiers:

Input Validation
Business Validation
PIX Payment Transaction Query
Data Consistency Validation
Response Assembly

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
`EXC0018`	Please inform the DocumentNumber or EndToEndId or ConciliationId.	No identifier provided	Provide at least one of the identifiers
Business Validation
`EXC0002`	CPF/CNPJ not found	Person not found by TaxNumber	Verify if the CPF/CNPJ is correct
`EXC0005`	Unable to find the account information of the payer	AccountHolder not found for the person	Verify if the person has an account in the system
`EXC0004`	Error {0} for BusinessUnitId {1} configurations	MatchingBusinessUnit SPI not configured	Verify SPI configuration of the BusinessUnit
`EXC0003`	Account not found	Account not found with the provided banking data	Verify banking data (Bank, Bank Branch, Account, Digit)
Transaction Processing
`EXC0019`	Transaction not found with the provided data	PixIn not found by identifier	Verify if the identifier is correct
`EXC0019`	Transaction not found with the provided data	Identifier data inconsistency	Verify consistency between identifiers
`EXC0019`	Transaction not found with the provided data	BusinessUnit of the transaction does not match	Verify if the transaction belongs to the informed BusinessUnit
`EXC0019`	Transaction not found with the provided data	Banking data does not match the transaction	Verify if banking data corresponds to the transaction
`EXC0023`	EXC0023 - Receipt in process. Try again in a few moments.	PixInNote not found	Wait for processing or verify transaction status
`EXC0023`	EXC0023 - Receipt in process. Try again in a few moments.	Note not found	Wait for processing or verify transaction status
`EXC0023`	EXC0023 - Receipt in process. Try again in a few moments.	Operation not found	Wait for processing or verify transaction status
Success
`INF0013`	Method executed successfully	Query executed successfully	Transaction data returned correctly