Data Transfer Object
Contents
<a name='T-OpenPath-Dto-Gto-Public-AddressDto'></a>
AddressDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Details for this address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-City'></a>
City property
Summary
The city of the address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Country'></a>
Country property
Summary
The full Country Name of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-CountryCode'></a>
CountryCode property
Summary
The two letter Country Code of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Created'></a>
Created property
Summary
The date that this Address was first created in the system.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Demographic'></a>
Demographic property
Summary
The specific demographic information for the postal code of this address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Id'></a>
Id property
Summary
The Address ID is the unique identity of this payment or payment method within the OpenPath system and is associated to either a payment method or a customer
IsActive property
Summary
If we can determine, if this address is currently and active address for the Customer or Payment Method.
Latitude property
Summary
The Latitude of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Lines'></a>
Lines property
Summary
This is all the Address Lines associated with this Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Longitude'></a>
Longitude property
Summary
The Longitude of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Normalized'></a>
Normalized property
Summary
The Normalized Address, with consists of only the letters and numbers of Address Line 1 and the Postal Code.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-PostalCode'></a>
PostalCode property
Summary
The Postal Code or Zip Code of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Region'></a>
Region property
Summary
The State, Provence, Teritory, etc. of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-RegionCode'></a>
RegionCode property
Summary
The abbrevated State, Provence, Teritory, etc. of the Address.
<a name='P-OpenPath-Dto-Gto-Public-AddressDto-Updated'></a>
Updated property
Summary
The last date this address was used or updated.
<a name='T-OpenPath-Dto-Gto-Public-AddressLineDto'></a>
AddressLineDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The address lines associated with an address, such as street address, suites, apts, ect.
<a name='P-OpenPath-Dto-Gto-Public-AddressLineDto-Id'></a>
Id property
Summary
The internal database ID of this address line.
<a name='P-OpenPath-Dto-Gto-Public-AddressLineDto-Line'></a>
Line property
Summary
The value for this address line.
<a name='T-OpenPath-Dto-Gto-Public-CardDto'></a>
CardDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The card or credit card information supplied for a Payment type.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-BankAddress'></a>
BankAddress property
Summary
The address of the issuing bank.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-BankContacts'></a>
BankContacts property
Summary
Contact information for this bank.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-BankName'></a>
BankName property
Summary
The name of the bank that issued this card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Bin'></a>
Bin property
Summary
The Bank Identication Number, which is the first six digits of the card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Brand'></a>
Brand property
Summary
The brand of the card, e.g. Visa/Dankort
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Currency'></a>
Currency property
Summary
The currency this card settles in.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-ExpirationDate'></a>
ExpirationDate property
Summary
The expiration is a date and time format.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-ExpirationMonth'></a>
ExpirationMonth property
Summary
The expiration month on the card. Valid numbers are 1-12.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-ExpirationYear'></a>
ExpirationYear property
Summary
The expiration year on the card. Valid numbers are 2000+.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-IsLuhns'></a>
IsLuhns property
Summary
Is this card number a valid Luhns Algorithm number?
<a name='P-OpenPath-Dto-Gto-Public-CardDto-IsPrepaid'></a>
IsPrepaid property
Summary
Is this a prepaid card, such as a gift card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-LastFour'></a>
LastFour property
Summary
The last four digits of the card number.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-NameOnCard'></a>
NameOnCard property
Summary
The printed name on the card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-NumberLength'></a>
NumberLength property
Summary
The expected number of digits for this BIN number.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Scheme'></a>
Scheme property
Summary
The primary network scheme for this card, e.g. Visa, MasterCard
<a name='P-OpenPath-Dto-Gto-Public-CardDto-SubType'></a>
SubType property
Summary
The banks denoted sub-type of this card, e.g. Black, Business, Travel Rewards
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Track1'></a>
Track1 property
Summary
The data on the first track on the megnetic strip on the card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Track2'></a>
Track2 property
Summary
The data on the first track on the megnetic strip on the card.
<a name='P-OpenPath-Dto-Gto-Public-CardDto-Type'></a>
Type property
Summary
The type of card this is, e.g. Credit, Debit
<a name='T-OpenPath-Dto-Gto-Public-ContactDto'></a>
ContactDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
A contact line item that can be emails, phones, social profiles and ect.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-Id'></a>
Id property
Summary
The internal ID of the contact line item.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-IsActive'></a>
IsActive property
Summary
Is this contact information known to still be active?
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-IsPrimary'></a>
IsPrimary property
Summary
Is this their primary contact information.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-Normalized'></a>
Normalized property
Summary
The normalized value of the contact information.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-SubType'></a>
SubType property
Summary
The sub type of the contact record.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-Type'></a>
Type property
Summary
The type of contact record this is.
<a name='P-OpenPath-Dto-Gto-Public-ContactDto-Value'></a>
Value property
Summary
The original value of the contact information.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum'></a>
ContactSubTypeEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
Contacts detailed type of contact information.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Business'></a>
Business constants
Summary
Contact type is the business phone number.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-EmailBusiness'></a>
EmailBusiness constants
Summary
Contacts business email address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Facebook'></a>
Facebook constants
Summary
Contacts Facebook social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Fax'></a>
Fax constants
Summary
Contact type is a fax line.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-GitHub'></a>
GitHub constants
Summary
Contacts Github social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Home'></a>
Home constants
Summary
Contact type is the home phone number.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-LinkedIn'></a>
LinkedIn constants
Summary
Contacts Linkedin social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-MessengerDiscord'></a>
MessengerDiscord constants
Summary
Contacts Discord address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-MessengerFacebook'></a>
MessengerFacebook constants
Summary
Contacts Facebook messenger address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-MessengerSkype'></a>
MessengerSkype constants
Summary
Contacts Skype address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-MessengerSlack'></a>
MessengerSlack constants
Summary
Contacts Slack address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-MessengerWhatsApp'></a>
MessengerWhatsApp constants
Summary
Contacts WhatsApp address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Mobile'></a>
Mobile constants
Summary
Contact type is a mobile phone or cell phone.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Other'></a>
Other constants
Summary
Other contact information that doesn't have a sub type.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Personal'></a>
Personal constants
Summary
Contacts personal email address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Profile'></a>
Profile constants
Summary
Contacts unknown social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-ProfileGravatar'></a>
ProfileGravatar constants
Summary
Contacts Gravtar social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-ProfileInstagram'></a>
ProfileInstagram constants
Summary
Contacts Instagram social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-TTY'></a>
TTY constants
Summary
Contact type is a TTY number, TTY or Teletypewriter is a device that allows users to send typed messages across phone lines. Many people who are Deaf, deafened, hard of hearing, or who are deafblind may use TTYs to call other individuals.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Teams'></a>
Teams constants
Summary
Contacts Microsoft Teams address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Twitter'></a>
Twitter constants
Summary
Contacts Twitter social profile address or link.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Website'></a>
Website constants
Summary
Contacts business website url.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-WebsiteApi'></a>
WebsiteApi constants
Summary
Contacts API url.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-WebsiteKnowledgebase'></a>
WebsiteKnowledgebase constants
Summary
Contacts knowledgebase website url.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-WebsitePersonal'></a>
WebsitePersonal constants
Summary
Contacts personal website url.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactSubTypeEnum-Youtube'></a>
Youtube constants
Summary
Contacts Youtube social profile address or link.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum'></a>
ContactTypeEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
Primary contact types, phone, email, website, ect.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum-Email'></a>
Email constants
Summary
The contact type for this entry is an email address.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum-MesMessengersagener'></a>
MesMessengersagener constants
Summary
The contact type for this entry is a social media profile.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum-Phone'></a>
Phone constants
Summary
The contact type for this entry is a phone number.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum-Profile'></a>
Profile constants
Summary
The contact type for this entry is a social media profile.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ContactTypeEnum-Website'></a>
Website constants
Summary
The contact type for this entry is a social media profile.
<a name='T-OpenPath-Dto-Gto-Public-CustomerDto'></a>
CustomerDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Information about a transactions customer.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-Contacts'></a>
Contacts property
Summary
The contact details for this customer, which can be phone numbers, emails, socical links, ect.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-Created'></a>
Created property
Summary
The date this customer record was first created.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-FirstName'></a>
FirstName property
Summary
The first name of the customer.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-Id'></a>
Id property
Summary
The internal ID of the Customer.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-LastName'></a>
LastName property
Summary
The last name of the customer.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-ShippingAddress'></a>
ShippingAddress property
Summary
The shipping address of the customer for this transaction.
<a name='P-OpenPath-Dto-Gto-Public-CustomerDto-Updated'></a>
Updated property
Summary
The date this customer record was last updated.
<a name='T-OpenPath-Dto-Gto-Public-DemographicDto'></a>
DemographicDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Demographic information for a given area.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-AliasIntroduction'></a>
AliasIntroduction property
Summary
The date this City Alias was introduced for this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-AreaCodes'></a>
AreaCodes property
Summary
The telephone area codes available in this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-AsianPopulation'></a>
AsianPopulation property
Summary
The estimated Asian population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-AverageHouseValue'></a>
AverageHouseValue property
Summary
The median house value in the postal code based on the latest American Community Survey (ACS) data from the U.S. Census.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-BlackPopulation'></a>
BlackPopulation property
Summary
The estimated Black/African population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-BoxCount'></a>
BoxCount property
Summary
Total count of PO Box deliveries in this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-BusinessAnnualPayroll'></a>
BusinessAnnualPayroll property
Summary
The total annual payroll for this postal code in $1000.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-BusinessEmploymentFlag'></a>
BusinessEmploymentFlag property
Summary
Employment flag indicating range of employment in protected classes.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-BusinessFirstQuarterPayroll'></a>
BusinessFirstQuarterPayroll property
Summary
The total payroll for the first quarter this postal code in $1000.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CBSAPopulation'></a>
CBSAPopulation property
Summary
The estimated population for the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CarrierRouteRateSortation'></a>
CarrierRouteRateSortation property
Summary
Identifies where automation Carrier Route rates are available.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Cbsa'></a>
Cbsa property
Summary
Core Based Statistical Area Number.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CbsaDivision'></a>
CbsaDivision property
Summary
Core Based Statistical Area Division.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CbsaName'></a>
CbsaName property
Summary
Core Based Statistical Area Name or Title.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CbsaType'></a>
CbsaType property
Summary
Core Based Statistical Area Type (Metro or Micro).
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CityDeliveryIndicator'></a>
CityDeliveryIndicator property
Summary
Specifies whether or not a post office has city-delivery carrier routes.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CongressionalDistrict'></a>
CongressionalDistrict property
Summary
This field shows which 110th Congressional Districts the postal code belongs to.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-CongressionalLandArea'></a>
CongressionalLandArea property
Summary
This field provides the approximate land area covered by the Congressional District for which the postal code belongs to.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Csa'></a>
Csa property
Summary
Core Statistical Area. This area is a group of MSA's combined into a population core area.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-DeliveryBusiness'></a>
DeliveryBusiness property
Summary
The # of active business delivery mailboxes and centralized units for this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-DeliveryResidential'></a>
DeliveryResidential property
Summary
The # of active residential delivery mailboxes and centralized units for this postal coed.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Division'></a>
Division property
Summary
9 geographically grouped areas consisting of several States.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-FemalePopulation'></a>
FemalePopulation property
Summary
The estimated Female population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-FinanceNumber'></a>
FinanceNumber property
Summary
A code assigned to Postal Service facilities.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-GrowingCountyA'></a>
GrowingCountyA property
Summary
The estimated number of housing units in this county as of July 1, 2003.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-GrowingCountyB'></a>
GrowingCountyB property
Summary
The estimated number of housing units in this county as of July 1, 2004.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-GrowthIncreaseNumber'></a>
GrowthIncreaseNumber property
Summary
The change in housing units from 2003 to 2004, expressed as a number.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-GrowthIncreasePercentage'></a>
GrowthIncreasePercentage property
Summary
The change in housing units from 2003 to 2004, expressed as a percentage.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-GrowthRank'></a>
GrowthRank property
Summary
The rank in which this county is growing according to the US Census.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-HawaiianPopulation'></a>
HawaiianPopulation property
Summary
The estimated Hawaiian population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-HispanicPopulation'></a>
HispanicPopulation property
Summary
The estimated Hispanic population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Households'></a>
Households property
Summary
The estimated number of households of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Id'></a>
Id property
Summary
Internal ID of this demographic information.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-IncomePerHousehold'></a>
IncomePerHousehold property
Summary
The median household per postal code based on the latest American Community Survey (ACS) data from the U.S. Census.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-IndianPopulation'></a>
IndianPopulation property
Summary
The estimated American Indian and Alaska Native population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-LandArea'></a>
LandArea property
Summary
Shows the approximate land area of this postal code in square miles.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MailingName'></a>
MailingName property
Summary
Yes or No (Y/N) flag indicating whether or not the USPS accepts this City Alias Name for mailing purposes.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MalePopulation'></a>
MalePopulation property
Summary
The estimated Male population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MedianAge'></a>
MedianAge property
Summary
The median age for all people based in the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MedianAgeFemale'></a>
MedianAgeFemale property
Summary
The median age for females based in the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MedianAgeMale'></a>
MedianAgeMale property
Summary
The median age for males based in the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Mfdu'></a>
Mfdu property
Summary
Integer Total count of multifamily deliveries in this postal code; generally analogous to apartments.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Msa'></a>
Msa property
Summary
Metropolitan Statistical Area number assigned.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MsaName'></a>
MsaName property
Summary
Primary Metropolitan Statistical Area name or Title.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-MultiCounty'></a>
MultiCounty property
Summary
Flag indicating whether this postal code crosses county lines.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-NumberOfBusinesses'></a>
NumberOfBusinesses property
Summary
The total number of Business Establishments for this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-NumberOfEmployees'></a>
NumberOfEmployees property
Summary
The total number of employees for this postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-OtherPopulation'></a>
OtherPopulation property
Summary
The estimated population of all other races for the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-PersonsPerHousehold'></a>
PersonsPerHousehold property
Summary
The estimated average number of persons per household of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Pmsa'></a>
Pmsa property
Summary
Primary Metropolitan Statistical Area Number.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-PmsaName'></a>
PmsaName property
Summary
Primary Metropolitan Statistical Area name or Title.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Population'></a>
Population property
Summary
The population of the postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-PostalCode'></a>
PostalCode property
Summary
00000-99999 Five digit numeric postal code of the area.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-PostalCodeIntroduction'></a>
PostalCodeIntroduction property
Summary
The date this postal code was introduced into the database.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-Sfdu'></a>
Sfdu property
Summary
Total count of single family deliveries in this postal code; generally analogous to homes.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-UniquePostalCodeName'></a>
UniquePostalCodeName property
Summary
Field that specifies whether the City State Record contains the organization name for a unique postal code.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-WaterArea'></a>
WaterArea property
Summary
Shows the approximate water area of this postal code in square miles.
<a name='P-OpenPath-Dto-Gto-Public-DemographicDto-WhitePopulation'></a>
WhitePopulation property
Summary
The estimated White/Caucasian population of the postal code.
<a name='T-OpenPath-Dto-Gto-Public-IpAddressDto'></a>
IpAddressDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Information about this IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-Address'></a>
Address property
Summary
The address associated with this IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-As'></a>
As property
Summary
AS number and organization, separated by space (RIR). Empty for IP blocks not being announced in BGP tables.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-Id'></a>
Id property
Summary
The unique database ID for this IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-IpAddress'></a>
IpAddress property
Summary
The IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-IsMobile'></a>
IsMobile property
Summary
Is this IP address from a mobile (cellular) connection.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-IsProxy'></a>
IsProxy property
Summary
Does a Proxy, VPN or Tor exit with this IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-Isp'></a>
Isp property
Summary
The name of the Internet Service Provider.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-Organization'></a>
Organization property
Summary
The name of the organization that owns this IP address.
<a name='P-OpenPath-Dto-Gto-Public-IpAddressDto-Reverse'></a>
Reverse property
Summary
Reverse DNS of the IP address.
<a name='T-OpenPath-Dto-Gto-Public-LineItemDto'></a>
LineItemDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The Level III data or Products associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-CommodityCode'></a>
CommodityCode property
Summary
The commodity code of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Description'></a>
Description property
Summary
The description of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Discount'></a>
Discount property
Summary
The discount applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Duty'></a>
Duty property
Summary
The duty applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-DutyDescription'></a>
DutyDescription property
Summary
The description of the duty applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-DutyName'></a>
DutyName property
Summary
The name of the duty applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-ExternalId'></a>
ExternalId property
Summary
The referencing external ID of the item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Id'></a>
Id property
Summary
The line item ID.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Name'></a>
Name property
Summary
The name of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Quantitiy'></a>
Quantitiy property
Summary
The quantity of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-ShipFromPostalCode'></a>
ShipFromPostalCode property
Summary
The postal code this item will be shipping from.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Shipping'></a>
Shipping property
Summary
The shipping costs applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-ShippingDescription'></a>
ShippingDescription property
Summary
The description of the shipping applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-ShippingName'></a>
ShippingName property
Summary
The name of the shipping applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Tax'></a>
Tax property
Summary
The tax of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-TaxDescription'></a>
TaxDescription property
Summary
The decription of the tax applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-TaxName'></a>
TaxName property
Summary
The name of the Tax applied to this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-TaxRate'></a>
TaxRate property
Summary
The tax rate applied to the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-Total'></a>
Total property
Summary
The total of the line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-UnitOfCost'></a>
UnitOfCost property
Summary
The unit of cost for the measure of this line item.
<a name='P-OpenPath-Dto-Gto-Public-LineItemDto-UnitOfMeasure'></a>
UnitOfMeasure property
Summary
The unit of measurement for the line item.
<a name='T-OpenPath-Dto-Gto-Public-MetaDataDto'></a>
MetaDataDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Data supplied from external resources that does not map to fields within the OpenPath system, such as propritary data supplied by processors, gateways or third party APIs and FinTech companies.
<a name='P-OpenPath-Dto-Gto-Public-MetaDataDto-Id'></a>
Id property
Summary
The ID of this meta data.
<a name='P-OpenPath-Dto-Gto-Public-MetaDataDto-Key'></a>
Key property
Summary
The meta data Key.
<a name='P-OpenPath-Dto-Gto-Public-MetaDataDto-Value'></a>
Value property
Summary
The meta data value.
<a name='T-OpenPath-Dto-Gto-Public-PacketDto'></a>
PacketDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The root transaction packet processed by Openpath.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-AssociatedSiteId'></a>
AssociatedSiteId property
Summary
The OpenPath Site that processed this transaction.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-Id'></a>
Id property
Summary
The packet ID.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-Received'></a>
Received property
Summary
The date and time the transaction was received by OpenPath from the requester.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-Responded'></a>
Responded property
Summary
The date and time the transaction was returned to requester by OpenPath.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-SourceIpAddress'></a>
SourceIpAddress property
Summary
The IP address of the transaction requester, not the customers IP address.
<a name='P-OpenPath-Dto-Gto-Public-PacketDto-Transaction'></a>
Transaction property
Summary
The transaction information for this transaction.
<a name='T-OpenPath-Dto-Gto-Public-PathDto'></a>
PathDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The internal transaction paths that this transaction passed through in the OpenPath engine.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-FromPathId'></a>
FromPathId property
Summary
The ID of the OpenPath path that passed this transaction
<a name='P-OpenPath-Dto-Gto-Public-PathDto-FromPathName'></a>
FromPathName property
Summary
The name of the OpenPath path that passed this transaction.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-FromPathType'></a>
FromPathType property
Summary
The type of OpenPath path that passed this transaction.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-Id'></a>
Id property
Summary
The ID of this path result.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-Result'></a>
Result property
Summary
The result text of this path that transaction passed through.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-TimeStamp'></a>
TimeStamp property
Summary
The time the transaction was passed through this OpenPath path.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-ToPathId'></a>
ToPathId property
Summary
The next path name, this path passed this transaction to.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-ToPathName'></a>
ToPathName property
Summary
The next path name, this path passed this transaction to.
<a name='P-OpenPath-Dto-Gto-Public-PathDto-ToPathType'></a>
ToPathType property
Summary
The next path type, this path passed this transaction to.
<a name='T-OpenPath-Dto-Gto-Public-PaymentDto'></a>
PaymentDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The payment object associated with this transaction, they payment type will determine the payment object, which can be credit cards, checks, apple pay, ect.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-BillingAddress'></a>
BillingAddress property
Summary
The billing address associated with this payment method.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-Created'></a>
Created property
Summary
The data this payment or payment method was created.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-Customer'></a>
Customer property
Summary
The customer associated with this payment method.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-Id'></a>
Id property
Summary
The Payment ID is the unique identity of this payment or payment method within the OpenPath system.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-IsActive'></a>
IsActive property
Summary
If it can be determined then an indicator if this is an active payment method or not.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-PaymentMethod'></a>
PaymentMethod property
Summary
The payment object associated with this payment and payment type.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-PaymentType'></a>
PaymentType property
Summary
The type of payment this is such as Credit Card, ACH, Check, Apple Pay, Amazon Pay, etc..
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-Token'></a>
Token property
Summary
The unique tokenized value for this payment or payment method created by OpenPath.
<a name='P-OpenPath-Dto-Gto-Public-PaymentDto-Updated'></a>
Updated property
Summary
The last time this payment method was used or updated.
<a name='T-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum'></a>
PaymentTypeEnum type
Namespace
OpenPath.Dto.Gto.Public.Enumeration
Summary
Payment types for payment objects.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-Ach'></a>
Ach constants
Summary
Electronic bank-to-bank payment.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-AmazonPay'></a>
AmazonPay constants
Summary
Amazon wallet payment type
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-ApplePay'></a>
ApplePay constants
Summary
Apple Pay payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-BitCoin'></a>
BitCoin constants
Summary
BitCoin cypto currency payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-Card'></a>
Card constants
Summary
Credit and Debit card types.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-Check'></a>
Check constants
Summary
Electronic check type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-Ethereum'></a>
Ethereum constants
Summary
Ethereum cypto currency payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-GiftCard'></a>
GiftCard constants
Summary
GiftCard cypto currency payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-GooglePay'></a>
GooglePay constants
Summary
Google Pay payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-Litecoin'></a>
Litecoin constants
Summary
Litecoin cypto currency payment type.
<a name='F-OpenPath-Dto-Gto-Public-Enumeration-PaymentTypeEnum-PayPal'></a>
PayPal constants
Summary
Paypal wallet payment type.
<a name='T-OpenPath-Dto-Gto-Public-ResultDto'></a>
ResultDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The transaction results from the different external systems this transaction was passed through for transaction verification, such as gateway responses, processor responses, AVS and security.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Data'></a>
Data property
Summary
The data associated with this result.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Id'></a>
Id property
Summary
The ID of this result.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Payment'></a>
Payment property
Summary
The payment method used to generate this result.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Result'></a>
Result property
Summary
The approval result of this result.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Severity'></a>
Severity property
Summary
The result severity as pertains to being able to retry the payments again.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Source'></a>
Source property
Summary
The source of this result.
<a name='P-OpenPath-Dto-Gto-Public-ResultDto-Specific'></a>
Specific property
Summary
The specific mapped result.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum'></a>
ResultPaymentEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
Results from different payment types.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-AmazonPay'></a>
AmazonPay constants
Summary
Results from a Amazon Pay payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-ApplePay'></a>
ApplePay constants
Summary
Results from an Apple Pay payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-AutomatedClearingHouse'></a>
AutomatedClearingHouse constants
Summary
Results from ACH transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-BitCoin'></a>
BitCoin constants
Summary
Results from a BitCoin crypto payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Check'></a>
Check constants
Summary
Results from Check transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-CreditCard'></a>
CreditCard constants
Summary
Results from Credit Card transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Crypto'></a>
Crypto constants
Summary
Results from a Crypto payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-DebitCard'></a>
DebitCard constants
Summary
Results from Debit Card transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-GooglePay'></a>
GooglePay constants
Summary
Results from a Google Pay payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-MobilePay'></a>
MobilePay constants
Summary
Results from a mobile payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Multiple'></a>
Multiple constants
Summary
Results from a multiple payment types.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-PayPal'></a>
PayPal constants
Summary
Results from a Pay Pal payment transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-PostTransaction'></a>
PostTransaction constants
Summary
Results from a Post thransaction wrap up.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-SEPA'></a>
SEPA constants
Summary
Results from SEPA transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Ticket'></a>
Ticket constants
Summary
Results from a Ticket.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Vault'></a>
Vault constants
Summary
Results from a customer vault.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultPaymentEnum-Wallet'></a>
Wallet constants
Summary
Results from a payment wallet.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum'></a>
ResultResultEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
Transaction responses.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Approved'></a>
Approved constants
Summary
The transaction payment was approved.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Declined'></a>
Declined constants
Summary
The transaction was declined.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Error'></a>
Error constants
Summary
Their was an error while processing this transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Information'></a>
Information constants
Summary
The result type is informational only and didn't affect the final transaction result.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Pending'></a>
Pending constants
Summary
The transaction was not fully processed and is in a pending state.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultResultEnum-Rejected'></a>
Rejected constants
Summary
This transaction was rejected by filtering systems.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum'></a>
ResultSeverityEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
The severity of the decline, meaning could this transaction be processed again.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-Action'></a>
Action constants
Summary
A actionable declined, the transaction would go through if information was corrected.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-Hard'></a>
Hard constants
Summary
A hard decline, the transaction will never approve even if resubmitted now or in the future.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-NotApplicable'></a>
NotApplicable constants
Summary
A severity is not applicable to this transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-Soft'></a>
Soft constants
Summary
A soft decline, the transaction didn't go through but may go through in the future.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSeverityEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='T-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum'></a>
ResultSourceEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
The source of the transaction result, such as OpenPath, the Gateway or Processor.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Address'></a>
Address constants
Summary
The result came the processors AVS system.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Chargeback'></a>
Chargeback constants
Summary
Information received when a transaction charges back.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Gateway'></a>
Gateway constants
Summary
The result came from the gateway.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-GatewayCCPayload'></a>
GatewayCCPayload constants
Summary
Received gateway credit card payload.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-GatewayResponse'></a>
GatewayResponse constants
Summary
The gateway response.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Information'></a>
Information constants
Summary
Additional information from OpenPath or external systems.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-OpenPath'></a>
OpenPath constants
Summary
Information received from OpenPath.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Processor'></a>
Processor constants
Summary
The result came from the processor.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Refund'></a>
Refund constants
Summary
Information received about performing a chargeback.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Response'></a>
Response constants
Summary
The transaction response from the payment attempt.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-SecurityCode'></a>
SecurityCode constants
Summary
The result came the credit card security code.
<a name='F-OpenPath-Dto-Gto-Public-Enum-ResultSourceEnum-Transaction'></a>
Transaction constants
Summary
The result came directly from the transaction itself.
<a name='T-OpenPath-Dto-Gto-Public-SubscriptionDto'></a>
SubscriptionDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
The details of a subscription associated with a transaction.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Amount'></a>
Amount property
Summary
The amount that gets billed each subscription cycle.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-BillingDay'></a>
BillingDay property
Summary
The day of the month the subscription should be billed on
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Frequency'></a>
Frequency property
Summary
The frequency based on the frequency unit the subscription is billed at.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-FrequencyUnit'></a>
FrequencyUnit property
Summary
The frequency unit that the subscription is billed at.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Id'></a>
Id property
Summary
The internal ID of this subscription plan.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-IsInitial'></a>
IsInitial property
Summary
Was this subscription payment the initial subscription payment.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Name'></a>
Name property
Summary
The name of this subscription plan.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Origin'></a>
Origin property
Summary
What is the point of control and origin of this subscription.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-OriginId'></a>
OriginId property
Summary
The subscription ID from the origin subscription system.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-Payments'></a>
Payments property
Summary
The number of payments that need to be made before this subscription ends.
<a name='P-OpenPath-Dto-Gto-Public-SubscriptionDto-StartDate'></a>
StartDate property
Summary
The date the subscription starts on.
<a name='T-OpenPath-Dto-Gto-Public-Enum-SubscriptionFrequencyEnum'></a>
SubscriptionFrequencyEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
For recurring billing this setting tells us the frequency unit of when we rebill, every x Days, Months or Years.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionFrequencyEnum-Days'></a>
Days constants
Summary
The subscription is billed every x number of days.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionFrequencyEnum-Months'></a>
Months constants
Summary
The subscription is billed every x number of months.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionFrequencyEnum-Years'></a>
Years constants
Summary
The subscription is billed every x number of years.
<a name='T-OpenPath-Dto-Gto-Public-Enum-SubscriptionOriginEnum'></a>
SubscriptionOriginEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
For recurring billing, where are the recurring records stored? They can be stored at the CRM, OpenPath or Gateway. Also, if the origin is unknown, but we see the same transaction coming through our system we can create a Predicted record.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionOriginEnum-CRM'></a>
CRM constants
Summary
The CRM or eCommerce platform controls the subscription and recurring transactions.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionOriginEnum-Gateway'></a>
Gateway constants
Summary
The gatway controls the subscription and recurring transactions.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionOriginEnum-OpenPath'></a>
OpenPath constants
Summary
OpenPath controls the subscription and recurring transactions.
<a name='F-OpenPath-Dto-Gto-Public-Enum-SubscriptionOriginEnum-Predicted'></a>
Predicted constants
Summary
This subscription is of unknown origin but has been determined to be a subscription model.
<a name='T-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum'></a>
TransactionDeviceEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
An enumeration of the types of terminals the transaction came from.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-AirPay'></a>
AirPay constants
Summary
Transaction was initiated through Air Pay.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-DialTerminal'></a>
DialTerminal constants
Summary
Transaction was initiated from a telephone using the Dial Terminal.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-ElectonricCashRegister'></a>
ElectonricCashRegister constants
Summary
Transaction was initiated from an Electronic Cash Register.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-Internal'></a>
Internal constants
Summary
Transaction was initiated from an Internal system.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-PersonalComputerBasedTerminal'></a>
PersonalComputerBasedTerminal constants
Summary
Transaction was initiated from a Personal Computer.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-Recurring'></a>
Recurring constants
Summary
Transaction was initiated from a Recurring billing engine.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-SelfServiceTerminal'></a>
SelfServiceTerminal constants
Summary
Transaction was initiated from a Self Service Terminal.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-UnattendedTerminal'></a>
UnattendedTerminal constants
Summary
Transaction was initiated from an Unattended Terminal.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-VirtualTerminal'></a>
VirtualTerminal constants
Summary
Transaction was initiated from a Virtual Terminal.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-Website'></a>
Website constants
Summary
Transaction was initiated from a Website.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionDeviceEnum-WirelessPOS'></a>
WirelessPOS constants
Summary
Transaction was initiated from a Wireless Point of Sale.
<a name='T-OpenPath-Dto-Gto-Public-TransactionDto'></a>
TransactionDto type
Namespace
OpenPath.Dto.Gto.Public
Summary
Contains the core information about a payment transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-AuthorizationCode'></a>
AuthorizationCode property
Summary
Authorization Code returned by the Gateway or Processor.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Currency'></a>
Currency property
Summary
The currency this transaction was processed in.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-CustomerIpAddress'></a>
CustomerIpAddress property
Summary
The IP address of the customer that initiated this transaction if online.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Description'></a>
Description property
Summary
The description of this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-DeviceType'></a>
DeviceType property
Summary
An enumeration of the types of terminals the transaction came from.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-EmployeeNumber'></a>
EmployeeNumber property
Summary
The ID, email or number of the employee who processed this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Id'></a>
Id property
Summary
The internal OpenPath Transaction ID.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-IsTaxExempt'></a>
IsTaxExempt property
Summary
Was this transaction a tax exempt transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-LineItems'></a>
LineItems property
Summary
The Level III data or Products associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-MarketType'></a>
MarketType property
Summary
The market origin of this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-MetaData'></a>
MetaData property
Summary
Any additional data supplied from third party sources or data that is not natively mapped.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-OrderNumber'></a>
OrderNumber property
Summary
The merchant supplied order number associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-ParentId'></a>
ParentId property
Summary
The Parent ID of the original OpenPath Transaction ID associated with this transaction. If this is the original "Parent" transaction then this ID will be null.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Paths'></a>
Paths property
Summary
The Paths the transaction flowed through in OpenPath.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Payment'></a>
Payment property
Summary
The payment method associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-PoNumber'></a>
PoNumber property
Summary
Purchase Order Number supplied by the merchant.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-ProcessingSystem'></a>
ProcessingSystem property
Summary
The system used to process this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Result'></a>
Result property
Summary
The result of the transaction when attempted to process.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Results'></a>
Results property
Summary
A list of mapped and original responses from all systems.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Subscription'></a>
Subscription property
Summary
The subscription plan associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Surcharge'></a>
Surcharge property
Summary
The amount of Surcharges that were applied to the total of this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Total'></a>
Total property
Summary
The total amount billed, refunded, credited or associated with this transaction.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-TransactionId'></a>
TransactionId property
Summary
The Transaction ID returned by the Gateway or Processor.
<a name='P-OpenPath-Dto-Gto-Public-TransactionDto-Type'></a>
Type property
Summary
The type of payment transaction this is.
<a name='T-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum'></a>
TransactionMarketEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
Used by some processors for processing, where the order originated.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-ECommerce'></a>
ECommerce constants
Summary
Transaction originated from an eCommerce site.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-MailOrder'></a>
MailOrder constants
Summary
Transaction was manually entered from Mail Order.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-MailOrderTelephone'></a>
MailOrderTelephone constants
Summary
Transaction was manually entered from Mail Order or via Telephone.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-Retail'></a>
Retail constants
Summary
Transaction originated from a retail terminal.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-Telephone'></a>
Telephone constants
Summary
Transaction was manually entered from via Telephone.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionMarketEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='T-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum'></a>
TransactionResultEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
The result of the transaction when attempted to process.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Approved'></a>
Approved constants
Summary
The transaction request was approved.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-BouncedBack'></a>
BouncedBack constants
Summary
When OpenPath is not being used to Process Transactions and only being used to evaluate a transaction a Bounce Back result will be returned.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Declined'></a>
Declined constants
Summary
The transaction request was declined.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Error'></a>
Error constants
Summary
There was an error processing this transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Pending'></a>
Pending constants
Summary
For ACH, SEPA and some other transactions outside of credit cards, response may be pending until clearace has been recevied at which time the transaction result will be updated.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Processed'></a>
Processed constants
Summary
When not payment activies are received, such as creating subscriptions that haven't billed, a Processed message will be returned.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Processing'></a>
Processing constants
Summary
The transaction is still processing through OpenPath and the Processors.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Queued'></a>
Queued constants
Summary
The transaction was not processed, but queued for review and needs to be manually reviewed and submitted.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Rejected'></a>
Rejected constants
Summary
The transaction request was rejected due to any set of filters.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionResultEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='T-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum'></a>
TransactionTypeEnum type
Namespace
OpenPath.Dto.Gto.Public.Enum
Summary
An enumeration of different payment type requests.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Authorization'></a>
Authorization constants
Summary
Authorizes the transaction by the bank pending the final capture of the payment.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Cancel'></a>
Cancel constants
Summary
A request to cancel existing subscriptions.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Capture'></a>
Capture constants
Summary
Captures a previously Authorized payment.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-ChargeBack'></a>
ChargeBack constants
Summary
When a chargeback was recevied from the original transaction.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-ChargebackAlert'></a>
ChargebackAlert constants
Summary
A chargeback alert was recieved from the issuing bank.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Credit'></a>
Credit constants
Summary
Applies a balance to the card holders card without a previous Sale or Capture.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-NotSet'></a>
NotSet constants
Summary
Should never be received, but is a fall back for data imports that don't provide this data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Offline'></a>
Offline constants
Summary
A transaction that was handled offline and is being applied to the transaction report.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-PreventionAlert'></a>
PreventionAlert constants
Summary
A prevention alert was recieved from the card network.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Refund'></a>
Refund constants
Summary
Refunds a full or partial amount of a previous Sale or Capture.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Sale'></a>
Sale constants
Summary
Both an Authorization and a Capture performed together.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Settle'></a>
Settle constants
Summary
The transaction settled.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Unknown'></a>
Unknown constants
Summary
Should never be received, but is a fall back for data imports that don't have matching data.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Update'></a>
Update constants
Summary
Updates a Sale, Authorization or Capture with new information.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Validate'></a>
Validate constants
Summary
A transaction that was handled offline and is being applied to the transaction report.
<a name='F-OpenPath-Dto-Gto-Public-Enum-TransactionTypeEnum-Void'></a>
Void constants
Summary
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article