E-Payment Integrator Credit Card Processing Component : Credit Card Processing OCX, Credit Card Processing .NET Component, Credit Card Processing Class, Credit Card Processing Bean, Credit Card Processing Object

Available in: EPAY

ICharge Component [E-Payment Integrator V5]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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 Card, Card, Card, and TransactionAmount properties. Most gateways will also require additional properties, such as Customer, Customer, Customer, 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 PreAuthorize method, or simply authorize the transaction with the Authorize 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:


Gateway	Home page
No Gateway (0)	n/a
Authorize.Net AIM(1)	http://www.authorize.net
DPI Link (2)	This gateway is no longer in service.
eProcessing Transparent Databse Engine(3)	http://www.eProcessingNetwork.com
GoRealTime (Full-pass) (4)	http://www.gorealtime.com
IBill Processing Plus (5)	This gateway is no longer in service.
Intellipay ExpertLink (6)	http://www.intellipay.com
Iongate (7)	This gateway is no longer in service.
iTransact RediCharge HTML (8)	http://www.itransact.com
NetBilling DirectMode(9)	http://www.netbilling.com
Verisign PayFlow Pro (10)	https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-pro-overview-outside
Payready Link (11)	This gateway is no longer in service.
NOVA's Viaklix (12)	This gateway is no longer in service.
USA ePay CGI Transaction Gateway(13)	http://www.usaepay.com
Plug 'n Pay (14)	http://www.plugnpay.com
Planet Payment iPay(15)	http://planetpayment.com/
MPCS (16)	http://merchantcommerce.net/
RTWare (17)	http://www.rtware.net/
ECX (18)	http://www.ecx.com
Bank of America eStores (Form Post)(19)	http://bankofamerica.com/merchantservices
Innovative Gateway (PHP)(20)	http://www.innovativegateway.com
Merchant Anywhere (Transaction Central) (21)	http://www.merchantanywhere.com/
SkipJack (22)	http://www.skipjack.com
ECHOnline NVP API(23)	http://www.echo-inc.com
3 Delta Systems (3DSI) EC-Linx(24)	http://www.3dsi.com
TrustCommerce API(25)	http://www.trustcommerce.com
PSIGate XML(26)	http://www.psigate.com
PayFuse XML(27)	http://www.firstnationalmerchants.com/
PayFlowLink (28)	http://www.verisign.com
Paymentech Orbital Gateway V4.3(29)	http://www.paymentech.com
LinkPoint (30)	http://www.linkpoint.com
Moneris eSelect Plus Canada(31)	http://www.moneris.com
uSight Gateway Post-Auth(32)	http://gateway.usight.com
Fast Transact VeloCT (Direct Mode)(33)	http://www.fasttransact.com/
NetworkMerchants Direct-Post API(34)	http://www.nmi.com/
Ogone DirectLink(35)	http://www.ogone.be
Concord EFSNet (36) (Depreciated, use LinkPoint)	https://secure.todaysebiz.com
TransFirst Transaction Central Classic (formerly PRIGate) (37)	www.transfirst.com
Protx (38) (Depreciated, use SagePay (67) instead)	http://www.sagepay.com
Optimal Payments / FirePay Direct Payment Protocol (39)	http://www.optimalpayments.com/
Merchant Partners (Transaction Engine) (40)	http://www.merchantpartners.com/
CyberCash (41)	http://www.cybercash.net/
First Data Global Gateway (Linkpoint) (42)	http://www.firstdata.com
YourPay (43) (Depreciated, use Linkpoint (42) instead)	http://www.yourpay.com
ACH Payments AGI (44)	http://www.ach-payments.com
Payments Gateway AGI(45)	https://www.paymentsgateway.net/
Cyber Source SOAP API (46)	http://www.cybersource.com
eWay XML API (Australia) (47)	http://www.eway.com.au/
goEmerchant XML(48)	http://www.goemerchant.com/
PayStream Web Services (SOAP) Interface (Australia)(49)	http://www.paystream.com.au
TransFirst eLink(50)	http://www.transfirst.com
Chase Merchant Services (Linkpoint) (51)	http://www.chase.com
PSIGate XML Interface (52)	http://www.psigate.com
Thompson Merchant Services NexCommerce (iTransact mode) (53)	http://www.thompsonmerchant.com
WorldPay Select Junior Invisible (54)	http://www.worldpay.com
TransFirst Transaction Central (55)	http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Paygea (56)	http://www.paygea.com/
Sterling SPOT API (HTTPS POST)(57)	http://www.sterlingpayment.com
PayJunction Trinity Gateway (58)	http://www.payjunction.com
SECPay (United Kingdom) API Solution(59)	http://www.secpay.com
Payment Express PXPost (60)	http://www.paymentexpress.com
Elavon/NOVA/My Virtual Merchant (61)	http://www.myvirtualmerchant.com
Sage Payment Solutions (Bankcard HTTPS Post protocol)(62)	http://www.sagepayments.com
SecurePay (Script API/COM Object Interface) (63)	http://securepay.com
Moneris eSelect Plus USA (64)	http://www.moneris.com
Beanstream Process Transaction API(65)	http://beanstream.com
Verifi Direct-Post API(66)	http://www.verifi.com
SagePay Direct (Previously Protx) (67)	http://www.sagepay.com
Merchant E-Solutions Payment Gateway (Trident API)(68)	http://merchante-solutions.com/
PayLeap Web Services API (69)	http://www.payleap.com
PayPoint.net (Previously SECPay) API Solution (70)	http://paypoint.net
Worldpay XML (Direct/Invisible) (71)	http://www.worldpay.com
ProPay Merchant Services API (72)	http://www.propay.com
Intuit QuickBooks Merchant Services (QBMS) (73)	http://payments.intuit.com/
Heartland POS Gateway (74)	http://www.heartlandpaymentsystems.com/
Litle Online Gateway (75)	http://www.litle.com/
BrainTree DirectPost (Server-to-Server) Gateway (76)	http://www.braintreepaymentsolutions.com/
JetPay Gateway (77)	http://www.jetpay.com/
Sterling XML Gateway (78)	http://www.securenet.com
Landmark Flat File HTTPS Post (79)	http://landmarkclearing.com/
HSBC XML API (80)	http://www.business.hsbc.co.uk/1/2/business-banking/business-payment-processing/business-debit-and-credit-card-processing
BluePay 2.0 Post (81)	http://www.bluepay.com
Adyen API Payments (82)	http://www.adyen.com
Barclay XML API (83)	http://www.barclaycard.co.uk/business/
PayTrace Payment Gateway (84)	http://www.paytrace.com/
YKC Gateway (85)	http://www.ykc-bos.co.jp/
Cyberbit Gateway (86)	http://www.cyberbit.eu/

Property List

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


AuthCode	Authorization code from a previous transaction.
CardAggregate	This property allows you to get or set an XML aggregate built from all of the Card properties.
CardType	Type of credit card being used in this transaction.
CardCVV2Data	A three digit security code located on the back of many credit cards (optional).
CardCVVIndicator	If you do not send any data in the CVV2Data property, some gateways require a reason that the card verification value was not included in the authorization request.
CardExpMonth	Expiration month of the credit card specified in Number .
CardExpYear	Expiration year of the credit card specified in Number .
CardNumber	Customer's credit card number for this transaction.
CustomerAddress	Customer's street address.
CustomerAggregate	This property allows you to get or set an XML aggregate built from all of the Customer properties.
CustomerCity	Customer's city.
CustomerCountry	Customer's country.
CustomerEmail	Customer's email address.
CustomerFax	Customer's fax number.
CustomerFirstName	Customer's first name.
CustomerFullName	Customer's full name.
CustomerId	Merchant-generated customer Id.
CustomerLastName	Customer's last name.
CustomerPhone	Customer's phone number.
CustomerState	Customer's state.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
Gateway	Gateway to process transactions with.
GatewayURL	Default URL for a specific Gateway.
InvoiceNumber	Merchant-generated invoice number.
MerchantLogin	Merchant's Gateway login.
MerchantPassword	Merchant's Gateway password.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
ResponseApprovalCode	Contains an authorization code when a transaction has been approved.
ResponseApproved	Indicates the status of the last transaction.
ResponseAVSResult	Contains the Address Verification System result code.
ResponseCode	Indicates the status of the authorization request.
ResponseCVVResult	Contains the returned CVV2 result code if it was requested.
ResponseData	The entire response returned from the gateway processor.
ResponseErrorCode	Additional error code returned by some gateways.
ResponseErrorText	Additional error description returned by some gateways.
ResponseInvoiceNumber	Invoice number submitted in authorization request (if applicable).
ResponseProcessorCode	Response code from the underlying processor.
ResponseText	Text information that describes each response code.
ResponseTransactionId	Contains the Visa Transaction Identifier or MasterCard Reference Number.
SpecialFieldCount	The number of records in the SpecialField arrays.
SpecialFieldName	Name of special configuration property to submit in this transaction.
SpecialFieldValue	Value of special configuration property to submit in this transaction.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
TestMode	Turns test mode on and off for transactions sent to the current Gateway.
Timeout	A timeout for the component.
TransactionAmount	Purchase amount for an authorization transaction.
TransactionDesc	Description of goods purchased.
TransactionId	Merchant-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.


AddSpecialField	Adds a special field name and the corresponding value.
AuthOnly	Initiates an authorization-only request transaction.
AVSOnly	Used to check the validity of the card without authorizing funds.
Capture	Captures a previously authorized transaction.
Config	Sets or retrieves a configuration setting.
Credit	Credits a previously captured transaction.
Force	Used when authorization cannot be obtained online.
GetResponseVar	Parses additional information out of the response.
Interrupt	Interrupts the current action.
Reset	Clears all properties to their default values.
ResetSpecialFields	Resets all special fields to the default settings.
Sale	Initiates an Sale transaction (authorization and capture).
VoidTransaction	Voids 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.


Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows 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.


AIMHashSecret	Extra security key for Authorize.Net's AIM (3.1) protocol.
CurrencyCode	Currency code for the Orbital, WorldPayXML, PayPoint, Adyen, YKC, Cyberbit, and CyberSource gateways.
CurrencyExponent	Currency exponent for the Orbital gateway.
CustomerProfileFromOrderInd	Customer Profile Number generation Options for the Orbital gateway.
CyberSourceShipTo	ShipTo xml aggregate for use with the CyberSource gateway.
EFSNetCreditMode	Indicates whether to use Credits or Refunds.
GoEMerchantUseGatewayId	Indicates whether to send a password or gateway Id for the GoEMerchant gateway.
IssueNumber	Special Issue Number used for Switch and Solo cards.
MerchantAlias	PayFuse requires this additional merchant property.
ProtxUseAbort	Indicates whether to use Abort or Void for void transactions.
RawRequest	Returns the data that was sent to the gateway.
Referer	The Bank of America gateway requires that the control send an HTTP referer header.
StartMonth	Used for some international cards.
StartYear	Used for some international cards.
TerminalId	Terminal Id number for the Orbital, PlanetPayment gateways, or Installation Id for Worldpay.
TimeZone	Merchant's numeric time zone code.
USAePayCreditMode	Determines what type of credit will be performed, open credit or referenced credit.
ValidateCardNumber	Determines whether data set to the CardNumber property is validated.
PFPInquiry	Submits an Inquiry transaction to the PayFlowPro gateway.
LicenseId	LicenseId field required by the Heartland gateway.
SiteId	SiteId field required by the Heartland gateway.
SiteTrace	Optional transaction identifier for the Heartland gateway.
DeviceId	DeviceId field required by the Heartland gateway.
DeveloperId	Optional DeveloperId field used by the Heartland gateway.
VersionNumber	Optional VersionNumber field used by the Heartland gateway.
MerchantCode	Required field for the Litle gateway, and optional field for the WorldPayXML gateway.
OrbitalSalemUsername	Orbital Connection Username field used by the Orbital gateway.
OrbitalSalemPassword	Orbital Connection Password field used by the Orbital gateway.
PONumber	PONumber field used by the LinkPoint gateway.
MagneticStripe	Magnetic stripe data used by the LinkPoint and Litle gateway.
TrackData	Magnetic stripe data used by the LinkPoint and Litle gateway.
Capability	Capability field of pos structure used by the Litle gateway.
EntryMode	EntryMode field of pos structure used by the Litle gateway.
CardHolderID	CardHolderID field of pos structure used by the Litle gateway.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.