# Estorno pontos avulsos

## Cenário

O objetivo do endpoint **DebitarConsumidor** documentado neste artigo é baixar/debitar uma quantidade de reais (R$) do consumidor especificado por você, via API do seu Programa de Fidelidade . Geralmente utiliza-se este endpoint em cenários que o cliente faz uma devolução de um único produto/serviço dentro de uma transação previamente pontuada.

Exemplo: Cliente foi pontuado em uma única transação no valor de R$ 56,00 e dentro deste pedido seu sistema contemplou 3 itens como segue abaixo:

`Produto 1 - R$ 10,00` \
`Produto 2 - R$ 20,00` \
`Produto 3 - R$ 26,00` \
`Total: R$ 56,00.`

Caso seu cliente realize a devolução/cancelamento do produto 3, no valor de R$ 26,00, você poderia estornar toda a pontuação do cliente e pontuar novamente **ou utilizar este endpoint DebitarConsumidor** no valor do produto 3.

### Recomendação

Nós sempre recomendamos que o estorno de pontos seja de forma centralizada utilizando o endpoint presente no link <https://docs.fidelimax.com.br/pontuacao/pontuar>, pois **garante o estorno de forma consistente**, porém se seu cenário não permitir a utilização do estorno consistente, utilize o estorno de pontos avulsos documentado neste artigo.

{% hint style="info" %}
**Dica**: Sempre que utilizar este endpoint, indique a data do estorno em questão, sendo a mesma data das pontuações que você planeja estornar parcialmente, pois cabe a você garantir a integridade dos dados. O não cumprimento desta regra acarretará problemas em TODOS os relatórios gerenciais do programa de fidelidade.
{% endhint %}

### Importante:

O uso indiscriminado deste endpoint acarreta na perda da consistência dos dados, portanto, a Fidelimax recomenda que o estorno de pontos, sempre que possível, seja realizado de forma centralizada utilizando o endpoint presente no link <https://docs.fidelimax.com.br/pontuacao/pontuar>, pois o sistema conseguirá garantir a integridade dos dados.

<mark style="color:green;">`POST`</mark> `https://api.fidelimax.com.brapi/Integracao/DebitarConsumidor`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-eff46235-5aed-47a3-b5d2-2bb41b82c345>

#### Headers

| Name                                        | Type   | Description                                                                                                    |
| ------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- |
| AuthToken<mark style="color:red;">\*</mark> | string | Token de integração que esta na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar. |
| Content-Type                                | String | application/json                                                                                               |

#### Request Body

| Name                                                 | Type   | Description                                                                                                                                                                                                                                                                                                                                                                                          |
| ---------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cpf                                                  | string | CPF do Consumidor. Campo obrigatório se os campos cartão, telefone não forem enviados                                                                                                                                                                                                                                                                                                                |
| telefone                                             | string | Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se os campos cpf, cartao não forem enviados                                                                                                                                                                                                                                                                                        |
| debito\_reais<mark style="color:red;">\*</mark>      | number | Quantidade de Reais a serem estornados como pontos                                                                                                                                                                                                                                                                                                                                                   |
| descricao\_estorno<mark style="color:red;">\*</mark> | string | Descrição do motivo de estorno da pontuação, esse campo deve conter no máx 50 carácteres.                                                                                                                                                                                                                                                                                                            |
| data                                                 | string | A data é referente ao mesmo dia em que a pontuação de crédito para o consumidor foi feita na plataforma de fidelidade, essa data é utilizada para todos os relatórios gerenciais do sistema e não para checar os pontos em si. Cabe a você garantir essa consistência, se a data não for preenchida o estorno será a data em que a requisição for feita. O formato deve ser dia/mês/ano (dd/mm/yyyy) |

{% tabs %}
{% tab title="200 nome - Nome do consumidor
documento - Documento do consumidor
telefone - Telefone do consumidor
saldo\_pre\_estorno: Saldo de pontos do consumidor antes da realização do estorno
pontos\_estornados: Pontos que foram estornados
CodigoResposta - Identificação da resposta
MensagemErro - Mensagem retornada pela API" %}

```
{    
    "nome": "Consumidor 1",
    "documento": "123456789",
    "telefone": "111111111",   
    "saldo_pre_estorno": 90,
    "pontos_estornados": 10,
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
Atenção: Reforçamos a recomendação, como melhor prática, da utilização do estorno realizado de **forma consistente** pelo endpoint presente no link abaixo, utilize o endpoint acima apenas em casos pontuais.\
\
<https://docs.fidelimax.com.br/pontuacao/pontuar>
{% endhint %}