redeem(programName, membershipNumber, voucherCode, 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

53.0

Requires Chatter

Yes

Signature

public static ConnectApi.RedeemVoucherOutput redeem(String programName, String membershipNumber, String voucherCode, 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

amount
Type: ConnectApi.RedeemVoucherInput
The value of the voucher to be redeemed.

Return Value

Type: ConnectApi.RedeemVoucherOutput

Example


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