cnabXpress :: API / Cobrança / Cobrança / Remessa
Acesso
URL | http://api.techmundi.com/cnab/cobranca/cobranca/remessa/ |
Cabeçalhos HTTP
Content-Type | application/json |
Accept | application/json |
Access-Control-Request-Method | PUT |
X-API-Key | chave de identificação do cliente (fornecida pela Techmundi Software) |
Parâmetros
campo | tipo | tamanho | requerido | descrição |
---|---|---|---|---|
eol.style | string | 7 | --- | Estilo de fim de linha. Informar: "Windows", "Mac" ou "Linux". Padrão: "Linux". |
padrao | int | 1 | --- | Padrão do arquivo CNAB. Informar 1 para CNAB 240 bytes ou 2 para CNAB 400 bytes. Padrão: 1 CNAB 240 bytes |
sequencia | int | 4 | sim | Número sequencial de remessa do arquivo CNAB. Deve seguir as regras do padrão e ser diferente (incrementado) a cada remessa enviada. Via API, esta numeração deve ser controlada pelo cliente. A API não faz nenhum controle desta numeração. |
mensagem1 | string | 40 | --- | Mensagem 1 a ser enviada no arquivo CNAB. |
mensagem2 | string | 40 | --- | Mensagem 2 a ser enviada no arquivo CNAB. |
mensagem3 | string | 40 | --- | Mensagem 3 a ser enviada no arquivo CNAB. |
mensagem4 | string | 40 | --- | Mensagem 4 a ser enviada no arquivo CNAB. |
mensagem5 | string | 40 | --- | Mensagem 5 a ser enviada no arquivo CNAB. |
contaCodigoBanco | string | 3 | sim | Código do banco da conta bancária. São aceitos todos os códigos suportados, que até o momento são: 001 Banco do Brasil S/A 033 Banco Santander S/A 104 Caixa Econômica Federal S/A 218 Banco BS2 S/A 237 Banco Bradesco S/A 274 Money Plus (Grafeno / KS) 341 Banco Itaú S/A 756 Banco Cooperativo SICOOB S/A SIF Banco SIFRA |
contaAgencia | string | 5 | sim | Número da agência da conta bancária. Geralmente contém somente 4 (quatro) dígitos, mas em situações especiais pode conter 5 (cinco) dígitos. Não deve ser preenchido com zeros à esquerda se contiver somente 4 (quatro) dígitos. |
contaAgenciaDV | string | 1 | sim | Dígito verificador da agência da conta bancária. Caso não seja conhecido, informar 0 (zero). |
contaNumero | string | 12 | sim | Número da conta bancária. Não deve ser preenchido com zeros à esquerda. |
contaNumeroDV | string | 2 | sim | Dígito verificador do número da conta bancária. Geralmente contém somente 1 (um) dígito, mas em situações especiais pode conter 2 (dois) dígitos. Não deve ser preenchido com zeros à esquerda se contiver somente 1 (um) dígito. Caso não seja conhecido, informar 0 (zero). |
contaAgContaDV | string | 1 | sim | Dígito verificador da agência e número da conta bancária. Caso não seja conhecido, informar 0 (zero). |
contaISPB | string | 8 | --- | Código ISPB do banco. Se não for conhecido, não deve ser informado. |
contaConvenio | string | 20 | sim | Número do convênio da empresa com o banco da conta. |
contaCarteira | string | 10 | sim | Número da carteira de cobrança da empresa no banco da conta. |
lotes | array | --- | sim | Array de lotes de registros de remessas. Cada lote precisa conter um ou mais registros, sem limite de quantidade. Os dados dos lotes de registros de remessas estão explicados abaixo. |
Lotes de registros de remessa
Cada conjunto de registros de remessa precisa ser devidamente identificado e precisa conter um ou mais registros de dados, conforme descrito abaixo.
campo | tipo | tamanho | requerido | descrição |
---|---|---|---|---|
tipoCarteira | int | 1 | --- | Tipo de carteira. Informar: 1 para Cobrança Simples (padrão, se nenhum for informado) 2 para Cobrança Vinculada 3 para Cobrança Caucionada 4 para Cobrança Descontada 5 para Cobrança Vendor 6 para Cobrança Cessão |
formaCadastro | int | 1 | --- | Forma de cadastramento. Informar: 1 para Cobrança Registrada (padrão, se nenhum for informada) 2 para Cobrança sem Registro 3 para Com Cadastramento / Recusa do Débito Automático |
tipoDocumento | int | 1 | --- | Tipo de documento. Informar: 1 para Tradicional 2 para Escritural (padrão, se nenhum for informado) |
formaEmissao | int | 1 | --- | Forma de emissão da cobrança. Informar: 1 para Banco Emite 2 para Cliente Emite (padrão, se nenhum for informado) 3 para Banco Pré-emite e Cliente Complementa 4 para Banco Reemite 5 para Banco Não Reemite 6 para Banco Emitente - Aberta 7 para Banco Emitente - Auto-envelopável |
formaDistribuicao | int | 1 | --- | Forma de distribuição da cobrança. Informar: 1 para Banco Distribui 2 para Cliente Distribui (padrão, se nenhum for informado) 3 para Banco envia e-mail 4 para Banco envia SMS |
codigoMovimento | string | 2 | sim | Código do movimento de remessa. Pode ser um conjunto diferente de códigos para bancos diferentes.
Para os bancos 001 Banco do Brasil S/A, 033 Banco Santander S/A ou 104 Caixa Econômica Federal S/A, informar: 01 Remessa 02 Pedido de Baixa 03 Pedido de Protesto Falimentar 04 Concessão de Abatimento 05 Cancelamento de Abatimento Concedido 06 Alteração de Vencimento 07 Alteração do Controle do Participante 08 Alteração de seu Número 09 Pedido de Protesto 12 Ped. Exc. de Cadastro Pagador Débito 13 Inclusão de Cadastro Pagador 14 Alteração Cadastro Pagador 18 Sustar Protesto e Baixar Título 19 Sustar Protesto e Manter em Carteira 20 Alteração de Valor 21 Alteração de Valor com Emissão de Boleto 22 Transferência Cessão Crédito ID. Prod.10 23 Transferência entre Carteiras 24 Dev. Transferência entre Carteiras 31 Alteração de Outros Dados 32 Instrução de Negativação 45 Pedido de Negativação 46 Excluir Negativação com Baixa 47 Excluir Negativação e Manter Pendente 68 Acerto nos Dados do Rateio de Crédito 69 Cancelamento do Rateio de Crédito
Para o banco 218 Banco BS2 S/A, informar:
Para o banco 341 Banco Itaú S/A, informar: |
mensagem1 | string | 40 | --- | Mensagem 1 a ser enviada no arquivo CNAB. |
mensagem2 | string | 40 | --- | Mensagem 2 a ser enviada no arquivo CNAB. |
mensagem3 | string | 40 | --- | Mensagem 3 a ser enviada no arquivo CNAB. |
mensagem4 | string | 40 | --- | Mensagem 4 a ser enviada no arquivo CNAB. |
mensagem5 | string | 40 | --- | Mensagem 5 a ser enviada no arquivo CNAB. |
registros | array | --- | --- | Array de registros de remessas. Cada lote precisa conter um ou mais registros de remessas, e cada registro representa uma cobrança que será enviada ao banco. Os registros de remessa são explicados abaixo. |
Registros de remessas
campo | tipo | tamanho | decimal | requerido | descrição |
---|---|---|---|---|---|
nossoNumero | string | 20 | --- | --- | Nosso número do título/boleto, com até 20 (vinte) caracteres. * Se não for informado, será preenchido com zeros. * Se o código de movimento for 01 (entrada de títulos), caso esteja preenchido com zeros, a numeração será feita pelo banco. |
nossoNumeroDV | string | 1 | --- | --- | DV (dígito verificador) do nosso número do título/boleto, com 1 (um) dígito. Se não for informado, será considerado 0 (zero). |
numeroDocto | string | 15 | --- | --- | Número do documento na empresa (beneficiário), com até 15 caracteres. |
numeroControle | string | 25 | --- | --- | Número de controle (identificação) do título na empresa (beneficiário). É um código no sistema da empresa que permite encontrar o lançamento. |
numeroContrato | string | 10 | --- | --- | Número do contrato da operação de crédito. Número adotado pela empresa (beneficiária) para identificação do número do contrato. Pode conter até 10 dígitos. |
numeroPedido | string | 15 | --- | --- | Número do pedido do pagador, se houver, contendo até 15 dígitos. |
dataEmissao | date | 10 | --- | sim | Data da emissão do título no formato dd/mm/aaaa. Deve ser uma data MENOR OU IGUAL à data de vencimento do título. |
dataVencimento | date | 10 | --- | sim | Data de vencimento do título no formato dd/mm/aaaa. |
valorNominal | float | 13 | 2 | sim | Valor nominal do título. |
codigoMoeda | int | 2 | --- | --- | Código da moeda. Informar um dos códigos da lista abaixo: 01 = Reservado para uso futuro 02 = Dólar americano comercial (venda) 03 = Dólar americano turismo (venda) 04 = ITRD 05 = IDTR 06 = UFIR Diária 07 = UFIR Mensal 08 = FAJ-TR 09 = Real (padrão, se nenhum for informado) 10 = TR 11 = IGPM 12 = CDI 13 = Percentual do CDI 14 = Euro 15 = CDI – CETIP 16 = CHF 17 = CUB/RS (NOVO) 18 = CUB/RS (R8-N) 19 = CUB/SC (ANTIGO) 20 = CUBRS 21 = CUB-SC (NOVO) 22 = GBP 23 = ICC (SALVADOR) 24 = IGPM (A) 25 = IGPM (N) 26 = INCC 27 = INCC-M 28 = INPC 29 = JPY 30 = TJLP |
pagadorInscricao | string | 15 | --- | sim | Número do CNPJ (14 dígitos) ou CPF (11 dígitos) do pagador. Para uso futuro (em caso de alteração ou esgotamento da numeração) a FEBRABAN aceitará até 15 dígitos. |
pagadorInscMunicipal | string | 20 | --- | --- | Número da inscrição municipal do pagador, contendo até 20 dígitos. |
pagadorInscEstadual | string | 20 | --- | --- | Número da inscrição estadual do pagador, contendo até 20 dígitos. |
pagadorNome | string | 40 | --- | sim | Nome do pagador, contendo até 40 caracteres. |
pagadorEndereco | string | 40 | --- | sim | Endereço do pagador, contendo até 40 caracteres. |
pagadorBairro | string | 15 | --- | sim | Bairro do endereço do pagador, contendo até 15 caracteres. |
pagadorCEP | string | 8 | --- | sim | CEP do endereço do pagador, com 8 (oito) dígitos. |
pagadorMunicipio | string | 15 | --- | sim | Cidade (município) do endereço do pagador, contendo até 15 caracteres. |
pagadorUF | string | 2 | --- | sim | UF do município do endereço do pagador, com 2 (dois) caracteres. |
pagadorEmail | string | 50 | --- | --- | E-mail do pagador, contendo até 50 caracteres. |
pagadorDDD | string | 2 | --- | --- | Código DDD do celular do pagador, com 2 (dois) dígitos. |
pagadorCelular | string | 9 | --- | --- | Número do celular do pagador, com 9 (nove) dígitos. |
notaFiscalTipo | int | 2 | --- | --- | Tipo da nota fiscal do pagador, se houver. Informar um dos códigos da lista abaixo: 1 = (CC-e) Carta de Correção Eletrônica 2 = (CF-e) Cupom Fiscal eletrônico 3 = (CT-e) Conhecimento de transporte eletrônico 4 = (CT-e OS) Conhecimento de Transporte para Fretamento e Outros Serviços 5 = (MDF-e) Manifesto de Documentos Fiscais Eletrônicos 6 = (MF-e) Módulo Fiscal Eletrônico 7 = (NF-e) Nota Fiscal Eletrônica (padrão, se nenhum for informado) 8 = (NFA-e) Nota fiscal avulsa eletrônica 9 = (NFC-e) Nota fiscal ao consumidor eletrônica 10 = (NFS-e) Nota Fiscal de Serviço Eletrônica 11 = (XXX-e) Outros |
notaFiscalNumero | string | 15 | --- | --- | Número da nota fiscal do pagador, se houver, contendo até 15 dígitos. |
notaFiscalChave | string | 44 | --- | --- | Chave de acesso da nota fiscal do pagador, contendo até 44 dígitos. |
especie | int | 2 | --- | --- | Espécie do título. Informar um dos códigos da lista abaixo: 01 = Cheque 02 = Duplicata mercantil 03 = Duplicata mercantil para indicação 04 = Duplicata de serviço 05 = Duplicata de serviço para indicação 06 = Duplicata rural 07 = Letra de câmbio 08 = Nota de crédito comercial 09 = Nota de crédito a exportação 10 = Nota de crédito industrial 11 = Nota de crédito rural 12 = Nota promissória 13 = Nota promissória rural 14 = Triplicata mercantil 15 = Triplicata de serviço 16 = Nota de seguro 17 = Recibo 18 = Fatura 19 = Nota de débito 20 = Apólice de seguro 21 = Mensalidade escolar 22 = Parcela de consórcio 23 = Nota fiscal (padrão, se nenhum for informado) 24 = Documento de dívida 25 = Cédula de produto rural 26 = Warrant 27 = Dívida ativa de estado 28 = Dívida ativa de município 29 = Dívida ativa da união 30 = Encargos condominiais 31 = Cartão de crédito 32 = Boleto de proposta 99 = Outros |
aceite | int | 1 | --- | --- | Identificação de título aceito/não aceito. Informar: 1 = se foi aceito 2 = se não foi aceito (padrão, se nenhum for informado) |
codigoMulta | int | 1 | --- | --- | Código da multa (por atraso de pagamento). Informar: 1 = para valor fixo 2 = para percentual |
dataMulta | date | 10 | --- | --- | Data da multa no formato dd/mm/aaaa. Se for informada, deve ser uma data igual ou superior à data de vencimento. Será considerada somente se for informado um código de multa. |
valorMulta | float | 13 | 2 | --- | Valor ou percentual da multa. Será considerado somente se for informado um código de multa. |
codigoJuros | int | 1 | --- | --- | Código do juros de mora. Informar: 1 = se os juros forem informados em valor por dia de atraso 2 = se os juros forem informados em taxa mensal (percentual) |
dataJuros | date | 10 | --- | --- | Data do juros de mora no formato dd/mm/aaaa. Se for informada, deve ser uma data igual ou superior à data de vencimento. Será considerada somente se for informado um código de juros de mora. |
valorJuros | float | 13 | 2 | --- | Juros de mora por dia/taxa. Se o código do juros de mora for: 1 = informar o valor por dia de atraso. 2 = informar o percentual mensal (não é um percentual diário) |
codigoDesconto1 | int | 1 | --- | --- | Código do desconto 1. Informar: 1 = para valor fixo até a data informada 2 = para percentual até a data informada 3 = para valor por antecipação dia corrido 4 = para valor por antecipação dia útil 5 = para percentual sobre o valor nominal dia corrido 6 = para percentual sobre o valor nominal dia útil 7 = para cancelamento de desconto * se forem utilizados os códigos 1 ou 2, será obrigatório informar a data. * o código 7 só poderá ser informado se o código de movimento for 31 (alteração de dados). |
dataDesconto1 | date | 10 | --- | --- | Data do desconto 1 no formato dd/mm/aaaa. Será considerada somente se for informado um código de desconto. |
valorDesconto1 | float | 13 | 2 | --- | Valor ou percentual do desconto 1. Será considerado somente se for informado um código de desconto. |
codigoDesconto2 | int | 1 | --- | --- | Código do desconto 2. Informar: 1 = para valor fixo até a data informada 2 = para percentual até a data informada 3 = para valor por antecipação dia corrido 4 = para valor por antecipação dia útil 5 = para percentual sobre o valor nominal dia corrido 6 = para percentual sobre o valor nominal dia útil 7 = para cancelamento de desconto * se forem utilizados os códigos 1 ou 2, será obrigatório informar a data. * o código 7 só poderá ser informado se o código de movimento for 31 (alteração de dados). |
dataDesconto2 | date | 10 | --- | --- | Data do desconto 2 no formato dd/mm/aaaa. Será considerada somente se for informado um código de desconto. |
valorDesconto2 | float | 13 | 2 | --- | Valor ou percentual do desconto 2. Será considerado somente se for informado um código de desconto. |
codigoDesconto3 | int | 1 | --- | --- | Código do desconto 3. Informar: 1 = para valor fixo até a data informada 2 = para percentual até a data informada 3 = para valor por antecipação dia corrido 4 = para valor por antecipação dia útil 5 = para percentual sobre o valor nominal dia corrido 6 = para percentual sobre o valor nominal dia útil 7 = para cancelamento de desconto * se forem utilizados os códigos 1 ou 2, será obrigatório informar a data. * o código 7 só poderá ser informado se o código de movimento for 31 (alteração de dados). |
dataDesconto3 | date | 10 | --- | --- | Data do desconto 3 no formato dd/mm/aaaa. Será considerada somente se for informado um código de desconto. |
valorDesconto3 | float | 13 | 2 | --- | Valor ou percentual do desconto 3. Será considerado somente se for informado um código de desconto. |
valorAbatimento | float | 13 | 2 | --- | Valor do abatimento. |
valorIOF | float | 13 | 2 | --- | Valor do IOF a ser recolhido. |
codigoProtesto | int | 1 | --- | --- | Código para protesto. Informar: 1 = para protestar dias corridos 2 = para protestar dias úteis 3 = para não protestar 4 = para protestar fim alimentar - dias úteis 5 = para protestar fim alimentar - dias corridos 6 = para não negativar 7 = para negativação sem protesto 8 = para cancelamento protesto automático * o código 9 pode ser informado somente se o movimento de remessa for 31. |
diasProtesto | int | 2 | --- | --- | Número de dias para protesto. * Se forem informados os códigos 1, 2, 4 ou 5, informar a quantidade de dias (após o vencimento) para protestar o título. |
codigoBaixa | int | 1 | --- | --- | Código para baixa/devolução. Informar: 1 = para baixar / devolver 2 = para não baixar / não devolver 3 = para cancelar prazo para baixa / devolução * o código 3 pode ser informado somente se o movimento de remessa for 31. |
diasBaixa | int | 3 | --- | --- | Número de dias para baixa/devolução. É o número de dias CORRIDOS (não somente dias úteis) após a data de vencimento de um título não pago, que deverá ser baixado e devolvido para o beneficiário. |
avalistaInscricao | string | 15 | --- | --- | Número do CNPJ (14 dígitos) ou CPF (11 dígitos) do sacador/avalista. Para uso futuro (em caso de alteração ou esgotamento da numeração) a FEBRABAN aceitará até 15 dígitos. |
avalistaNome | string | 40 | --- | --- | Nome do sacador/avalista, contendo até 40 caracteres. |
avalistaEndereco | string | 40 | --- | --- | Endereço do sacador/avalista, contendo até 40 caracteres. |
avalistaBairro | string | 15 | --- | --- | Bairro do endereço do sacador/avalista, contendo até 15 caracteres. |
avalistaCEP | string | 8 | --- | --- | CEP do endereço do sacador/avalista, com 8 (oito) dígitos. |
avalistaMunicipio | string | 15 | --- | --- | Cidade (município) do endereço do sacador/avalista, contendo até 15 caracteres. |
avalistaUF | string | 2 | --- | --- | UF do município do endereço do sacador/avalista, com 2 (dois) caracteres. |
infoPagador | string | 10 | --- | --- | Informação ao pagador, contendo até 10 caracteres. Texto de observações destinado ao envio de informações do beneficiário ao pagador. Este campo só poderá ser utilizado caso haja troca de arquivos magnéticos entre o banco e o pagador. |
mensagem1 | string | 40 | --- | --- | Mensagem 1, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem2 | string | 40 | --- | --- | Mensagem 2, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem3 | string | 40 | --- | --- | Mensagem 3, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem4 | string | 40 | --- | --- | Mensagem 4, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem5 | string | 40 | --- | --- | Mensagem 5, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem6 | string | 40 | --- | --- | Mensagem 6, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
mensagem7 | string | 40 | --- | --- | Mensagem 7, contendo até 40 caracteres. Texto de observações destinado ao envio de mensagens livres, a serem impressas no campo de instruções da ficha de compensação do boleto de pagamento, caso o banco emita e envie os boletos ao pagador. |
debitoBanco | string | 3 | --- | --- | Código do banco para débito automático. |
debitoAgencia | string | 5 | --- | --- | Código da agência para débito automático. |
debitoAgenciaDV | string | 1 | --- | --- | DV (Dígito verificador) da agência para débito automático. |
debitoConta | string | 12 | --- | --- | Número da conta para débito automático. |
debitoContaDV | string | 1 | --- | --- | DV (Dígito verificador) do número da conta para débito automático. |
debitoAgeCtaDV | string | 1 | --- | --- | DV (Dígito verificador) da agência + número da conta para débito automático. |
debitoAviso | int | 1 | --- | --- | Aviso para débito automático. Informar: 1 = para emitir aviso com o endereço informado no arquivo remessa 2 = para não emitir aviso ao pagador (padrão, se nenhum for informado) 3 = para emitir aviso com o endereço constante do cadastro do banco |
Exemplo
"eol.style":"Windows", "padrao":1, "sequencia":123, "contaCodigoBanco":"218", "contaAgencia":"0389", "contaAgenciaDV":"1", "contaNumero":"1234567", "contaNumeroDV":"0", "contaAgContaDV":"0", "contaISPB":"1211", "contaConvenio":"39473299", "contaCarteira":"125", "lotes":[{ "tipoCarteira":1, "formaCadastro":1, "tipoDocumento":2, "formaEmissao":2, "formaDistribuicao":2, "codigoMovimento":"01", "registros":[ { "nossoNumero":"19327129", "numeroDocto":"ABB67986-1", "numeroControle":"12332", "dataEmissao":"05/06/2024", "dataVencimento":"25/06/2024", "valorNominal":1221.30, "pagadorInscricao":"27188902000129", "pagadorInscEstadual":"ISENTO", "pagadorNome":"Empresa XYZ Ltda", "pagadorEndereco":"Avenida Cidade Nova, 45", "pagadorBairro":"Jardins", "pagadorCEP":"01100011", "pagadorMunicipio":"São Carlos", "pagadorUF":"SP", "notaFiscalTipo":7, "notaFiscalNumero":"3287", "especie":23, "aceite":2 }, { "nossoNumero":"199122154", "numeroDocto":"SMU-68712-A", "numeroControle":"12989", "dataEmissao":"05/06/2024", "dataVencimento":"25/06/2024", "valorNominal":500.23, "pagadorInscricao":"10872287000120", "pagadorInscEstadual":"ISENTO", "pagadorNome":"Empresa Teste Ltda", "pagadorEndereco":"Rua Salinas, 423 LJ 203", "pagadorBairro":"Sapopema", "pagadorCEP":"13100011", "pagadorMunicipio":"Itapevi", "pagadorUF":"SP", "notaFiscalTipo":7, "notaFiscalNumero":"18990", "especie":23 } ] }]
Dados de retorno
message | código e texto da mensagem de retorno de processamento |
data | texto do arquivo CNAB |
Códigos e mensagens de retorno
200 OK | processamento concluído com sucesso |
400 Bad Request | processamento incorreto, banco não existe ou não suportado |
401 Unauthorized | código de usuário não existe / incorreto / inválido, ou há algum problema com o cadastro ou pagamento |
405 Method Not Allowed | método não suportado |