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 / débito em conta / remessa

Acesso

URL http://191.252.200.209/_api/cnab/debito-conta/remessa/
método PUT

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", "Mac" ou "Linux". Padrão: "Linux".
cnabPadrao int 1 --- Padrão do arquivo CNAB. Informar:
1 para CNAB 240 bytes (default/padrão)
2 para CNAB 400 bytes.
emitenteContaTipo int 1 --- Tipo de conta do emitente. Informe uma das opções:
  • 1 conta corrente individual
  • 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
070 = BRB Banco Regional de Brasília S/A
104 = Caixa Econômica Federal S/A
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.
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
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
pagadorCadastroNome string 40 --- sim Nome do pagador.
pagadorCadastroCpfCnpj string 14 --- sim CPF ou CNPJ do pagador.
pagadorCadastroInscricaoMunicipal string 20 --- --- Inscrição municipal do pagador.
pagagorCadastroInscricaoEstadual string 20 --- --- Inscrição estadual do pagador.
pagagorCadastroEmail string 100 --- --- Endereço de e-mail do pagador.
pagagorCadastroFoneDDD string 2 --- --- DDD do número de telefone do pagador.
pagagorCadastroFoneNumero string 9 --- --- Número de telefone do pagador.
pagagorEnderecoLogradouro string 40 --- --- Logradouro do endereço do pagador.
pagagorEnderecoBairro string 15 --- --- Bairro do pagador.
pagagorEnderecoMunicipio string 20 --- --- Cidade do pagador.
pagagorEnderecoUF string 2 --- --- UF do pagador.
pagagorEnderecoCEP string 8 --- --- CEP do pagador.
pagadorContaCodigoBanco string 3 --- sim Código do banco do pagador.
pagadorContaAgencia string 4 --- sim Número da agência da conta do pagador.
pagadorContaAgenciaDV string 1 --- sim Dígito verificador do número da agência da conta do pagador.
pagadorContaNumero string 12 --- sim Número da conta do pagador.
pagadorContaNumeroDV string 1 --- sim Dígito verificador do número da conta do pagador.
pagadorContaAgenciaContaDV string 1 --- --- Dígito verificador do número da agência e conta do pagador. Se não souber, não informar.
pagadorContaChaveISPB string 8 --- --- Código ISPB da conta do pagador.
pagadorContaChavePix string 100 --- --- Chave PIX do pagador. A chave PIX pode ser um cpf/cnpj, número de telefone (com DDD), e-mail ou chave aleatória. Se for informado, vai gerar um lote de remessa por PIX. Se não for informado, pode gerar uma TEF ou TED, conforme o código do banco do pagador.
pagadorContaChavePixTipo int 1 --- --- Tipo de chave PIX do pagador, se for informada a chave PIX. Informar:
  • 0 para nenhum (ou não informar)
  • 1 se for um CPF ou CNPJ
  • 2 se for um e-mail
  • 3 se for um telefone
  • 4 se for uma chave aleatória
documentoNumero string 20 --- sim Número do documento para identificar o lançamento de débito em conta. Este número pode ser utilizado no retorno, para baixar o lançamento.
documentoValorDebito float 13 2 sim Valor do débito em conta.
documentoDataDebito string 10 --- sim Data do débito em conta no formato "dd/mm/aaaa".

Exemplo

{
  "estiloFimLinha": "Windows",
  "cnabPadrao": 1,
  "emitenteContaTipo": 1,
  "emitenteContaCodigoBanco": "001",
  "emitenteContaNomeBanco": "BANCO DO BRASIL S.A.",
  "emitenteContaAgencia": "0035",
  "emitenteContaAgenciaDV": "0",
  "emitenteContaNumero": "456213552",
  "emitenteContaNumeroDV": "3",
  "emitenteContaAgenciaContaDV": "4",
  "emitenteContaConvenio": "121232321",
  "emitenteContaCarteira": "130",
  "emitenteContaISPB": "",
  "lotes": [
    {
      "registros": [
        {
          "pagadorCadastroNome": "pagador 1",
          "pagadorCadastroCpfCnpj": "23113001744",
          "pagadorContaCodigoBanco": "218",
          "pagadorContaAgencia": "6275",
          "pagadorContaAgenciaDV": "0",
          "pagadorContaNumero": "20430",
          "pagadorContaNumeroDV": "1",
          "pagadorContaChavePix": "",
          "pagadorContaChavePixTipo": 0,
          "documentoValorDebito": 938.12,
          "documentoDataDebito": "21/07/2025"
        },
        {
          "pagadorCadastroNome": "pagador 2",
          "pagadorCadastroCpfCnpj": "09783539856",
          "pagadorContaCodigoBanco": "033",
          "pagadorContaAgencia": "4032",
          "pagadorContaAgenciaDV": "0",
          "pagadorContaNumero": "69593",
          "pagadorContaNumeroDV": "7",
          "pagadorContaChavePix": "",
          "pagadorContaChavePixTipo": 0,
          "documentoValorDebito": 87.15,
          "documentoDataDebito": "21/07/2025"
        },
        {
          "pagadorCadastroNome": "pagador 3",
          "pagadorCadastroCpfCnpj": "43385910057",
          "pagadorContaCodigoBanco": "001",
          "pagadorContaAgencia": "1302",
          "pagadorContaAgenciaDV": "0",
          "pagadorContaNumero": "51178",
          "pagadorContaNumeroDV": "2",
          "pagadorContaChavePix": "",
          "pagadorContaChavePixTipo": 0,
          "documentoValorDebito": 380.55,
          "documentoDataDebito": "21/07/2025"
        }
      ]
    }
  ]
}

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