Validar cupón

Descripción

Permite validar un voucher proporcionado, retornando la situación de validez del voucher en el sistema.

📨 Cuerpo de la Requisición (Request Body)

Parámetro	Tipo	Obligatorio	Descripción
`voucher`	string	Sí	Código del voucher a validar.
`idMembership`	int32	Sí	ID del contrato asociado.
`idService`	int32	No	ID del servicio asociado.
`idBranch`	int32	Sí	ID de la unidad.

📤 Estructura de la Respuesta

La respuesta retorna la información del voucher validado, incluyendo datos de descuentos aplicables para contrato, servicio único, recurrencia y anualidad.

Campo	Tipo	Descripción
`idVoucher`	int32	Identificador del voucher en el sistema.
`idVoucherItem`	int32	Identificador del ítem del voucher.
`voucher`	string	Código del voucher informado en la validación.
`flFreePass`	boolean	Indica si el voucher concede acceso gratuito.
`membershipValue`	number	Valor original del contrato antes de aplicar el descuento.
`discountKind`	int32	Tipo de descuento aplicado al contrato.
`discountValue`	number	Valor del descuento aplicado al contrato.
`finalMembershipValue`	number	Valor final del contrato tras aplicar el descuento.
`flSingleServiceDiscount`	boolean	Indica si el voucher tiene descuento para servicio único.
`singleServiceValue`	number	Valor original del servicio único.
`singleServiceDiscountKind`	int32	Tipo de descuento aplicado al servicio único.
`singleServiceDiscountValue`	number	Valor del descuento aplicado al servicio único.
`finalSingleServiceDiscountValue`	number	Valor final del servicio único tras aplicar el descuento.
`flRecurringDiscount`	boolean	Indica si el voucher tiene descuento recurrente.
`monthsRecurringDiscount`	int32	Número de meses en que se aplicará el descuento recurrente.
`flAnnuityDiscount`	boolean	Indica si el voucher tiene descuento en la anualidad.
`annuityValue`	number	Valor original de la anualidad.
`annuityDiscountKind`	int32	Tipo de descuento aplicado a la anualidad.
`annuityDiscountValue`	number	Valor del descuento aplicado a la anualidad.
`finalAnnuityValue`	number	Valor final de la anualidad tras aplicar el descuento.
`dayAnnuity`	int32	Día configurado para el cobro de la anualidad.
`monthAnnuity`	int32	Mes configurado para el cobro de la anualidad.
`finalValue`	number	Valor total final tras aplicar todos los descuentos del 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 cupón#

Descripción#

📨 Cuerpo de la Requisición (Request Body)#