pagamentos
Tutoriais

Manuais / tutoriais

Manuais, tutoriais e ajuda geral. Escolha a categoria (à direita) para ser direcionado para o grupo de documentações disponíveis.

cnabXpress :: API / pagamento a fornecedores / remessa

Acesso

URL http://191.252.200.209:8081/cnab/pagto-fornec/remessa/
método POST

Cabeçalhos HTTP

Content-Type application/json
Accept application/json
x-api-key chave de acesso do cliente (fornecida pela Techmundi Software)

Parâmetros

campo tipo tamanho requerido descrição
estiloFimLinha string 7 --- Estilo de fim de linha. Informar:
"Windows" = fim de linha estilo Windows
"Mac" = fim de linha estilo MacOS
"Linux" = fim de linha estilo Linux (valor padrão)
cnabPadrao int 1 --- Padrão do arquivo CNAB. Informar:
1 para CNAB 240 bytes (valor padrão)
2 para CNAB 400 bytes.
emitenteContaTipo int 1 --- Tipo de conta do emitente. Informe uma das opções:
1 = conta corrente individual (valor padrão)
2 = conta corrente conjunta
3 = conta poupança individual
4 = conta poupança conjunta
5 = conta judicial individual
6 = conta judicial conjunta
7 = conta de pagamento
emitenteContaCamara string 3 --- Número da câmara de compensação da conta do emitente. Caso não saiba, não informe ou informe "000" (3 zeros).
emitenteContaCodigoBanco string 3 sim Código do banco da conta bancária. Informar:
001 = Banco do Brasil S/A
033 = Banco Santander S/A
041 = Banco do Estado do Rio Grande do Sul S/A
104 = Caixa Econômica Federal S/A
218 = Banco BS2 S/A
237 = Banco Bradesco S/A
274 = BMP Money Plus (Grafeno)
MTP = BMP Money Plus (Multiplica)
310 = VORTX DTVM (Yaaleh)
336 = Banco C6 S/A
341 = Banco Itaú S/A
756 = Banco Cooperativo SICOOB S/A
AR3 = AR3 Capital
SIF = Banco SIFRA
emitenteContaNomeBanco string 30 --- Nome do banco da conta do emitente
emitenteContaAgencia 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.
emitenteContaAgenciaDV string 1 sim Dígito verificador da agência da conta bancária. Caso não seja conhecido, informar 0 (zero).
emitenteContaNumero string 12 sim Número da conta bancária. Não deve ser preenchido com zeros à esquerda.
emitenteContaNumeroDV 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).
emitenteContaAgContaDV string 1 sim Dígito verificador da agência e número da conta bancária. Caso não seja conhecido, informar 0 (zero).
emitenteContaAgenciaContaDV string 1 sim Dígito verificador da agência e número da conta bancária. Caso não seja conhecido, informar 0 (zero).
emitenteContaISPB string 8 --- Código ISPB do banco. Se não for conhecido, não deve ser informado.
emitenteContaConvenio string 20 sim Número do convênio da empresa com o banco da conta.
emitenteContaCarteira string 10 sim Número da carteira de cobrança da empresa no banco da conta.
mensagem string 40 --- Mensagem opcional para a remessa.
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
tipoMovimento int 2 --- Tipo de movimento. Informe uma das opções:
01 = Entrada de títulos (valor padrão)
02 = Pedido de baixa
03 = Protesto para fins alimentares
04 = Concessão de abatimento
05 = Cancelamento de abatimento
06 = Alteração de vencimento
07 = Concessão de desconto
08 = Cancelamento de desconto
09 = Protestar
10 = Sustar protesto e baixar título
11 = Sustar protesto e manter em carteira
12 = Alteração de juros de mora
13 = Dispensar cobrança de juros de mora
14 = Alteração de valor/percentual de multa
15 = Dispensar cobrança de multa
16 = Alteração de valor/data de desconto
17 = Não conceder desconto
18 = Alteração do valor de abatimento
19 = Prazo limite de recebimento - alterar
20 = Prazo limite de recebimento - dispensar
21 = Alterar número do título dado pelo beneficiário
22 = Alterar número controle do participante
23 = Alterar dados do pagador
24 = Alterar dados do sacador/avalista
30 = Recusa da alegação do pagador
31 = Alteração de outros dados
33 = Alteração dos dados do rateio de crédito
34 = Pedido de cancelamento dos dados do rateio de crédito
35 = Pedido de desagendamento do débito automático
40 = Alteração de carteira
41 = Cancelar protesto
42 = Alteração de espécie de título
43 = Transferência de carteira/modalidade de cobrança
44 = Alteração de contrato de cobrança
45 = Negativação sem protesto
46 = Solicitação de baixa de título negativado sem protesto
47 = Alteração do valor nominal do título
48 = Alteração do valor mínimo/percentual
49 = Alteração do valor máximo/percentual
61 = Alteração para inclusão/manutenção de QR Code Pix
formaLancamento int 2 --- Forma de lançamento. Informe uma das opções:
30 = pagamento de títulos do mesmo banco
31 = pagamento de títulos de outros bancos (valor padrão)
instrucaoMovimento int 2 --- Código da instrução de movimento. Informe uma das opções:
00 = Inclusão de Registro Detalhe Liberado (valor padrão)
09 = Inclusão do Registro Detalhe Bloqueado
10 = Alteração do Pagamento Liberado para Bloqueado (Bloqueio)
11 = Alteração do Pagamento Bloqueado para Liberado (Liberação)
17 = Alteração do Valor do Título
19 = Alteração da Data de Pagamento
23 = Pagamento Direto ao Fornecedor - Baixar
25 = Manutenção em Carteira - Não Pagar
27 = Retirada de Carteira - Não Pagar
40 = Alegação do Pagador
99 = Exclusão do Registro Detalhe Incluído Anteriormente
registros array --- sim Array de registros de dados de remessas. Cada lote precisa conter um ou mais registros de remessas, e cada registro representa uma operação que será enviada ao banco. Os registros de remessa são explicados abaixo.

Registros de remessas

campo tipo tamanho decimal requerido descrição
fornecedorCadastroNome string 40 --- sim Nome do fornecedor.
fornecedorCadastroCpfCnpj string 14 --- sim CPF ou CNPJ do fornecedor.
fornecedorContaCodigoBanco string 3 --- sim Código do banco do fornecedor.
documentoControle string 20 --- sim Número de controle (interno) do documento que será pago.
documentoCodigoBarras string 48 --- sim Código de barras do documento que será pago.
documentoValorNominal float 13 2 sim Valor nominal do documento.
documentoDataVencimento string 10 --- sim Data do pagamento do documento, no formato "dd/mm/aaaa".
documentoQRCode string 79 --- --- QR Code do documento.
documentoQRCodeTXID string 30 --- --- TXID do QR Code do documento.
documentoValorDesconto float 12 3 --- Valor do desconto do documento.
documentoValorAbatimento float 12 3 --- Valor do abatimento do documento.
documentoValorMora float 12 3 --- Valor dos juros ao dia (mora) do documento.
documentoValorMulta float 12 3 --- Valor da multa por atraso de pagamento do documento.
avalistaCadastroNome string 40 --- --- Nome do avalista, se houver.
avalistaCadastroCpfCnpj string 14 --- --- CPF ou CNPJ do avalista, se houver.

Exemplo

{
  estiloFimLinha: "Windows",
  padrao: 1,
  emitenteCadastroNome: "Empresa Teste Ltda",
  emitenteCadastroCpfCnpj: "12368826000128",
  emitenteEnderecoLogradouro: "Rua Tal",
  emitenteEnderecoNumero: "80",
  emitenteEnderecoComplemento: "",
  emitenteEnderecoBairro: "Salvador",
  emitenteEnderecoCidade: "Sergipe",
  emitenteEnderecoUF: "PE",
  emitenteEnderecoCEP: "19827083",
  emitenteContaTipo: 1,
  emitenteContaCodigoBanco: "033",
  emitenteContaNomeBanco: "BANCO SANTANDER SA",
  emitenteContaAgencia: "0500",
  emitenteContaAgenciaDV: "0",
  emitenteContaNumero: "27612",
  emitenteContaNumeroDV: "0",
  emitenteContaAgenciaContaDV: "0",
  emitenteContaConvenio: "123456789",
  emitenteContaCarteira: "175",
  lotes: [
    {
      mensagem: "",
      registros: [
        {
          fornecedorCadastroNome: "fornecedor 1",
          fornecedorCadastroCpfCnpj: "90554982727735",
          fornecedorContaCodigoBanco: "033",
          documentoControle: "9456773045",
          documentoCodigoBarras: "95298039199013264524186378257965869358412143",
          documentoValorNominal: 704.37,
          documentoDataVencimento: "02/03/2026"
        },
        {
          fornecedorCadastroNome: "fornecedor 2",
          fornecedorCadastroCpfCnpj: "68907222792472",
          fornecedorContaCodigoBanco: "341",
          documentoControle: "1141993333",
          documentoCodigoBarras: "24613980940543765979800157272159880261769383",
          documentoValorNominal: 163.68,
          documentoDataVencimento: "02/03/2026"
        },
        {
          fornecedorCadastroNome: "fornecedor 3",
          fornecedorCadastroCpfCnpj: "57237727507132",
          fornecedorContaCodigoBanco: "033",
          documentoControle: "7959433462",
          documentoCodigoBarras: "05828711183771241983305540883291528394076446",
          documentoValorNominal: 128.83,
          documentoDataVencimento: "02/03/2026"
        },
        {
          fornecedorCadastroNome: "fornecedor 4",
          fornecedorCadastroCpfCnpj: "59188238524297",
          fornecedorContaCodigoBanco: "033",
          documentoControle: "7745833661",
          documentoCodigoBarras: "19376431105114144162372537925024301717603817",
          documentoValorNominal: 249.1,
          documentoDataVencimento: "02/03/2026"
        },
        {
          fornecedorCadastroNome: "fornecedor 5",
          fornecedorCadastroCpfCnpj: "65701691873473",
          fornecedorContaCodigoBanco: "104",
          documentoControle: "1429585421",
          documentoCodigoBarras: "74235123253784872209678022878291860917299310",
          documentoValorNominal: 835.32,
          documentoDataVencimento: "02/03/2026"
        }
      ]
    }
  ]
}

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