Introdução
A consulta de pagamentos processados traz um detalhamento dos pagamentos processados e obtidos na etapa de consulta via UniqueID.
Ou seja, a consulta via UniqueID retorna uma lista de 1 ou N pagamentos, e cada pagamento recebe um identificador (uniqueId do pagamento). O objetivo desta consulta é consultar individualmente os identificadores dos pagamentos.
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://staging.pagamentobancario.com.br/api/v1/dda/[UniqueID]
Onde:
[UniqueID] se trata do valor retornado no campo "ddaPayments.UniqueID" ou no campo "ddaDuplicatePayments.uniqueId" do JSON de resposta da consulta via UniqueID.
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
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 do arquivo 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.