Endpoints for creating, validating, retrieving, and cancelling reward vouchers for partner applications.
Cancels a reward voucher.
Cancels a reward voucher identified by the provided reference. If the voucher is already used or expired, cancellation will fail.
path Parameters
referenceThe unique reference identifier of the voucher to cancel.
Cancels a reward voucher. › Responses
Voucher was successfully cancelled.
Creates a new reward voucher.
Issues a new reward voucher for the specified consumer. The voucher remains active for 30 days and can only be used by the person who created it. If unused after 30 days, the points or cashback will be returned to the customer's balance.
Creates a new reward voucher. › Request Body
personalCodeloyaltyProgramTypecashValueCreates a new reward voucher. › Responses
Voucher was successfully created.
referencecashValueexpiredAtRetrieves a paginated list of active reward vouchers for a consumer.
Retrieves all active (unused and unexpired) reward vouchers for the specified consumer.
query Parameters
personalCodeThe unique personal code of the consumer.
OrderByPageThe page number to retrieve. Must be greater than 0. Defaults to 1.
The page number to retrieve. Must be greater than 0. Defaults to 1.
SizeThe number of items per page. Must be greater than 0. Defaults to 10.
The number of items per page. Must be greater than 0. Defaults to 10.
Retrieves a paginated list of active reward vouchers for a consumer. › Responses
A paginated list of active vouchers was returned.
Validates a reward voucher and returns its value.
Validates a reward voucher for a specific consumer and transaction amount. Ensures the voucher is active, belongs to the consumer, and is applicable for the transaction.
path Parameters
referenceThe unique reference identifier of the voucher to validate.
query Parameters
personalCodeThe personal code of the consumer attempting to use the voucher.
totalAmountThe total transaction amount for which the voucher is being validated. Must be greater than 0.
Validates a reward voucher and returns its value. › Responses
Voucher is valid and its value is returned.
referencecashValue