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 / crédito em conta / remessa

Acesso

URL http://191.252.200.209/_api/cnab/credito-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.
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.
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
077 = Banco Inter S/A
104 = Caixa Econômica Federal S/A
237 = Banco Bradesco S/A
341 = Banco Itaú S/A
748 = Banco Cooperativo Sicredi 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.
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.
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
tipoServico int 2 sim Tipo de serviço. Informar 98 (pagamentos diversos).
tipoMovimento int 2 --- Tipo de movimento. Depende de cada banco. Se não for conhecido ou não houver, não deve ser informado.
finalidadeTED string 5 --- Finalidade da TED. Depende de cada banco. Para o banco 033 Banco Santander S/A, informar:
  • 00010 para operações de TED para conta corrente ou poupança
  • Não informar este parâmetro para as demais operações
Para o banco 341 Banco Itaú S/A, informar:
  • 00010 para operações de TED para conta corrente ou poupança
  • Não informar este parâmetro para as demais operações
Para os demais bancos, não informar este parâmetro.
finalidadePagamento string 2 --- Finalidade do pagamento. Depende de cada banco.
Para o banco 033 Banco Santander S/A, informar:
  • CC para TEF, TED ou PIX para conta corrente
  • PP para TEF ou TED para conta poupança
Para os demais bancos, não informar este parâmetro.
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
favorecidoContaTipo int 1 --- -- Tipo de conta do favorecido. Informe uma das opções:
  • 1 conta corrente individual (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
favorecidoCadastroNome string 40 --- sim Nome do favorecido.
favorecidoCadastroCpfCnpj string 14 --- sim CPF ou CNPJ do favorecido.
favorecidoContaCodigoBanco string 3 --- sim Código do banco do favorecido.
favorecidoContaAgencia string 4 --- sim Número da agência da conta do favorecido.
favorecidoContaAgenciaDV string 1 --- sim Dígito verificador do número da agência da conta do favorecido.
favorecidoContaNumero string 12 --- sim Número da conta do favorecido.
favorecidoContaNumeroDV string 1 --- sim Dígito verificador do número da conta do favorecido.
favorecidoContaChavePix string 100 --- --- Chave PIX do favorecido. 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 favorecido.
favorecidoContaChavePixTipo int 1 --- --- Tipo de chave PIX do favorecido, se for informada a chave PIX. Informar:
  • 0 para nenhum
  • 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
documentoValorNominal float 13 2 sim Valor do crédito em conta.
documentoDataVencimento string 10 --- sim Data do crédito em conta no formato "dd/mm/aaaa".

Exemplo

{
  "estiloFimLinha": "Windows",
  "cnabPadrao": 1,
  "sequencia": 1,
  "emitenteContaTipo": 1,
  "emitenteContaCodigoBanco": "033",
  "emitenteContaNomeBanco": "BANCO SANTANDER",
  "emitenteContaAgencia": "0590",
  "emitenteContaAgenciaDV": "0",
  "emitenteContaNumero": "47289",
  "emitenteContaNumeroDV": "0",
  "emitenteContaAgenciaContaDV": "0",
  "emitenteContaConvenio": "123456789",
  "emitenteContaCarteira": "175",
  "lotes": [
    {
      "tipoServico": 98,
      "tipoMovimento": 0,
      "formaLancamento": 3,
      "finalidadeTED": "00010",
      "finalidadePagamento": "CC",
      "registros": [
        {
          "favorecidoCadastroNome": "Favorecido 1",
          "favorecidoCadastroCpfCnpj": "79378438732",
          "favorecidoContaCodigoBanco": "756",
          "favorecidoContaAgencia": "0304",
          "favorecidoContaAgenciaDV": "0",
          "favorecidoContaNumero": "1415",
          "favorecidoContaNumeroDV": "7",
          "favorecidoContaTipo": "C",
          "favorecidoContaTipoDescricao": "Corrente",
          "favorecidoContaChavePix": "",
          "favorecidoContaChavePixTipo": 0,
          "documentoValorNominal": 384.66,
          "documentoDataVencimento": "21/07/2025"
        },
        {
          "favorecidoCadastroNome": "Favorecido 2",
          "favorecidoCadastroCpfCnpj": "11128087882",
          "favorecidoContaCodigoBanco": "237",
          "favorecidoContaAgencia": "1068",
          "favorecidoContaAgenciaDV": "0",
          "favorecidoContaNumero": "7567",
          "favorecidoContaNumeroDV": "5",
          "favorecidoContaTipo": "C",
          "favorecidoContaTipoDescricao": "Corrente",
          "favorecidoContaChavePix": "",
          "favorecidoContaChavePixTipo": 0,
          "documentoValorNominal": 879.5,
          "documentoDataVencimento": "21/07/2025"
        }
      ]
    },
    {
      "tipoServico": 98,
      "tipoMovimento": 0,
      "formaLancamento": 3,
      "finalidadeTED": "00010",
      "finalidadePagamento": "PP",
      "registros": [
        {
          "favorecidoCadastroNome": "Favorecido 3",
          "favorecidoCadastroCpfCnpj": "12164598706",
          "favorecidoContaCodigoBanco": "237",
          "favorecidoContaAgencia": "6578",
          "favorecidoContaAgenciaDV": "0",
          "favorecidoContaNumero": "4221",
          "favorecidoContaNumeroDV": "5",
          "favorecidoContaTipo": "P",
          "favorecidoContaTipoDescricao": "Poupança",
          "favorecidoContaChavePix": "",
          "favorecidoContaChavePixTipo": 0,
          "documentoValorNominal": 470.79,
          "documentoDataVencimento": "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