| Section | Description |
|---|---|
| 1 | Any fields containing commas should be surrounded by quotes as in “Smith, Jr.”, “340 E 59th St, Apt 301”, or “Thanks John, for all the hard work”. The only fields that can contain commas are First_name, Last_name, Address_1, Address_2, City, Message, Subject, Valediction and Title. |
| 2 | For bulk shipments of physical cards for the first record of the order, the First Name, Last Name, Address 1, Address 2, City, State and Zip fields belong to the person that the bulk shipment of cards are mailed to. Subsequent records for the order should have the First Name, Last Name, Address 1, Address 2, City, State and Zip fields that belong to the person that the bulk shipment of cards should be mailed to. This means, for example, that an order for 5 bulk cards should have 6 records, one for the person who receives the package of bulk cards, and 5 for the recipients of the bulk cards. If possible, the address in the 5 subsequent records should be the actual address of the recipient. If not, it needs to be the address of the person who receives the bulk order. In this case, the end recipient will not be able to use the physical card for online purchases as his or her address will not match the address associated with the card. In the same vein, it is possible to submit a name such as “Thank you” or “Congratulations”, in which case the user will not be able to make online purchases, as their name will not match the name on the card. |
| 3 | Message, Subject, Sender, Title and Valediction are used only for individual shipment of virtual cards that Virtual Incentives delivers. If the client wishes to deliver virtual cards, the client should submit a bulk order for virtual cards. The redemption codes and redemption URLs will appear in the response file for the order. |
| 4 | SKUs and order type fields are case sensitive. |
| 5 | Reloadable Notes: For reloadable cards, the item_id and unique_identifier fields are key to properly creating and subsequently adding additional funds to the card. For an initial load, provide an item_id field and a unique_identifier. As the item_id should correspond to your order id and the unique_identifier should correspond to the recipient, this unique_identifier should be submitted again for subsequent loadings of the card, with a different item_id, which indicates that the card should be reloaded. For example, for an initial load of a card, an example record would be: 1234,123,individual-shipment, URV-P-024,,1,100,,Bob,Williams,address 1,,New York,NY,10011,,,,, In the above example the card is created and mailed to the recipient with a balance of $100. 123 uniquely identifies the recipient in our database. To reload this same card, the example record would be: 1235,123,individual-shipment, URV-P-024,,1,200,,,,,,,,,,,,, In the above example, the card created in the first example has an additional $200 added to the balance of the card. 1235, the item_id is different than in the first example, as this is a new order from our perspective, but 123, the unique_identifier for the recipient is the same as in the first order, as we are applying the $200 to an existing card. If the same item_id and unique_identifier are supplied in two different records, either in the same file or in separate files, the second order will be rejected as an error. The fields first_name, last_name, address_1, address_2, city, state,zip and country are only required for the initial load of a card. For subsequent loadings of a card these fields are not required. Any of these fields that are provided for subsequent loads will be ignored. |
Example 1
In this example, the client has ordered five $10 Home Depot cards to be mailed to the recipients.
1234,123,individual-shipment, HOM-P-010,,1,10,,Bob,Williams,,address 1,,New York,NY,10011,,,,,
1234,124,individual-shipment, HOM-P-010,,1,10,,John,Doe,,address 1,,New York,NY,10011,,,,,
1234,125,individual-shipment, HOM-P-010,,1,10,,Peter,”Smith, Jr.”,,address 1,,New York,NY,10011,,,,,
1234,126,individual-shipment, HOM-P-010,,1,10,,Mary,Silver,,address 1,,NewarkY,NJ,10011,,,,,
1234,127,individual-shipment, HOM-P-010,,1,10,,Bob,Marley,,address 1,,New York,NY,10011,,,,,
No message field is permitted because only open loop SKUs can have a message. The email field is blank because Virtual Incentives is mailing these cards to the client. The last name field in record three is enclosed in double quotes because the field value contains a comma. Item_price is omitted because this is for a closed loop product with a defined denomination.
Example 2
In this example, the client has ordered five $10 Home Depot cards to be mailed to the client in one package.
1235,128,bulk-shipment,HOM-P-010,,5,,,Bob,Smith,,client address 1,,New York,NY,10011,,,,,
1235,123, bulk-shipment,HOM-P-010,,1,10,,Bob,Williams,,recipient address 1,,New York,NY,10011,,,,,
1235,124, bulk-shipment, HOM-P-010,,1,10,,John,Doe,,recipient address 1,,New York,NY,10011,,,,,
1235,125, bulk-shipment, HOM-P-010,,1,10,,Peter,”Smith, Jr.”,, address 1,,New York,NY,10011,,,,,
1235,126, bulk-shipment, HOM-P-010,,1,10,,Mary,Silver,,address 1, address 2,NewarkY,NJ,10011,,,,,
1235,127, bulk-shipment, HOM-P-010,,1,10,,Bob,Marley,,address 1,,New York,NY,10011,,,,,
Here, unlike example 1, an additional record is needed to indicate where the bulk package of the card should be mailed. The recipients have bulk-shipment as their order_type field because they are part of a bulk shipment. The quantity field in record one is 5, indicating that 5 records will immediately follow with the recipient’s name and address information. Email is not required because a package of 5 cards will be delivered to the client’s address, specified in the first order record. Item_price is omitted because this is for a closed loop product with a defined denomination.
Example 3
In this example, the client has ordered five $100 Virtual Visa cards to be fulfilled by Virtual Incentives.
1236,129,individual-shipment,VV1-V-000,,1,100,email1,Mike,Smith,,,,,,,,Merry Christmas,A gift for you from XYZ company,,,
1236,130,individual-shipment, VV1-V-000,,1,100,email2,Bill,White,,,,,,,Merry Christmas,A gift for you from XYZ company,,,
1236,131,individual-shipment, VV1-V-000,,1,100,email3,Izzy,Pop,,,,,,,Merry Christmas,A gift for you from XYZ company,,,
1236,132,individual-shipment, VV1-V-000,,1,100,email4,Greg,Johnson,,,,,,,Merry Christmas,A gift for you from XYZ company,,,
1236,133,individual-shipment, VV1-V-000,,1,100,email5,Al,Smith,,,,,,,Merry Christmas,A gift for you from XYZ company,,,
Even though the message, subject, and sender must be the same for all records for a particular order, they still must be included in each record. In this case, item_piece is populated because open loop SKUs do not have a defined denomination.
Example 4
In this example, the client has ordered five $100 Virtual Visa cards in a bulk format, so that the redemption codes and redemption URLs are made available to the client by Virtual Incentives in the response file.
1237,134,bulk-shipment, VV1-V-000,,5,100,,,,,,,,,,,,,
Example 5
In this example, the client has ordered five $100 Physical Visa cards with the recipient names on the cards to be mailed to the client in bulk.
1238,135,bulk-shipment,P29-V-000,,5,100,,Bob,Smith,,client address 1,,New York,NY,10011,Great Job This Year,,,,
1238,140,bulk-shipment,P29-V-000,,1,100,,Tom,Smith,,recipient address 1,,recipient city 1,recipient 1 state,recipient 1 zip,Great Job This Year,,,,
1238,141,bulk-shipment,P29-V-000,,1,100,,Bob,Hammer,,recipient address 2,,recipient city 2,recipient 2 state,recipient 2 zip,Great Job This Year,,,,
1238,142,bulk-shipment,P29-V-000,,1,100,,Steve,Carlton,,recipient address 3,,recipient city 3,recipient 3 state,recipient 3 zip,Great Job This Year,,,,
1238,143,bulk-shipment,P29-V-000,,1,100,,Lary,Bird,,recipient address 4,,recipient city 4,recipient 4 state,recipient 4 zip,Great Job This Year,,,,
1238,144,bulk-shipment,P29-V-000,1,100,,Mary,Hand,,recipient address 5,,recipient city 5,recipient 5 state,recipient 5 zip,Great Job This Year,,,,
The message field is populated by a 17 character or less value to be embossed on the bottom of all five cards. This field is optional for this order. The name and address information for the first record is where the cards are mailed in one package. The subsequent five records have the name and address information for each of the recipients. Thus, this order for five bulk delivery physical cards has 6 records. The recipients have bulk-shipment as their order_type field because they are part of a bulk shipment. The quantity field in record one is 5, indicating that five records will immediately follow with the recipients name and address information. The item_id field for this order is the same, which links them all together. The first record in such an order must be the record which contains the name and address of the recipient of the bulk package of cards.
Example 6
In this example, the client has ordered five $100 Physical Visa cards to be mailed to the recipients.
1239,136,individual-shipment, P29-V-000,,1,100,,Bob,Williams,,address 1,,New York,NY,10011,Merry Christmas,,,,
1239,137,individual-shipment, P29-V-000,,1,100,,John,Doe,,address 1,address 2,New York,NY,10011, Merry Christmas,,,,
1239,138,individual-shipment, P29-V-000,,1,100,,Peter,”Smith, Jr.”,,address 1,,New York,NY,10011, Merry Christmas,,,,
1239,139,individual-shipment, P29-V-000,,1,100,,Mary,Silver,,address 1,address 2,New York,NY,10011, Merry Christmas,,,,
1239,140,individual-shipment, P29-V-000,,1,100,,Pink,Floyd,,address 1,,New York,NY,10011,Merry Christmas,,,,
No email address is present because these cards will be mailed individually by Virtual Incentives.
Example 7
In this example, the client has ordered five $100 Physical Visa cards with the recipient names on the cards to be mailed to the client in bulk. In this case the client does not want the recipient’s name to be on the card and does not have an address for the recipient. The client wants “Thank You” to appear on the card.
1238,135,bulk-shipment,P29-V-000,,5,100,,Bob,Smith,,client address 1,,New York,NY,10011,,,,,
1238,140,bulk-shipment,P29-V-000,,1,100,,Thank,You,, client address 1,,New York,NY,10011,,,,,
1238,141,bulk-shipment,P29-V-000,,1,100,,Thank,You,, client address 1,,New York,NY,10011,,,,,
1238,142,bulk-shipment,P29-V-000,,1,100,,Thank,You,, client address 1,,New York,NY,10011,,,,,
1238,143,bulk-shipment,P29-V-000,,1,100,,Thank,You,, client address 1,,New York,NY,10011,,,,,
1238,144,bulk-shipment,P29-V-000,,1,100,,Thank,You,, client address 1,,New York,NY,10011,,,,,
The name and address information for the first record is where the cards should be mailed in one package. The subsequent five records have the address information for the client because the client does not have an address for the recipients. The name of each recipient that will appear on the card is “Thank You”. This order for five bulk delivery physical cards has six records. The recipients have bulk-shipment as their order_type field because they are part of a bulk shipment. The quantity field in record one is 5, indicating that 5 records will immediately follow with the recipient’s name and address information. The item_id field for this order is the same, which links them all together.