Pular para o conteúdo principal

Consulta de CNAB de aquisição

Devolve o CNAB de aquisição da subscrição, no layout posicional de 444 caracteres, codificado em Base64.

O arquivo é gerado no momento da consulta, a partir dos dados atuais da operação. Ele não é armazenado, então duas consultas em dias diferentes devolvem nomes de arquivo e datas de gravação diferentes. Use este endpoint para reenviar o arquivo ao destino, não como registro do que foi enviado anteriormente.


Consulta de CNAB de aquisição (GET)

Request

ENDPOINT
/integralization/integralization_process/INTEGRALIZATION-KEY/subscription/SUBSCRIPTION-KEY/acquisition_cnab
MÉTODO
GET

Path Params

CampoTipoDescriçãoCaracteres
INTEGRALIZATION-KEYstringChave única do processo de integralização (UUID v4).36
SUBSCRIPTION-KEYstringChave única da subscrição (UUID v4).36

Response

STATUS
200
Response Body
{
"file_name": "CBNC210900.REM",
"document_base64": "MDFSRU1FU1NBMDFDT0JSQU5DQSAgICAgICAwMDAwMDAwMDAwMDAwMDAxMjM1NEZVTkRPIEhN..."
}

Response Body Params

CampoTipoDescrição
file_namestringNome do arquivo, no formato CBNC<DDMM>00.REM. O dia e o mês são os da geração.
document_base64stringConteúdo do arquivo em Base64.
observação

Ao decodificar o Base64 você obtém um arquivo de texto, não um PDF: uma linha de 444 caracteres por registro, com um header, um detalhe por parcela e um trailer.


Erros

HTTPCódigoQuando ocorre
400INT000005 (SubscriptionNotLinked)A subscrição não pertence ao processo de integralização informado.
403INT000003 (IntegralizationNotBelongToTenant)O processo de integralização não pertence ao cliente que fez a requisição.
404INT000004 (SubscriptionNotFound)Subscrição não encontrada.
422INT000036 (FinancialIndexNotSupported)O índice de correção da operação não é suportado na geração do CNAB.
422INT000043 (AcquisitionCnabNumeroDocumentoDoesNotFit)O número do contrato não cabe no campo de número do documento.
422INT000044 (TenantInvestorNameMissing)O investidor da subscrição não tem nome cadastrado.