A  API Reward (Minutrade) possibilita solicitar a geração de bilhetes de promoções por portadores de cartão da Elo.


Reward

Estados de verificação.

Utilizado, por exemplo, para verificação de contatos de um portador.

VerifiedStatus

UNVERIFIED

Iniciou-se o processo de verificação, porém ele ainda não foi concluído.
Após a conclusão mudará para `VERIFIED` ou `FAILED`.

PENDING

VERIFIED

FAILED

O processo de verificação não se aplica a este ítem.

NOT_APPLICABLE

Gender

FEMALE

MALE

OTHER

MaritalStatus

DIVORCED

MARRIED

SINGLE

WIDOWED

COMMON_LAW_MARRIED

RewardStatus

REQUESTED

APPROVED

ERROR

número do RG (dígitos) sem hífen ou pontos.

number

organização emissora do documento (exemplo: `SSP`)

issuerOrganization

estado de emissão do documento (exemplo: `SP`)

issuerState

issueDate

RGInput

cnpj

LegalIdsInput

Entrada com dados básicos para redes sociais.

Nome do provedor da rede social, ex: Facebook, Twitter...

provider

username

SocialNetworkInput

compositionId

Identificador global único do cartão para o qual o benefício está disponível.

cardId

RequestRewardInput

rewardId

ResendRewardInput

input

Solicita a recompensa de um benefício disponível para o portador.

requestReward

Solicita o reenvio do comprovante da recompensa de um benefício solicitado pelo portador anteriormente.

resendReward

Procura o usuário pelo identificador global único

legalId

Procura o usuário pelo seu `username` na rede social especificada.

socialNetwork

Procura pelo usuário associado ao portador de cartões com o
identificador global único especificado.

cardHolderId

Procura pelo usuário associado ao comerciante com o
identificador global único especificado.

Caso o comerciante tenha mais de um usuário responsável, retorna
o mais antigo.

merchantId

_Query_ (consulta) de usuário por vários meios de entrada.

Esta consulta deve ser feita com apenas um parâmetro não-`null`
para designar o método de procura. Utilizar mais de um pode
resultar em resultados distintos em cada chamada.

user

Toda a possível identificação legal de uma pessoa ou empresa

LegalIds

Renda anual de uma pessoa física (individual e familiar).

Renda anual pessoal (individual) da pessoa física.

personal

Renda anual total da família da pessoa física.

family

Moeda associada aos valores informados.

Código da moeda com 3 letras
[ISO4217](https://en.wikipedia.org/wiki/ISO_4217)
Exemplo: `EUR`, `USD`, `BRL`...

currency

PersonYearlyIncome

Profissão (ocupação) de uma pessoa física.

Identificador opaco da Profissão

Deve ser informado como entrada em mutações que precisam de profissão.

Texto a ser exibido ao usuário em formulários e consultas.

Este texto é localizado (traduzido) para a linguagem informada na
consulta.

display

PersonOccupation

width

height

Tipo do arquivo na convenção (_MIME - Multipurpose Internet Mail
Extensions_), como `image/png`, `image/jpeg`

mimeType

ImageUrl

Ítem de contato com pessoa física, como email ou telefone...

Com o intuito de manter a privacidade, o campo `value` pode ser
mascarado.

Identificador global único para este objeto

Tipo designa como interpretar o valor, podendo ser telefone,
email, ou aplicativo de mensagens instantâneas.

type

Contexto do contato, que varia com o tipo:
 - Se o tipo for `PHONE`, `WHATSAPP` ou `EMAIL`, este poderia ser: vendas, suporte ...
 - Se o tipo for `IM`, pode ser: skype, whatsapp, facebook messenger...
 - Se for `OTHER`, pode ser qualquer texto

context

Valor do contato. Exemplos: `+12345678` para telefone,
`user@server.com` para email, etc.

Este campo pode ser transformado dependendo de regras de acesso e
permissões. Um comerciante pode receber valores mascarados com o
intuito de manter a privacidade da pessoa física. Um exemplo seria
receber apenas os últimos 4 dígitos do telefone, ou apenas as
primeiras letras do email seguida do domínio.

value

O processo de verificação é feito por nosso sistema enviando uma
mensagem ao contato e então pedindo que a chave enviada seja
reenviada ao sistema.

> **NOTA:** apenas os tipos de contatos `PHONE` e `EMAIL` são
> verificáveis. Os demais retornarão sempre `NOT_APPLICABLE`.

verified

PersonContact

Endereço Físico Mundial, que pode ser usado para envios ou contas

Contexto do endereço, por exemplo: Casa, Trabalho, Matriz, Filial

Análogo a campo de mesmo nome em `PersonContact` e `CompanyContact`.

Código do país com 3 letras
([ISO3166-alpha3](https://pt.wikipedia.org/wiki/ISO_3166-1_alfa-3)).
Exemplos: `USA`, `BRA`...

country

city

abbrev

Nome do estado por completo ou abreviado (opcional).

Abreviações de estados podem não estar disponíveis para alguns países,
casos em que o nome por completo é retornado.

state

district

O tipo deve ser `Av.` (Avenida), `R.` (Rua), `Rd.` (Rodovia)...

kind

Nome da via, para ser usado em conjunto com `kind` e `number`, compondo
a primeira linha de endereço.

place

Complemento opcional, como número de apartamento.

complement

Ponto de referência (exemplo: próximo ao posto)

reference

Instruções (exemplo: autorização do receptor)

instructions

Longitude, opcional: em graus.

Contém a longitude caso seja manualmente provido ou automaticamente
descoberto à partir do endereço. Caso não seja possível prover, será
`null`.

Latitude, opcional: em graus.

Contém a latitude caso seja manualmente provido ou automaticamente
descoberto à partir do endereço. Caso não seja possível prover, será
`null`.

Address

Portador de cartão

Usualmente uma pessoa

Identificador Global Único para este objeto

Nome completo do portador como nos documentos oficiais (RG, CPF)

name

firstName

lastName

Nome de usuário a ser exibido (exemplo: encurtado, alias...)

displayName

Nome da empresa.

Para cartões corporativos (pessoa jurídica), este campo informa o
nome fantasia da empresa. Para a razão social, veja
`companyLegalName`.

Para cartões de pessoa física será sempre `null`.

companyName

Nome legal da empresa, como escrito em documentos.

Para cartões corporativos (pessoa jurídica), este campo informa a
razão social da empresa. Para nome fantasia, veja `companyName`

Para cartões de pessoa física será sempre `null`.

companyLegalName

Todos os documentos legais de identificação de empresas ou pessoas.

legalIds

birthday

Masculino ou Feminino, conforme documentos oficiais

gender

maritalStatus

Renda anual do portador (individual e familiar).

Este campo é informacional e pode ser utilizado no preenchimento
de formulários de outros serviços, por exemplo para emissão de
seguros.

income

Língua a ser utilizada no retorno da consulta.

Por padrão adota-se a língua de quem faz a requisição, porém uma
diferente pode ser requisitada e está será utilizada, ou a mais
próxima disponível. O formato é: `en_US` (Inglês dos EUA), `en`
(Inglês genérico), `pt_BR` (Português do Brasil), `pt`
(Português genérico). O formato é o mesmo de [IETF language
tag](https://en.wikipedia.org/wiki/IETF_language_tag).

language

Profissão do portador.

Este campo é informacional e pode ser utilizado no preenchimento
de formulários de outros serviços, por exemplo para emissão de
seguros.

Por padrão adota-se a língua de quem faz a requisição, porém uma
diferente pode ser requisitada e está será utilizada, ou a mais
próxima disponível. O formato é: `en_US` (Inglês dos EUA), `en`
(Inglês genérico), `pt_BR` (Português do Brasil), `pt` (Português
genérico). O formato é o mesmo de [IETF language
tag](https://en.wikipedia.org/wiki/IETF_language_tag).

occupation

Caso fornecido, largura da imagem, em _pixels_.

Caso fornecido, altura da imagem, em _pixels_.

Caso fornecido, o tipo de arquivo desejado (`mime-type`).

URL para foto de perfil.
Caso sejam providos sugestões de altura e largura (opcionais) para
o tamanho a ser mostrado, o servidor irá retornar a URL para a imagem
com o tamanho mais próximo ao requisitado.
Caso seja provido o `mimeType`, a este será dada preferência, o que
é muito útil em dispositivos que lidam com um único formato de imagens.
Tanto o tamanho quanto o `mimeType` da imagem apontada pela URL
são retornados.

image

contacts

addresses

Carteiras em posse deste portador de cartão.

wallets

Limita a lista às primeiras entradas, caso provido.
Se for `null`, a listagem é ilimitada.
Utilizado em navegação para frente.

first

Inicia após o cursor opaco, se provido.
Utilizado em navegação para frente.

after

Limita a lista às últimas entradas, caso provido.
Se for `null`, a listagem é ilimitada.
Utilizado em navegação para trás.

last

Inicia antes do cursor opaco, se provido.
Utilizado em navegação para trás.

before

filter

Cartões em posse.

Lista todos os cartões de um portador utilizando paginação e um
filtro opcional.

Note que nem todos os campos de um cartão serão retornados pois
estes têm privacidade restrita ao portador, emissor ou demais
entidades autorizadas pela plataforma.

Opcionalmente pode-se utilizar o `filter` para selecionar apenas
cartões de um certo emissor, produto, que oferece algum serviço ou
que tenha alguma restrição de uso.

cards

cardTokens

Seguros Viagem relacionados ao portador.

Lista todos os seguros viagem relacionados ao portador utilizando
paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o `filter` para selecionar apenas
seguros ativos, expirados, cancelados e limitar a um certo
intervalo de datas.

travelInsurances

Seguros de Garantia Estendida relacionados ao portador.

Lista todos os seguros de extensão de garantia de produtos
relacionados ao portador utilizando paginação e um filtro
opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o `filter` para selecionar apenas
seguros ativos, expirados, cancelados e limitar a um certo
intervalo de datas.

extendedWarrantyInsurances

Seguros de Proteção de Compra relacionados ao portador.

Lista todos os seguros de proteção de compra de produtos
relacionados ao portador utilizando paginação e um filtro
opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o `filter` para selecionar apenas
seguros ativos, expirados, cancelados e limitar a um certo
intervalo de datas.

purchaseProtectionInsurances

Assistência residencial solicitadas pelo portador.

Lista todas as Assistências residencias relacionadas ao 
portador utilizando paginação e um filtro opcional.

A ordem da listagem é do mais recente para o mais antigo.

Opcionalmente pode-se utilizar o `filter` para selecionar assistências pelo seu
status, tipo ou ID.

homeAssistences

  , se provido.
Utilizado em navegação para frente.

_Query_ (consulta) documentos enviados para verificação

documents

rewards

CardHolder

Um estabelecimento comercial que realiza transações com cartões Elo.

legalName

address

Categorias de comerciantes (Código ISO, nome)

transactionFees

MerchantEC

code

description

Consulta todos os objetos de cartão (`Card`) disponíveis no contexto.

Se executado por um portador de cartão, serão retornados todos os
cartões que este possui e foram emitidos por este emissor.

Se executado por um emissor de cartão, serão retornados todos os
cartões emitidos por este.

Em outros casos, como ao ser executado por um comerciante, um erro
será produzido.

CardIssuer

SocialNetwork

agreementTerm

timestamp

UserAgreement

Chave de acesso (`accessToken`) e informações sobre sua origem.

A chave de acesso (`accessToken`) ativa para este usuário

accessToken

Quando a chave de acesso (`accessToken`) foi criada

ipv6Mapped

Endereços de rede IPv4 ou IPv6 de onde partiu a solicitação de criação.

Se for IPv6, deve estar entre colchetes. Exemplo: `[::1]`
Se for IPv4, deve seguir a notação com pontos: `127.0.0.1`

O opcional `ipv6Mapped` estabelece que os endereços IPv4 sempre serão
codificados como IPv6 usando regras de mapeamento: `[::ffff:127.0.0.1]`

Pode ser `null` se o endereço IP era desconhecido no momento de criação
da chave de acesso.

Localização geográfica de onde partiu a solicitação de criação da
chave de acesso (`accessToken`). Pode ser aproximada à partir do IP.

Pode ser `null`.

geolocation

Dispositivo utilizado para a criação da chave de acesso
(`accessToken`). Pode ser aproximado, por exemplo, usando o Agente
de Usuário (_User-Agent_) para identificar sistema operacional,
marca e modelo...

device

AccessTokenInfo

Identificador da chave para este usuário.

Em operações que retornem dados cifrados este será o identificador
da chave a ser especificado, como na consulta `CardInterface {
sensitive(keyId: "X") }`

Este identificador é gerado no momento que a chave é adicionada,
vide `addPublicKeyToUser()`

> **NOTA:** tem escopo do usuário, **não** é global do sistema.

A chave serializada no formato requerido.

Se nenhum formato for especificado, será retornada como [JSON Web
Key - JWK](https://tools.ietf.org/html/rfc7517)