Extrato
Utilizado para listar o histórico de pontuações que o consumidor tem no programa de fidelidade
postExtratoConsumidor
post
https://api.fidelimax.com.br/api/Integracao/ExtratoConsumidor
Exemplo em POSTMAN - https://bit.ly/2Aj9t1J
Request
Response
Request
Path Parameters
AuthToken
optional
string
Token de integração que está na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar
Body Parameters
cpf
required
string
CPF do Consumidor
cartao
required
string
Cartão que pode ser vinculado ao consumidor
telefone
required
string
Telefone do Consumidor, formato (11)99999-9999
dias_filtro
optional
integer
Quantidade de dias que será realizado o filtro
skip
optional
integer
Quantidade de registros para pular
take
optional
integer
Quantidade de registros para retornar
Response
200: OK
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": ""}
Last updated 7 months ago