`redeem(programName, membershipNumber, voucherCode, voucherNumber, amount)`

Redeem partial value of a voucher for a program member. The status of the voucher gets updated to redeemed and the use date gets updated to the current date.

API Version

55.0

Requires Chatter

Signature

public static ConnectApi.RedeemVoucherOutput redeem(String programName, String membershipNumber, String voucherCode, String voucherNumber, ConnectApi.RedeemVoucherInput amount)

Parameters

programName

Type: String

The loyalty program name.

membershipNumber

Type: String

The loyalty program membership number.

voucherCode

Type: String

The voucher code to redeem.

The voucher definition associated with the voucher code must be active to redeem the voucher.

Note

voucherNumber

Type: String

The auto-generated voucher number.

amount

Type: ConnectApi.RedeemVoucherInput

The value of the voucher to be redeemed.

Return Value

Type: ConnectApi.RedeemVoucherOutput

Example

1public class TestRedeemVoucher {
2     ConnectApi.RedeemVoucherInput redeemInput = new ConnectApi.RedeemVoucherInput(); 
3     redeemInput.redeemAmount = 10.2;
4     ConnectApi.RedeemVoucherOutput output = ConnectApi.LoyaltyVoucherConnect.redeem('DemoProgram', 'M1234', 'VC001', '00000006', redeemInput);
5}