Vehicles are one of the key objects to manage with the PayByPhone Business Account.
With the roles of Account Owner, Business Manager, or Business Admin, you have the ability to create Vehicle Profiles in two ways:
- Single Business Vehicle Profile creation using the “add vehicle” modal
- Bulk Vehicle Profile creation using file upload.
Table of Contents:
Uploading Vehicle information into your PayByPhone Business Account.
Step 1 - Navigate to the Vehicle menu.
Step 2 - Click on the Upload Button
Step 3 - Follow the steps on the upload dialog
Step 4 - Confirmation
FAQ - Examples of template file for upload
FAQ - Vehicle Upload Error List
If a row has an error in any field, that row will not be uploaded and no vehicle profile will be created for that row of data.
Details about Countries, States, Provinces and Plate numbers.
ISO 3166-1 alpha-2 country codes:
ISO 3166-2:CA Province Codes
ISO 3166-2:US State Codes
The process requires a few steps to complete:
Step 1 - Navigate to the Vehicle menu.
Select Vehicles from the menu to the left.
Step 2 - Click on the Upload Button
Click the Upload button at the top of the screen.
This will open the upload dialogue box.
Step 3 - Follow the steps on the upload dialog
- Click the Download this document text at the top of the screen.
- Add your vehicle details (check that the data format is correct using the details of ISO-3166 at the end of this document).
- License Plate (US), Immatriculation (FR), or Number Plate (UK) [required]
- Only alphanumeric characters will be stored, all other characters will be removed.
- Country Code: ISO-3166-1 alpha-2. [required]
- Example: FR: France, UK: United Kingdom, CH: Switzerland
- State or Province: Use ISO 3166-2: CA or ISO 3166-2: US format [required]
- Example WA: Washington State, NY: New York State
- Example: QC: Province of Quebec.
- Vehicle Identification Number (VIN) [optional]
- If any values are entered but do not meet the requirements the bulk vehicle upload will fail.
- Requirement: VIN is exactly 17-characters.
- Requirement: When alphabetic characters are used in VIN the letters A to H or J to N or P or R to Z are accepted. The VIN may not contain letters “I”, “O” or “Q”.
- Requirement: Valid numeric characters are 0,1,2,3,4,5,6,7,8,9.
- Requirement: Alphabetic numbers can be accepted as upper and lowercase letters, but they will be stored as UPPER CASE in the system.
- Save the template as a *.csv file. (comma-separated values)
- Click on “Upload” to upload the CSV file that you have saved.
Step 4 - Confirmation
The Vehicle Profiles are validated before displayed in the Vehicles section of the PayByPhone Business Portal.
If there are any errors with the data upload process, a message will be provided to the user. Please check to ensure that no error messages are sent and confirm that the file was uploaded correctly
FAQ - Examples of template file for upload
TEMPLATE 1: Vehicle upload template for CA or US business clients:
License Plate Number (required) |
Country ISO-3166 alpha-2 (required) |
State ISO 3166-2:US Province ISO 3166-2:CA (required) |
VIN [Vehicle Identification Number ISO-3779] (Optional) |
TEMPLATE 2: Vehicle upload template for All other business clients
Number Plate / Registration Plate / Plaques d’Immatriculation (required) |
Country ISO-3166 alpha-2 (required) |
VIN [Vehicle Identification Number ISO-3779] (Optional) |
FAQ - Vehicle Upload Error List
If a row has an error in any field, that row will not be uploaded and no vehicle profile will be created for that row of data.
- If the file that you have uploaded has errors. You will receive an error message that describes the row with the errors and error type.
- Once the errors are corrected, that row of data can be uploaded, or the Vehicle Profile can be created using the “Add Vehicle” Button
- If a row of data includes matching vehicle information of an existing Vehicle Profile, the uploaded data will overwrite the data in the existing Vehicle Profile.
- A common error for vehicle file upload occurs when a file is edited in a text editor (not an Excel or Google Sheets spreadsheet program.
- The vehicle identification number (VIN) column is optional. If data is entered into the field it must match the format of a VIN number, or there will be an error on upload.
Details about Countries, States, Provinces and Plate numbers.
If the country of your Business Account is set to US (United States of America):
- THEN Vehicles could have a US country code + any valid ISO 3166-2:US state code
- THEN Vehicles could have a CA country code + any valid ISO 3166-2:CA Province code
- If any rows of vehicle data in the file uploaded have a vehicle country code that is not CA or US, the row of data will be considered to be an error and will be rejected.
If the country of your Business Account is set to CA (Canada):
- THEN Vehicles could have a US country code + any valid ISO 3166-2:US state code
- THEN Vehicles could have a CA country code + any valid ISO 3166-2:CA Province code
- If any rows of vehicle data in the file uploaded have a vehicle country code that is not CA or US, the row of data will be considered to be an error and will be rejected.
If the country of your Business Account is set to a value other than US (United States) or CA (Canada) then it is valid for the vehicles listed in the uploaded file to have any valid ISO-3166 alpha-2 country code except US or CA.
ISO 3166-1 alpha-2 country codes:
ISO 3166 alpha-2 is the international standard used to define the 2-letter abbreviations for all of the countries of the world. This system ensures that the data is stored accurately and can be used by all systems in a consistent manner. The specific codes are listed below.
AT, Austria
BE, Belgium
BG, Bulgaria
HR, Croatia
CH, Switzerland
CY, Cyprus
CZ, Czech Republic
DK, Denmark
EE, Estonia
FI, Finland
FR, France
DE, Germany
GR, Greece
HU, Hungary
IE, Ireland, Republic of (EIRE)
IT, Italy
LV, Latvia
LT, Lithuania
LU, Luxembourg
MT, Malta
NL, Netherlands
PL, Poland
PT, Portugal
RO, Romania
SK, Slovakia
SI, Slovenia
ES, Spain
SE, Sweden
GB, United Kingdom (Great Britain)
US-United States of America
CA-Canada
ISO 3166-2:CA Province Codes:
ISO 3166 is the international standard used to define the 2-letter abbreviations for the provinces of Canada. This system ensures that the data is stored accurately and can be used by all systems in a consistent manner. The specific codes are listed below.
Code |
Subdivision name (en) |
Subdivision name (fr) |
Subdivision category |
CA-AB |
Alberta |
Province |
|
CA-BC |
Colombie-Britannique |
Province |
|
CA-MB |
Manitoba |
Province |
|
CA-NB |
Nouveau-Brunswick |
Province |
|
CA-NL |
Terre-Neuve-et-Labrador |
Province |
|
CA-NS |
Nouvelle-Écosse |
Province |
|
CA-ON |
Ontario |
Province |
|
CA-PE |
Île-du-Prince-Édouard |
Province |
|
CA-QC |
Québec |
Province |
|
CA-SK |
Saskatchewan |
Province |
|
CA-NT |
Territoires du Nord-Ouest |
Territory |
|
CA-NU |
Nunavut |
Territory |
|
CA-YT |
Yukon |
Territory |
ISO 3166-2:US State Codes:
ISO 3166 is the international standard used to define the 2-letter abbreviations for the states of the United States of America. This system ensures that the data is stored accurately and can be used by all systems in a consistent manner. The specific codes are listed below.
Code |
Subdivision name (en) |
Subdivision category |
US-AL |
state |
|
US-AK |
state |
|
US-AZ |
state |
|
US-AR |
state |
|
US-CA |
state |
|
US-CO |
state |
|
US-CT |
state |
|
US-DE |
state |
|
US-FL |
state |
|
US-GA |
state |
|
US-HI |
state |
|
US-ID |
state |
|
US-IL |
state |
|
US-IN |
state |
|
US-IA |
state |
|
US-KS |
state |
|
US-KY |
state |
|
US-LA |
state |
|
US-ME |
state |
|
US-MD |
state |
|
US-MA |
state |
|
US-MI |
state |
|
US-MN |
state |
|
US-MS |
state |
|
US-MO |
state |
|
US-MT |
state |
|
US-NE |
state |
|
US-NV |
state |
|
US-NH |
state |
|
US-NJ |
state |
|
US-NM |
state |
|
US-NY |
state |
|
US-NC |
state |
|
US-ND |
state |
|
US-OH |
state |
|
US-OK |
state |
|
US-OR |
state |
|
US-PA |
state |
|
US-RI |
state |
|
US-SC |
state |
|
US-SD |
state |
|
US-TN |
state |
|
US-TX |
state |
|
US-UT |
state |
|
US-VT |
state |
|
US-VA |
state |
|
US-WA |
state |
|
US-WV |
state |
|
US-WI |
state |
|
US-WY |
state |
|
US-DC |
district |
|
US-AS |
outlying area |
|
US-GU |
outlying area |
|
US-MP |
outlying area |
|
US-PR |
outlying area |
|
US-UM |
outlying area |
|
US-VI |
outlying area |