Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the Number is set, but it can also be changed manually. A list of valid card types is included below.

Three digit security code on back of card (optional).

This alphanumeric field contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult field and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This field contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this field.

Expiration month of the credit card specified in Number.

This field contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

Expiration year of the credit card specified in Number.

This field contains the expiration date of the customer's credit card. This field must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

Determines whether data set to the Number or MagneticStripe fields is validated.

By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the Number or MagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

Track data read off of the card's magnetic stripe.

If EntryDataSource is not one of the manually entered enumerations, then this field must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.

The following example shows how to set the MagneticStripe and EntryDataSource fields if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1) or class.Card = new CCCard("4788250000028291=05121015432112345678", dsTrack2) or CCCardType Card = new CCCard() Card.MagneticStripe = "B4788250000028291^TSYS^05121015432112345678" Card.EntryDataSource = dsTrack1

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

Customer's credit card number for the transaction.

If you're sending the transaction with MagneticStripe data, this field should be left empty.

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This field can take one of the following values:

This is the subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

This field contains comma-separated lists of alternative subject names for the certificate.

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signatures
• Key Authentication
• Key Encryption
• Data Encryption
• Key Agreement
• Certificate Signing
• Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Indicates whether a personal or business account is used for this transaction.

Available values:

Account holder's name. This field contains the customer's name as it appears on their account. Many gateways use this field in addition to, or instead of, the Customer Firsts and Last name fields. Note that if this field is not specified, the FullName field from the EPCustomer type will be used instead.

Bank account number for ACH transactions. This field contains the customer's bank account number, which along with the RoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This field is required for all ACH transactions.

Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this field allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.

Available values:

Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This field contains the name of the bank associated with the RoutingNumber.

Routing number for ACH transactions. This field contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the AccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This field is required for all ACH transactions.

Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.

Customer's street address. This field is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This field. City, state, and zip code are set in the City, State, and Zip fields.

The length of this field varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This field.

NOTE: For the Moneris gateway, this field should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

class.Customer = new EPCustomer(); class.Customer.Address = "123"; class.AddSpecialField("avs_street_name, "Nowhere Ln");

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This field allows you to get or set an XML aggregate built from all of the fields from this type. "EPCustomer" is the root element, and the names of the fields create the tags under the root. For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

Customer's city. This field is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS fields include Address, State, and Zip.

Customer's country. This field contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this field with the PayFuse gateway, this field should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

Customer's email address. This optional field contains the customer's email address.

Customer's fax number. This optional field contains the customer's fax number.

Customer's first name. This field contains the customer's first name.

Customer's full name. This field contains the customer's full name as it appears on the credit card or bank account. Many gateways use this field in addition to, or instead of, the FirstName and LastName fields. If a gateway requires a FullName and the field is empty, FullName will be constructed using the contents of FirstName and LastName.

Merchant-generated customer Id. This field contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

Customer's last name. This field contains the customer's last name as it appears on their credit card.

Customer's phone number. This optional field contains the customer's phone number.

Customer's state. This field is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS fields include Address, City, and Zip.

Customer's zip code (or postal code if outside of the USA). This field is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS fields include Address, City, and State.

The end date of the subscription.

The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.

The frequency of payments.

Possible values are:

• "None"
• "Daily"
• "Weekly"
• "BiWeekly"
• "FourWeeks"
• "SemiMonthly"
• "Monthly"
• "BiMonthly"
• "Quarterly"
• "SemiAnnually"
• "Annually"

Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values.

If FrequencyUnit is applicable to the gateway, this field specifies the length of time between charges. This is used in combination with FrequencyUnit to specify the frequency of the billing. For instance if FrequencyUnit is set to "Days" and Frequency is set to "5", payments will occur every 5 days.

The unit of time to be used when calculating the frequency of payments.

Possible values are:

• "D" or "Days"
• "M" or "Months"
• "Y" or "Years"

The initial amount to be charged (such as a trial period or setup fee). This amount can vary from RecurAmount.

The amount to be charged on a recurring basis. This amount can vary from InitialAmount.

The date on which the recurring payments will start processing.

This property specifies the start date. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.

The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.

The total number of trial payments.

Contains an authorization code when a transaction has been approved. This field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction is not approved, then the contents of this field should be ignored.

Indicates the status of the last transaction. This field will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the Code should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

Contains the Address Verification System result code. This one character field contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this field will contain the following possible values:

American Payment Solutions

For American Payment Solutions, this field will contain the following possible values:

Barclay

For Barclay, the field will contain the following possible values:

BlueSnap

For BlueSnap, the field will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following fields:

The possible values for each result character are:

HSBC

For HSBC, the field will contain the following possible values:

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the field will contain the following possible values:

QBMS

For the QBMS gateway, the AVSResult field will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an AVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the field will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the field will contain the following possible values:

Worldpay

For Worldpay, the field will contain a 4-character string, which contains the AVS checks for the following fields:

The possible values for each result character are:

Worldpay Online

For Worldpay Online, the field will contain one of the following:

Indicates the status of the authorization request. This field contains the actual response code as returned by the Gateway. Unlike the Approved field, this Code field may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the Code as well as the Approved field. The Point of Sale system should evaluate this response code and NOT the Text to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

Contains the returned CVV2 result code if it was requested. This field contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

A gateway may also support custom codes or human-readable response messages in this field. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the field will contain:

Adyen

For Adyen, the field will contain:

Barclay

For Barclay, the field will contain:

BlueSnap

For BlueSnap, the field will contain:

(Note: There are some scenarios in which the field will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

For DataCash, the field will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the field will contain the following possible values:

Worldpay Online

For Worldpay Online, the field will contain one of the following:

The entire response returned from the gateway processor. This field contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response fields.

Additional error code returned by some gateways. If a gateway returns it, this field will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ErrorText for a human-readable description of this ErrorCode.

Additional error description returned by some gateways. If a gateway returns it, this field will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ErrorCode for an accompanying code which may be parsed and used by your application.

Invoice number submitted in authorization request (if applicable). This field contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

Response code from the underlying processor. Often times a Gateway will return a Code that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this field will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

Contains the Subscription or Profile Identifier for the recurring payment. This field contains a subscription identifier or profile number used to reference a recurring payment. This field is used when performing subsequent actions on a recurring payment.

Text information that describes each response code. This field contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

Contains the Visa Transaction Identifier or MasterCard Reference Number. This field contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

Customer's shipping street address.

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

Customer's shipping city.

Customer's shipping country. This field contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Customer's email address.

Customer's first name.

Customer's last name.

Customer's phone number.

Customer's shipping state.

Customer's shipping zip code (or postal code if outside of the USA).

Name of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.

This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

Value of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.

Note: This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The expiration month of the card currently being processed for the recurring payments.

The expiration year of the card currently being processed for the recurring payments.

The card number currently being processed for the recurring payments.

The date in which the recurring payments will stop processing.

The date is returned in the format specified within the DateFormat config.

The frequency in which payments will occur.

If FrequencyUnit is applicable, this field will contain the length of the corresponding FrequencyUnit in which payments will occur.

This component uses pre-defined Frequency values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.

• None
• Daily
• Weekly
• BiWeekly
• FourWeeks
• SemiMonthly
• Monthly
• BiMonthly
• Quarterly
• SemiAnnually
• Annually

The unit frequency in which the payments will be processed.

This component uses pre-defined FrequencyUnit values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.

• Days
• Weeks
• Months
• Years

The date that the last/previous transaction was processed.

The date is returned in the format specified within the DateFormat config.

The date of the next upcoming transaction.

The date is returned in the format specified within the DateFormat config.

The amount being charged on a recurring basis.

The total number of remaining payments until the recurring payments will stop processing.

The date in which the recurring payments started processing.

The date is returned in the format specified within the DateFormat config.

The current status of the recurring subscription.

Contains the Subscription or Profile Identifier for the recurring payment.

This field contains a subscription identifier or profile number used to reference a recurring payment.

Contains the name of the recurring subscription or profile.

The total number of payments.

This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Note: This setting is applicable only in Windows.

This field contains a password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

This field contains a user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

RecurringBilling Config Settings

This contains a 1-character transaction indicator identifying the type of transaction being authorized. Supported values vary between gateways, so please consult gateway documentation for more information. Note: Other values necessary for passing 3D Secure data are 3DSXID and 3DSCAVV. This setting is only valid for E-Commerce transactions.

This configuration setting can be used to specify a single input format for the InitialAmount and RecurAmount. When set to a value other than 0, the class will automatically convert the amount from the specified format to the format expected by the gateway. Valid values are:

Note that this setting is only designed for use with currencies that have two digits after the decimal point, like US dollars.

If this configuration setting is set to True when creating a customer profile (default False), the profile will be created as a guest profile. A guest profile will be deleted automatically after 90 days of inactivity. This setting can also be checked after getting the status of a customer profile to tell if it is a guest profile.

This config holds the masked card number that is stored in the payment profile selected by AuthNetCIMPaymentProfileIndex.

When updating a payment profile, this masked card number will be re-submitted if real card information is not specified, which prevents Authorize.Net from changing the card information on file. This makes it possible to update just the billing information associated with a payment profile without affecting the stored card information. This configuration setting can also be used when updating a subscription with the Authorize.NET gateway.

This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Payment Profiles assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMPaymentProfileIndex.

This config is used to retrieve or set the ID of a Payment Profile. This config will be populated after a Payment Profile is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '1' (Payment Profile), the Payment Profile ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus.

This is an actionable config that parses the Payment Profile contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMPaymentProfileCount. Index values less than 1 and greater than AuthNetCIMPaymentProfileCount will cause an exception to be thrown. When this config is set, the Payment Profile at the specified index will be parsed and the Card, ECheckBank, and Customer properties will be populated based on the data in the response.

This config is used to specify the request type to send for the Authorize.NET CIM gateway and is used in conjunction with the API methods to perform various actions.

The available request types are:

This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Shipping Addresses assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMShippingAddressIndex.

This config is used to retrieve or set the ID of a Shipping Address. This config will be populated after a Shipping Address is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '2' (Shipping Address), the Shipping Address ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus.

This is an actionable config that parses the Shipping Address contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMShippingAddressCount. Index values less than 1 and greater than AuthNetCIMShippingAddressCount will cause an exception to be thrown. When this config is set, the Shipping Address at the specified index will be parsed and the ShippingInfo properties will be populated based on the data in the response.

When getting the status of a subscription in the Authorize.Net gateway, if this configuration setting is set to "False" (default) GetSubScriptionStatus will only return the Status of the subscription in SubscriptionDetails. When set to "True", calling GetSubscriptionStatus will return more details about the subscription and populate other fields in SubscriptionDetails, as well as AuthNetCIMMaskedCardNumber, AuthNetCIMPaymentProfileId, AuthNetShipToCompany, and AuthNetCIMShippingAddressId.

This setting can be set to an Authorize.Net opaque data descriptor in order to use it in place of explicit card or bank account information. AuthNetOpaqueValue must also be set.

This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.

This setting can be set to an Authorize.Net opaque data value in order to use it in place of explicit card or bank account information. AuthNetOpaqueDescriptor must also be set.

This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.

This configuration setting can be used to set the company associated with the shipping address of the customer.

This config is used to specify the 'username' value to authenticate with the Bambora gateway and is only applicable when calling CreateSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 1. This configuration setting must be set when BASYSRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 2. This configuration setting must be set when BASYSRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription.

Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling CreateSubscription.

This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 3. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting BASYSRequestType configuration setting to 0. This configuration setting must be set when the BASYSRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription.

Customer status at the time the customer profile is created and BASYSRequestType is set to 0 (Default).

Possible values are:

The default value is 0 (Active).

Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.

Note: If only the billing date is to be updated, it is better to set the BASYSRequestType configuration setting to 4 and set the BASYSNumberOfDays configuration setting to the number of days to be added to the billing date.

This configuration setting must be set to the number of days to be added to the next billing date when BASYSRequestType configuration setting is set to 4 and when calling and UpdateSubscription. BASYSContractKey must also be set to the corresponding contract key.

When BASYSRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.

Possible values are:

The default value is 0 (Credit Card).

This configuration setting is used to specify the request type for the BASYS gateway.

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

The default value is 0 (Customer Profile).

This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting BASYSRequestType configuration setting to 5.

When BASYSRequestType is set to 5 (Get Token) a token type must be set to one of the following values.

Possible values are:

The default value is 0 (Gateway Format).

When BlueSnapRequestType is set to 2, this setting can be queried to determine how many card payment sources the last retrieved vaulted shopper profile has.

Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!

When BlueSnapRequestType is set to 2, this setting can be used to specify which of the last retrieved vaulted shopper's card payment sources the class should populate its fields with. Valid values are -1 to BlueSnapCardCount-1.

To add a new card payment source, set this to -1, which will cause the class to reset the populated fields to their default values.

To update an existing card payment source (be it the card expiration date or its billing information), first set this to the desired card's index, modify the fields you wish to change, and set the full card number and security code, and then call UpdateSubscription. (The update request will fail if you do not set the full card number and security code first, they are not returned when the vaulted shopper is retrieved.)

Note that the BlueSnap API makes no guarantee about the order of the card payment sources when it returns a vaulted shopper response. As such, it is important that you never assume that you know which card is at a particular index right after you call GetSubscriptionStatus or UpdateSubscription.

Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when updating a vaulted shopper profile's payment source: {"udf": [ { "udfValue": "aaa", "udfName": "ENT_UDF1" }, { "udfValue": "bbb", "udfName": "ENT_UDF2" } ]} Note: Content set using this setting will be used as the value of the transactionFraudInfo.enterpriseUdfs JSON field in the request body; it is not validated or manipulated first, it is used "as-is".

Each time this setting is queried, it will retrieve a new pfToken from BlueSnap. This token can then be passed to BlueSnap's hosted payment fields libraries, and then later passed in the vaulted shopper request using the special field pfToken. Refer to BlueSnap's documentation for more information about hosted payment fields.

This configuration setting is used to specify the request type for the BlueSnap gateway.

When you set the value of this setting, the class resets the properties, special fields, and configuration settings it uses to map to BlueSnap vaulted shopper fields. Only the following retain their values: Gateway, MerchantLogin, MerchantPassword, TestMode, BlueSnapVaultedShopperId, and Response fields (other than CVVResult and AVSResult, which are reset).

It is expected that you will call GetSubscriptionStatus to retrieve and populate the class with the latest vaulted shopper details after setting this (unless you plan to create a new vaulted shopper, or keep in mind that any fields not sent in an update request may be cleared by BlueSnap).

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

The default value is 0, which is the only valid request type when calling the CreateSubscription.

The other request types require you to set the Vaulted Shopper ID via the BlueSnapVaultedShopperId configuration setting, after which you may use the GetSubscriptionStatus and UpdateSubscription methods to retrieve and add/update vaulted shopper data (note that any method parameters are ignored).

Note that all basic information is automatically retrieved and then re-sent when adding/updating any payment source in order to prevent BlueSnap from clearing those fields.

This configuration setting must be set to a valid vaulted shopper ID when updating a BlueSnap vaulted shopper. After creating a new vaulted shopper, it will contain the newly created vaulted shopper's ID. See BlueSnapRequestType for more information.

This field is used for the gateways the support International card types. Supported gateways include: Adyen, Barclay, CyberSource, FastTransact, HSBC, NetBanx, NetBilling, Orbital, PayFuse, PaymentExpress, PayPoint, PlugNPay, SagePay, SECPay, and WorldPayXML. Switch, Solo, and some Maestro cards have a 1 or 2 digit Issue number printed on the front of the card, directly following the card number. If that issue number is present, it should be set with this config setting.

This configuration setting is used to specify the last 4 digits of the credit card in certain scenarios.

When set to "True" (default value), in the case of a manually entered card, the transaction will be processed with the card being identified as present. When set to "False", the transaction will be processed as a 'Card Not Present' transaction.

This config is currently applicable to the Heartland gateway.

If there is a Start Date present on the card, set the month here and the year in CardStartYear.

If there is a Start Date on present on the card, set the year here and the month in CardStartMonth.

This configuration setting is used to specify the credit card token (sometimes called a "nonce") to perform a transaction.

Note that this is only valid when the Gateway property is set to gwNuvei or gwSquare.

This config is used to specify the type of credit card being used in a retail transaction. The type will be computed by the component based on the Card data but this value can be specified to override any computed values.

The available card types are:

This configuration setting contains the Check Number. This is valid only for the BASYS, PhoeniXGate, and Repay gateways.

When set to 'true', the component will perform a checksum test on the RoutingNumber when CreateSubscription is called. This check helps identify errors within the specified RoutingNumber. Note that this check does not guarantee that the RoutingNumber is correct for the bank you wish to work with but does help in identifying mistyped numbers. The default value is 'false'.

When true, this setting indicates that the customer gave the merchant permission to perform a Card On File (COF) transaction. Currently only used by CardPointe (gwCardPointe).

This config contains the Customer's Company Name associated with the billing address.

This field is used to specify the total convenience fee charged for the transaction. This field is applicable to the FirstDataPayPoint and Litle / Vantiv gateway.

This field is used to set a password for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used. This config is applicable to the PlugNPay gateway.

This field is used to set a username for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used.

This setting determines whether CyberSource subscriptions will be deleted (True) or just cancelled (False) when the CancelSubscription method is called.

By default this setting is False; calling CancelSubscription will cause a subscription to be cancelled, but it will remain in the CyberSource Business Center.

If this setting is set to "True", the request field values will be XML escaped prior to being sent to the CyberSource gateway. If this setting is set to "False" (default), the class does not perform any XML escaping and the values are sent exactly as specified. The default value is "False".

This field is used to specify the date format to be used for the various date properties: StartDate, EndDate, StartDate, EndDate, NextPaymentDate, and LastPaymentDate. The date must be specified and will be displayed in the format specified. The default format is: "MM/dd/yyyy".

Applicable format values are:

When set to true, this config will cause the component to automatically escape the XML data in the request. The default value is false. This is currently only supported in the Authorize.Net XML and CIM gateways.

This config is used to specify the Customer Id for the Eway account and is used for authentication.

This setting may be used to specify the date that the InitialAmount should be charged. The date is based on the format specified via DateFormat and must be the same as, or before StartDate. This setting is optional.

This setting defines the transaction type for the Eway gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This setting is used when sending a registration request for the FirstDataPayPoint gateway. For the registration to be stored in First Data's system, the customer must be asked for approval of the registration process and this setting must be set to 'True'. If 'False' (default value) is set, the registration process will fail.

This setting defines the transaction type for the FirstDataPayPoint gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

Certain gateways allow the request to be hashed as an additional authentication mechanism. This configuration setting controls which algorithm is used for hashing. Valid values are:

Some gateways allow for the generation of a hash for added security. The following gateways support this config.

Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the MerchantLogin, TransactionId, and TransactionAmount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the class throws an exception. If the AIMHashSecret is left blank, this check will not be performed. The Server's Hash Secret may be set using the Authorize.Net online merchant interface, located at https://secure.authorize.net/.

Bank of America: This value will be the HMAC Key generated for you by the gateway. This value is required and an exception will be thrown if not specified.

BarClay and Ingenico: This value is optional and when specified 'SHASIGN' parameter will be computed and sent.

Bambora/Beanstream: If hash validation is required then set this to your hash key. HashAlgorithm will also need to be set accordingly.

Nuvei: This value is required in all transactions. The value is unique to each terminal and can be set through the online interface at "https://testpayments.nuvei.com/merchant/selfcare/".

USAePay: This value is optional and when a 'Pin' value is specified, the 'UMhash' parameter will be computed and sent.

This config contains the customer's date of birth as it appears on his driver's license. The format varies between gateways, so please see the specifications for correct formatting. This config may be used by the gateway for fraud screening.

This config contains the customer's driver's license number and may be used by the gateway for fraud screening.

This config contains the two-digit abbreviated postal code indicating the state in which the customer's driver's license was issued. This config may be used by the gateway for fraud screening.

This specifies the method used to identify the customer when performing a retail transaction.

Possible values are:

This setting specifies an XML aggregate when creating or updating a subscription for the Litle gateway. Specifically this allows you to create, update, or delete Discounts and AddOns. Please see the Litle XML Reference Guide for further information regarding these XML fields. This setting is only used when LitleTransactionType is set to '1' and CreateSubscription or UpdateSubscription is called.

This setting specifies the transaction type for the Litle gateway and is applicable when calling CreateSubscription, UpdateSubscription, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This setting specifies a trial frequency for the Litle gateway. It is used in conjunction with PaymentSchedule. Possible values are:

• "MONTH" (Trial interval of one month)
• "DAY" (Trial interval of one day).

For the CardPointe gateway, this configuration setting is required, and should contain your Merchant Id.

For the Litle gateway, this configuration setting is required, and should contain your Merchant Id.

For the MIT gateway, this configuration setting is required, and should contain your Merchant Number (Contado).

For the Priority Payment Systems gateway, this configuration setting is required, and should contain your Merchant Id.

For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your MerchantLogin (e.g., when processing AMEX transactions, or when supporting multiple currencies).

The last 4 digits of the account number are required to perform UpdateSubscription, CancelSubscription, and GetSubscriptionStatus methods for the MerchantPartners or the WorldPay Link gateways.

This setting is used to specify the encrypted reader type used to read and encrypt a swiped card. The specified value is sent in the request and is used by the gateway to decrypt the card data so the transaction can be processed.

Valid Values:

When making a Merchant Initiated Transaction (MIT), this configuration setting should be set to true to indicate to the payment gateway that the transaction is merchant initiated. Used by the Orbital payment gateway.

When making a Merchant Initiated Transaction (MIT), this configuration setting can be used to specify the transaction Id of a previously successful authorization. Used by the Orbital and CyberSource payment gateways.

When making a Merchant Initiated Transaction (MIT), this configuration setting is used to specify the type or reason for the merchant initiated transaction. The possible values and formats for this field vary by gateway, so check the gateway's documentation for the associated values and their meanings.

This field is used to specify your MyVirtualMerchant user Id which is required (along with MerchantLogin and MerchantPassword) as part of the user authentication.

The Version portion of the User-Agent HTTP header is required by NetBilling. The default value is "1".

This config is used when creating a secure card for Nuvei to list the terminals that will be allowed to use the created card. This should be a comma-separated list of terminal Ids, i.e. "11111,22222,33333".

This settings specifies the transaction type for the OmniFund gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

If OrbitalConnectionPassword is set, the OrbitalConnectionUsername should also be set. This field is case-sensitive.

If OrbitalConnectionUsername is set, the OrbitalConnectionPassword should also be set.

Note: This field is auto-populated to "NO" when OrbitalCustomerProfileFromOrderInd is set.

This config is used to specify the IP address of the payer, which is required by some gateways.

This field is used to specify the client code that is assigned by 3DSI. This code uniquely identifies your organization for the purpose of accessing and authenticating to the Payment WorkSuite.

This field is used to specify the location code that uniquely identifies a specific location that is associated with the merchant identified by the specified PaymentWorkSuiteMerchantCode.

This field is used to specify the merchant code that uniquely identifies a specific merchant within the Payment WorkSuite.

This config is used to specify the transaction type to send for the Payment WorkSuite gateway and is used in conjunction with the API methods to perform various actions.

The available transaction types are: