Search: 
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:

GatewayHome page
No Gateway (0) n/a
Authorize.Net (1)http://www.authorize.net
DPI Link (2)This gateway is no longer in service.
eProcessing (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 (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)http://www.viaklix.com
USA ePay (13)http://www.usaepay.com
Plug 'n Pay (14)http://www.plugnpay.com
Planet Payment (15)http://planetpayment.com/
MPCS (16)http://merchantcommerce.net/
RTWare (17)http://www.rtware.net/
ECX (18)http://www.ecx.com
Bank of America (19)http://bankofamerica.com/merchantservices
Innovative Gateway (20)http://www.innovativegateway.com
Merchant Anywhere (Transaction Central) (21)http://www.merchantanywhere.com/
SkipJack (22)http://www.skipjack.com
ECHOnline (23)http://www.echo-inc.com
3 Delta Systems (3DSI) EC-Linx(24)http://www.3dsi.com
TrustCommerce (25)http://www.trustcommerce.com
PSIGate (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 (32)http://gateway.usight.com
Fast Transact (33)http://www.fasttransact.com/
NetworkMerchants (34)http://www.networkmerchants.com/
Ogone DirectLink(35)http://www.ogone.be
Concord EFSNet (36)http://www.concordefsnet.com/
Payment Resources International PRIGate (37)http://www.paymentresource.com/TransactionCentral.asp
Protx (38) (Depreciated, use SagePay (67) instead)http://www.sagepay.com
Optimal Payments / FirePay Direct Payment Protocol (39)http://www.optimalpayments.com/
Merchant Partners (40)http://www.merchantpartners.com/
CyberCash (41)http://www.cybercash.net/
FirstData / CardService International (42)http://www.firstdata.com
YourPay (43)http://www.yourpay.com
ACH Payments (44)http://www.ach-payments.com
Payments Gateway (45)https://www.paymentsgateway.net/
Cyber Source SOAP API (46)http://www.cybersource.com
eWay (Australia) (47)http://www.eway.com.au/
goEmerchant XML(48)http://www.goemerchant.com/
PayStream (Australia)(49)http://www.paystream.com.au
TransFirst eLink(50)http://www.transfirst.com
Chase Merchant Services (51)http://www.chase.com
PSIGate XML Interface (52)http://www.psigate.com
NexCommerce (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 (57)http://www.sterlingpayment.com
PayJunction Trinity Gateway (58)http://www.payjunction.com
SECPay (59)http://www.secpay.com
Payment Express PXPost (60)http://www.paymentexpress.com
Elavon/My Virtual Merchant (61)http://www.myvirtualmerchant.com
Sage Payment Solutions (Bankcard HTTPS 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 (65)http://beanstream.com
Verifi (66)http://www.verifi.com
SagePay Direct (Previously Protx) (67)http://www.sagepay.com
Merchant E-Solutions (68)http://merchante-solutions.com/
PayLeap Web Services API (69)http://www.payleap.com
PayPoint.net (Previously SECPay) (70)http://paypoint.net
Worldpay XML (Direct/Invisible) (71)http://www.worldpay.com

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.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
ProxyA set of properties related to proxy access.
ResponseContains the response to the authorization.
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 previously captured transaction.
ForceUsed when authorization cannot be obtained online.
GetResponseVarParses additional information out of the response.
InterruptInterrupts the current action.
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.

AIMHashSecretExtra security key for Authorize.Net's AIM (3.1) protocol
CurrencyCodeCurrency code for the Orbital and CyberSource gateway
CurrencyExponentCurrency exponent for the Orbital gateway
CustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway
CyberSourceShipToShipTo xml aggregate for use with the CyberSource gateway
EFSNetCreditModeIndicates whether to use Credits or Refunds
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway
IssueNumberSpecial Issue Number used for Switch and Solo cards
MerchantAliasPayFuse requires this additional merchant property
ProtxUseAbortIndicates whether to use Abort or Void for void transactions
ProtxUseDirectRefundIndicates whether to use Refund or DirectRefund for Credit transactions
RawRequestReturns the data that was sent to the gateway
RefererThe Bank of America gateway requires that the control send an HTTP referer header
StartMonthUsed for some international cards
StartYearUsed for some international cards
TerminalIdTerminal Id number for the Orbital gateway, or Installation Id for Worldpay
TimeZoneMerchant's numeric time zone code
ValidateCardNumberDetermines whether data set to the CardNumber property is validated
AcceptEncodingUsed to tell the server which types of content encodings the client supports
AllowHTTPCompressionThis property enables HTTP compression for receiving data
AuthorizationThe Authorization string to be sent to the server
EncodeURLIf set to true the URL will be encoded by the component
GetOn302RedirectIf set to true the component will perform a GET on the new location
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
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
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
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component
UsePlatformHTTPClientWhether or not to use the platform HTTP client
UserAgentInformation about the user agent (browser)
UseWinInetIf set, the WinInet API is used for retrieving the URL
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet
UseIPv6Whether or not to use IPv6
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
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;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
TcpNoDelayWhether or not to delay when sending packets
ReuseSSLSessionDetermines if the SSL session is reused
SSLCipherStrengthThe minimum cipher strength used for bulk encryption
SSLEnabledProtocolsUsed to enable/disable the supported security protocols
SSLProviderThe name of the security provider to use
SSLSecurityFlagsFlags that control certificate verification
OpenSSLCADirThe path to a directory containing CA certificates
OpenSSLCAFileName of the file containing the list of CA's trusted by your application
OpenSSLCipherListA string that controls the ciphers to be used by SSL
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG)
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
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.