Obtendo os Pagamentos das Negociações através de Pooling

Quando o gerenciamento financeiro dos pagamentos no CobranSaaS é feito pela própria plataforma, os pagamentos podem ser integrados aos sistemas legados via pooling, usando a API do CobranSaaS para obter apenas eventos de atualização ainda não capturados.

A lista de pagamentos de acordos, renegociações e pagamentos avulsos pode ser acessada pelo método Acordos API - Listar pagamentos (GET /api/acordos/pagamentos). A documentação está em seudominio.cobransaas.com.br/#/docs-api/acordos/api-acordos-pagamentos (substitua "seudominio" pelo domínio da sua empresa).

Por retornar múltiplos registros, é importante usar a paginação, conforme detalhado em seudominio.cobransaas.com.br/#/docs-api/introducao/paginacao.

Consulte Integrando Negociações e Pagamentos através das APIs do CobranSaaS para mais detalhes sobre a obtenção dos pagamentos.

O método aceita parâmetros para filtrar os pagamentos, como:

• integracao (AGUARDANDO, PENDENTE, PARCIAL, CONCLUIDO, CANCELADO, INTERNO) para filtrar por status de integração, útil no pooling.
• dataHoraInclusaoInicio e dataHoraInclusaoFim (formato Datetime "YYYY-MM-DDTHH:MM:SS") para filtrar por período de atualização.
• agrupador para filtrar por ID do agrupador.
• situacao (ATIVO, PENDENTE, CANCELADO) para filtrar por status do pagamento.
• dataOperacao, dataOperacaoInicio, dataOperacaoFim para filtrar por data de operação.
• dataLiquidacao, dataLiquidacaoInicio, dataLiquidacaoFim para filtrar por data de liquidação.
• dataProcessamento para filtrar por data de processamento.
• selector para incluir detalhes do acordo, cliente, agrupador, canal de pagamento, abatimentos e liquidações.

Para usar selector, é obrigatório o modo de paginação CONTINUABLE (parâmetro mode), conforme a documentação de paginação. Caso contrário, retorna erro 400 com a mensagem "A consulta deve ser realizada com continuable para usar selector".

Exemplos de chamadas e respostas estão no arquivo Negociações.postman_collection.json, disponível em Integrando Negociações e Pagamentos através das APIs do CobranSaaS.