Após a simulação de negociações em múltiplas etapas, a efetivação é feita pelo método Acordos API - Efetivar acordo.
Os parâmetros de entrada são similares aos da terceira etapa da simulação.
Para acordos, renegociações e pagamentos avulsos, os parâmetros cliente, negociacao e meioPagamento são obrigatórios, com seus respectivos IDs. Para promessas de pagamento, meioPagamento não é necessário. O parâmetro observacao é opcional. Devem ser informadas obrigatoriamente a lista de parcelas da dívida e a opção de parcelamento. Se a assessoria receber pagamentos diretamente, a lista de pagamentos pode ser informada opcionalmente.
Cada parcela deve conter seu ID no atributo parcela e os 7 atributos de desconto (valorDesconto, descontoPrincipal, descontoJuros, descontoPermanencia, descontoMora, descontoMulta e descontoOutros), geralmente iguais aos da última simulação, mesmo que zero.
A opção de parcelamento deve ser identificada pelo número de parcelas no atributo numeroParcelas, onde 0 indica pagamento à vista, 1 parcela única, 2 duas parcelas, e assim por diante, sem considerar entrada, que pode ou não existir. Os atributos dataEmissao, dataVencimento, valorEntrada, descontoDivida, taxaOperacao e descontoTarifa são obrigatórios e geralmente iguais aos da última simulação. O atributo descontoTarifaParcela é opcional, mas recomendado, também com valores da última simulação.
Se houver pagamentos recebidos pela assessoria, devem ser informados com os atributos dataPagamento, valorRecebido, valorDesconto e formaLiquidacao, que pode ser CNAB, MANUAL, CARTAO_CREDITO, DINHEIRO, CHEQUE ou LINK_PAGAMENTO, conforme o meio de pagamento. Para CARTAO_CREDITO ou CHEQUE, detalhes devem ser informados nos atributos cartaoCredito e cheque, conforme documentação do método.
Após a efetivação, o método retorna os detalhes da negociação, que passam a ser as informações oficiais, substituindo as temporárias da simulação. Entre as informações retornadas estão:
- id - identificador único interno do CobranSaas;
- idExterno - identificador para sistemas externos integrados via API;
- numeroAcordo - número para identificação pelos usuários;
- meioPagamento - dados do meio de pagamento escolhido (para acordos, renegociações e pagamentos avulsos);
- linkPagamento - URL para pagamento online da entrada, disponível se o meio de pagamento for LINK_PAGAMENTO.
Exemplos de chamadas e de retornos do método Acordos API - Efetivar acordo constam no arquivo Assessorias - Acordos API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.
Comentários
0 comentário
Artigo fechado para comentários.