Glossary

Terms that are commonly used in our documentation can be found here!

Demographic Fields

address1
Line one of the physical addres for a registrant
address2
Line two of the physical addres for a registrant
anniversaryDate
Anniversary date of the registrant
city
City of the registrant
companyName
Company Name for a registrant
country
United states or Canada -country of a registrant
custom1
Custom field that can be used for a variety of inputs that the merchant has preconfigured
custom2
Custom field that can be used for a variety of inputs that the merchant has preconfigured
custom3
Custom field that can be used for a variety of inputs that the merchant has preconfigured
custom4
Custom field that can be used for a variety of inputs that the merchant has preconfigured
custom5
Custom field that can be used for a variety of inputs that the merchant has preconfigured
custom6
Custom field that can be used for a variety of inputs that the merchant has preconfigured
customerNumber
A number that can be assigned to a registrant that is not the card number or account code
dateOfBirth
Birthdate of the registrant
email
Email address of a registrant
favoriteStore
Self selected favorite store of the registrant. This is used in segmented campaign offers
fax
Fax number of a registrant
firstName
The first name field holds the guest’s first name. This information can be used to personalize marketing emails, look up the guest in our system and look up the guest at the point of sale. This piece of information is provided by the guest during registration.
lastName
The last name field holds the guest’s last name. This information can be used to personalize marketing emails, look up the guest in our system and look up the guest at the point of sale. This piece of information is provided by the guest during registration.
mobilePhone
Mobile phone number of a registrant. This is the only field used in SMS campaigns
optIn
Opt in for Email
password
Password for the registrant
perks
An account specific attribute that can effect how the registrant’s account behaves. Additional configuration required
phone
Phone number of a registrant
postalCode
US State or Canadian Province of a registrant
referrerEmail
Email address of a referee for this registrant
salutation
This field is also used to determine the gender of a registrant
stateProvince
US State or Canadian Province of a registrant
textCampaignOptIn
Step 1 in a double opt in for SMS message campaigns. Additional configuration required
username
Username for the registrant

Commonly Used General Terms

Activation
The act of changing the state of the card from inactive to active
activationStore
Store to attribute the activation transaction to
attached cards
An account with multiple unique cards that retain their own balance and history information
Auto Combine
The act of automatically combining an account with another based on demographic field matches
Card Template
Code of the card template that is in the PXS
combined cards
An account with multiple unique cards that share their balances and history
enrollDate
Date of enrollemnt
lastActivityDate
The last in store activity on an account
Loadmap
The load map is a structured object that contains information on wallets, activation items and tender items which are location specific. This information can be used to determine what POS items should be tracked, what rewards might be available and what sorts of items will need to be inserted into the check as a result of various actions.
merchant ID
Number code for the merchant in the PXS
printedCardNumber
Number printed on the back of the card
PXC
Paytronix controller
PXS
Paytronix system
Registration
The act of adding a username and password and optionally other demographic information to an account
registration code
A code that is used on some card batches that adds additional security

All Account Statuses

active
Card has been activated
converted
Account has been enrolled in another program
disabled
Card has been disabled by a guest
exchanged
Card has been exchanged for another account
inactive
Card number exists but is not active in the paytronix system
suspended
Card has been temproarlily disabled by a CSR
terminated
Card has been permanently disabled by a CSR

Push Services Terms

APNS
Apple Push Notification Service. Apple’s push service
Device Token
Name of Apple’s push identifier
FCM
Firebase Cloud Messaging. Google’s push service
Push Identifier
The identifier for a specific device that paytronix uses to send push messages to this device
Registration Id/Token
Name of Google’s push identifier
Sender Id
Google assigned id for a user of their API (linked to a google account)
Server API Key
An OAuth key that authorizes a server to send push messages to Google (Deprecated)
Service Account Key
A private key contained in a JSON file used to mint tokens to authenticate with FCM

Passbook Services Terms

Apple WWDR Certificate
An intermediate certificate provided by Apple. See Apple’s certificate authority
p12 package
The password protected package that the integrator provides to Paytronix so that the passes may be signed
Pass Certificate
A certificate generated by Apple once provided a certificate signing request
Pass Type Identifier
The identifier specifying the pass for a specific merchant
Private Key
A key known only to the integrator and Paytronix for use in signing passes
Team Identifier
The identifier signifying the Apple Developer account

Supported Country Codes

Code Country
US United States
CA Canada
GB United Kingdom
IE Republic of Ireland
MX Mexico
BR Brazil
SG Singapore
JM Jamaica
KY Cayman Islands
TC Turks and Caicos
ES Spain
FR France
DE Germany
PT Portugal
AF Afghanistan
AL Albania
DZ Algeria
AS American Samoa
AD Andorra
AO Angola
AI Anguilla
AQ Antarctica
AG Antigua and Barbuda
AR Argentina
AM Armenia
AW Aruba
AU Australia
AT Austria
AZ Azerbaijan
BS Bahamas
BH Bahrain
BD Bangladesh
BB Barbados
BY Belarus
BE Belgium
BZ Belize
BJ Benin
BM Bermuda
BT Bhutan
BO Bolivia
BA Bosnia and Herzegovina
BW Botswana
BV Bouvet Island
IO British Indian Ocean Territory
BN Brunei Darussalam
BG Bulgaria
BF Burkina Faso
BI Burundi
KH Cambodia
CM Cameroon
CV Cape Verde
CF Central African Republic
TD Chad
CL Chile
CN China
CX Christmas Island
CC Cocos (Keeling) Islands
CO Colombia
KM Comoros
CG Congo
CK Cook Islands
CR Costa Rica
CI Cote D’Ivoire
HR Croatia
CU Cuba
CY Cyprus
CZ Czech Republic
DK Denmark
DJ Djibouti
DM Dominica
DO Dominican Republic
EC Ecuador
EG Egypt
SV El Salvador
GQ Equatorial Guinea
ER Eritrea
EE Estonia
ET Ethiopia
FK Falkland Islands (Malvinas)
FO Faroe Islands
FJ Fiji
FI Finland
GF French Guiana
PF French Polynesia
TF French Southern Territories
GA Gabon
GM Gambia
GE Georgia
GH Ghana
GI Gibraltar
GR Greece
GL Greenland
GD Grenada
GP Guadeloupe
GU Guam
GT Guatemala
GN Guinea
GW Guinea-Bissau
GY Guyana
HT Haiti
HM Heard Island and Mcdonald Islands
VA Holy See (Vatican City State)
HN Honduras
HK Hong Kong
HU Hungary
IS Iceland
IN India
ID Indonesia
IR Iran
IQ Iraq
IL Israel
IT Italy
JP Japan
JO Jordan
KZ Kazakhstan
KE Kenya
KI Kiribati
KP Korea
KR Korea
KW Kuwait
KG Kyrgyzstan
LA Lao People’s Democratic Republic
LV Latvia
LB Lebanon
LS Lesotho
LR Liberia
LY Libyan Arab Jamahiriya
LI Liechtenstein
LT Lithuania
LU Luxembourg
MO Macao
MK Macedonia
MG Madagascar
MW Malawi
MY Malaysia
MV Maldives
ML Mali
MT Malta
MH Marshall Islands
MQ Martinique
MR Mauritania
MU Mauritius
YT Mayotte
FM Micronesia
MD Moldova
MC Monaco
MN Mongolia
MS Montserrat
MA Morocco
MZ Mozambique
MM Myanmar
NA Namibia
NR Nauru
NP Nepal
NL Netherlands
AN Netherlands Antilles
NC New Caledonia
NZ New Zealand
NI Nicaragua
NE Niger
NG Nigeria
NU Niue
NF Norfolk Island
MP Northern Mariana Islands
NO Norway
OM Oman
PK Pakistan
PW Palau
PS Palestinian Territory
PA Panama
PG Papua New Guinea
PY Paraguay
PE Peru
PH Philippines
PN Pitcairn
PL Poland
PR Puerto Rico
QA Qatar
RE Reunion
RO Romania
RU Russian Federation
RW Rwanda
SH Saint Helena
KN Saint Kitts and Nevis
LC Saint Lucia
PM Saint Pierre and Miquelon
VC Saint Vincent and the Grenadines
WS Samoa
SM San Marino
ST Sao Tome and Principe
SA Saudi Arabia
SN Senegal
CS Serbia and Montenegro
SC Seychelles
SL Sierra Leone
SK Slovakia
SI Slovenia
SB Solomon Islands
SO Somalia
ZA South Africa
GS South Georgia and the South Sandwich Islands
LK Sri Lanka
SD Sudan
SR Suriname
SJ Svalbard and Jan Mayen
SZ Swaziland
SE Sweden
CH Switzerland
SY Syrian Arab Republic
TW Taiwan
TJ Tajikistan
TZ Tanzania
TH Thailand
TL Timor-Leste
TG Togo
TK Tokelau
TO Tonga
TT Trinidad and Tobago
TN Tunisia
TR Turkey
TM Turkmenistan
TV Tuvalu
UG Uganda
UA Ukraine
AE United Arab Emirates
UM United States Minor Outlying Islands
UY Uruguay
UZ Uzbekistan
VU Vanuatu
VE Venezuela
VN Viet Nam
VG Virgin Islands
VI Virgin Islands
WF Wallis and Futuna
EH Western Sahara
YE Yemen
ZM Zambia
ZW Zimbabwe

Supported Country State/Province Codes

Code State/Province
Country United States
AL Alabama
AK Alaska
AZ Arizona
AR Arkansas
CA California
CO Colorado
CT Connecticut
DE Delaware
DC District of Columbia
FL Florida
GA Georgia
HI Hawaii
ID Idaho
IL Illinois
IN Indiana
IA Iowa
KS Kansas
KY Kentucky
LA Louisiana
ME Maine
MD Maryland
MA Massachusetts
MI Michigan
MN Minnesota
MS Mississippi
MO Missouri
MT Montana
NE Nebraska
NV Nevada
NH New Hampshire
NJ New Jersey
NM New Mexico
NY New York
NC North Carolina
ND North Dakota
OH Ohio
OK Oklahoma
OR Oregon
PA Pennsylvania
PR Puerto Rico
RI Rhode Island
SC South Carolina
SD South Dakota
TN Tennessee
TX Texas
UT Utah
VT Vermont
VA Virginia
WA Washington
WV West Virginia
WI Wisconsin
WY Wyoming
AS American Samoa
FM Federated States of Micronesia
GU Guam
MH Marshall Islands
MP Northern Mariana Islands
PW Palau
VI Virgin Islands
AA Armed Forces Americas
AE Armed Forces Europe
AP Armed Forces Pacific
Country Canada
AB Alberta
BC British Columbia
MB Manitoba
NB New Brunswick
NL Newfoundland and Labrador
NT Northwest Territories
NS Nova Scotia
NU Nunavut
ON Ontario
PE Prince Edward Island
QC Quebec
SK Saskatchewan
YT Yukon
Country Mexico
AGU Aguascalientes
BCN Baja California
BCS Baja California Sur
CAM Campeche
CHP Chiapas
CHH Chihuahua
COA Coahuila
COL Colima
DUR Durango
GUA Guanajuato
GRO Guerrero
HID Hidalgo
JAL Jalisco
MEX México
CMX Mexico City
MIC Michoacán
MOR Morelos
NAY Nayarit
NLE Nuevo León
OAX Oaxaca
PUE Puebla
QUE Querétaro
ROO Quintana Roo
SLP San Luis Potosí
SIN Sinaloa
SON Sonora
TAB Tabasco
TAM Tamaulipas
TLA Tlaxcala
VER Veracruz
YUC Yucatán
ZAC Zacatecas
Country Spain
C A Coruña
VI Álava
AB Albacete
A Alicante
AL Almería
O Asturias
AV Ávila
BA Badajoz
B Barcelona
BI Bizkaia
BU Burgos
CC Cáceres
CA Cádiz
S Cantabria
CS Castellón
CR Ciudad Real
CO Córdoba
CU Cuenca
SS Gipuzkoa
GI Girona
GR Granada
GU Guadalajara
H Huelva
HU Huesca
PM Illes Balears
J Jaén
LO La Rioja
GC Las Palmas
LE León
L Lleida
LU Lugo
M Madrid
MA Málaga
MU Murcia
NA Navarra
NA Nafarroa
OR Ourense
P Palencia
PO Pontevedra
SA Salamanca
TF Santa Cruz de Tenerife
SG Segovia
SE Sevilla
SO Soria
T Tarragona
TE Teruel
TO Toledo
V Valencia
VA Valladolid
ZA Zamora
Z Zaragoza