Mudanças entre as edições de "API de listagem de parcelamentos do portal de negociação (quitação)"
(Criou página com 'A API de listagem de parcelamentos do portal de negociação (quitação) deve ser utilizada para exibir os parcelamentos de todas as dívidas em aberto com o credor válidos...') |
|||
Linha 2: | Linha 2: | ||
− | Endpoint: https:// | + | Endpoint: https://app.recuperador.com.br/api/v1PortalNegociacaoParcelasTotal/?id_credor=XXXX&id_cliente=YYYY |
Ação: '''GET''' | Ação: '''GET''' |
Edição atual tal como às 21h18min de 21 de junho de 2023
A API de listagem de parcelamentos do portal de negociação (quitação) deve ser utilizada para exibir os parcelamentos de todas as dívidas em aberto com o credor válidos para viabilizar a chamada da API para cadastro de acordo de forma semelhante ao portal de negociação (quitação).
Endpoint: https://app.recuperador.com.br/api/v1PortalNegociacaoParcelasTotal/?id_credor=XXXX&id_cliente=YYYY
Ação: GET
Formato: JSON
Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.
Parâmetros de entrada
{
id_credor: int, id_cliente: int
}
Seguem informações complementares sobre cada parâmetro de entrada:
- ID credor: deve ser preenchido código do credor para quitação das dívidas. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.
- ID cliente: deve ser preenchido código do cliente (devedor) para quitação das dívidas. Utilize a API para listagem de dívidas elegíveis para negociação pelo portal de negociação para obter o id correto.
Lista de retorno
[
{ parcelas: int, descricao: string }
]
Seguem informações complementares sobre cada coluna da lista de retorno:
- Parcelas: retornará um inteiro representando a quantidade de parcelas definida no parcelamento em questão. Exemplo: 1, 2, 3 etc.
- Descricao: exibirá a descrição (resumo) do parcelamento em questão. Exemplo: 1x de R$ 516,59.