Quando o sistema legado gerencia os pagamentos das negociações no CobranSaaS, eles podem ser integrados via APIs. Se o ID da negociação não estiver no legado, ele deve ser obtido no CobranSaaS, conforme Obtendo a Identificação da Negociação do Pagamento a ser integrado no CobranSaaS.
A integração é feita pelo método POST /api/acordos/pagamentos. A documentação está em seudominio.cobransaas.com.br, substituindo "seudominio" pelo domínio da sua empresa.
Consulte Integrando Negociações e Pagamentos através das APIs do CobranSaaS para detalhes essenciais da integração.
Parâmetros obrigatórios:
- acordo: ID ou ID externo da negociação.
- formaLiquidacao: forma de pagamento (ex: CARTAO_CREDITO, PIX, DINHEIRO).
- valorRecebido: valor efetivamente recebido.
- valorDesconto: valor de desconto concedido (pode ser zero).
Parâmetros opcionais:
- idExterno: ID externo do pagamento no sistema legado.
- dataPagamento: data do pagamento.
- valorEncargos: valor dos encargos incluídos.
- integrar: se informado, deve ser FALSE para indicar que o abatimento já foi feito no legado.
- agrupador: ID do agrupador para vincular o pagamento.
- canalPagamento: ID do canal de pagamento.
- observacao: observação sobre o pagamento.
O método retorna o id interno gerado pelo CobranSaaS para o pagamento, junto com seus detalhes.
Se o parâmetro acordo não for válido, retorna erro 400 com a mensagem "O acordo não foi encontrado".
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.
Comentários
0 comentário
Artigo fechado para comentários.