cnabXpress :: API / crédito em conta / retorno
Acesso
| URL | http://191.252.200.209/_api/cnab/credito-conta/retorno/ |
| método | PUT |
Cabeçalhos HTTP
| Content-Type | application/json |
| Accept | application/json |
| x-api-key | chave de identificação 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. |
| emitenteContaCodigoBanco | string | 3 | sim | Código do banco da conta bancária. Informar: 001 = Banco do Brasil S/A 041 = Banco do Estado do Rio Grande do Sul S/A 077 = Banco Inter S/A 104 = Caixa Econômica Federal S/A 341 = Banco Itaú S/A 748 = Banco Cooperativo Sicredi S/A |
| 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). |
| 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. |
| arquivoRetorno | string | --- | sim | Texto do arquivo de retorno enviado pelo banco. |
Dados de retorno
| campo | tipo | tamanho | decimal | descrição |
|---|---|---|---|---|
| favorecidoCadastroEmpresaID | int | 0 | 0 | Número identificador da empresa (favorecido) |
| favorecidoCadastroNome | string | 40 | 0 | Nome (razão social) do favorecido |
| favorecidoCadastroCpfCnpj | string | 14 | 0 | CPF ou CNPJ do favorecido |
| favorecidoCadastroInscricaoMunicipal | string | 20 | 0 | Inscrição municipal do favorecido |
| favorecidoCadastroInscricaoEstadual | string | 20 | 0 | Inscrição estadual do favorecido |
| favorecidoCadastroEmail | string | 100 | 0 | Endereço de e-mail do favorecido |
| favorecidoCadastroFoneDDD | string | 2 | 0 | DDD do telefone do favorecido |
| favorecidoCadastroFoneNumero | string | 9 | 0 | Número do telefone do favorecido |
| favorecidoEnderecoLogradouro | string | 40 | 0 | Nome do logradouro do endereço do favorecido |
| favorecidoEnderecoNumero | string | 5 | 0 | Número do endereço do favorecido |
| favorecidoEnderecoComplemento | string | 15 | 0 | Complemento do endereço do favorecido |
| favorecidoEnderecoBairro | string | 15 | 0 | Bairro do favorecido |
| favorecidoEnderecoCidade | string | 20 | 0 | Cidade (município) do favorecido |
| favorecidoEnderecoUF | string | 2 | 0 | UF do favorecido |
| favorecidoEnderecoCEP | string | 8 | 0 | CEP do favorecido |
| favorecidoContaCodigoBanco | string | 3 | 0 | Código do banco da conta do favorecido |
| favorecidoContaNomeBanco | string | 30 | 0 | Nome do banco do favorecido |
| favorecidoContaAgencia | string | 5 | 0 | Número da agência do favorecido |
| favorecidoContaAgenciaDV | string | 1 | 0 | DV do número da agência do favorecido |
| favorecidoContaNumero | string | 12 | 0 | Número da conta do favorecido |
| favorecidoContaNumeroDV | string | 2 | 0 | DV do número da conta do favorecido |
| favorecidoContaAgenciaContaDV | string | 1 | 0 | DV do número de agência e conta do favorecido |
| favorecidoContaIPSB | string | 8 | 0 | Número do ISPB do favorecido |
| documentoNumero | string | 20 | 0 | Número do documento |
| documentoDataVencimento | date | 10 | 0 | Data do vencimento do documento no formato dd/mm/aaaa |
| documentoDataBaixa | date | 10 | 0 | Data da baixa ou liquidação do documento no formato dd/mm/aaaa |
| documentoDataMovimento | date | 10 | 0 | Data do movimento do documento no formato dd/mm/aaaa |
| documentoValorNominal | float | 13 | 2 | Valor nominal (original) do documento |
| documentoValorPago | float | 13 | 2 | Valor pago na baixa (liquidação) do documento |
| documentoMsgRetorno1 | string | 70 | 0 | Mensagem de retorno 1 do documento |
| documentoMsgRetorno2 | string | 70 | 0 | Mensagem de retorno 2 do documento |
| documentoMsgRetorno3 | string | 70 | 0 | Mensagem de retorno 3 do documento |
| documentoAutenticacao | string | 100 | 0 | Número da autenticação do documento |
| documentoOcorrenciaN_Codigo | string | 2 | 0 | Código da ocorrência N, onde N é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| documentoOcorrenciaN_Descricao | string | 60 | 0 | Descrição da ocorrência N, onde N é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| documentoOcorrenciaN_Data | date | 10 | 0 | Data da ocorrência N no formato dd/mm/aaaa, onde N é o número da ocorrência (iniciando em 1). Várias ocorrências podem ser retornadas pelo banco. |
| documentoOcorrenciaN_Valor | float | 13 | 2 | Valor da ocorrência N, onde N é 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 |
