E-Payment Integrator 2020 .NET Edition

Questions / Feedback?

ICharge Component

Properties   Methods   Events   Configuration Settings   Errors  

The ICharge component is used to authorize credit card transactions with any of the supported Internet Payment Gateways.

Syntax

DPayments.InPay.Icharge

Remarks

The ICharge component allows you to use multiple Internet Payment Gateways through one interface and one component. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.

The ICharge component allows your website to securely perform credit card transactions without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the component's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.

The first thing you must do is select one of the many gateways supported by the ICharge component, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the ICharge component.

To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.

Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.

Now you are ready to process transactions. For each transaction, you must set the Number, ExpMonth, ExpYear, and TransactionAmount properties. Most gateways will also require additional properties, such as Address, FirstName, LastName, InvoiceNumber, etc. Any additional required properties are listed in the Gateway property description.

Once these properties are set, you may run validity checks on the card data with the AVSOnly method, or simply authorize the transaction with the Sale method. If your Gateway supports it, you may also Void transactions that have not yet gone to settlement with the VoidTransaction method. Transactions that have already been settled may be refunded with the Credit method. Please note that some gateways use the Credit method for both voids and credits. See the transaction methods for more information.

The following gateways are supported by the ICharge component:

GatewayHome page
No Gateway (0) n/a
Authorize.Net AIM (1)http://www.authorize.net
eProcessing Transparent Database Engine (2)http://www.eProcessingNetwork.com
Intellipay ExpertLink (3)http://www.intellipay.com
iTransact RediCharge HTML (4)http://www.itransact.com
NetBilling DirectMode (5)http://www.netbilling.com
PayFlow Pro (6)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
USA ePay CGI Transaction Gateway (7)http://www.usaepay.com
Plug 'n Pay (8)http://www.plugnpay.com
Planet Payment iPay (9)http://planetpayment.com/
MPCS (10)http://merchantcommerce.net/
RTWare (11)http://www.rtware.net/
ECX (12)http://www.ecx.com
Bank of America (Global Gateway e4) (13)http://bankofamerica.com/merchantservices
Innovative Gateway (PHP) (14)http://www.innovativegateway.com
Merchant Anywhere (Transaction Central Classic) (15)http://www.merchantanywhere.com/
SkipJack (16)http://www.skipjack.com
3 Delta Systems (3DSI) EC-Linx (18)http://www.3dsi.com
TrustCommerce API (19)http://www.trustcommerce.com
PSIGate HTML (20)http://www.psigate.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
PayFlow Link (22)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
Chase Paymentech Orbital Gateway (23)https://merchantservices.chase.com/
LinkPoint (24)http://www.linkpoint.com
Moneris eSelect Plus Canada (25)http://www.moneris.com
uSight Gateway Post-Auth (26)This gateway is no longer in service.
Fast Transact VeloCT (Direct Mode) (27)http://www.fasttransact.com/
NetworkMerchants Direct-Post API (28)http://www.nmi.com/
Ingenico DirectLink / Ogone (29)https://www.ingenico.be/
TransFirst Transaction Central Classic (formerly PRIGate) (30)http://www.transfirst.com
Merchant Partners (Transaction Engine) (31)http://www.merchantpartners.com/
CyberCash (32)https://www.paypal.com/cybercash
First Data Global Gateway (Linkpoint) (33)http://www.firstdata.com
YourPay (Linkpoint) (34) http://www.yourpay.com
ACH Payments AGI (35)http://www.ach-payments.com
Forte AGI / Payments Gateway AGI(36)https://www.forte.net/
Cyber Source SOAP API (37)http://www.cybersource.com
eWay XML API (Australia) (38)http://www.eway.com.au/
goEmerchant XML (39)http://www.goemerchant.com/
TransFirst eLink (40)http://www.transfirst.com
Chase Merchant Services (Linkpoint) (41)http://www.chase.com
Thompson Merchant Services NexCommerce (iTransact mode) (42)http://www.thompsonmerchant.com
WorldPay Select Junior Invisible (43)http://www.worldpay.com
TransFirst Transaction Central Classic (44)http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Sterling SPOT XML API (HTTPS POST) (45)http://www.sterlingpayment.com
PayJunction Trinity Gateway (46)http://www.payjunction.com
SECPay (United Kingdom) API Solution(47)http://www.secpay.com
Payment Express PXPost (48)http://www.paymentexpress.com
Elavon/NOVA/My Virtual Merchant (49)https://support.convergepay.com/s/
Sage Payment Solutions (Bankcard HTTPS Post protocol) (50)http://www.sagepayments.com
SecurePay (Script API/COM Object Interface) (51)http://securepay.com
Moneris eSelect Plus USA (52)http://www.moneris.com
Bambora / Beanstream Process Transaction API (53)https://www.bambora.com/en/ca/
Verifi Direct-Post API (54)http://www.verifi.com
SagePay Direct (Previously Protx) (55)https://www.opayo.uk/
Merchant E-Solutions Payment Gateway (Trident API) (56)http://merchante-solutions.com/
PayLeap Web Services API (57)http://www.payleap.com
PayPoint.net (Previously SECPay) API Solution (58)http://paypoint.net
Worldpay XML (Direct/Invisible) (59)http://www.worldpay.com
ProPay Merchant Services API (60)http://www.propay.com
Intuit QuickBooks Merchant Services (QBMS) (61)This gateway is no longer in service. It has been replaced by Quickbooks Payments (113).
Heartland POS Gateway (62)http://www.heartlandpaymentsystems.com/
Litle / Vantiv Online Gateway (63)http://www.litle.com/
BrainTree DirectPost (Server-to-Server Orange) Gateway (64)http://www.braintreepaymentsolutions.com/
JetPay Gateway (65)http://www.jetpay.com/
HSBC XML API (ClearCommerce Engine) (66)https://www.business.hsbc.uk/en-gb/payments/business-card
BluePay 2.0 Post (67)http://www.bluepay.com
Adyen API Payments (68)http://www.adyen.com
Barclay ePDQ (DirectLink) (69)http://www.barclaycard.co.uk/business/
PayTrace Payment Gateway (70)https://www.paytrace.net/
YKC Gateway (71)http://www.ykc-bos.co.jp/
OmniFund HTTP API / GoToBilling(73)http://omnifund.com/
TransNational Bankcard (74)http://www.tnbci.com/
Netbanx (75)http://www.netbanx.com/
MIT (76)http://www.centrodepagos.com.mx
DataCash (77)http://www.datacash.com/
ACH Federal (78)http://www.achfederal.com/
Global Iris (HSBC) (79)https://www.globalpaymentsinc.com/en-gb
First Data Global Gateway E4 (80)http://www.firstdata.com
First Atlantic Commerce (81)http://www.firstatlanticcommerce.com/
Bluefin (82)http://www.bluefin.com/
Payscape (83)http://www.payscape.com
Pay Direct (Link2Gov) (84)https://www.fisglobal.com/solutions/other/government/
Authorize.NET CIM (85)http://www.authorize.net
5th Dimension Logistics (86)http://www.5thdl.com/
WorldPay US Link Gateway (87)https://www.worldpay.com/en-us/index
3DSI Payment WorkSuite (88)http://www.3dsi.com/
PSIGate XML (89)http://www.psigate.com
First Data PayPoint (90)https://www.firstdata.com/en_us/products/financial_institutions.html
ExPay Gateway (91)http://www.expay.asia
Payvision Gateway (92)http://www.payvision.com/
Converge (formerly MyVirtualMerchant) (93)https://support.convergepay.com/s/
Payeezy Gateway (formerly First Data E4) (94)https://developer.payeezy.com/
Monetra Gateway (95)http://www.monetra.com
Authorize.NET XML (96)http://www.authorize.net/
PhoeniXGate Gateway (97)http://www.phoenixmanagednetworks.com/
Repay Gateway (98)https://www.repay.com/
Global Payroll Gateway (99)https://www.gpgway.com/
PayWiser Gateway (100)https://paywiser.eu/
Veritas Gateway (101)http://www.veritaspay.com/
Stripe Gateway (102)http://www.stripe.com/
KartePay Gateway (103)https://www.kartepay.com/
BlueSnap Gateway (104)https://home.bluesnap.com/
American Payment Solutions (105)https://www.apspayments.com/
BASYS Gateway (106)https://basyspro.com/
Worldpay Online (107)https://www.worldpay.com
Square (108)https://www.squareup.com
Priority Payment Systems (109)https://prioritypaymentsystems.com
Nuvei / GlobalOnePay (110)https://nuvei.com/en-us/
CardPointe (111)https://cardconnect.com/cardpointe
Metrobank (112)https://www.metrobankcard.com/
Quickbooks Payments (113)https://quickbooks.intuit.com/payments/
Shift4 (114)https://www.shift4.com/
Square Payments (115)https://squareup.com/us/en
Heartland Portico Gateway (116)http://www.heartlandpaymentsystems.com/
PayTrace Payment Gateway JSON (117)https://www.paytrace.net/

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthCodeAuthorization code from a previous transaction.
CardContains the customer's credit card information.
CustomerContains the customer's name, address, and other identifying information.
GatewayGateway to process transactions with.
GatewayURLDefault URL for a specific Gateway .
InvoiceNumberMerchant-generated invoice number.
Level2AggregateThe level 2 aggregate containing the data to be sent in the request.
Level3AggregateThe level 3 aggregate containing the data to be sent in the request.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
ProxyA set of properties related to proxy access.
ResponseContains the response to the authorization.
ShippingInfoContains the customer's shipping name, address, and other identifying information.
SpecialFieldsA list of additional fields to send in the request.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TestModeTurns test mode on and off for transactions sent to the current Gateway .
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization transaction.
TransactionDescDescription of goods purchased.
TransactionIdMerchant-generated transaction Id used for all transactions.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddSpecialFieldAdds a special field name and the corresponding value.
AuthOnlyInitiates an authorization-only request transaction.
AVSOnlyUsed to check the validity of the card without authorizing funds.
CaptureCaptures a previously authorized transaction.
ConfigSets or retrieves a configuration setting.
CreditCredits a customer's card.
DoEventsProcesses events from the internal message queue.
ForceUsed when authorization cannot be obtained online.
GetResponseVarParses additional information out of the response.
InterruptInterrupts the current action.
RefundRefunds a previously captured transaction.
ResetClears all properties to their default values.
ResetSpecialFieldsResets all special fields to the default settings.
SaleInitiates an Sale transaction (authorization and capture).
VoidTransactionVoids a previously authorized transaction.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

3DSAuthenticationStatusIndicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction.
3DSCAVVCardholder Authentication Verification Value from a 3D Secure authentication.
3DSDSTransactionIdDirectory server transaction Id from a 3D Secure authentication.
3DSECIElectronic Commerce Indicator.
3DSEnrollmentStatusIndicates whether 3D Secure authentication is available for the cardholder.
3DSXIDTransactionId from a 3D Secure authentication.
AdyenShopperInteractionSpecifies the sales channel the shopper gives their card details through.
AllowPartialAuthsSpecifies whether partial authorizations are allowed.
AmountFormatUsed to set the input format for TransactionAmount.
ApplePayDataThe Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions.
APSRequestTypeSpecifies the request type to use for the American Payment Solutions gateway.
AuthNetBillToCompanyThe company that should be included with the customer's information for the Authorize.NET XML gateway.
AuthNetCIMPaymentProfileIdThe Payment Profile ID assigned by Authorize.NET CIM gateway.
AuthNetCIMProfileIdThe Profile ID assigned by Authorize.NET CIM gateway.
AuthNetCIMProfileResponseProfile creation response.
AuthNetCIMShippingAddressIdThe Shipping Address ID assigned by Authorize.NET CIM gateway.
AuthNetCreateCIMProfileWhether to create a CIM Profile.
AuthNetCryptogramTokenized credit card cryptogram.
AuthNetCustomerTypeSpecifies the customer type for the Authorize.NET XML gateway.
AuthNetOpaqueDescriptorAn Authorize.Net opaque data descriptor.
AuthNetOpaqueValueAn Authorize.Net opaque data value.
AuthNetShipToCompanyThe name of the company associated with the customer's shipping address.
AuthNetSplitTenderIdAuthorize.Net assigned id for partially authorized transactions.
AuthNetTokenizedCardThe credit card token.
BamboraPasscodeThe API passcode used for authentication with Bambora.
BankNameName of the card issuer.
BarclayKeepTransactionOpenDetermines whether to perform a maintenance transaction that keeps the transaction open for further processing with the Barclay and Ingenico gateways.
BarclayPartialRefundDetermines whether to send a partial or full refund transaction with the Barclay and Ingenico gateways.
BASYSCardInfoKeyBASYS Gateway Credit Card Profile Id.
BASYSProcessRecurringCreditDetermines whether to process the transaction via Credit Card Profile Id.
BASYSProcessTokenCreditDetermines whether to process the transaction using a Credit Card Token.
BASYSTokenBASYS Gateway Credit Card Token.
BASYSTokenModeIndicates the type of token that is being used for the transaction.
BASYSVoidModeIndicates whether to perform a Void or Reversal.
BluefinReversalDetermines which transaction type will be use for VoidTransaction with the Bluefin gateway.
BluePayMasterIdUsed to reference a previous transaction in BluePay.
BluePayUpdateUsed to perform an Update transaction for BluePay.
BlueSnapEnterpriseUdfsUser-Defined Fields (UDFs) to send with a BlueSnap Sale or AuthOnly request.
BlueSnapGetTokenRetrieves a new hosted payment fields token (pfToken) from BlueSnap.
BlueSnapRetrieveTransactionRetrieves a BlueSnap transaction.
BlueSnapTransactionMetaDataTransaction metadata to send with a BlueSnap Sale or AuthOnly request.
CardholderPresentCodeSpecifies the way in which transaction took place.
CardIssueNumberSpecial Issue Number used for Switch and Solo cards.
CardLast4DigitsThe last 4 digits of a credit card.
CardPointeEncryptionHandlerThe encryption handler to use when requesting a token from CardPointe.
CardPointeGetTokenRetrieves an account token from CardPointe.
CardStartMonthUsed for some international cards.
CardStartYearUsed for some international cards.
CardTokenThe credit card token.
CAVVResponseContains CAVV response value returned by the gateway.
COFPermissionIndicates if the customer gave permission to make a Card On File transaction.
ConvenienceFeeThe total convenience fee charged for a transaction.
ConvergeTokenModeUsed to request a token from the Converge gateway.
CurrencyCodeCurrency code for the currency of the transaction.
CurrencyExponentCurrency exponent to be used in conjunction with the Currency code of the transaction.
CustomerProfileIdUsed to send a customer profile Id to a gateway.
CyberSourceAuthTokenThe request token from a previous authorization for the CyberSource gateway.
CyberSourceProfileIdThe Id of a Customer's Profile stored within the CyberSource gateway.
CyberSourceVoidModeIndicates whether to perform a Void or Reversal.
CyberSourceXMLEscapeDetermines whether to XML escape the CyberSource gateway request field values.
DataCash3DSCardholderRegisteredIndicates whether the cardholder was registered for 3D Secure for the DataCash gateway.
DataCashAuthOnlyFinalityIndicates whether an AuthOnly transaction should be treated as final for the DataCash gateway.
DataCashExtendedPolicyAggregateUsed to specify an XML aggregate for Extended Policies within the DataCash gateway.
DynamicDescriptorA merchant defined transaction description which appears on the customer's credit card statement.
EscapeXMLAutomatically escape data within XML tags.
ExPayGetMethodsUsed to send a GetMethods request to the ExPay gateway.
ExPayGetStatusUsed to send a GetStatus request to the ExPay gateway.
ExPayPaymentIdThe payment Id used to retrieve a transaction status for the ExPay gateway.
ExPayServiceIdThe Id of the service to use to perform an authorization for the ExPay gateway.
FDMSCurrentBalanceContains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSGiftCardTransactionTypeSpecifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSKeyIdThe Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSProcessGiftCardSpecifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSTransArmorTokenThe Transarmor token that replaces a card number and used for transaction processing.
FDMSWalletProviderIdSpecifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
GlobalIrisRefundPasswordThe Refund password for the Global Iris gateway.
GlobalPayrollCreateTokenSends a create token request to the Global Payroll gateway.
GlobalPayrollTokenThe token value for a corresponding card when using the Global Payroll gateway.
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway.
HashAlgorithmAlgorithm used for hashing.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
HeartlandDeveloperIdOptional DeveloperId field used by the Heartland gateway.
HeartlandDeviceIdDeviceId field required by the Heartland gateway.
HeartlandLicenseIdLicenseId field required by the Heartland gateway.
HeartlandReversalAmountThe settlement amount to be used when performing a reversal for the Heartland gateway.
HeartlandSecretAPIKeySpecifies the secret key to be used for authentication with Heartland.
HeartlandShipDayShip day field required by the Heartland gateway e-commerce/direct marketing transactions.
HeartlandShipMonthShip month field required by the Heartland gateway e-commerce/direct marketing transactions.
HeartlandSiteIdSiteId field required by the Heartland gateway.
HeartlandSiteTraceOptional transaction identifier for the Heartland gateway.
HeartlandTokenMappingThe type of token to return when using Tokenization with the Heartland gateway.
HeartlandTokenValueUsed to retrieve or specify a Heartland token value.
HeartlandVersionNumberOptional VersionNumber field used by the Heartland gateway.
LitleAdvancedFraudChecksIdUsed to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway.
LitleCustomBillingAggregateUsed to specify an XML aggregate for Custom Billing support within the Litle gateway.
MerchantAliasAn additional merchant property used to specify an alias for the merchant.
MerchantCodeA gateway-supplied merchant number, code, or Id.
MerchantESolutionsAccountDataSourceSpecifies the source of a customer's data in an authorization request to Merchant e-Solutions.
MerchantESolutionsCardOnFileTells Merchant e-Solutions that you will be storing card information.
MerchantESolutionsMerchantInitiatedTells Merchant e-Solutions that you are performing a Merchant Initiated Transaction.
MerchantESolutionsMotoECommerceIndUsed to tell Merchant e-Solutions if a transaction is Mail Order, Telephone Order, or E-Commerce.
MerchantESolutionsTokenHolds a token representing card information stored by Merchant e-Solutions.
MerchantESolutionsTokenizeCardWhen set, will request a tokenized card from Merchant e-Solutions.
MerchantPartnersLast4DigitsThe last 4 digits of the card number for a transaction processed via the MerchantPartners gateway.
MerchantPartnersProfileIdThe profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.
MetrobankLocaleSets the locale for a 3-party request to Metrobank.
MetrobankReturnURLSets the URL where a user will be redirected after a 3-party request to Metrobank.
MetrobankThreePartyRequestIndicates that the component should return data for a 3-party request to Metrobank.
MetrobankThreePartyResponseUsed to manually parse a response after a 3-Party request to Metrobank.
MetrobankVoidTypeUsed to type of transaction should be voided in a request to Metrobank.
MITAESSeedIdThe Seed Id used to perform AES encryption for the MIT gateway.
MITBranchIdBranch reference number for the MIT gateway.
MITCompanyIdCompany reference number for the MIT gateway.
MITCountryCountry of operation for the MIT gateway.
MITEncryptionAlgorithmThe Encryption Algorithm to use with the MIT gateway.
MITEncryptionKeyThe Encryption Key to use with the MIT gateway.
MITFlagFor the MIT framework - Used to indicate that a transaction is merchant initiated.
MITPriorTransIdFor the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.
MITRecurringSpecifies whether to perform a recurring transaction request for the MIT gateway.
MITTPOperationThe operation type for the MIT gateway.
MITTypeFor the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).
MonerisNVPAPIIndicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway.
MyVirtualMerchantTransactionTypeUsed to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways.
MyVirtualMerchantUserIdThe MyVirtualMerchant user Id as configured on VirtualMerchant.
NetbanxAccountNumberAccount Number for the Netbanx gateway.
NetBillingVersionThe Version to be sent in the User-Agent heading of a NetBilling gateway request.
OrbitalAuthReversalIndicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway.
OrbitalConnectionPasswordOrbital Connection Password field used by the Orbital gateway.
OrbitalConnectionUsernameOrbital Connection Username field used by the Orbital gateway.
OrbitalCustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway.
OrbitalCustomerProfileIdThe Id for a customer profile in the Orbital gateway.
OrbitalCustomerProfileOrderOverrideIndIndicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
OrbitalDigitalTokenCryptogramHolds the cryptogram when making a CDPT request with Orbital.
OrbitalDPANIndicatorIndicates the type of a CDPT authorization with Orbital.
OrbitalTxRefIdxIndentifies the unique components of transactions that have been adjusted more than one time for the Orbital gateway.
OrbitalVoidAdjustedAmountSpecifies the amount to void from a previous authoization for the Orbital gateway.
PayDirectConvenienceFeeThe total convenience fee charged when using the PayDirect gateway.
PayDirectMerchantAmountThe MerchantAmount used by the PayDirect gateway.
PayDirectSettleMerchantCodeThe Settle Merchant Code required for authorization when using the PayDirect gateway.
PayerIPThe IP address of the payer.
PayFlowProInquirySubmits an Inquiry transaction to the PayFlowPro gateway.
PayFlowProTokenUsed specify a token to be used instead of card data for the Payflow Pro gateway.
PayFlowProUploadSubmits an Upload transaction to the PayFlowPro gateway.
PayJunctionUpdateAmountIndicates whether the capture method should send an update amount request when using the PayJunction gateway.
PaymentWorkSuiteClientCodeThe 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteLocationCodeThe 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteMerchantCodeThe 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.
PayPointFreedomAPIIndicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways.
PayTraceAddPurchaseCardDataSends a Level3 request for the PayTrace gateway.
PayTraceIntegratorIdUsed to specify the Integrator Id value assigned by the PayTrace gateway.
PayTraceJSONCardTokenThe token value for a corresponding card.
PayTraceJSONEncryptionKeyThe Encryption Key to use with the PayTraceJSON gateway.
PayTraceJSONGetClientKeyTokenRetrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace.
PayvisionTransactionGuidThe GUID obtained with an authorization for the Payvision gateway.
PayWiserCaptureReferenceIdThe capture reference id returned by PayWiser after doing a Sale transaction.
PayWiserCardTokenThe token value for a corresponding card when using the PayWiser gateway.
PayWiserEMerchantPayDetermines whether to process the transaction via E-Merchant Pay Acquiring Bank.
PayWiserReserveReferenceIdThe reserve reference id returned by PayWiser after doing a Sale transaction.
PayWiserTokenizeCardWhether to generate a Token Reference Id.
PayWiserTokenReferenceIdThe token reference id for a corresponding card when using the PayWiser gateway.
PhoeniXGateCardInfoKeyPhoeniXGate Gateway Credit Card Profile Id.
PhoeniXGateProcessRecurringCreditDetermines whether to process the transaction via Credit Card Profile Id.
PhoeniXGateProcessTokenCreditDetermines whether to process the transaction using a Credit Card Token.
PhoeniXGateTokenPhoeniXGate Gateway Credit Card Token.
PhoeniXGateTokenModeIndicates the type of token that is being used for the transaction.
PhoeniXGateVoidModeIndicates whether to perform a Void or Reversal.
PKPaymentTokenUsed to send an Apple Pay PKPaymentToken to the gateway.
PPSPaymentTokenA Priority Payment Systems payment token.
QBMSMobileWhether or not this transaction is being sent from a mobile device.
QBPaymentsMobileWhether or not this transaction is being sent from a mobile device.
RawRequestReturns the data that was sent to the gateway.
RawResponseReturns the data that was received from the gateway.
RecurringIndicatorMarks a request as a recurring transaction.
RepayCardInfoKeyRepay Gateway Credit Card Profile Id.
RepayProcessRecurringCreditDetermines whether to process the transaction via Credit Card Profile Id.
RepayProcessTokenCreditDetermines whether to process the transaction using a Credit Card Token.
RepayTokenRepay Gateway Credit Card Token.
RepayTokenModeIndicates the type of token that is being used for the transaction.
RepayVoidModeIndicates whether to perform a Void or Reversal.
ResponseCardNumberThe card number as returned in the response from the gateway.
ResponseCardTypeThe card type as returned in the response from the gateway.
SagePayCreateTokenSends a create token request to the SagePay gateway.
SagePayRemoveTokenSends a remove token request to the SagePay gateway.
SagePayRepeatPerforms a Repeat transaction for the SagePay gateway.
SagePayRequestTokenSpecifies whether to request a token when performing an Auth or Sale when using the SagePay gateway.
SagePayStoreTokenSpecifies whether to store a token when using the SagePay gateway.
SagePayTokenThe token value for a corresponding card when using the SagePay gateway.
SagePayUseAbortIndicates whether to use Abort or Void for void transactions.
Shift4AuthTokenSpecifies the Auth Token when making an Access Token request to the Shift4 gateway.
Shift4ClientGuidSpecifies the Client Guid when making an Access Token request to the Shift4 gateway.
Shift4GetAccessTokenPerforms an Access Token Exchange request with the Shift4 gateway.
Shift4InterfaceNameSpecifies the name of the interface for the Shift4 gateway.
Shift4InterfaceVersionSpecifies the version of the interface for the Shift4 gateway.
SquareAdditionalRecipientsAdditional recipients data to send with a Square Sale or AuthOnly request.
SquareApplicationFeeAllows you to specify an application fee as part of the transaction.
SquareCustomerCardIdThe Id of the card saved to a customer profile.
SquareIdempotencyKeyValue that uniquely identifies a Square Sale, AuthOnly, or Refund request.
SquareLocationIdSquare location Id to make the transaction request against.
SquareOrderIdSquare Order Id to associate with a Square Sale or AuthOnly request.
SquareTenderIdSquare Tender Id associated with a Square transaction.
StoreCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).
StripeApplicationFeeA fee in cents that will be applied to the charge.
StripeDestinationAccountId of an existing, connected Stripe account.
StripeDestinationAmountThe amount to transfer to the destination account.
StripeOnBehalfOfThe Stripe account Id that these funds are intended for.
StripeRefundApplicationFeeWhether the application fee should be refunded when refunding the charge.
StripeRefundReasonReason for the refund.
StripeRefundReverseTransferWhether the transfer should be reversed when refunding the charge.
StripeShippingCarrierThe delivery service that shipped a physical product.
StripeShippingTrackingNumberThe tracking number for a physical product.
StripeTransferGroupIdentifies the transaction as part of a group.
StripeVersionDetermines which version of the Stripe API should be used.
SurchargeAmountUsed to specify the amount of the surcharge for the transaction.
TerminalIdTerminal Id value sent in the transaction.
TipAmountUsed to specify the amount of the tip for the transaction.
USAEPayPerformVoidReleaseSpecifies whether to perform a void or void:release transaction.
UseCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.
UserIdUsed to specify an Id for the API user.
VeritasBankNameName of the card issuer.
VeritasEncryptionKeyEncryption key used to encrypt credit card information.
VeritasEncryptionKeyEncryption key used to encrypt credit card information.
VeritasTokenVeritas token.
VeritasVoidRefundReasonIdVeritas gateway void reason.
WorldpayOnlineTokenWorldpay Online token.
WorldpayOnlineTokenActionUsed to generate, update, or delete a Worldpay Online token.
XChildrenCountThe number of child elements of the current element.
XChildrenName[x]The name of the child element.
XChildrenXText[x]The inner text of the child element.
XElementThe name of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 4D Payments Inc. - All rights reserved.
E-Payment Integrator 2020 .NET Edition - Version 20.0 [Build 8153]