--- updatedAt: 2026-09-08T22:06:49.000Z agentTools: projectIndex: https://developers.virtualincentives.com/llms.txt --- # Create Orders **Endpoint:** `https://rest.virtualincentives.com/{version}/{format}/orders` **Method:** `POST` # Definitions | Field | Type | Description | | ------------------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | programid | **required**
integer | The `programid` serves an identifier that determines the funding account and branding to use for this request. | | clientid | **required**
string(50) | 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. | | 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. | | shipping | object | This field is required only for bulk physical rewards. It contains the address which the courier will deliver the bulk order. | | shipping.company | string(100) | The name of your company. | | shipping.attention | string(100) | The name of the person within your organization who should receive the bulk package. | | shipping.address1 | string(100) | Courier address line 1. | | shipping.address2 | string(50) | Courier address line 2. | | shipping.city | string(50) | Courier city line. | | shipping.state | string(20) | Courier state abbreviation (ISO 3166-2, subdivision).. | | string.zip | string(50) | Courier zip code line. | | string.country | string(2) | Courier country abbreviation line (ISO 3166-2). | | email | string(200) | Account holder email address. Required for virtual rewards only.

**Note:** For anonymous rewards, please use a generic support email address, such as . | | 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. | | currency | **optional**
string(3) | The three-letter currency code that specifies the denomination of the requested amount (e.g., USD, EUR, GBP). | | 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) | User Defined field - pass unique identifiers here to link orders to your internal records (e.g., reward ID, respondent ID, employee ID). | | udf2 | string(100) | Additional User Defined field.

Pass a unique **Reload ID** here when creating or loading a Reloadable card or USD Cash Payout.

**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.

Required for Global Cash Payout orders; used to display the sender’s brand name throughout the redemption experience.

**Note:** See ‘udf1’ for definition. | | phone | **optional**
string(20) | Mobile phone number of the recipient. Used for SMS reward delivery. The number must be supplied as digits only.

**Note:** Required if reward delivery is SMS, or phone country is provided. | | phonecountry | **optional**
string(2) | Mobile phone number country of origin. This is the 2-character country code (ISO 3166-2).

**Note:** Required if reward delivery is SMS, or phone number is provided. | | w9eligible | **optional**
string(5) | Determines the W9 Eligibility of a reward for 1099 reporting. Options are **true** or **false**. | | w9id | **optional**
string(50) | The W9ID used for 1099 reporting.

**Note:** Required if w9eligible is **true**. | | identity | object | Account holder information used for identity verification.

**Note:** Required for the initial order of a Cash Payout API First product. Do not provide for reload orders. | | first\_name | string(50) | Legal first name of the account holder. This information must match what's on the account holder's government issued drivers license or ID card. | | last\_name | string(50) | Legal last name of the account holder. This information must match what's on the account holder's government issued drivers license or ID card. | | date\_of\_birth | string(10) | Account holder's date of birth.

**Format:** MM/DD/YYYY | | ssn\_last\_four | integer (4) | Last 4 digits of the account holder's social security number. | | bank | object | Account holder's checking account or debit card information in which payouts will be sent.

**Note:** Required for the initial order of a Cash Payout API First product. Do not provide for reload orders. | | type | string(12) | Type of payout destination. Options are **bank\_account** or **debit\_card**. | | account\_number | integer (14) | Account number associated with the account holder's checking account. | | routing\_number | integer (9) | Routing number associated with the account holder's checking account. | | card\_number | integer (16) | 16 digit card number associated with the account holder's debit card. | | expiration | integer (4) | 4 digit expiration associated with the account holder's debit card.

**Format:** MMYY | | cvv | integer (3) | 3 digit security code associated with the account holder's debit card. | | transfer\_note | string (255) | Custom note for the payout credit. Defaults to "Payout from \{Customer Name}" if no note is provided. | | payout\_note | string (255) | Custom note for the payout debit. Defaults to "Payment to Cardholder Account Ending \{1234}" if no note is provided. | | accepted\_partner\_terms | string (5) | Confirmation that the account holder has reviewed and agreed to the terms and conditions. Options are **true** or **false**.

**Note:** Required for the initial order of a Cash Payout API First product. Optional for reload orders. | | ip\_address | string (15) | Account holder's IP address. Must be IPV4 formatted and a public IP Address. Ex: "24.98.120.43"

**Note:** Required for the initial order of a Cash Payout API First product. Optional for reload orders. | | id | **response only**
integer | Unique Account Holder ID. | | number | **response only**
integer | Order number generated upon successful creation. | | status | **response only**
string(50) | Order status of the requested order. See [Appendix A](https://developers.virtualincentives.com/docs/appendices-1) for definitions. | | link | **response only**
string(250) | Redemption link returned upon successful account creation. | # Examples ## Reward Request XML - Virtual ```text 26002 REST v6 individual        Recipient Recipient sample@example.com UVC-V-V03 10.00      ``` ## Reward Response XML - Virtual ```text 26002 REST v6 individual 24693500 completed 261330 Recipient Recipient sample@example.com UVC-V-V03 USD 10.00 https://www2.virtualrewardcenter.com/landing?id=258155&sid=7EC30816-7B7E-0133-1E76- 12FC32977705 false ``` ## Reward Request JSON - Virtual ```text { "order": { "programid": "26002", "clientid": "REST v6", "fulfillment": "individual", "accounts": [ { "firstname": "Recipient", "lastname": "Recipient", "email": "sample@example.com", "sku": "UVC-V-V03", "amount": "10.00" } ] } } ``` ## Reward Response JSON - Virtual ```text { "order": { "programid": "26002", "clientid": "REST v6", "fulfillment": "individual", "number": "24693500", "status": "completed", "accounts": [ { "id": "261330", "firstname": "Recipient", "lastname": "Recipient", "email": "sample@example.com", "sku": "UVC-V-V03", "currency": "USD", "amount": "10.00", "link": "https://www2.virtualrewardcenter.com/landing?id=258155&sid=7EC30816-7B7E-0133-1E76-12FC32977705", "w9eligible": false } ] } } ``` ## Reward Request XML - Physical ```text  26002  56258126 individual         John    Doe    123 Any Street    Apt 212    Any City    NY    98625    US    UVC-P-V03    10.00        ``` ## Reward Response XML - Physical ```text 26002 56258126 individual 24693506 completed 261337 John Doe 123 Any Street Apt 212 Any City NY 98625 US UVC-P-V03 USD 10.00 ``` ## Reward Request JSON - Physical ```text { "order": { "programid": "26002", "clientid": "9749368", "fulfillment": "individual", "accounts": [ { "firstname": "Reward", "lastname": "Recipient", "sku": "UVC-P-V03", "amount": "10.00", "address1": "Any Address", "city": "Any City", "state": "NY", "zip": "98625", "country": "US" } ] } } ``` ## Reward Response JSON - Physical ```text { "Order":{ "Programid":"26002", "Clientid":"9749368", "Fulfillment":"individual", "Number":"24693508", "Status":"completed", "Accounts":[ { "Id":"261341", "firstname":"Reward", "lastname":"Recipient", "address1":"Any Address", "city":"Any City", "state":"NY", "Zip":"98625", "country":"US", "sku":"UVC-P-V03", "currency":"USD", "Amount":"10.00", "Link":"" } ] } } ``` ## Reward Request XML - Bulk Physical ```text 26002 REST v6 Bulk Sample Company Sample Attention 123 Any Street Apt 212 Any City NY 98625 US        Reward Recipient 123 Any Address Any City NY 98625 US UVC-P-V03 10.00      ``` ## Reward Response XML - Bulk Physical ```text 26002 REST v6 bulk Sample Company Sample Attention 123 Any Street Apt 212 Any City NY 98625 US 24693500 processing 261330 Reward Recipient 123 Any Address Any City NY 98625 US UVC-P-V03 USD 10.00 false ``` ## Reward Request JSON - Bulk Physical ```text { "order": { "programid": "26002", "clientid": "9749363", "fulfillment": "bulk", "shipping": { "company": "Sample Company", "attention": "Sample", "address1": "Any Address", "address2": "Apt 212", "city": "Any City", "state": "NY", "zip": "98625", "country": "US" }, "accounts": [ { "firstname": "Reward", "lastname": "Recipient", "sku": "UVC-P-V03", "amount": "10.00", "address1": "Any Address", "city": "Any City", "state": "NY", "zip": "98625", "country": "US" } ] } } ``` ## Reward Response JSON - Bulk Physical ```text { "Order":{ "Programid":"26002", "Clientid":"9749363", "Fulfillment":"bulk", "Shipping":{ "company":"Sample Company", "attention":"Sample", "address1":"Any Address", "address2":"Apt 212", "city":"Any City", "state":"NY", "Zip":"98625", "country":"US" }, "Number":"24693503", "Status":"processing", "Accounts":[ {"id":"261333", "firstname":"Reward", "lastname":"Recipient", "address1":"Any Address", "city":"Any City", "state":"NY", "Zip":"98625", "country":"US", "sku":"UVC-P-V03", "currency":"USD", "Amount":"10.00", "Link":"" } ] } } } ```