> For the complete documentation index, see [llms.txt](https://docs.fidelimax.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fidelimax.com.br/voucher/consultar-voucher.md).

# Consultar Voucher

## ConsultarVoucher

<mark style="color:blue;">`GET`</mark> `https://api.fidelimax.com.br/api/Integracao/StatusVoucher/:voucher`

Exemplo no POSTMAN - <https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-583ac222-d6d0-4a61-bb34-6576e3c3cad6>

#### Query Parameters

| Name                                      | Type   | Description                                                                                                         |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| voucher<mark style="color:red;">\*</mark> | string | Voucher gerado automaticamente pelo sistema que é apresentado ao cliente após ele realizar um resgate de um prêmio. |

#### Headers

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

{% tabs %}
{% tab title="200 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"
			}
	}
}

```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/voucher/consultar-voucher.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.