Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}

Method: GET

Definitions

Field	Type	Description
id	response only integer	Unique Account Holder ID.
email	required string(200)	Account holder email address. Note: For anonymous rewards, please use a generic support email address, such as [email protected].
firstname	required string(50)	Account holder first name. Note: This field is displayed in the email and VRC salutation. For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
lastname	required string(50)	Account holder last name. Note: For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
sku	required string(50)	Virtual prepaid product SKU requested. Note: SKU document delivered separately.
amount	required decimal	The `amount` Denomination of the reward being issued. Note: Currency is determined by the SKU requested.
address1	string(100)	Account holder address line 1.
address2	string(50)	Account holder address line 2.
city	string(50)	Account holder city.
state	string(20)	Account holder state abbreviation (ISO 3166-2, subdivision).
zip	string(10)	Account holder zip code.
country	string(2)	Account holder country abbreviation (ISO 3166-2).
udf1	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf2	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf3	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf4	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf5	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf6	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf7	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf8	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf9	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf10	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
link	response only string(250)	Redemption link returned upon successful account creation.

Examples

XML Example

<recipient>
  <id>258155</id>
  <firstname>Reward</firstname>
  <lastname>Recipient</lastname>
  <email>[email protected]</email>
  <address1>1401 rte 52</address1>
  <address2>suite 101B</address2>
  <city>Fishkill</city>
  <state>NY</state>
  <zip>12524</zip>
  <country>US</country>
  <sku>UVC-V-P18</sku>
  <amount>10.00</amount>
  <udf1>Sample</udf1>
  <link>https://www2.virtualrewardcenter.com/landing?id=258155&amp;sid=7EC30816-7B7E-0133-1E76-12FC32977705</link>
</recipient>

JSON Example

{"recipient":{

"Id":"258155",
"firstname":"Reward",
"lastname":"Recipient",
"email":"[email protected]",
"address1":"1401 rte 52",
"Address2":"suite 101B",
"city":"Fishkill",
"state":"NY",
"Zip":"12524",
"country":"US",
"sku":"UVC-V-P18",
"Amount":"10.00",
"udf1":"Sample",
"link":"https://www2.virtualrewardcenter.com/landing?id=258155&sid=7EC30816-7B7E-0133-1E76-12FC32977705"}}