Consultar Voucher

Utilizado para consultar se o voucher apresentado pelo consumidor é valido, trazendo as informações contidas nele

get
ConsultarVoucher
https://api.fidelimax.com.br/api/Integracao/StatusVoucher/:voucher
Request
Response
Request
Headers
AuthToken
required
string
Token de integração que está na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar.
Query Parameters
voucher
required
string
Voucher gerado automaticamente pelo sistema que é apresentado ao cliente após ele realizar um resgate de um prêmio.
Response
200: OK
CodigoResposta - Identificação numérica da resposta 
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK
voucher - Objeto que contém as informações vinculadas a um voucher
voucher.identificador - Identificador único vinculado que será enviado ao cliente quando ele resgatar o prêmio, ele será um voucher/cupom que é gerado na sua loja online que pode dar descontos/frete grátis ao seus clientes.
voucher.resgatado - Quando "true" indica que o voucher já foi baixado no programa de fidelidade
voucher.data_resgate - Data em que o voucher foi resgatado, quando a propriedade "resgatado" estiver como "true"
voucher.valor_cashback - Quando a plataforma de fidelidade tiver a opção de cashback habilitado o valor de cashback relativo ao voucher é retornada
voucher.consumidor - Objeto que contém as informações básicas do consumidor que resgatou o voucher
voucher.consumidor.nome - Nome do consumidor
voucher.consumidor.documento - Documento do consumidor
voucher.consumidor.email - E-mail do consumidor
{
	"CodigoResposta": 100,
	"MensagemErro": null,
	"voucher": 
	{
			"identificador": "PCX111",
			"resgatado": true,
			"data_resgate": "26/07/2017",
			"valor_cashback": 27.22,
			"consumidor": 
			{
				"nome": "Nome do Consumidor",
				"documento": "11122233399",
				"email": "Nome Consumidor"
			}
	}
}
​
​

🎁 Premiação - Previous

Cadastro de Voucher

Next - 🎁 Premiação

Resgatar Voucher

Last updated 4 months ago

Consultar Voucher

getConsultarVoucher

get
ConsultarVoucher