Search: 
Available in: EPAY
ICharge Component [IBiz E-Payment Integrator V3]

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 CardNumber, CardExpMonth, CardExpYear, and TransactionAmount properties. Most gateways will also require additional properties, such as CustomerAddress, CustomerFirstName, CustomerLastName, 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 he Credit method. Please note that some gateways use the Credit method for both voids and credits. See the TransactionType property 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)http://www.ibill.com
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 (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)http://www.protx.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
Transaction Central (55)Used by several other gateways.
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
NOVA/My Virtual Merchant (61)http://www.myvirtualmerchant.com
Sage Payment Solutions Bankcard HTTPS (62)http://www.sagepayments.com
SecurePay (Script API/COM Object Interface) (63)http://securepay.com
Moneris eSelect Plus USA (64)http://www.moneris.com

Property List


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

CardCVV2Data A three digit security code located on the back of many credit cards (optional).
CardExpMonth Expiration month of the credit card specified in CardNumber.
CardExpYear Expiration year of the credit card specified in CardNumber.
CardNumber Customer's credit card number for this transaction.
CardType Type of credit card being used in this transaction.
CustomerAddress Customer's street address.
CustomerCity Customer's city.
CustomerCountry Customer's country.
CustomerEmail Customer's email address.
CustomerFax Customer's fax number.
CustomerFirstName Customer's first 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).
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
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.
ProxyAuthorization Similar to the Authorization property, but for proxy authorization.
ProxyPassword A password if Basic authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxySSL Determines when to use SSL for the connection to the proxy.
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if Basic authentication is to be used for the proxy.
ResponseAVS Contains the Address Verification System result code.
ResponseApprovalCode Contains an authorization code when a transaction has been approved.
ResponseCVV2 Contains the returned CVV2 result code if it was requested.
ResponseCode Indicates the status of the authorization request.
ResponseData The entire response returned from the gateway processor.
ResponseInvoiceNumber Invoice number submitted in authorization request (if applicable).
ResponseText Text information that describes each response code.
ResponseTransactionId Contains the Visa Transaction Identifier or MasterCard Reference Number.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
SpecialFieldCount Number of special gateway configuration fields to include in the transaction.
SpecialFieldNames Array of special gateway field names to submit in this transaction.
SpecialFieldValues Array of special gateway field values to submit in this transaction.
Timeout A timeout for the component.
TransactionAmount Purchase amount for an authorization transaction.
TransactionApproved Indicates the status of the last transaction.
TransactionDesc Description of goods purchased.
TransactionId Transaction Id used for Capture, Credit, and Void transactions.
TransactionType Specifies the type of transaction to process.

Method List


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

AddSpecialField Adds a special field name and the corresponding value.
Authorize Initiates an authorization request transaction.
Capture Captures a previously authorized transaction.
Config Sets or retrieves a component configuration setting.
Credit Credits a previously captured transaction.
GetQBAggregate Exports the XML required to reconcile with QuickBooks.
Interrupt Interrupts the current action.
PreAuthorize Runs pre-authorization checks on the customer's credit card data.
ResetData Clears all properties to their default values.
ResetSpecialFields Resets all special fields to the default settings.
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 complete descriptions.

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 complete descriptions.

AIMHashSecret Extra security key for Authorize.Net's AIM (3.1) protocol.
AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AuthCode Authorization Code for FORCE (voice auth) transactions.
Authorize.Net The version of the Authorize.Net protocol the component uses.
CVV2Indicator Extra information about why no CVV2 data was passed
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyCode Currency code for the Orbital gateway.
CurrencyExponent Currency exponent for the Orbital gateway.
EFSNetCreditMode Indicates whether to use Credits or Refunds.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
GoEMerchantUseGatewayId Indicates whether to send a password or gateway Id for the GoEMerchant gateway.
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
IssueNumber Special Issue Number used for Switch and Solo cards
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
MerchantAlias PayFuse requires this additional merchant property.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
PayFuseTestMode Used to set various test modes for the PayFuse gateway.
ProtxUseAbort Indicates whether to use Abort or Void for void transactions.
ProtxUseDirectRefund Indicates whether to use Refund or DirectRefund for Credit transactions.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
Referer The Bank of America gateway requires that the control send an HTTP referer header.
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
SocketHandle The handle of the main socket used by the component.
StartMonth Used for some international cards
StartYear Used for some international cards
TerminalId Terminal Id number for the Orbital gateway.
TestMode Test mode flag for LinkPoint
TimeZone Merchant's numeric time zone code
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
ValidateCardNumber Determines whether data set to the CardNumber property is validated.
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

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