Quando o gerenciamento financeiro dos pagamentos das negociações efetuadas no CobranSaaS também for realizado através da plataforma CobranSaaS, os pagamentos das negociações efetuadas na plataforma CobranSaaS podem ser integrados aos sistemas legados através de um processo de pooling, a ser implementado através do consumo da API do CobranSaaS que está disponível para, em intervalos de tempo que sejam adequados ao processo de integração a ser implementado, obter somente os eventos de atualização das informações dos pagamentos das negociações que ainda não haviam sido obtidos pelo processo consumidor.
A lista de pagamentos de acordos, renegociações e pagamentos avulsos realizadas no CobranSaaS pode ser obtida através do método Acordos API - Listar pagamentos (GET /api/acordos/pagamentos), cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/acordos/api-acordos-pagamentos, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
Uma vez que este método pode retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas ao mesmo, conforme a documentação que está disponível no link seudominio.cobransaas.com.br/#/docs-api/introducao/paginacao.
As informações detalhadas em Integrando Negociações e Pagamentos através das APIs do CobranSaaS devem ser observadas para que a obtenção dos pagamentos das negociações efetuadas no CobranSaaS possa ser realizada com êxito.
Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de pagamentos de negociações retornados.
Para a realização do pooling, está disponível o parâmetro de entrada integracao (AGUARDANDO, PENDENTE, PARCIAL, CONCLUIDO, CANCELADO e INTERNO), que permite, por exemplo, obter somente os pagamentos de negociações que estão em uma ou mais situações específicas de integração como, por exemplo, a integração PENDENTE, quando esta informação for informada neste parâmetro.
Para a realização do pooling, também estão disponíveis os parâmetros de entrada dataHoraInclusaoInicio e dataHoraInclusaoFim, ambos do tipo de dados Datetime (formato "2024-01-01T00:00:00"), que permitem obter somente os pagamentos de negociações que foram atualizadas/movimentadas em um determinado período de tempo como, por exemplo, o dia anterior ou então a hora anterior.
O parâmetro agrupador pode ser utilizado para pesquisar somente pagamentos de negociações de um agrupador específico, identificado através do seu ID. O parâmetro situacao (ATIVO, PENDENTE e CANCELADO) pode ser utilizado para pesquisar pagamentos que estejam em uma ou mais situações específicas. O parâmetro dataOperacao pode ser utilizado para pesquisar pagamentos com uma data específica de operação e os parâmetros dataOperacaoInicio e dataOperacaoFim podem ser utilizados para pesquisar pagamentos com datas de operação em um determinado período. O parâmetro dataLiquidacao pode ser utilizado para pesquisar pagamentos com uma data específica de liquidação e os parâmetros dataLiquidacaoInicio e dataLiquidacaoFim podem ser utilizados para pesquisar pagamentos com datas de liquidação em um determinado período. O parâmetro dataProcessamento pode ser utilizado para pesquisar pagamentos com uma data específica de processamento. Para que nas informações dos pagamentos das negociações sejam retornadas também as informações do acordo, cliente, agrupador, canal de pagamento e das listas dos abatimentos e das liquidações, o parâmetro de entrada selector pode ser utilizado com uma ou mais opções (acordo, cliente, agrupador, canalPagamento, abatimentos e liquidacoes), conforme consta na documentação deste método. Para utilizar o parâmetro de entrada selector é necessário utilizar também o modo de paginação CONTINUABLE, informando o parâmetro de entrada mode com a opção CONTINUABLE, conforme descrito em Paginação, conforme a documentação que está disponível no link seudominio.cobransaas.com.br/#/docs-api/introducao/paginacao. Se for informado o parâmetro selector e não for informado o parâmetro mode, um código de erro 400 (Tratamento de Erros, conforme a documentação que está disponível no link seudominio.cobransaas.com.br/#/docs-api/introducao/tratamento-erros) é retornado com a mensagem "A consulta deve ser realizada com continuable para usar selector".
Exemplos de chamadas e de retornos deste método constam no arquivo Negociações.postman_collection.json, disponível como anexo em Integrando Negociações e Pagamentos através das APIs do CobranSaaS.
0 Comentários