CardType
TCardTypes
Default: 0

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.

CVVData
string
Default: ""

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.

CVVPresence
CCCVVPresences
Default: 0

Indicates the presence of the card verification value.

This field is used to indicate the presence of CVVData.

The component 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)

EntryDataSource
EntryDataSources
Default: 0

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

ExpMonth
int
Default: 1

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.

ExpYear
int
Default: 2000

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.

IsEncrypted
bool
Default: False

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.

MagneticStripe
string
Default: ""

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?"

component.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1) or component.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.

Number
string
Default: ""

Customer's credit card number for the transaction.

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

EffectiveDate
string (read-only)
Default: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
string (read-only)
Default: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string (read-only)
Default: ""

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

Fingerprint
string (read-only)
Default: ""

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

FingerprintSHA1
string (read-only)
Default: ""

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

FingerprintSHA256
string (read-only)
Default: ""

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

Issuer
string (read-only)
Default: ""

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

PrivateKey
string (read-only)
Default: ""

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.

PrivateKeyAvailable
bool (read-only)
Default: False

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).

PrivateKeyContainer
string (read-only)
Default: ""

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

PublicKey
string (read-only)
Default: ""

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

PublicKeyAlgorithm
string (read-only)
Default: ""

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.

PublicKeyLength
int (read-only)
Default: 0

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

SerialNumber
string (read-only)
Default: ""

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.

SignatureAlgorithm
string (read-only)
Default: ""

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.

Store
string
Default: "MY"

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte []
Default: "MY"

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

The type of certificate store for this certificate.

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

SubjectAltNames
string (read-only)
Default: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)
Default: ""

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.

ThumbprintSHA1
string (read-only)
Default: ""

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.

ThumbprintSHA256
string (read-only)
Default: ""

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.

Usage
string (read-only)
Default: ""

The text description of UsageFlags.

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

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

UsageFlags
int (read-only)
Default: 0

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.

Version
string (read-only)
Default: ""

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

Subject
string
Default: ""

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 as follows:

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

Encoded
string
Default: ""

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.

EncodedB
byte []
Default: ""

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.

AccountClass
AccountClass
Default: 0

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

Available values:

AccountHolderName
string
Default: ""

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.

AccountNumber
string
Default: ""

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.

AccountType
AccountTypes
Default: 0

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
string
Default: ""

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.

RoutingNumber
string
Default: ""

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.

Address
string
Default: ""

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:

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

Address2
string
Default: ""

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

Aggregate
string
Default: ""

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>

City
string
Default: ""

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.

Country
string
Default: ""

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".

Email
string
Default: ""

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

Fax
string
Default: ""

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

FirstName
string
Default: ""

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

FullName
string
Default: ""

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.

Id
string
Default: ""

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.

LastName
string
Default: ""

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

Phone
string
Default: ""

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

State
string
Default: ""

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.

Zip
string
Default: ""

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.

EndDate
string
Default: ""

The end date of the subscription.

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

Frequency
string
Default: ""

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.

FrequencyUnit
string
Default: ""

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"

InitialAmount
string
Default: ""

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

RecurAmount
string
Default: ""

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

StartDate
string
Default: ""

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.

TotalPayments
int
Default: 0

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

TrialPayments
int
Default: 0

The total number of trial payments.

ApprovalCode
string (read-only)
Default: ""

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.

Approved
bool (read-only)
Default: False

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.

AVSResult
string (read-only)
Default: ""

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:

Code
string (read-only)
Default: ""

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.

CVVResult
string (read-only)
Default: ""

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:

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:

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:

Data
string (read-only)
Default: ""

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.

ErrorCode
string (read-only)
Default: ""

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.

ErrorText
string (read-only)
Default: ""

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.

InvoiceNumber
string (read-only)
Default: ""

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.

ProcessorCode
string (read-only)
Default: ""

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.

SubscriptionId
string (read-only)
Default: ""

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
string (read-only)
Default: ""

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).

TransactionId
string (read-only)
Default: ""

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).

Address
string
Default: ""

Customer's shipping street address.

Address2
string
Default: ""

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

City
string
Default: ""

Customer's shipping city.

Country
string
Default: ""

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.

Email
string
Default: ""

Customer's email address.

FirstName
string
Default: ""

Customer's first name.

LastName
string
Default: ""

Customer's last name.

Phone
string
Default: ""

Customer's phone number.

State
string
Default: ""

Customer's shipping state.

Zip
string
Default: ""

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

Name
string
Default: ""

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 component by submitting additional information to the gateway.

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

Value
string
Default: ""

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 component by submitting additional information to the gateway.

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

CardExpMonth
int (read-only)
Default: 0

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

CardExpYear
int (read-only)
Default: 0

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

CardNumber
string (read-only)
Default: ""

The card number currently being processed for the recurring payments.

EndDate
string (read-only)
Default: ""

The date in which the recurring payments will stop processing.

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

Frequency
string (read-only)
Default: ""

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

FrequencyUnit
string (read-only)
Default: ""

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

LastPaymentDate
string (read-only)
Default: ""

The date that the last/previous transaction was processed.

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

NextPaymentDate
string (read-only)
Default: ""

The date of the next upcoming transaction.

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

RecurAmount
string (read-only)
Default: ""

The amount being charged on a recurring basis.

RemainingPayments
int (read-only)
Default: 0

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

StartDate
string (read-only)
Default: ""

The date in which the recurring payments started processing.

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

Status
string (read-only)
Default: ""

The current status of the recurring subscription.

SubscriptionId
string (read-only)
Default: ""

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.

SubscriptionName
string (read-only)
Default: ""

Contains the name of the recurring subscription or profile.

TotalPayments
int (read-only)
Default: 0

The total number of payments.

AuthScheme
ProxyAuthSchemes
Default: 0

The 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 component. Look at the configuration file for the component 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.

AutoDetect
bool
Default: False

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
string
Default: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields 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.

Port
int
Default: 80

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

Server
string
Default: ""

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.

SSL
ProxySSLTypes
Default: 0

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

User
string
Default: ""

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields 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.