Introdução
A consulta dos últimos arquivos processados é uma etapa opcional do fluxo. Nesta rota, retornaremos os últimos arquivos DDA processados, com seus respectivos UniqueID.
O objetivo aqui é apresentar à SH uma lista dos arquivos processados, para que esta capture os UniqueId e faça a consulta completa.
Definições da requisição:
Método
GET
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) |
Query Parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
dateStart |
string | Data inicial que o arquivo DDA foi exportado do banco (YYYY-MM-DD) |
dateEnd |
string | Data final que o arquivo DDA foi exportado do banco (YYYY-MM-DD) |
origin |
string | Tipo de origem do arquivo. Valores possíveis: van ou user
|
accountHash |
string | Hash identificador da conta bancária |
page |
number | Número da página a ser retornada |
pageLimit |
number | Limite de registros por página |
Exemplo de Retorno
Status=200 - Sucesso
Onde:
| Campo | Tipo | Descrição |
|---|---|---|
| status | string |
Status do processamento do arquivo
|
| uniqueId | string |
Identificador de envio do arquivo. Retorna o uniqueID do arquivo, obtivo no processamento de seu envio (rota de envio do arquivo). |
| origin | string |
Origem do arquivo DDA
|
| createdAt | string |
Data de processamento do arquivo DDA Formato: AAAA-MM-DDTHH:MM.SSSZ Exemplo: 2024-09-25T19:02:32.769Z |
| accountHash | string | Identificador da conta na qual o arquivo foi processado. Retorna o mesmo "accountHash" no qual o arquivo foi processado originalmente |
| message | string |
Mensagem indicativa da operação
|
Obs.: Observe que os resultados aparecem de forma paginada. Portanto, é importante que a integração considere a possibilidade de trabalhar com diversas páginas, dentro do objeto "meta".
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=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.