This property allows you to get or set an XML aggregate built from all of the Card properties. "EPCardType" is the root element. The Card properties make up the tags under the root, but without the beginning "Card". For instance: <EPCardType> <Number>4444333322221111</Number> <CVV2Data>996</CVV2Data> <CVVIndicator>cvPresent</CVVIndicator> <ExpMonth>12</ExpMonth> <ExpYear>2010</ExpYear> <Type>ctVisa</Type> </EPCardType>

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the 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 property 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 property which can be used to determine if the customer is actually in possession of the credit card.

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

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

Indicates the presence of the card verification value.

This property is used to indicate the presence of .

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

Available values are:

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

Expiration month of the credit card specified in .

This property 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 .

This property contains the expiration date of the customer's credit card. This property 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 property is validated.

By default, when the field is set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111". 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 field, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the may be affected, and the card number will not be verified.

Customer's credit card number for the transaction.

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

Customer's street address. This property 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 property. City, state, and zip code are set in the , , and properties.

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

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

class.CustomerAddress = "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 property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

Customer's city. This property 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 properties include , , and .

Customer's country. This property 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 property with the PayFuse gateway, this property 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 property contains the customer's email address.

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

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

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

Merchant-generated customer Id. This property 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 property contains the customer's last name as it appears on their credit card.

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

Customer's state. This property 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 properties include , , and .

Customer's zip code (or postal code if outside of the USA). This property 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 properties include , , and .

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

Indicates the status of the last transaction. This property 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 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.

The amount approved for the transaction, this is the amount actually charged to the credit card.

This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).

Contains the Address Verification System result code. This one character property 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 property will contain the following possible values:

American Payment Solutions

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

Barclay

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

BlueSnap

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

The possible values for each result character are:

HSBC

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

PayTrace / PayTraceJSON

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

QBMS

For the QBMS gateway, the property 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 of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

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

Stripe

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

Worldpay

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

The possible values for each result character are:

Worldpay Online

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

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the property, this property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the as well as the property. The Point of Sale system should evaluate this response code and NOT the 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 property 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 property. 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 property will contain:

Adyen

For Adyen, the property will contain:

Barclay

For Barclay, the property will contain:

BlueSnap

For BlueSnap, the property will contain:

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

DataCash

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

Stripe

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

Worldpay Online

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

The entire response returned from the gateway processor. This property 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 properties.

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

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

Invoice number submitted in authorization request (if applicable). This property 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 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 property 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.

Text information that describes each response code. This property 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 property 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 property. Data returned in this property (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 property 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 and properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

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

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

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

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

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

By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication.

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

If 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 is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of and .

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

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

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

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

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

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

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

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

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

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

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

iCharge Config Settings

This setting is used to pass the 3D Secure authentication status on to the transaction server. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include 3DSCAVV, 3DSXID and 3DSECI. This setting is only valid for E-Commerce transactions. Applicable values are:

This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be formatted as a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include 3DSXID and 3DSECI. This setting is only valid for E-Commerce transactions.

This setting is used to pass the directory server transaction Id to the gateway for 3DS 2.0. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the Gateway property is set to gwNetbanx.

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 setting is used to pass the cardholder's 3D Secure enrollment status to the gateway for 3D Secure 1.0.2. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the Gateway property is set to gwNetbanx.

This setting is used to pass the 3D Secure TransactionId (XID) data on to the gateway. This setting must be formatted as a 20-byte plaintext value, or a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. For example: Other settings necessary for passing 3D Secure data are 3DSCAVV and 3DSECI. This setting is only valid for E-Commerce transactions.

This configuration setting is used to specify the sales channel the shopper gives their card details through and whether the shopper is a returning customer. Default value is 0.

Available values are:

When set to 'True', partial authorizations will be allowed and must be handled accordingly. A partial authorization occurs when a customer's available funds for a specific card can only meet a portion of the total TransactionAmount. Therefore a second means of payment must be used to pay for the remaining amount. When such a case occurs, the partially approved amount will be made available via ResponseApprovedAmount. When set to 'False', if a customer's card does not have funds the available to account for the entire TransactionAmount the transaction will be declined. The default value is 'True'.

This configuration setting can be used to specify a single input format for the TransactionAmount property. 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.

This setting specifies the Base-64 encoded data containing the encrypted payment data received from Apple. The encrypted payment data must be retrieved in a separate process by communicating with the Apple Passbook app. Once the encrypted payment data is received from Apple set this configuration setting, which takes the place of Card, and perform either an AuthOnly or Sale transaction to process the payment.

This setting is applicable to the following gateways:

• Authorize.NET (gwAuthorizeNet)
• BlueSnap (gwBlueSnap)

This config is used to specify the type of request which will occur when the Sale method is called. By default it is set to Normal (0), in which case the class will send a normal transaction sale request.

The other options are used to instruct the class to send the appropriate type of request needed to query, create, update, or delete a customer vault record when Sale is called.

Possible values for this setting are:

• 0 - Normal (default)
• 1 - Add Customer Vault Record
• 2 - Update Customer Vault Record
• 3 - Delete Customer Vault Record
• 4 - Query Customer Vault Record

Please see the gateway setup information for American Payment Solutions for more details on how to use the ICharge class to work with customer vault records. Refer to American Payment Solutions' documentation for more information about the customer vault in general.

This configuration setting is used to specify the company in the billing information for the customer.

Note that this is only valid when the Gateway property is set to gwAuthorizeNetXML.

This config is used to specify the ID of a payment profile to be used to perform a transaction. A payment profile is tied to a AuthNetCIMProfileId and is used to identify the payment option to charge. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw card and billing data with the transaction. Therefore this property is required. Note: The RecurringBilling class can be used to manage payment profiles.

This config is used to specify the ID of a profile to be used to perform a transaction. A profile is used to identify the customer initiating the transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw customer data with the transaction. Therefore this property is required. Note: The RecurringBilling class can be used to manage profiles.

When requesting a CIM profile to be created by setting the AuthNetCreateCIMProfile configuration setting to True, this configuration setting will contain the response. For Example: icharge.Config("AuthNetCreateCIMProfile=True"); icharge.Sale(); Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));

Note that this is read-only and only valid when Gateway property is set to gwAuthorizeNetXML.

This config is used to specify the ID of a shipping address profile to be used to perform a transaction. A shipping address profile is tied to a AuthNetCIMProfileId and is used to identify the shipping location of the item purchased in the current transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access shipping information stored on their Customer Information Manager (CIM) instead of sending raw shipping data with the transaction. This property is optional. If an shipping address ID is not specified, shipping information will not be included with the transaction. Note: The RecurringBilling class can be used to manage shipping address profiles.

Whether to create a CIM profile for the customer during a Sale or AuthOnly transaction. By default this configuration setting is set to False. When set to True, the response for the profile creation will be returned in the AuthNetCIMProfileResponse configuration setting. For Example: icharge.Config("AuthNetCreateCIMProfile=True"); icharge.Sale(); Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));

Note that this is only valid when the Gateway property is set to gwAuthorizeNetXML.

This configuration setting is used to specify the value of the cryptogram received from the token provider. This configuration setting is required when AuthNetTokenizedCard configuration setting is set.

Note that this is only valid when calling Sale method and the Gateway property is set to gwAuthorizeNetXML.

This configuration setting is used to specify the customer type to send during a request to the Authorize.NET XML gateway. Default value is 0.

Available values are:

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.

When AllowPartialAuths configuration setting is set to true and there are not enough funds to cover the full transaction amount set using the TransactionAmount property, Authorize.NET will return a Split Tender Id that can be later used, to link to the original partially authorized transaction, to charge the full amount, void, or capture.

This configuration setting is used to specify the credit card token to perform a Sale transaction.

Note that this is only valid when calling Sale method and the Gateway property is set to gwAuthorizeNetXML.

This configuration setting is used to set the API passcode when using the passcode option for authentication with Bambora.

This configuration setting is required for some merchants when calling the Sale method, and must be set to the name of the card issuer. For example: icharge.Config("BankName=Wells Fargo"); icharge.Sale();

By default (value of 'False'), all maintenance transactions (such as Capture, Refund, and VoidTransaction) will close the transaction after the operation is performed. When set to 'True', the operation will be performed and the transaction will be left open for further processing. This config works in conjunction with the following methods:

AuthOnly

Capture

Refund

VoidTransaction

By default (value of 'False'), the Refund method will send a partial or full refund which closes the transaction. When this setting is set to 'True', a partial refund transaction will be sent and the transaction will be left open for another potential refund.

If BASYSProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.

Note: BASYSCardInfoKey can be obtained via the RecurringBilling class.

Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, BASYSCardInfoKey and MerchantCode configuration settings must also be set. For instance: icharge.Config("MerchantCode=YourBASYSMerchantKey"); icharge.Config("BASYSProcessRecurringCredit=True"); icharge.Config("BASYSCardInfoKey=YourBASYSCardInfoKey"); icharge.TransactionAmount = "1.00"; icharge.Sale();

Determines whether to process the transaction using a Credit Card Token provided by BASYS Gateway. By default this configuration setting is set to False. If set to True, BASYSTokenMode and BASYSToken must also be set. For Instance: icharge.Config("BASYSProcessTokenCredit=True"); icharge.Config("BASYSToken=YourToken"); icharge.TransactionAmount = "1.00"; icharge.Sale();

If BASYSProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.

Note: BASYSToken can be obtained via the RecurringBilling class.

Indicates the type of token that is being used for the transaction. If BASYSProcessTokenCredit is set to True this must be set to one of the following values.

Possible values:

If BASYSVoidMode is set to "0" (default), VoidTransaction sends a void to undo an unsettled transaction. If BASYSVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.

Possible values:

By default, when VoidTransaction is called with gwBluefin selected the request will use the REFUND transaction type, which is used to void an unsettled Sale transaction. Set this configuration setting to True to use the REVERSAL transaction type instead, which will void an uncaptured authorization. Note that the REVERSAL transaction type may or may not be allowed depending on the payment processor for the account.

This setting takes a previous transaction's ResponseTransactionId. For any parameters that are not set, BluePay will use values from the referenced transaction.

When set to true, the component will update a prevous transaction when the Sale method is called. BluePayMasterId must be set to the ResponseTransactionId of the previous request, and the transaction can only be updated before it has been settled by BluePay.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Sale or AuthOnly: {"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 transaction request using the special field pfToken or securityCodePfToken. Refer to BlueSnap's documentation for more information about hosted payment fields.

Setting this to a card transaction ID (or querying it with the TransactionId property set) will cause the class to retrieve the associated transaction and populate its fields accordingly. Please refer to the BlueSnap section of the "ICharge Gateway Setup and Required Properties" page for more information on how the class's fields map to BlueSnap's fields.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Sale or AuthOnly: {"metaData": [ { "metaValue": 20, "metaKey": "stateTaxAmount", "metaDescription": "State Tax Amount" }, { "metaValue": 20, "metaKey": "cityTaxAmount", "metaDescription": "City Tax Amount" }, { "metaValue": 10, "metaKey": "shippingAmount", "metaDescription": "Shipping Amount" } ]} Note: Content set using this setting will be used as the value of the transactionMetaData JSON field in the request body; it is not validated or manipulated first, it is used "as-is".

This config allows you to specify the way in which the transaction took place. This config is applicable to the Barclay, HSBC, and PayFuse gateways.

Applicable values are:

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.

This configuration setting is used to specify the encryption handler when requesting a token from CardPointe (gwCardPointe). This should be set to "RSA" if using a private key provided by CardPointe to encrypt the account value before sending. If the account value in the token request is not encrypted, this setting is not necessary.

This configuration setting is used to request a token from CardPointe (gwCardPointe). If CardToken is set, it will be used for the account in the request. If not, CardNumber will be used instead.

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 gwConverge, gwMoneris, gwNuvei, gwSquare, gwSquarePayments, gwStripe, or gwQBPayments.

This property will contain the CAVV response value to the authorization and will be populated along with Response. Values vary between gateways, so please consult gateway documentation for more information.

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 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 configuration setting is used to request a token when making a request to gwConverge. If this is set to 1 or 2 before calling Sale or AuthOnly, Converge will return a token in the response, which will be available through the CardToken configuration setting.

Possible values for this setting are:

• 0 - Don't request a token (default)
• 1 - Generate a token and return it in the response.
• 2 - Generate a token, add it to Converge's Card Manager, and return it in the response.

This config is used to specify the currency code to be used in the transaction. Default values and codes vary based on the gateway. This config will be populated with the default value for the gateway when Gateway is set.

For more information on these currency code values, please refer to the ISO 4217 standard as well as the gateway specification.

If not set, "2" is sent by default. Currently only supported in the Orbital and WorldPayXML gateways.

This configuration setting is used to specify a customer profile Id when performing a transaction.

Note that this is only valid when the Gateway property is set to gwCardPointe.

This config is used to specify a request token for authorization update transactions (such as captures, credits, voids, and reversals). This is only applicable when using the Atos interface.

This config allows you to specify a customer Profile Id to process a transaction using the customer's information stored within CyberSource's systems (this is known as Payment Tokenization). When specified, the ProfileId will be sent instead of the card data (when performing an AuthOnly or Sale) and thus the stored card in the customer's profile will be charged. Additionally you can Credit a card on a customer's profile by specifying a Profile Id and a TransactionId of "" (empty string). Please note that the component does NOT support creating, modifying, or deleting customer profiles. These will need to be created using the RecurringBilling component or by other means such as within CyberSource's Business Center.

If CyberSourceVoidMode is set to "Void" (default), VoidTransaction sends a void transaction to cancel a Capture or Credit request. Note a transaction can only be voided if CyberSource has not already submitted the capture or credit request to the processor (this is usually done once a day). If CyberSourceVoidMode is set to "Reverse", a full authorization reversal transaction is sent to reverse a previous authorization (i.e. after performing an AuthOnly transaction). Note in a reversal, it is required that TransactionAmount be set to the full amount authorized (as you cannot partially reverse an authorization).

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 config is used when sending 3D Secure data to the DataCash gateway. It indicates whether the cardholder was registered for 3D Secure and the PARes or VERes status. Available values are:

This config is used to specify whether an AuthOnly transaction should be treated as final. If the final settlement amount is not known, this config should be set to 'False' to indicate that the settlement amount will likely be changed prior to settlement. When set to 'True' or '' (empty string) (default value) the transaction will be treated as final. Note that with '' (empty string) the transaction will be treated as final unless the merchant configuration has been set up or there is a risk of reversal. MasterCard Europe and Maestro have created this mandate to improve the management of cardholder 'open to buy' limits.

The specified aggregate will be contained within the "ExtendedPolicy" element of the request.

The three available policies (elements) that can be specified are: "cv2_policy", "postcode_policy", and "address_policy". Each of these elements have five available attributes, "notprovided", "notchecked", "matched", "notmatched", "partialmatch", of which have the following available values: "accept" and "reject".

Below is a sample XML aggregate: <cv2_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="reject"/> <postcode_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="accept"/> <address_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="accept"/>

This field is used to specify a dynamic descriptor (sometimes called a soft descriptor) for the transaction. Typically this value is used to specify transaction specific details which will be displayed on the customer's credit card statement.

The following gateways currently support this functionality: Heartland.

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

This is an action config that will send a GetMethods request to the ExPay gateway. Method information returned in the response can be parsed via the GetResponseVar method or the X*** configuration settings.

This is an action config that will send a GetStatus request to the ExPay gateway. TransactionId or ExPayPaymentId is required (specifying both will result in an error). Status information returned in the response can be parsed via the GetResponseVar method or the X*** configuration settings.

This config is used to specify a payment Id to retrieve a transaction status for via ExPayGetStatus.

This config is used to specify the Id of the service (retrieved via a ExPayGetMethods call) and is required to perform an authorization via an AuthOnly call.

When returned in the response, this field will be populated with the current balance on the card used to process the transaction.

This field is used to specify the gift card transaction type you wish to perform. All gift card transactions are performed by setting the type via this config and calling the Sale method. When the transaction type is set to '0', the Sale, VoidTransaction and Refund methods can be called to perform their respective transactions. Note to process a gift card transaction, FDMSProcessGiftCard must be set to 'True'.

Applicable values are:

This config is used to specify the Key Id, obtained from FDMS, that corresponds to the HMAC Key (specified via HashSecret) and is sent within the Authorization header of the request.

When set to 'True', the current transaction will be run as a gift card transaction. The default value 'False', will perform a regular credit card transaction.

This config is used to both retrieve and specify a Transarmor Token for the First Data E4, Payeezy, and Bank Of America gateways. If your account is configured for Transarmor tokens, a token will be created by the server and returned via this config when performing a transaction using a Card data. Additionally, you can set this config to a previously retrieved token value and the token will be sent in the request rather than the Card data. This increases security as raw card data is no longer needed. Note when sending an FDMSTransArmorToken value, the CardType, CardExpMonth, and CardExpYear are required.

This field is used to specify a wallet provider when using a digital wallet like Apple Pay or Android Pay. By default this field is not sent, and no wallet provider is used.

Applicable values are:

This config is used to specify the refund password provided to you by Global Iris. When a refund is performed, the component will use the specified password to generate and send a 'refundhash' in the request. This value is required when performing a Refund transaction.

This is an action config which when called will send a create token request to the Global Payroll gateway. A successful response will contain the GlobalPayrollToken for the specified CardNumber.

This field is used to retrieve or specify a token value. This field will be populated after a call to GlobalPayrollCreateToken This field should be specified prior to performing a transaction using a token value instead of Card.

By default, the Password property is sent as the "password" field in all requests. If the GoEMerchantUseGatewayId configuration setting is set to True, the class will instead treat the password as the "gateway_id" field in all requests.

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, ResponseTransactionId, 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 . 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.

If HeartlandDeveloperId is set, the HeartlandVersionNumber should also be set. If set, this field must be exactly 6 characters in length.

This is issued by Heartland during registration.

This is issued by a Heartland Payment Systems Administrator during registration.

The Heartland gateway supports reversals of credit card transactions. To perform a reversal, TransactionAmount can be set and the VoidTransaction can be called. When performing a reversal, TransactionAmount must be set to the original authorized amount of the transaction you are performing the reversal on. This field should then be set to the settlement amount of the transaction (or the final authorized amount after the reversal is performed).

If Heartland provides a secret key for use with their API, this property can be used to send it to the gateway. When this key is set, the HeartlandLicenseId, HeartlandSiteId, HeartlandDeviceId, MerchantLogin and MerchantPassword are not required, and will not be sent to the gateway.

The ship day for the Heartland transaction. Valid values are 1 - 31.

The ship month for the Heartland transaction. Valid values are 1 - 12.

This is issued by Heartland during registration.

Heartland supplies an additional way to trace the transaction, beyond the InvoiceNumber and TransactionId.

The field is used to specify the type of token that should be returned when using the Heartland gateway. By setting this field to a value other than 0 (None), a Token will be requested and returned in the response via HeartlandTokenValue (provided one can be generated). Please see the "ICharge Gateway Setup and Required Properties" page for more details about using tokenization, as there are special merchant account configurations required.

The available mapping values are:

This field is used to retrieve a Heartland Token value when using Heartland Tokenization (which is accomplished by setting HeartlandTokenMapping to a value greater than 0). A token replaces the card number in all subsequent transactions thus increasing security. This field can also be used to specify a previously retrieved token value. When set, the specified token value will be sent in the request instead of the card number.

If HeartlandVersionNumber is set, the HeartlandDeveloperId should also be set. If set, this field must be exactly 4 characters in length.

This field is used to specify the Id for the AdvancedFraudChecks element for the Litle gateway. Custom attributes can also be included by using the AddSpecialField method with the name "CustomAttributeX", where X is a number from 1 to 5. For example: icharge.Config("LitleAdvancedFraudChecksId=ASDFG-AXXXXAB999"); icharge.AddSpecialField("CustomAttribute1", "One"); icharge.AddSpecialField("CustomAttribute2", "Two");

This field is used to specify an XML aggregate for Custom Billing support within the Litle gateway. When specifying custom billing, you can use either the phone or url child.

Below is a sample XML aggregate for the phone child: <phone>555-555-5555</phone> <descriptor>Billing Descriptor</descriptor>

Below is a sample XML aggregate for the url child: <url>retail.url</url> <descriptor>www.retail.com</descriptor>

The HSBC and PayFuse gateway both allow for a merchant alias to be specified (and in some cases it may be required). This field allows you to specify the alias.

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

This configuration setting is used to specify the source of a customer's data in an authorization request. For a "Card on File" request when the merchant is using data that they stored themselves, this value should be set to "Y". As per Merchant e-Solutions' documentation, valid values are:

This configuration setting is used to inform Merchant e-Solutions that the merchant will be storing a customer's credit card data. For the initial request, after which the customer's data will be stored, this should be set to true.

This configuration setting is used to inform Merchant e-Solutions that a transaction was initiated by the merchant and not by the cardholder.

This configuration setting is used to tell Merchant e-Solutions if a given transaction is Mail Order, Telephone Order, E-Commerce, or in person. As per Merchant e-Solutions' documentation, valid values are:

If this configuration setting contains a token during a request to MerchantESolutions, the token will be sent as part of the request. After a successful Sale, AuthOnly, or AVSOnly request with MerchantESolutionsTokenizeCard set, the token representing the card used in the request will be available by querying this configuration setting.

This configuration setting is used to request a tokenized card from Merchant e-Solutions. If it is set to true during a successful Sale, AuthOnly, or AVSOnly request, the response will include a token representing the card used in the transaction. Note that a token will not be requested if a token is already set in MerchantESolutionsToken.

The last 4 digits of the card number are required to process transactions using a stored profile Id (via MerchantPartnersProfileId) for the MerchantPartners or WorldPay Link gateways.

This field is used to specify the Profile Id of a stored profile and is used to process a transaction instead of specifying the card data. A profile is created via the RecurringBilling component and the SubscriptionId response field is used to obtain the profile Id to be set in this field. MerchantPartnersLast4Digits is a required field when using a stored profile. Note this config is only applicable to Sale and Credit transactions processed via the MerchantPartners or WorldPay Link gateways.

This configuration setting is used when setting the Locale for a 3-party request with Metrobank. Controls the language that will appear on the payment page where the user is redirected.

This configuration setting is used when setting the URL where a user will be redirected after a 3-party request with Metrobank. There must be a server listening at that URL to receive the transaction response.

When sending a 3-party request to Metrobank, this configuration setting should be used to skip sending the request and output it directly to the RawRequest configuration setting instead. It can then be included in the POST request through which the user is redirected.

After sending a 3-party request to Metrobank and receiving the response, this configuration setting can be used to manually enter the response data into the ICharge component to parse the response.

Metrobank allows a merchant to void Purchase, Capture, or Refund transactions, but the request must indicate which type of transaction to void. Valid values are: