Cancel and Reissue
Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/reissue
Method: PUT
Definitions
| Field | Type | Description |
|---|---|---|
| fulfillment | required string(50) | Allowed values are bulk or individual. For virtual rewards: - bulk returns the reward link in the API response. - individual rewards are emailed directly to the recipient. For physical rewards: - bulk rewards are shipped via courier to a single address specified in the shipping object. - individual rewards are sent via USPS directly to the recipient. |
| 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 (virtual) string(50) | Account holder last name. Note: For anonymous rewards, please use a generic name such as “Participant” or “Recipient”. |
| required (virtual) string(200) | Account holder email address. Note: For anonymous rewards, please use a generic support email address, such as [email protected]. | |
| address1 | required (physical) string(100) | Account holder address line 1. |
| address2 | required (physical) string(50) | Account holder address line 2. |
| city | required (physical) string(50) | Account holder city. |
| state | required (physical) string(20) | Account holder state abbreviation (ISO 3166-2, subdivision). |
| zip | required (physical) string(10) | Account holder zip code. |
| country | required (physical) string(2) | Account holder country abbreviation (ISO 3166-2). |
| order | response only object | The order object for the reissued recipient. For definitions, see Create Orders. |
| events | response only object | A list of all the events related to this action. For definitions, see Get Recipient Events. |
Examples
Request XML (Virtual)
<recipient>
<note>Test</note>
<reissue>
<fulfillment>individual</fulfillment>
<firstname>Reward</firstname>
<lastname>Recipient</lastname>
<email>[email protected]</email>
</reissue>
</recipient>
Request JSON (Virtual)
{
"recipient": {
"note":"Test",
"reissue": {
fulfillment: "individual",
firstname: "Reward",
lastname: "Recipient",
email: "[email protected]"
}
}
}
Request XML (Physical)
<recipient>
<note>Test</note>
<reissue>
<fulfillment>individual</fulfillment>
<address1>1401 Rt 52</address1>
<address2>Suite 101</address2>
<city>Fishkill</city>
<state>NY</state>
<zip>12524</zip>
<country>US</country>
</reissue>
</recipient>
Request JSON (Physical)
{
"recipient": {
"note":"Test",
"reissue": {
fulfillment: "individual",
address1: "1401 Rt 52",
address2: "Suite 101",
city: "Fishkill",
state: "NY",
zip: "12524",
country: "US"
}
}
}
Response XML (Virtual)
<recipient>
<id>263850</id>
<events>
<event>
<id>566808</id>
<date>03/30/2021 10:20</date>
<name>Reward Canceled</name>
<note>Test</note>
</event>
<event>
<id>566809</id>
<date>03/30/2021 10:20</date>
<name>Credit Applied</name>
<note>$100.00</note>
</event>
<event>
<id>566812</id>
<date>03/30/2021 10:20</date>
<name>Reissued Reward</name>
</event>
<event>
<id>566810</id>
<date>03/30/2021 10:20</date>
<name>Cancel & Reissue Fee</name>
<note>($7.95)</note>
</event>
</events>
<note>Test</note>
<reissue>
<fulfillment>individual</fulfillment>
<firstname>Reward</firstname>
<lastname>Recipient</lastname>
<email>[email protected]</email>
<order>
<programid>27155</programid>
<clientid />
<fulfillment>individual</fulfillment>
<number>24695925</number>
<status>processing</status>
<accounts>
<account>
<id>263851</id>
<firstname>Reward</firstname>
<lastname>Recipient</lastname>
<email>[email protected]</email>
<sku>UVC-V-V03</sku>
<currency>USD</currency>
<amount>100.00</amount>
<link>https://www2.virtualrewardcenter.com/landing?id=263851&sid=E39B3B24-0DFD-3D0D-FE25-5732042330CA</link>
</account>
</accounts>
</order>
</reissue>
</recipient>
Response JSON (Virtual)
{
"recipient": {
"note": "Test",
"reissue": {
"fulfillment": "individual",
"firstname": "Reward",
"lastname": "Recipient",
"email": "[email protected]",
"order": {
"programid": "27155",
"clientid": "",
"fulfillment": "individual",
"number": "24695933",
"status": "processing",
"accounts": [
{
"id": "263859",
"firstname": "Reward",
"lastname": "Recipient",
"email": "[email protected]",
"sku": "UVC-V-V03",
"currency": "USD",
"amount": "100.00",
"link": "https://www2.virtualrewardcenter.com/landing?id=263859&sid=052C2308-453A-7ED5-90DD-09643EDB74A1"
}
]
}
},
"id": "263858",
"events": [
{
"id": "566853",
"date": "03/31/2021 16:17",
"name": "Reward Canceled",
"note": "Test"
},
{
"id": "566854",
"date": "03/31/2021 16:17",
"name": "Credit Applied",
"note": "$100.00"
},
{
"id": "566857",
"date": "03/31/2021 16:17",
"name": "Reissued Reward"
},
{
"id": "566855",
"date": "03/31/2021 16:17",
"name": "Cancel & Reissue Fee",
"note": "($7.95)"
}
]
}
}
Response XML (Physical)
<recipient>
<id>263852</id>
<events>
<event>
<id>566817</id>
<date>03/30/2021 10:26</date>
<name>Reward Canceled</name>
<note>Test</note>
</event>
<event>
<id>566818</id>
<date>03/30/2021 10:26</date>
<name>Credit Applied</name>
<note>$100.00</note>
</event>
<event>
<id>566821</id>
<date>03/30/2021 10:26</date>
<name>Reissued Reward</name>
</event>
<event>
<id>566819</id>
<date>03/30/2021 10:26</date>
<name>Cancel & Reissue Fee</name>
<note>($7.95)</note>
</event>
</events>
<note>Test</note>
<reissue>
<fulfillment>individual</fulfillment>
<address1>1401 Rt 52</address1>
<address2>Suite 101</address2>
<city>Fishkill</city>
<state>NY</state>
<zip>12524</zip>
<country>US</country>
<order>
<programid>26002</programid>
<clientid />
<fulfillment>individual</fulfillment>
<number>24695927</number>
<status>processing</status>
<accounts>
<account>
<id>263853</id>
<firstname>Reward</firstname>
<lastname>Recipient</lastname>
<email>[email protected]</email>
<sku>UVC-P-V03</sku>
<currency>USD</currency>
<amount>100.00</amount>
<link></link>
</account>
</accounts>
</order>
</reissue>
</recipient>
Response JSON (Physical)
{
"recipient": {
"note": "Test",
"reissue": {
"fulfillment": "individual",
"address1": "1401 Rt 52",
"address2": "Suite 101",
"city": "Fishkill",
"state": "NY",
"zip": "12524",
"country": "US",
"order": {
"programid": "26002",
"clientid": "",
"fulfillment": "individual",
"number": "24695935",
"status": "processing",
"accounts": [
{
"id": "263861",
"firstname": "Reward",
"lastname": "Recipient",
"email": "[email protected]",
"sku": "UVC-P-V03",
"currency": "USD",
"amount": "100.00",
"link": ""
}
]
}
},
"id": "263860",
"events": [
{
"id": "566862",
"date": "03/31/2021 16:30",
"name": "Reward Canceled",
"note": "Test"
},
{
"id": "566863",
"date": "03/31/2021 16:30",
"name": "Credit Applied",
"note": "$100.00"
},
{
"id": "566866",
"date": "03/31/2021 16:30",
"name": "Reissued Reward"
},
{
"id": "566864",
"date": "03/31/2021 16:30",
"name": "Cancel & Reissue Fee",
"note": "($7.95)"
}
]
}
}
Updated over 3 years ago