Welcome‎ > ‎Version 3‎ > ‎Merchant Api‎ > ‎Methods‎ > ‎

Redeem Voucher

Redeems or unredeems a voucher for the merchant.

Method: PUT /api/v3/merchant/voucher

Authentication: oauth

Required Parameters:
voucherId - the id of the voucher to redeem or unredeem.
 
Form
Required Form Name Data Type Explanation
Yes
MerchantRedeemed bool True if redeeming the voucher, false if unredeeming it.
YesVoucherCode
string
The voucher code being redeemed.
Yes
OfferOptionId
int
The offer option id being redeemed.
NoVoucherPin
string
A pin may be required for the merchant to redeem the voucher.

Returns
base response fields


Sample Request:

PUT http://api.groupcommerce.com/api/v3/merchant/voucher/

FORM: MerchantRedeemed=True&VoucherCode=P-13380-1-9C4C5&OfferOptionId=12900


Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1323476030624)/",
    "success": true,
    "version": "3"
}


Sample XML Response:

<redeemVoucherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-12-22T23:49:45.0194041Z</lastPublished>
    <success>true</success>
    <version>3</version>
</
redeemVoucherResponse>
Comments