# Extrato

## ExtratoConsumidor

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

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-38957e68-b41c-471e-bfe3-848cc25d4828><br>

#### 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                                                                                                                                                                                           |
| telefone     | string  | Telefone do Consumidor, formato (11)99999-9999                                                                                                                                                              |
| dias\_filtro | integer | Quantidade de dias atrás que será a data de inicio do filtro para o extrato de pontos. Exemplo é se você necessita listar os extratos de pontos dos últimos 5 dias é só informar o valor 5 neste parâmetro. |
| skip         | integer | Quantidade de registros para pular                                                                                                                                                                          |
| take         | integer | Quantidade de registros para retornar                                                                                                                                                                       |

{% tabs %}
{% tab title="200
total - Quantidade de registros no extrato completo do consumidor
saldo - Saldo em pontos do consumidor
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK
extrato - Array de objetos contendo informações do extrato
extrato.credito -  Pontos creditados no saldo do consumidor
extrato.debito - Pontos debitados no saldo do consumidor
extrato.premio\_nome - Nome do prêmio resgatado pelo consumidor
extrato.premio\_identificador - Identificador vinculado ao prêmio do consumidor
extrato.voucher - Voucher vinculado em cada resgate de prêmio
extrato.voucher\_resgatado - Voucher já foi resgatado pelo consumidor
extrato.data\_pontuacao - Data em que a pontuação foi realizada
extrato.data\_expiracao - Data em que a pontuação irá expirar
extrato.verificador - Verificador associado a uma pontuação de crédito
extrato.tipo\_compra - Descrição do tipo de crédito associado a pontuação
extrato.loja  - Nome da loja em que foi realizada a operação de pontuação
extrato.tipo\_pontuacao - Verificar valores na seção "Mapeamento Tipos Pontuações API"" %}

```
{    
    "total": 2,
    "saldo": 500,
    "extrato": [
     {
       "credito": 0
       "debito": 100
       "premio_nome": "Premio 1",
       "premio_identificador": "PRXX1",
       "voucher": "VD574AE",
       "voucher_resgatado": true,
       "data_pontuacao": "2017-08-03T15:11:33",
       "data_expiracao": "2018-08-03T15:11:33",
       "verificador": null,
       "tipo_compra": null,
       "loja": "Loja 1",
       "tipo_pontuacao": 206
     },
     {
       "credito": 500
       "debito": 0
       "premio_nome": null,
       "premio_identificador": null,
       "voucher": null,
       "voucher_resgatado": false,
       "data_pontuacao": "2017-08-04T15:11:33",
       "data_expiracao": "2018-08-04T15:11:33",
       "verificador": "fd7892",
       "tipo_compra": "Compras no Atacado",
       "loja": "Loja 2",
       "tipo_pontuacao": 205
     },
   ],
    "CodigoResposta": 100,
    "MensagemErro": ""
}
```

{% endtab %}
{% endtabs %}
