---
updatedAt: 2026-09-08T22:17:57.000Z
agentTools:
  projectIndex: https://developers.virtualincentives.com/llms.txt
---

# Create Orders

**Endpoint:** `https://rest.virtualincentives.com/{version}/{format}/orders`

**Method:** `POST`

# Definitions

<Table>
  <thead>
    <tr>
      <th>
        Field
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        programid
      </td>

      <td>
        * \*required\*\*<br />integer
      </td>

      <td>
        The `programid` serves an identifier that determines the funding account and branding to use for this request.
      </td>
    </tr>

    <tr>
      <td>
        clientid
      </td>

      <td>
        * \*required (empty)\*\*<br />string(50)
      </td>

      <td>
        Client provided unique identifier for the request. This field also serves as a duplicate transaction check. After a successful transaction is placed using this identifier, all subsequent requests using the same identifier are rejected as duplicate orders.
      </td>
    </tr>

    <tr>
      <td>
        email
      </td>

      <td>
        * \*required\*\*<br />string(200)
      </td>

      <td>
        Account holder email address.<br /><br />**Note:** For anonymous rewards, please use a generic support email address, such as [support@virtualincentives.com](mailto:support@virtualincentives.com).
      </td>
    </tr>

    <tr>
      <td>
        firstname
      </td>

      <td>
        * \*required\*\*<br />string(50)
      </td>

      <td>
        Account holder first name. <br /><br />**Note:** This field is displayed in the email and VRC salutation. For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
      </td>
    </tr>

    <tr>
      <td>
        lastname
      </td>

      <td>
        * \*required\*\*<br />string(50)
      </td>

      <td>
        Account holder last name.<br /><br />**Note:** For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
      </td>
    </tr>

    <tr>
      <td>
        sku
      </td>

      <td>
        * \*required\*\*<br />string(50)
      </td>

      <td>
        Virtual prepaid product SKU requested.<br /><br />**Note:** SKU document delivered separately.
      </td>
    </tr>

    <tr>
      <td>
        amount
      </td>

      <td>
        * \*required\*\*<br />decimal
      </td>

      <td>
        The `amount` Denomination of the reward being issued.<br /><br />**Note:** Currency is determined by the SKU requested.
      </td>
    </tr>

    <tr>
      <td>
        address1
      </td>

      <td>
        string(100)
      </td>

      <td>
        Account holder address line 1.
      </td>
    </tr>

    <tr>
      <td>
        address2
      </td>

      <td>
        string(50)
      </td>

      <td>
        Account holder address line 2.
      </td>
    </tr>

    <tr>
      <td>
        city
      </td>

      <td>
        string(50)
      </td>

      <td>
        Account holder city.
      </td>
    </tr>

    <tr>
      <td>
        state
      </td>

      <td>
        string(20)
      </td>

      <td>
        Account holder state abbreviation (ISO 3166-2, subdivision).
      </td>
    </tr>

    <tr>
      <td>
        zip
      </td>

      <td>
        string(10)
      </td>

      <td>
        Account holder zip code.
      </td>
    </tr>

    <tr>
      <td>
        country
      </td>

      <td>
        string(2)
      </td>

      <td>
        Account holder country abbreviation (ISO 3166-2).
      </td>
    </tr>

    <tr>
      <td>
        udf1
      </td>

      <td>
        string(100)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf2
      </td>

      <td>
        string(100)
      </td>

      <td>
        Additional User Defined field.<br /><br />Pass a unique **Reload ID** here when creating or loading a Reloadable card or cash payout.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf3
      </td>

      <td>
        string(1000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf4
      </td>

      <td>
        string(1000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf5
      </td>

      <td>
        string(1000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf6
      </td>

      <td>
        string(4000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf7
      </td>

      <td>
        string(4000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf8
      </td>

      <td>
        string(4000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf9
      </td>

      <td>
        string(4000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        udf10
      </td>

      <td>
        string(4000)
      </td>

      <td>
        Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition.
      </td>
    </tr>

    <tr>
      <td>
        phone
      </td>

      <td>
        * \*optional\*\*<br />string(20)
      </td>

      <td>
        Mobile phone number of the recipient. Used for SMS reward delivery. The number must be supplied as digits only.<br /><br />**Note:** Required if reward delivery is SMS, or phone country is provided.
      </td>
    </tr>

    <tr>
      <td>
        phonecountry
      </td>

      <td>
        * \*optional\*\*<br />string(2)
      </td>

      <td>
        Mobile phone number country of origin. This is the 2-character country code (ISO 3166-2).<br /><br />**Note:** Required if reward delivery is SMS, or phone number is provided.
      </td>
    </tr>

    <tr>
      <td>
        w9eligible
      </td>

      <td>
        * \*optional\*\*<br />string(5)
      </td>

      <td>
        Determines the W9 Eligibility of a reward for 1099 reporting. Options are **true** or **false**.
      </td>
    </tr>

    <tr>
      <td>
        w9id
      </td>

      <td>
        * \*optional\*\*<br />string(50)
      </td>

      <td>
        The W9ID used for 1099 reporting.<br /><br />**Note:** Required if w9eligible is **true**.
      </td>
    </tr>

    <tr>
      <td>
        id
      </td>

      <td>
        * \*response only\*\*<br />integer
      </td>

      <td>
        Unique Account Holder ID.
      </td>
    </tr>

    <tr>
      <td>
        number
      </td>

      <td>
        * \*response only\*\*<br />integer
      </td>

      <td>
        Order number generated upon successful creation.
      </td>
    </tr>

    <tr>
      <td>
        status
      </td>

      <td>
        * \*response only\*\*<br />string(50)
      </td>

      <td>
        Order status of the requested order. See [Appendix A](https://developers.virtualincentives.com/docs/appendix-1)  for definitions.
      </td>
    </tr>

    <tr>
      <td>
        link
      </td>

      <td>
        * \*response only\*\*<br />string(250)
      </td>

      <td>
        Redemption link returned upon successful account creation.
      </td>
    </tr>
  </tbody>
</Table>

# Examples

## Single Reward Request XML

```text
<order> 
 <programid>26490</programid>
 <clientid>56258125</clientid>
 <accounts>
  <account>
  <firstname>John</firstname>
  <lastname>Doe</lastname>
  <email>john.doe@example.com</email>
  <sku>UVC-V-A06</sku>
  <amount>10.00</amount>
  </account>
 </accounts>
</order>
```

## Single Reward Response XML

```text
<order>
 <programid>26490</programid>
 <clientid>56258125</clientid>
 <number>24681234</number>
 <status>completed</status>
 <accounts>
  <account>
   <id>88523</id>
   <firstname>John</firstname>
   <lastname>Doe</lastname>
   <email>john.doe@example.com</email>
   <sku>UVC-V-A06</sku>
   <amount>10.00</amount>
   <link>
    https://www.virtualrewardcenter.com/
    Landing.aspx?id=88523&sid=093677BA-71FA-4137-B435-C17B1748E725
   </link>
  </account>
 </accounts>
</order>
```

## Single Reward Request JSON

```text
{
 "order": {
  "programid":"26490",
  "clientid":"56258125",
  "accounts":[
   {
   "firstname":"John",
   "lastname":"Doe",
   "email":"john.doe@example.com",
   "sku":"UVC-V-A06",
   "amount":"10.00"
   }
  ]
 }
}
```

## Single Reward Response JSON

```text
{
 "order":{
  "programid":"26490",
  "clientid":"56258125",
  "number":"24681234",
  "status":"completed",
  "accounts":[
   {
    "id":"85425",
    "firstname":"John",
    "lastname":"Doe",
    "email":"john.doe@example.com",
    "sku":"UVC-V-A06",
    "amount":"10.00",
    "link":"https://www.virtualrewardcenter.com/
     Landing.aspx?id=85425&sid=b173b47f-228c-4a97
     -8d68-e5835ca4ac66"
   }
  ]
 }
}
```

## Multiple Rewards Request XML

```text
<order> 
 <programid>26490</programid>
 <clientid>56258125</clientid>
 <accounts>
  <account>
   <firstname>John</firstname>
   <lastname>Doe</lastname>
   <email>john.doe@example.com</email>
   <address1>123 Any Street</address1>
   <address2>Apt 212</address2>
   <city>Any City</city>
   <state>NY</state>
   <zip>98625</zip>
   <country>US</country>
   <sku>UVC-V-A06</sku>
   <amount>10.00</amount>
  </account>
  <account>
   <firstname>Jane</firstname>
   <lastname>Doe</lastname>
   <email>jane.doe@example.com</email>
   <sku>UVC-V-A06</sku>
   <amount>25.00</amount>
  </account>
 </accounts>
</order>
```

## Multiple Rewards Response XML

```text
<order>
 <programid>26490</programid>
 <clientid>56258125</clientid>
 <number>24681234</number>
 <status>completed</status>
 <accounts>
  <account>
   <id>88523</id>
   <firstname>John</firstname>
   <lastname>Doe</lastname>
   <email>john.doe@example.com</email>
   <address1>123 Any Street</address1>
   <address2>Apt 212</address2>
   <city>Any City</city>
   <state>NY</state>
   <zip>98625</zip>
   <country>US</country>
   <sku>UVC-V-A06</sku>
   <amount>10.00</amount>
   <link>
    https://www.virtualrewardcenter.com/
    Landing.aspx?id=88523&sid=093677BA-71FA-4137-B435-C17B1748E725
   </link>
  </account>
  <account>
   <id>88523</id>
   <firstname>Jane</firstname>
   <lastname>Doe</lastname>
   <email>jane.doe@example.com</email>
   <sku>UVC-V-A06</sku>
   <amount>25.00</amount>
   <link>
    https://www.virtualrewardcenter.com/
    Landing.aspx?id=88523&sid=093677BA-71FA-4137-B435-C17B1748E725
   </link>
  </account>
 </accounts>
</order>
```

## Multiple Rewards Request JSON

```text
{
 "order": {
  "programid":"26490",
  "clientid":"56258125",
  "accounts":[
   {
    "firstname":"John",
    "lastname":"Doe",
    "email":"john.doe@example.com",
    "address1":"123 Any Street",
    "address2":"Apt 212",
    "city":"Any City",
    "state":"NY",
    "zip":"98625",
    "country":"US",
    "sku":"UVC-V-A06",
    "amount":"10.00",
    "udf1":"",
    "udf2":""
   },
   {
    "firstname":"Jane",
    "lastname":"Doe",
    "email":"jane.doe@example.com",
    "sku":"UVC-V-A06",
    "amount":"25.00",
    "udf1":"",
    "udf2":""
   }
  ]
 }
}
```

## Multiple Rewards Response JSON

```text
{
 "order":{
  "programid":"26490",
  "clientid":"56258125",
  "number":"24681234",
  "status":"completed",
  "accounts":[
   {
    "id":"85425",
    "firstname":"John",
    "lastname":"Doe",
    "email":"john.doe@example.com",
    "sku":"UVC-V-A06",
    "amount":"10.00",
    "link":"https://www.virtualrewardcenter.com/
     Landing.aspx?id=85425&sid=b173b47f-228c-4a97
     -8d68-e5835ca4ac66"
   }
   {
    "id":"85425",
    "firstname":"Jane",
    "lastname":"Doe",
    "email":"jane.doe@example.com",
    "sku":"UVC-V-A06",
    "amount":"10.00",
    "link":"https://www.virtualrewardcenter.com/
     Landing.aspx?id=85425&sid=b173b47f-228c-4a97
     -8d68-e5835ca4ac66"
   }
  ]
 }
}
```