Validate Voucher

Description

Allows validating a provided voucher, returning the validity status of the voucher in the system.

📨 Request Body

Parameter	Type	Required	Description
`voucher`	string	Yes	Code of the voucher to be validated.
`idMembership`	int32	Yes	ID of the associated contract.
`idService`	int32	No	ID of the associated service.
`idBranch`	int32	Yes	ID of the branch.

📤 Response Structure

The response returns the information of the validated voucher, including applicable discount data for contract, single service, recurring, and annual fee.

Field	Type	Description
`idVoucher`	int32	Identifier of the voucher in the system.
`idVoucherItem`	int32	Identifier of the voucher item.
`voucher`	string	Code of the voucher provided for validation.
`flFreePass`	boolean	Indicates if the voucher grants free access.
`membershipValue`	number	Original value of the contract before applying the discount.
`discountKind`	int32	Type of discount applied to the contract.
`discountValue`	number	Value of the discount applied to the contract.
`finalMembershipValue`	number	Final value of the contract after applying the discount.
`flSingleServiceDiscount`	boolean	Indicates if the voucher has a discount for single service.
`singleServiceValue`	number	Original value of the single service.
`singleServiceDiscountKind`	int32	Type of discount applied to the single service.
`singleServiceDiscountValue`	number	Value of the discount applied to the single service.
`finalSingleServiceDiscountValue`	number	Final value of the single service after applying the discount.
`flRecurringDiscount`	boolean	Indicates if the voucher has a recurring discount.
`monthsRecurringDiscount`	int32	Number of months in which the recurring discount will be applied.
`flAnnuityDiscount`	boolean	Indicates if the voucher has a discount on the annual fee.
`annuityValue`	number	Original value of the annual fee.
`annuityDiscountKind`	int32	Type of discount applied to the annual fee.
`annuityDiscountValue`	number	Value of the discount applied to the annual fee.
`finalAnnuityValue`	number	Final value of the annual fee after applying the discount.
`dayAnnuity`	int32	Day configured for charging the annual fee.
`monthAnnuity`	int32	Month configured for charging the annual fee.
`finalValue`	number	Final total value after applying all discounts of the voucher.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Body Params

application/json-patch+json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "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

Validate Voucher#

Description#

📨 Request Body#