EXexato
Federação Brasileira de Bancos - FEBRABAN

Cheque status — Cheque Legal (FEBRABAN)

Checks whether a cheque has an occurrence reported by the issuing bank: stopped or revoked, cancelled, stolen, lost or from a closed account.

Source: Cheque Legal service of FEBRABAN, the Brazilian Federation of Banks: https://www.chequelegal.com.br/.

Returns: protocol, status code and text of the cheque, and the dates of the query, of the answer and of the last update by the bank.

Execution: synchronous; no PDF.

Note: Code 2 means the cheque has an occurrence or the bank did not accept the data sent; see SituacaoConsultaChequeSituacao. The service does not check whether the account has funds.

post/br/febraban/cheque-legal

Request

Query parameters

test_modeboolean

true returns simulated data, without querying the source. Queries that do not offer test mode return code 7.

lightweightboolean

Lightweight mode (internal use).

Request body application/x-www-form-urlencoded

cpf_cnpj_emissorstring required

CPF (11 digits) or CNPJ (14 digits) of the cheque issuer.

cpf_cnpj_interessadostring required

CPF (11 digits) or CNPJ (14 digits) of the party checking the cheque (e.g. the payee).

cmc7_1string

First field of the cheque CMC7 code (8 digits). Send the three fields or cmc7.

cmc7_2string

Second field of the cheque CMC7 code (10 digits).

cmc7_3string

Third field of the cheque CMC7 code (12 digits).

cmc7string

Full CMC7 code of the cheque, 30 digits (other characters are ignored). When sent, cmc7_1, cmc7_2 and cmc7_3 are ignored.

Response

Success

ApiResultType'Success' | 'SuccessWithRemarks' | 'InvalidInput' | 'DataUnavailable' | 'NotFound' | 'InvalidParameters' | 'UnsupportedCombination' | 'RemoteUnavailable' | 'Timeout' | 'RetryLimitReached' | 'RemoteError' | 'InProgress' | 'InsufficientCredits' | 'ConcurrentLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'Created' | 'Updated' | 'Deleted' | 'InternalError' | 'ValidationFailed' | 'Conflict' | 'ResourceLocked' | 'PendingApproval' | 'Approved' | 'Rejected' | 'Cancelled' | 'Paused' | 'Resumed'

New unified result type for queries and administrative operations. Replaces TransactionResultType with better semantics.

BalanceInBrlnumber double

Current balance in BRL.

BalanceInCreditsinteger

Current balance in credits.

DataSourceCategorystring

Data source category

Datestring date-time

Transaction date.

ElapsedTimeInMillisecondsinteger

Execution time (in milliseconds).

ExecutedDataSourceNamestring

Display name of the query type that actually ran.

ExecutedDataSourceTypeIdinteger

Id of the query type that actually ran (the one recorded on the transaction), which may differ from the requested type when the route is generic per state or when a master delegates to a sub-query.

HasOriginalFilesboolean

Indicates that the transaction carries original files from the source (the issued certificate, for example) for download at OriginalFilesUrl. False does not mean the URL does not exist: it is always built.

HasPdfboolean

Indicates that there is a PDF proof document for the result.

Messagestring

Message.

OriginalFilesUrlstring

URL to download the transaction's original files (when available).

OutdatedResultboolean

Indicates that the result is dated.

PdfUrlstring

URL to download the transaction's PDF proof document (when available).

ResultSubtypestring

Specific result subtype to provide additional context (e.g.: 'duplicate_name', 'invalid_cpf').

ResultTypeCodeinteger

Numeric result code (compatible with TransactionResultTypeCode but extensible).

TotalCostnumber double

Internal use only.

TotalCostInCreditsinteger

Total transaction cost in credits.

TransactionResultType'Success' | 'SuccessWithRemarks' | 'InvalidInputData' | 'UnavailableData' | 'EntityNotFound' | 'InvalidParameters' | 'ParametersNotSupported' | 'RemoteSystemUnavailable' | 'Timeout' | 'AttemptsLimitReached' | 'RemoteSystemError' | 'AsyncExecutionInProgress' | 'AwaitingExecution' | 'BirthDateRequired' | 'InsufficientBalance' | 'SimultaneousTransactionsLimitReached' | 'TransactionUnavailable' | 'AccessDenied' | 'TransactionCancelled' | 'InternalError'
<table class="transaction"><thead><tr><th>TransactionResultType Code</th><th>TransactionResultType</th><th>Final</th><th>Billable</th><th>Error</th></tr></thead><tbody><tr><td>1</td><td>Success</td><td>True</td><td>True</td><td>False</td></tr><tr><td>2</td><td>Partial success or success with remarks</td><td>True</td><td>True</td><td>False</td></tr><tr><td>3</td><td>Invalid input or document</td><td>True</td><td>False</td><td>True</td></tr><tr><td>4</td><td>Data not available</td><td>True (for the day)</td><td>False</td><td>False</td></tr><tr><td>5</td><td>Entity or document nonexistent/not found</td><td>True</td><td>True</td><td>False</td></tr><tr><td>6</td><td>Invalid input parameters</td><td>True</td><td>False</td><td>True</td></tr><tr><td>7</td><td>Unsupported parameter combination</td><td>True</td><td>False</td><td>True</td></tr><tr><td>8</td><td>Data source or remote system unavailable</td><td>False</td><td>False</td><td>True</td></tr><tr><td>9</td><td>Time limit exceeded</td><td>False</td><td>False</td><td>True</td></tr><tr><td>10</td><td>Attempts limit reached</td><td>False</td><td>False</td><td>True</td></tr><tr><td>11</td><td>Error in the data source or remote system</td><td>False</td><td>False</td><td>True</td></tr><tr><td>12</td><td>Transaction in progress</td><td>False</td><td>False</td><td>False</td></tr><tr><td>101</td><td>Insufficient credit balance, please contact us</td><td>False</td><td>False</td><td>True</td></tr><tr><td>102</td><td>Simultaneous transactions limit reached, please contact us</td><td>False</td><td>False</td><td>True</td></tr><tr><td>103</td><td>Transaction not available, please contact us</td><td>False</td><td>False</td><td>True</td></tr><tr><td>104</td><td>Invalid credentials or access denied, please contact us</td><td>False</td><td>False</td><td>True</td></tr><tr><td>105</td><td>Transaction cancelled, please contact us</td><td>False</td><td>False</td><td>True</td></tr><tr><td>255*</td><td>Unexpected internal error, please contact us</td><td>True (for the day)</td><td>False</td><td>True</td></tr><tr><td>* Query under maintenance, try again later or contact Exato to report the problem</td></tr></tbody></table>
TransactionResultTypeCodeinteger

Transaction result type code.

UniqueIdentifierstring

Unique transaction identifier. Store it for control and debugging.

Changes

No operation changes recorded.