Cancelar Proposta
Essa aba contem como realizar o cancelamento da proposta de um cliente.
Para realizar a solicitação, deve-se realizar a seguinte requisição:
- Realizar um DELETE para o seguinte endpoint:
DELETE {base_url}/core/financeiro/proposal
- Passando na query os seguintes campos:
Campo | Tipo | Descrição |
---|---|---|
customerDocument | string | Opcional. CPF do cliente, deve estar com pontuação. |
customerEmail | string | Opcional. E-mail do cliente. |
customerPhone | string | Opcional. Telefone do cliente, deve estar sem pontuação. |
externalId | string | Opcional. Id do cliente no parceiro, é utilizado apenas para métricas caso queiram visualizar a situação da solicitação dentro da Refuturiza. |
NOTE: É necessário passar pelo menos um dos campos.
Exemplo de request:
curl --location --request DELETE '{base_url}/core/financeiro/proposal?customerDocument=000.000.000-00&customerEmail=exemplo%40exemplo.com&customerPhone=11111111111&externalId=opcional' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token}'
Retorno esperado:
Após o envio das informações corretamente, será retornado uma mensagem de suscesso:
NOTE: Não enviamos nenhuma comunicação para esta solicitação, a comunicação é responsabilidade do Parceiro.
Casos de erro:
Exemplo de mensagem de erro quando token inválido ou expirado.
Status Code 401
Exemplo de mensagem de erro quando a request não apresenta um dos parâmetros.
Status Code 400
{
"message": "Pelo menos um identificador deve ser fornecido na solicitação.",
"success": false
}