Introdução
A consulta do processamento do DDA via UniqueID (valor este, retornado no campo "uniqueId" da primeira etapa do processo) é a segunda etapa do fluxo, e é o momento onde o resultado do processamento do arquivo será verificado.
O objetivo aqui é visualizarmos o resultado do processamento do arquivo ou eventuais erros que tenham ocorrido.
Definições da requisição:
Método
GET
URL da API
Homologação:
https://staging.pagamentobancario.com.br/api/v1/dda/[UniqueID]
Produção:
https://api.pagamentobancario.com.br/api/v1/dda/[UniqueID]
Onde:
[UniqueID] se trata do valor retornado no campo "UniqueID" do JSON de resposta da solicitação da consulta.
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) |
Exemplo de Retorno
Status=200 - Sucesso
Onde:
| Campo | Tipo | Descrição |
|---|---|---|
| dda.status | string |
Status do processamento do arquivo
|
| dda.uniqueID | string | Identificador de envio do arquivo. Retorna o mesmo uniqueId utilizado na URL. |
| dda.origin | string |
Origem do arquivo DDA
|
| dda.createdAt | string |
Data de processamento do arquivo DDA Formato: AAAA-MM-DDTHH:MM.SSSZ Exemplo: 2024-09-25T19:02:32.769Z |
| dda.accountHash | string | Identificador da conta na qual o arquivo foi processado. Retorna o mesmo "accountHash" do Header da requisição |
| dda.message | string |
Mensagem indicativa da operação
|
|
|
||
| ddaPayments | objeto | Retornado em caso de sucesso no processamento |
| ddaPayments.uniqueId | string | Identificador do pagamento contigo no DDA e interpretado pela Tecnospeed |
| ddaPayments.createPayment | string | Identifica se o pagamento já foi criado na Tecnospeed (não disponível ainda) |
| ddaPayments.description | string | Descrição do pagamento (se informado) |
| ddaPayments.barcode | string | Linha digitável indicada no arquivo DDA |
| ddaPayments.dueDate | string | Data do vencimento indicada no arquivo DDA |
| ddaPayments.paymentDate | string | Data do pagamento indicada no arquivo DDA |
| ddaPayments.nominalAmount | string | Valor nominal do pagamento indicado no arquivo DDA |
| ddaPayments.discountAmount | string | Valor do desconto indicado no arquivo DDA |
| ddaPayments.feeAmount | string | Valor de taxas (juros, multas) indicadas no arquivo DDA |
| ddaPayments.amount | string | Valor do pagamento indicado no arquivo DDA |
| ddaPayments.movimentCode | string | Código de movimento referente ao pagamento |
| ddaPayments.avalistaName | string | Nome do avalista indicado no arquivo |
| ddaPayments.avalistaCpfCnpj | string | CNPJ ou CPF do avalista indicado no arquivo |
| ddaPayments.compromiseType | string | |
| ddaPayments.transmissionParam | string | |
| ddaPayments.beneficiaryName | string | Nome do beneficiário indicado no arquivo DDA |
| ddaPayments.beneficiaryCpfCnpj | string | CNPJ ou CPF do beneficiário indicado no arquivo DDA |
| ddaPayments.tags | string | Tags de indicação (se disponível) |
| ddaDuplicatePayments | objeto | Retornado em caso de duplicidade na importação do arquivo |
| ddaDuplicatePayments.uniqueIdDDAOriginal | string | Identificador de envio do arquivo. Retorna o mesmo uniqueId gerado na primeira importação do arquivo |
| ddaDuplicatePayments.uniqueId | sting | Identificador de envio do arquivo. Retorna um novo uniqueId, referente ao reprocessamento. |
| ddaDuplicatePayments.createPayment | string | Identifica se o pagamento já foi criado na Tecnospeed (não disponível ainda) |
| ddaDuplicatePayments.description | string | Descrição do pagamento (se informado) |
| ddaDuplicatePayments.barcode | string | Linha digitável indicada no arquivo DDA |
| ddaDuplicatePayments.dueDate | string | Data do vencimento indicada no arquivo DDA |
| ddaDuplicatePayments.paymentDate | string | Data do pagamento indicada no arquivo DDA |
| ddaDuplicatePayments.nominalAmount | string | Valor nominal do pagamento indicado no arquivo DDA |
| ddaDuplicatePayments.discountAmount | string | Valor do desconto indicado no arquivo DDA |
| ddaDuplicatePayments.feeAmount | string | Valor de taxas (juros, multas) indicadas no arquivo DDA |
| ddaDuplicatePayments.amount | string | Valor do pagamento indicado no arquivo DDA |
| ddaDuplicatePayments.movimentCode | string | Código de movimento referente ao pagamento |
| ddaDuplicatePayments.avalistaName | string | Nome do avalista indicado no arquivo |
| ddaDuplicatePayments.avalistaCpfCnpj | string | CNPJ ou CPF do avalista indicado no arquivo |
| ddaDuplicatePayments.compromiseType | string | |
| ddaDuplicatePayments.transmissionParam | string | |
| ddaDuplicatePayments.beneficiary | string | Nome do beneficiário indicado no arquivo DDA |
| ddaDuplicatePayments.beneficiary.name | string | CNPJ ou CPF do beneficiário indicado no arquivo DDA |
| ddaDuplicatePayments.beneficiary.cpfcnpj | string | CNPJ ou CPF do beneficiário indicado no arquivo DDA |
| ddaDuplicatePayments.tags | string | Tags de indicação (se disponível) |
Status=401 - Falta de autorização
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 os 3 campos do header estão informados adequadamente |
Status=401 - Falta de autorização
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, recomenda-se a validação das credenciais de autenticação da rota. |
Status=404 - UniqueId não encontrado
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 o uniqueId identificado na URL está incorreto. |
Status=422 - Falta de autorização
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 | Objeto | Lista de erros identificadas e que impossibilitaram o processamento da requisição |
| internalCode | numérico |
Código de erro interno Obs.: Lista de erros em criação pela Tecnospeed |
| message | string | Mensagem de erro que orienta quanto ao problema. Neste caso, orienta-se que se verifique se todos os campos de autenticação (headers) estão preenchidos adequadamente. |
Comentários
0 comentário
Por favor, entre para comentar.