Validar Voucher

Descrição

Permite validar um voucher informado, retornando a situação de validade do voucher no sistema.

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`voucher`	string	Sim	Código do voucher a ser validado.
`idMembership`	int32	Sim	ID do contrato associado.
`idService`	int32	Não	ID do serviço associado.
`idBranch`	int32	Sim	ID da unidade.

📤 Estrutura da Resposta

A resposta retorna as informações do voucher validado, incluindo dados de desconto aplicável para contrato, serviço único, recorrência e anuidade.

Campo	Tipo	Descrição
`idVoucher`	int32	Identificador do voucher no sistema.
`idVoucherItem`	int32	Identificador do item do voucher.
`voucher`	string	Código do voucher informado na validação.
`flFreePass`	boolean	Indica se o voucher concede acesso gratuito.
`membershipValue`	number	Valor original do contrato antes da aplicação de desconto.
`discountKind`	int32	Tipo de desconto aplicado ao contrato.
`discountValue`	number	Valor do desconto aplicado ao contrato.
`finalMembershipValue`	number	Valor final do contrato após aplicação do desconto.
`flSingleServiceDiscount`	boolean	Indica se o voucher possui desconto para serviço único.
`singleServiceValue`	number	Valor original do serviço único.
`singleServiceDiscountKind`	int32	Tipo de desconto aplicado ao serviço único.
`singleServiceDiscountValue`	number	Valor do desconto aplicado ao serviço único.
`finalSingleServiceDiscountValue`	number	Valor final do serviço único após aplicação do desconto.
`flRecurringDiscount`	boolean	Indica se o voucher possui desconto recorrente.
`monthsRecurringDiscount`	int32	Quantidade de meses em que o desconto recorrente será aplicado.
`flAnnuityDiscount`	boolean	Indica se o voucher possui desconto na anuidade.
`annuityValue`	number	Valor original da anuidade.
`annuityDiscountKind`	int32	Tipo de desconto aplicado à anuidade.
`annuityDiscountValue`	number	Valor do desconto aplicado à anuidade.
`finalAnnuityValue`	number	Valor final da anuidade após aplicação do desconto.
`dayAnnuity`	int32	Dia configurado para cobrança da anuidade.
`monthAnnuity`	int32	Mês configurado para cobrança da anuidade.
`finalValue`	number	Valor final total após aplicação de todos os descontos do voucher.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "voucher": "string",
    "idMembership": 0,
    "idService": 0,
    "idBranch": 0
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idVoucher": 0,
    "idVoucherItem": 0,
    "voucher": "string",
    "flFreePass": true,
    "membershipValue": 0,
    "discountKind": 0,
    "discountValue": 0,
    "finalMembershipValue": 0,
    "flSingleServiceDiscount": true,
    "singleServiceValue": 0,
    "singleServiceDiscountKind": 0,
    "singleServiceDiscountValue": 0,
    "finalSingleServiceDiscountValue": 0,
    "flRecurringDiscount": true,
    "monthsRecurringDiscount": 0,
    "flAnnuityDiscount": true,
    "annuityValue": 0,
    "annuityDiscountKind": 0,
    "annuityDiscountValue": 0,
    "finalAnnuityValue": 0,
    "dayAnnuity": 0,
    "monthAnnuity": 0,
    "finalValue": 0
}

🟠400Bad Request

Validate the voucher

Validar Voucher#

Descrição#

📨 Corpo da Requisição (Request Body)#