cnabXpress :: API / Cobrança / Cobrança / Retorno
Acesso
| URL | http://api.techmundi.com/cnab/cobranca/cobranca/retorno/ |
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 |
| 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. |
| arquivoRetorno | string | --- | sim | Texto do arquivo de retorno enviado pelo banco. |
Dados de retorno
| campo | tipo | tamanho | decimal | descrição |
|---|---|---|---|---|
| pagCadEmpresaID | int | 0 | 0 | Número identificador da empresa (pagador) |
| pagCadNome | string | 40 | 0 | Nome (razão social) do pagador |
| pagCadCpfCnpj | string | 14 | 0 | CPF ou CNPJ do pagador |
| pagCadInscMunicipal | string | 20 | 0 | Inscrição municipal do pagador |
| pagCadInscEstadual | string | 20 | 0 | Inscrição estadual do pagador |
| pagCadEmail | string | 100 | 0 | Endereço de e-mail do pagador |
| pagCadCelularDDD | string | 2 | 0 | DDD do telefone do pagador |
| pagCadCelularNumero | string | 9 | 0 | Número do telefone do pagador |
| pagEndLogradouro | string | 40 | 0 | Nome do logradouro do endereço do pagador |
| pagEndNumero | string | 5 | 0 | Número do endereço do pagador |
| pagEndComplemento | string | 15 | 0 | Complemento do endereço do pagador |
| pagEndBairro | string | 15 | 0 | Bairro do pagador |
| pagEndCidade | string | 20 | 0 | Cidade do pagador |
| pagEndUF | string | 2 | 0 | UF do pagador |
| pagEndCEP | string | 8 | 0 | CEP do pagador |
| pagCtaCodigoBanco | string | 3 | 0 | Código do banco da conta do pagador |
| pagCtaNomeBanco | string | 30 | 0 | Nome do banco do pagador |
| pagCtaConvenio | string | 20 | 0 | Número do convênio do pagador |
| pagCtaCarteira | string | 10 | 0 | Número da carteira do pagador |
| pagCtaAgencia | string | 5 | 0 | Número da agência do pagador |
| pagCtaAgenciaDV | string | 1 | 0 | DV do número da agência do pagador |
| pagCtaNumero | string | 12 | 0 | Número da conta do pagador |
| pagCtaNumeroDV | string | 2 | 0 | DV do número da conta do pagador |
| pagCtaAgContaDV | string | 1 | 0 | DV do número de agência e conta do pagador |
| pagCtaIPSB | string | 8 | 0 | Número do ISPB do pagador |
| doctoNumero | string | 20 | 0 | Número do documento |
| doctoControle | string | 25 | 0 | Número de controle (interno) do documento |
| doctoPedido | string | 15 | 0 | Número do pedido vinculado ao documento |
| doctoContrato | string | 10 | 0 | Número do contrato vinculado ao documento |
| doctoNossoNumero | string | 20 | 0 | Nosso número do documento |
| doctoNossoNumeroDV | string | 1 | 0 | DV (dígito verificador) do nosso número do documento |
| doctoMsgRetorno1 | string | 70 | 0 | Mensagem de retorno 1 do documento |
| doctoMsgRetorno2 | string | 70 | 0 | Mensagem de retorno 2 do documento |
| doctoMsgRetorno3 | string | 70 | 0 | Mensagem de retorno 3 do documento |
| doctoDataEmissao | date | 10 | 0 | Data da emissão do documento no formato dd/mm/aaaa |
| doctoDataVencimento | date | 10 | 0 | Data do vencimento do documento no formato dd/mm/aaaa |
| doctoDataBaixa | date | 10 | 0 | Data da baixa ou liquidação do documento no formato dd/mm/aaaa |
| doctoDataMovimento | date | 10 | 0 | Data do movimento do documento no formato dd/mm/aaaa |
| doctoDataCredito | date | 10 | 0 | Data do crédito do recebimento no formato dd/mm/aaaa |
| doctoTipoMoeda | string | 3 | 0 | Sigla do tipo da moeda |
| doctoQtdeMoeda | float | 13 | 2 | Quantidade de moeda |
| doctoValorNominal | float | 13 | 2 | Valor nominal (original) do documento |
| doctoValorPago | float | 13 | 2 | Valor pago na baixa (liquidação) do documento |
| doctoValorAbatimento | float | 13 | 2 | Valor do abatimento concedido no pagamento |
| doctoValorDesconto | float | 13 | 2 | Valor do desconto concedido no pagamento |
| doctoValorJuros | float | 13 | 2 | Valor dos juros (multa + mora) cobrados no pagamento |
| doctoValorMora | float | 13 | 2 | Valor de mora cobrada no pagamento |
| doctoValorMulta | float | 13 | 2 | Valor da multa cobrada no pagamento |
| doctoValorDeducoes | float | 13 | 2 | Valor das deduções concedidas no pagamento |
| doctoValorAcrescimos | float | 13 | 2 | Valor dos acréscimos cobrados no pagamento |
| doctoValorTarifas | float | 13 | 2 | Valor das tarifas/custas cobradas no pagamento |
| doctoValorOutrasDespesas | float | 13 | 2 | Valor de outras despesas cobradas no pagamento |
| doctoValorOutrosCreditos | float | 13 | 2 | Valor de outros créditos concedidos no pagamento |
| doctoValorCredito | float | 13 | 2 | Valor do crédito (líquido) do recebimento |
| doctoValorIR | float | 13 | 2 | Valor do IR do documento |
| doctoValorISS | float | 13 | 2 | Valor do ISS do documento |
| doctoValorIOF | float | 13 | 2 | Valor do IOF do documento |
| doctoValorINSS | float | 13 | 2 | Valor do INSS do documento |
| doctoValorPIS | float | 13 | 2 | Valor do PIS do documento |
| doctoValorCOFINS | float | 13 | 2 | Valor do COFINS do documento |
| doctoValorCSLL | float | 13 | 2 | Valor do CSLL do documento |
| doctoOcorr?_codigo | Texto | 2 | 0 | Código da ocorrência ?, onde ? é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| doctoOcorr?_descricao | string | 60 | 0 | Descrição da ocorrência ?, onde ? é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| doctoOcorr?_data | date | 10 | 0 | Data da ocorrência ? no formato dd/mm/aaaa, onde ? é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| doctoOcorr?_valor | float | 13 | 2 | Valor da ocorrência ?, onde ? é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
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 |
