Welcome‎ > ‎Version 3‎ > ‎Merchant Api‎ > ‎Data Structures‎ > ‎

Voucher

Data Structure holding voucher information for a merchant.

Fields:
Field Data Type Nulls Description
customerName
string
The name of the customer the voucher is for.
expirationDate
datetime Y
The expiration date of the voucher.  Null if the voucher has no expiration date.
merchantRedeemed
bool

Whether or not this voucher has been redeemed by the merchant.
offerHeadline string

The title of the offer that the voucher is for.
offerOptionId int
The offer option id the voucher is for.  Part of the primary key for redemption.
voucherCode string

The voucher's code.  Part of the primary key for redemption.
 voucherPinRequiredbool
 When the voucher pin is required for redeeming a consumer's voucher.
 

Sample JSON Response:
{
    "customerName": "Test Customer",
    "expirationDate": "/Date(1288210020000)/",
    "merchantRedeemed": false,
    "offerHeadline": "One Great Offer",
    "offerOptionId", 3283,
    "voucherCode": "F-136-07-B4B",
    "voucherPinRequired": true
}



Sample XML Response:
<voucher>
    <customerName>Test Customer</customerName>
    <expirationDate>2010-10-27T20:07:00Z</expirationDate>
    <merchantRedeemed>false</merchantRedeemed>
    <offerHeadline>One Great Offer</offerHeadline>
    <offerOptionId>3283</offerOptionId>
    <voucherCode>F-136-07-B4B</voucherCode>
    <
voucherPinRequired>true</voucherPinRequired>
</voucher>
Comments