Extend User Defined Card Bin Ranges in POSitouch
- Last updated
- Save as PDF
Description: Learn to use the USERCARD.DAT and USERDEFC.DAT files to extend user defined card bin ranges beyond what the Backoffice supports in POSitouch.
Purpose
This article describes two methods for extending the User Defined Cards section of POSitouch beyond what's available in the Backoffice.
The two files that allow for expanded User Defined Cards are USERCARD.DAT and USERDEFC.DAT. Choose the file that best fits your site's needs:
USERCARD.DATis limited to 500 entries and requires settings to be configured in the Backoffice first. This file is primarily for extending the bin ranges linked to a single card. The Backoffice allows for up to eight user defined bin ranges, so if you only need additional bin ranges, this file may be sufficient.USERDEFC.DATallows an unlimited number of entries and lets you set additional flag settings through the CSV file.
USERCARD.DAT
Important: This file requires SPCWIN 5.34 dated 12/10/08 or later.
USERCARD.DAT is a comma-separated value file used by SPCWIN to expand bin ranges in the user defined cards (Backoffice Setup > Credit Cards > User Defined Credit Cards) of the Backoffice setup.
Note: USERCARD.DAT expands the bin ranges of currently defined card types — it doesn't create new card types. The card type must already be listed in the Backoffice setup with at least one bin range. USERCARD.DAT then expands the available bin ranges for that card type and links those ranges to the corresponding entry in the Backoffice user defined cards. The file can contain up to 500 entries.
To expand the list of available bin ranges for a card, enter the beginning and ending numbers of the card ranges, excluding the initial six numbers of the card as listed in the Backoffice user defined cards. You can include multiple bin ranges for each user defined card type in the USERCARD.DAT file
In the following example, two types of user defined cards exist: House Card and BOG Card. Both cards begin with 603571, but each is linked to a different payment type.
In the sample data, the first number in a row links the bin ranges (the second and third positions in the row) to the correct user defined bin range in the Backoffice setup.
In the sample row 2,2222222222111,2222222222222, the number 2 links the BOG Card to an additional bin range of 2222222222111–2222222222222. Any card between 603571-2222222222111 and 603571-2222222222222 is assigned to the BOG Card payment type.
In the sample row 1,2222222222226,2222222222227, any card between 603571-2222222222226 and 603571-2222222222227 links to card type #1, House Card.
USERCARD.DAT File Format
Sample data:
2,2222222222111,2222222222222 1,2222222222226,2222222222227
| Field | Description |
|---|---|
| 1 | User defined card number (links to the list in the Backoffice setup) |
| 2 | Beginning bin range number (numbers after the initial six digits) |
| 3 | Ending bin range number (numbers after the initial six digits) |
Note: Field 1 doesn't need to be in numerical order.
USERDEFC.DAT
Important: This file requires SPCWIN 5.36.2/6.36.2 and up, dated 08/2011 or later.
USERDEFC.DAT allows an unlimited number of user defined cards to link back to a single User Defined Card type in the Backoffice User Defined Card section of POSitouch. The file resides in the \SC folder where SPCWIN runs from. The file format is a CSV file with an unlimited number of rows.
Each row follows a specific format tied to the options found in the User Defined Cards section of the Backoffice. In the Backoffice, the user defined card type acts as a template for the entries in the CSV file. Settings in the Backoffice — such as No Check Expiration Date or card length — carry over to the cards defined in the CSV file
File Formatting Notes
- The credit card type and all other settings from the Backoffice Credit Card Types screen come from the user defined card template in the Backoffice. The first field of each line in the CSV file links the entry to the Backoffice setup. For example, if the first field in a record is 3, that record links to the third card type in User Defined Cards of the Backoffice.
- Fields b and c (bin range start and end numbers) can have any number of digits, but both fields must contain the same number of digits.
- Fields d through q have the same meanings as the corresponding options in the User Defined Cards section of the Backoffice. For example, No Check Expiration Date in the CSV file matches the same option in the Backoffice.
- Fields k through q are flag settings related to the Backoffice's User Defined Cards section. Valid values are 1 for yes/true, 0 for no/false, or * (see item 5).
- Fields d through q may contain an asterisk (*). If an asterisk is present, the system uses the settings from the Backoffice User Defined Cards section instead. Field a links the record to the card template in the Backoffice.
- You can omit fields d through q if you want all remaining fields populated with an asterisk. The system then uses the card template in field a to determine the card's settings.
- For example,
a,b,c,d,e,f,*,*,*,*,*,*,*,*,*,*,*can be shortened toa,b,c,d,e,f.
- For example,
- The card template in field a determines the card's settings.
- SPCWIN validates a card entered in the front of the house in the following order:
- By the User Defined Card setup in the Backoffice
- By USERDEFC.DAT
- By standard credit card bin ranges in POSitouch (Visa, Mastercard, Amex, Discover, and so on)
File Format
File name: USERDEFC.DAT
Each row uses the following fields:
a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q
| Field | Description |
|---|---|
| a | Row number from the User Defined Card setup |
| b | Bin range start number (any number of digits) |
| c | Bin range end number (any number of digits — start and end numbers should have the same number of digits) |
| d | Number of digits (0 = not restricted) |
| e | Media type |
| f | Extended bin range start |
| g | Extended bin range end |
| h | Extended bin range position |
| i | Trk1 character |
| j | Loyalty payment type number |
| k | Flag: check digits |
| l | Flag: no check expiration date |
| m | Flag: allow manual |
| n | Flag: no gift card increment |
| o | Flag: card exchange |
| p | Flag: redeem only |
| q | Flag: remote only |
Examples
In the Backoffice, a Givex range is set up with a starting and ending bin range of 000000 and 000000. The other options (No Chk Exp Date and related settings) are also set. This entry forms the basis for a template.
Additional settings found under More Flags are also configured.
Settings are also completed under the Setup Credit Card Types screen.
Building the CSV File Record
- To define a card range for a 15-digit card beginning and ending with 6010, the CSV file record starts with the following fields. These fields cover cards 601000000000000 through 601099999999999. Fields:
a,b,c,d
3,6010,6010,15
- To define a bin range of an undefined number of digits for cards starting with 54321024 through 54321587, and to set various flags for that bin range: Fields:
a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q
3,54321024,54321587,*,21,0,0,0,*,3,0,1,1,0,0,1,0