# Pontuar

## PontuaConsumidor

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

\
Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-8f2b88e6-b2c3-4395-9df4-d642ce46d3b1>

#### 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<mark style="color:red;">\*</mark> | String | application/json                                                                                               |

#### Request Body

| Name                                               | Type    | Description                                                                                                                                                                                                                                |
| -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| cpf                                                | string  | CPF do Consumidor. Campo obrigatório se os campos, cartao, telefone não forem enviados                                                                                                                                                     |
| telefone                                           | string  | Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se os campos cpf e cartao não forem enviados                                                                                                                             |
| pontuacao\_reais<mark style="color:red;">\*</mark> | number  | Pontuação feita em reais(R$). Exemplo o valor bruto do pedido de venda.                                                                                                                                                                    |
| tipo\_compra                                       | string  | Descrição do tipo da compra que será vinculado a pontuação                                                                                                                                                                                 |
| verificador                                        | string  | Verificador único que será vinculado a compra, com o verificador a pontuação poderá ser estornada quando o parâmetro estorno for enviado. Geralmente é o id único do seu sistema que ligará a pontuação ao Id da transação do seu sistema. |
| estorno                                            | boolean | Realizar operação de estorno, para realizar um estorno é necessário enviar o verificador e será estornado todo o valor da transação feita pelo verificador.                                                                                |

{% tabs %}
{% tab title="200 saldo - Saldo atual do consumidor
cashback - Saldo de cashback do consumidor, só é preenchido quando a plataforma de fidelidade está com o cashback habilitado
pontuacao\_resgatar - Consumidor possui pontos suficientes para resgatar algum prêmio
estorno - Operação de estorno foi realizada
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK" %}

```
{    
    "saldo": 500.0,
    "cashback": 5.00,
    "pontuacao_resgatar": true,   
    "estorno": false,
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fidelimax.com.br/pontuacao/pontuar.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.