Um voucher é um código resgatável atrelado à um benefício. Tal código de resgate é criado e gerenciado internamente dentro da API de benefícios, mas suas rotas podem ser utilizadas individualmente também.
No caso de um resgate de um voucher por um membro de uma comunidade, a interação com a API de voucher deve ser direta, através da rota de resgate /vouchers/:voucherId.
Essa rota revela ao usuário o código de um voucher que o mesmo tem direito caso todos seus campos da requisição sejam válidos.
Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator, member
Path Parameters
Name
Type
Description
voucherId*
String
ID do Voucher
Headers
Name
Type
Description
authorization*
Bearer
JWT
Request Body
Name
Type
Description
requiredFormData
[Objects]
Conjunto de campos obrigatórios para resgate do voucher
Caso o voucher seja referente ao resgate de um benefício de um token, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "benefit"
"tokenBenefitId": "789fgres1as",
"code": "50OFF",
"revealStatus": "revealed",
"revealDate": "2022-10-15 15:07:12",
"requiredFormData": [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios",
"content": "Rua Aristides Maia, 204, Catumbi, Rio de Janeiro, RJ"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail",
"content": "meu@email.com"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular",
"content": "5521998789636"
}
]
}
Caso o voucher seja referente ao resgate direto de um token, como atrelado à uma coleção do tipo Airdrop ou POAP, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "airdrop",
"collectionId": "fs21g65eahjn",
"tokenId" : "798efsf3sgf",
"code": "B87QM",
"revealStatus": "revealed",
"revealDate": "2022-10-15 15:07:12",
"requiredFormData": [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios",
"content": "Rua Aristides Maia, 204, Catumbi, Rio de Janeiro, RJ"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail",
"content": "meu@email.com"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular",
"content": "5521998789636"
}
]
}
id - String
Identificador próprio do benefício.
type - String
Determina o tipo de voucher à que se refere. Pode ser benefit ou airdrop.
benefitId - String
Identificador próprio relativo ao benefício com o qual o voucher se relaciona, quando ele é do tipo benefit.
collectionId - String
Identificador próprio relativo à coleção com o qual o voucher se relaciona, quando ele é do tipo airdrop.
tokenId - String
Identificador próprio relativo ao token resgatável com o qual o voucher se relaciona, quando ele é do tipo airdrop.
code - String
Código de resgate do benefício.
revealStatus - String
Status de revelação do código do benefício. Pode ser revealed ou hidden.
revealDate - DateTime
Data e hora da revelação do código do benefício.
requiredFormData - Array of Objects
Conjunto de dados necessários para liberação do uso do voucher.
name - String
Nome do campo de dados necessário.
type - String
Tipo de dado solicitado.
placeholder - String
Texto auxiliar de preenchimento do campo.
content - String
Conteúdo preenchido pelo usuário no resgate do voucher.
Código
Descrição
1
Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.
Código
Descrição
10
Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.
(JWT) Resgata um código de voucher de Airdrop ou POAP
Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator
Headers
Name
Type
Description
authorization*
Bearer
JWT
Request Body
Name
Type
Description
code
String
Código de resgate do voucher. Se não for passado, será gerado randomicamente.
tokenBenefitId
String
ID do Benefício (caso tipo seja benefit)
collectionId
String
ID da Coleção (caso tipo seja airdrop)
tokenId
String
ID da Coleção (caso tipo seja airdrop)
requiredFormData
[Objects]
Conjunto de campos obrigatórios para resgate do voucher
type*
String
Tipo do Voucher (benefit | airdrop)
Caso o voucher seja referente ao resgate de um benefício de um token, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "benefit"
"tokenBenefitId": "789fgres1as",
"code": "50OFF",
"revealStatus": "unrevealed",
"revealDate": null,
"redeemStatus": null,
"redeemDate": null,
"requiredFormData" : [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular"
}
]
}
Caso o voucher seja referente ao resgate direto de um token, como atrelado à uma coleção do tipo Airdrop ou POAP, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "airdrop",
"collectionId": "fs21g65eahjn",
"tokenId" : "798efsf3sgf",
"code": "B87QM",
"revealStatus": "unrevealed",
"revealDate": null,
"redeemStatus": null,
"redeemDate": null,
"requiredFormData" : [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular"
}
]
}
id - String
Identificador próprio do benefício.
type - String
Determina o tipo de voucher à que se refere. Pode ser benefit ou airdrop.
benefitId - String
Identificador próprio relativo ao benefício com o qual o voucher se relaciona, quando ele é do tipo benefit.
collectionId - String
Identificador próprio relativo à coleção com o qual o voucher se relaciona, quando ele é do tipo airdrop.
tokenId - String
Identificador próprio relativo ao token resgatável com o qual o voucher se relaciona, quando ele é do tipo airdrop.
code - String
Código de resgate do benefício.
revealStatus - String
Status de revelação do código do benefício. Pode ser revealed ou hidden.
revealDate - DateTime
Data e hora da revelação do código do benefício.
requiredFormData - Array of Objects
Conjunto de dados necessários para liberação do uso do voucher.
name - String
Nome do campo de dados necessário.
type - String
Tipo de dado solicitado.
placeholder - String
Texto auxiliar de preenchimento do campo.
content - String
Conteúdo preenchido pelo usuário no resgate do voucher.
Código
Descrição
1
Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.
Código
Descrição
10
Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.
Nível de permissionamento necessário: company_admin, company_moderator, community_admin, community_moderator
Path Parameters
Name
Type
Description
voucherId*
String
ID do Voucher
Headers
Name
Type
Description
authorization*
Bearer
JWT
Request Body
Name
Type
Description
code
String
Código de resgate do voucher
redeemStatus
String
Status de uso do voucher
redeemDate
DateTime
Data do uso do voucher
revealStatus
String
Status de revelação do código do voucher
revealDate
DateTime
Data de revelação do código do voucher
requiredFormData
[Objects]
Conjunto de campos obrigatórios para resgate do voucher
Caso o voucher seja referente ao resgate de um benefício de um token, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "benefit"
"tokenBenefitId": "789fgres1as",
"code": "10OFF",
"revealStatus": "revealed",
"revealDate": "2022-10-14 12:27:31",
"redeemStatus": null,
"redeemDate": null,
"requiredFormData" : [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular"
}
]
}
Caso o voucher seja referente ao resgate direto de um token, como atrelado à uma coleção do tipo Airdrop ou POAP, ele terá os seguintes campos como retorno:
{
"id": "8798wdefs",
"type": "airdrop",
"collectionId": "fs21g65eahjn",
"tokenId" : "798efsf3sgf",
"code": "B750M",
"revealStatus": "revealed",
"revealDate": "2022-10-14 12:27:31",
"redeemStatus": null,
"redeemDate": null,
"requiredFormData" : [
{
"name": "Endereço",
"type": "text"
"placeholder": "Digite aqui seu endereço para entrega de benefícios"
},
{
"name": "E-mail",
"type": "email"
"placeholder": "Digite aqui seu melhor e-mail"
},
{
"name": "Celular",
"type": "phone",
"placeholder": "Digite aqui seu número de celular"
}
]
}
id - String
Identificador próprio do benefício.
type - String
Determina o tipo de voucher à que se refere. Pode ser benefit ou airdrop.
benefitId - String
Identificador próprio relativo ao benefício com o qual o voucher se relaciona, quando ele é do tipo benefit.
collectionId - String
Identificador próprio relativo à coleção com o qual o voucher se relaciona, quando ele é do tipo airdrop.
tokenId - String
Identificador próprio relativo ao token resgatável com o qual o voucher se relaciona, quando ele é do tipo airdrop.
code - String
Código de resgate do benefício.
revealStatus - String
Status de revelação do código do benefício. Pode ser hidden ou revealed.
revealDate - DateTime
Data e hora da revelação do código do benefício.
redeemStatus - String
Status de resgate do código do benefício. Pode ser null ou redeemed.
redeemDate - DateTime
Data e hora do resgate do código do benefício.
requiredFormData - Array of Objects
Conjunto de dados necessários para liberação do uso do voucher.
name - String
Nome do campo de dados necessário.
type - String
Tipo de dado solicitado.
placeholder - String
Texto auxiliar de preenchimento do campo.
content - String
Conteúdo preenchido pelo usuário no resgate do voucher.
Código
Descrição
1
Credenciais de acesso necessárias. Por favor, execute sua autenticação na plataforma.
Código
Descrição
10
Credenciais de acesso expiradas. Por favor, execute novamente sua autenticação na plataforma.