cnabXpress :: API / pagamento a fornecedores / retorno
Acesso
| URL | http://191.252.200.209:8081/cnab/pagto-fornec/retorno/ |
| método | POST |
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" = 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. |
| 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 |
| 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 |
|---|---|---|---|---|
| fornecedorCadastroNome | string | 40 | 0 | Nome (razão social) do fornecedor |
| fornecedorCadastroCpfCnpj | string | 14 | 0 | CPF ou CNPJ do fornecedor |
| fornecedorContaCodigoBanco | string | 3 | 0 | Código do banco da conta do fornecedor |
| avalistaCadastroNome | string | 40 | --- | Nome do avalista, se houver. |
| avalistaCadastroCpfCnpj | string | 14 | --- | CPF ou CNPJ do avalista, se houver. |
| documentoControle | string | 20 | --- | Número de controle (interno) do documento pago. |
| documentoNossoNumero | string | 20 | --- | Nosso número do documento pago. |
| documentoCodigoBarras | string | 48 | --- | Código de barras do documento pago. |
| documentoValorNominal | float | 13 | 2 | Valor nominal do documento. |
| documentoValorDesconto | float | 13 | 2 | Valor do desconto do documento. |
| documentoValorAcrescimos | float | 13 | 2 | Valor dos acréscimos do documento. |
| documentoValorPagamento | float | 13 | 2 | Valor pago do documento. |
| documentoDataVencimento | string | 10 | --- | Data do crédito em conta no formato "dd/mm/aaaa". |
| documentoDataPagamento | string | 10 | --- | Data do pagamento do documento no formato "dd/mm/aaaa". |
| documentoMsgRetorno | string | 70 | 0 | Mensagem de retorno 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 |
