Pular para o conteúdo principal

Envio do arquivo - DDA

Guilherme Ganassin
Atualizado

Introdução

A solicitação de envio do arquivo é o método pelo qual o arquivo contendo a movimentação dos DDA, liberado pelo banco, em layout CNAB 240 padrão Febraban é encaminhado para ser processado pela Tecnospeed.

 

Se trata da primeira etapa do processo assíncrono, onde o sistema integrado com nossa API poderá realizar o envio do arquivo e obterá um protocolo em caso de sucesso. Este protocolo deverá ser consultado na segunda etapa do processo de consulta, para que se tenha acesso ao resultado do processamento do arquivo.

 

Definições da requisição:

 

Método

POST

 

URL da API

   Homologação:

https://staging.pagamentobancario.com.br/api/v1/dda

   Produção:

https://api.pagamentobancario.com.br/api/v1/dda

 

Headers

Os headers necessários para a autenticação da requisição são:

 Header  Descrição
 cnpjsh  CNPJ da Software House que possui contrato com a Tecnospeed
 tokensh  Token de autenticação da Software House (obtido através deste processo)
payercpfcnpj CNPJ do pagador que será responsável pelo envio do DDA. CNPJ cadastrado através deste processo)

 

Body 

O  body da requisição é enviado em formato form-data. Portanto os parâmetros de envio são:

 Campo Tipo  Descrição Valores aceitos
file File Arquivo DDA Arquivo padrão Febraban CNAB 240, com mapeamento de segmentos G e H
accountHash Text Identificador da conta que será responsável pelo arquivo DDA

AccountHash válido, cadastrado previamente, pertencente ao CNPJ do Pagador informado no header da requisição.

O cadastro da conta é feito através deste processo.

 

 

Exemplo de Retorno

Status=201 - Sucesso

{
    "uniqueId": "aaabbbccc",
    "status": "PROCESSING"
}

 

Onde:

Campo Tipo Descrição
uniqueId string  Protocolo de recebimento do pedido. Este protocolo deverá ser registrado pelo sistema do cliente e consultado na rota GET que mostra efetivamente o resultado da consulta.
status string  Identifica se a requisição entrou para a fila de processamento da API. Em caso de sucesso é esperado o stutus='Processing', que indica que o arquivo entrou na fila de processamento da API.

 

Status=401 - Falta de autorização

{
    "code": 401,
    "message": "CNPJ ou TOKEN incorretos, verifique sua conta em https://conta.tecnospeed.com.br"
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso, o erro indica que há uma falha na autenticação da requisição. Verifique se o CNPJ e token de SH informados estão corretos (cadastrados de acordo com este processo)

 

 

Status=401 - Falta de autorização

{
    "code": 401,
    "message": "Payer sem autorização para a função DDA"
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso, o erro indica que a SH ou os pagadores cadastrados por ela não possuem autorização para uso do DDA. 

 

Obs.: Caso a Software House não possua contrato para uso do DDA junto à Tecnospeed e tenha interesse em obtê-lo, entre em contato com nosso departamento comercial para que possamos iniciar a apresentação do recurso e do contrato.

 

Status=404 - Conta não encontrada

{
    "code": 404,
    "message": "conta não encontrada"
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso, o erro indica que a conta informada no body não foi encontrada ou não pertence ao CNPJ do Pagador presente na autenticação. 

Recomenda-se conferir o accountHash cadastrado neste processo.

 

 

Status=422 - Falha no processamento

{
    "code": 422,
    "message": "Unprocessable Entity",
    "errors": [
        {
            "message": "Ative o DDA para ser utilizado por essa conta",
            "internalCode": 3001
        }
    ]
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string  Mensagem de erro que orienta quanto ao problema. Neste caso, recomenda-se a validação das credenciais de autenticação da rota
errors > message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso, o erro indica que a conta utilizada no header da requisição não possui autorização para uso do DDA. 
errors > internalCode numérico Código de erro (mapeamento dos códigos ainda não disponível)

 

Obs.: Caso a Software House não possua contrato para uso do DDA junto à Tecnospeed e tenha interesse em obtê-lo, entre em contato com nosso departamento comercial para que possamos iniciar a apresentação do recurso e do contrato.

 

Status=422 - Falha no processamento

{
    "code": 422,
    "message": "Unprocessable Entity",
    "errors": [
        {
            "message": "Arquivo Inválido, verifique o conteúdo e extensão do arquivo",
            "internalCode": 4002
        }
    ]
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string  Mensagem de erro que orienta quanto ao problema. Neste caso, recomenda-se a validação das credenciais de autenticação da rota
errors > message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso, o erro indica que o arquivo enviado não está no layout processado pela Tecnospeed
errors > internalCode numérico Código de erro (mapeamento dos códigos ainda não disponível)

 

Status=422 - Falha no processamento

{
    "code": 422,
    "message": "Unprocessable Entity",
    "errors": [
        {
            "message": "Campo accountHash é obrigatório",
            "internalCode": 4001
        }
    ]
}

 

Onde:

Campo Tipo Descrição
code numérico  Código de erro que identifica a falha na autorização da requisição
message string  Mensagem de erro que orienta quanto ao problema. Neste caso, recomenda-se a validação das credenciais de autenticação da rota
errors > message string

Mensagem que identifica o tipo de erro ocorrido. Recomendamos que haja um mapeamento e apresentação desta mensagem ao usuário que efetua o envio do arquivo no sistema da SH. 

Neste caso verifique se os 3 campos obrigatórios do header foram informados corretamente
errors > internalCode numérico Código de erro (mapeamento dos códigos ainda não disponível)

 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.