Redeem Voucher

JSON example

{ 
  "contactID": "003xx000004WjzAAAS",
  "action": "Reserve", 
  "reservationKey": "key1", 
  "reservedValue": 50.57, 
  "redeemAmount": 50.57, 
  "currencyIsoCode": "Yen" 
}

JSON example to redeem vouchers using contactId or accountID.

{
  "redemptionAmount": "12",
  "contactId": "003xx000004WkhEAAS",
  "accountId":"001xx000003H3NnAAK",
  "memberId": "0lMxx00000002HxEAI"
}

Provide contactId to redeem the voucher. If accountID is provided, then the associated contactId is fetched and the voucher is redeemed

Note

Properties

Name	Type	Description	Required or Optional	Available Version
contactID	String	ID of the contact associated with the account.	Optional	62.0
currencyIsoCode	String	Three-letter ISO 4217 currency code of the monetary currency in which the voucher is redeemed.	Optional	55.0
redeemAmount	Double	The value of the voucher to be redeemed. Specify a value when a member hasn't redeemed the full value of the voucher. This value is only applicable for vouchers issued using Fixed Value voucher definitions. A value isn't required when the member has redeemed the complete value of the voucher in a single transaction. If you don’t specify a value to be redeemed for the fixed-value voucher, the voucher status changes to Redeemed, and the remaining value becomes zero. Note	Optional	53.0
action	ReservationAction	Specify whether to redeem, reserve, or reinstate the voucher. The values for this property could be Reserve, Reinstate, or Redeem.	Required	62.0
reservedValue	Currency	Specify the amount reserved for partially redeemable vouchers.	Optional	62.0
reservationKey	String	Specify the key used to redeem or reinstate a reserved voucher.	Optional	62.0

This table lists HTTP response code descriptions that are unique to this resource.