GlobalCharge Component

Properties   Methods   Events   Config Settings   Errors  

The GlobalCharge component is used to authorize credit card transactions with the Global Payments system, using the Global Transport Direct API. This component supports Direct Marketing, e-Commerce, Retail, and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

DPayments.DPaymentsSDK.Globalcharge

Remarks

First, set the UserId and Password with your login information. If you're submitting test transactions and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

After the merchant information is setup, you may enter transaction data. When the credit card's EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For swiped transactions (Retail and Restaurant industries) the EntryDataSource should be set to edsMagneticStripe and, the MagneticStripe field should be filled with the trackdata read from the card. In addition, the TransactionAmount should be set with the total amount for the transaction.

Now simply call the Sale or AuthOnly method to send the authorization to the Global Transport Server.

The result of the authorization request will be stored in the Response property. The Code field will contain the status of the request and the Text field will contain the human-readable response message. The contents of the Response should be logged after a successful transaction.

You may also use this component to Capture previously made AuthOnly transactions, void (VoidTransaction), Refund, and Reverse transactions, and validate address data without charging the card using AVSOnly.

Once a transaction request is approved, the transaction is added to the current batch on the Global Transport Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through Settlement in order for the blocked money to be transferred to the merchant's account.

If your Global Transport account is setup with the Host Auto Settle feature, you need take no further action. The Global Transport system will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant.

If your account is not set up to automatically settle transactions at the end of the day, then at the end of the day you will need to use the GlobalBatchMgr component to capture the transactions in the batch.

Property List

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

Method List

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

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.

Config Settings

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

Card Property (GlobalCharge Component)

Contains the customer's credit card information.

Syntax

• C#
• VB.NET

public CCCard Card { get; set; }

Public Property Card As CCCard

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

This property is not available at design time.

CustomerAddress Property (GlobalCharge Component)

Cardholder's billing street address, which is used for address verification.

Syntax

• C#
• VB.NET

public string CustomerAddress { get; set; }

Public Property CustomerAddress As String

Default Value

""

Remarks

This property is optional, but is required for the lowest rate on keyed transactions. This may contain up to 20 alphanumeric characters, but only the numeric portion of the street address is actually necessary for AVS checking.

CustomerId Property (GlobalCharge Component)

Contains a merchant-assigned number to identify the customer.

Syntax

• C#
• VB.NET

public string CustomerId { get; set; }

Public Property CustomerId As String

Default Value

""

Remarks

This property may contain a unique number that identifies a specific customer. The merchant defines and assigns this number to their customer. It may be up to 24 alphanumeric characters in length.

CustomerName Property (GlobalCharge Component)

The cardholder's name as it appears on the card.

Syntax

• C#
• VB.NET

public string CustomerName { get; set; }

Public Property CustomerName As String

Default Value

""

Remarks

This optional field may contain up to 26 alphanumeric characters and symbols.

CustomerZip Property (GlobalCharge Component)

The Cardholder's billing postal code, which is used in address verification.

Syntax

• C#
• VB.NET

public string CustomerZip { get; set; }

Public Property CustomerZip As String

Default Value

""

Remarks

This property is optional, but is required for the lowest rate on keyed transactions. This may contain up to 9 alphanumeric characters. Note that the supported Canadian postal code formats are "LNL NLN" and "LNLNLN".

GratuityAmount Property (GlobalCharge Component)

Tip portion of the TransactionAmount .

Syntax

• C#
• VB.NET

public string GratuityAmount { get; set; }

Public Property GratuityAmount As String

Default Value

""

Remarks

This property is only applicable to Restaurant (table service) transactions. It may contain up to 8 characters in the format "DDDDD.CC", left-justified with no fill. (eg "1.99").

Note that the TransactionAmount should always include any GratuityAmount. For example, if the sale price of the transaction is $10.00, and the tip on the transaction is $3.00 (for a grand total of $13.00), the TransactionAmount property should contain "13.00" and the GratuityAmount property should contain "3.00".

InvoiceNumber Property (GlobalCharge Component)

Optional invoice tracking number.

Syntax

• C#
• VB.NET

public string InvoiceNumber { get; set; }

Public Property InvoiceNumber As String

Default Value

""

Remarks

The maximum length for American Express cards is 16 characters, and 25 characters for all other card types. This property is required for the lowest rate on keyed transactions.

Password Property (GlobalCharge Component)

Password for authentication with the Global Payments Server

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Proxy Property (GlobalCharge Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

PurchaseOrderNum Property (GlobalCharge Component)

Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions.

Syntax

• C#
• VB.NET

public string PurchaseOrderNum { get; set; }

Public Property PurchaseOrderNum As String

Default Value

""

Remarks

This property may contain a Purchase Order Number from the customer. It may be up to 17 alphanumeric characters in length.

RegisterNumber Property (GlobalCharge Component)

A number that uniquely identifies the register or computer on which the transaction was performed.

Syntax

• C#
• VB.NET

public string RegisterNumber { get; set; }

Public Property RegisterNumber As String

Default Value

""

Remarks

This may be up to 10 alphanumeric characters in length.

Response Property (GlobalCharge Component)

Contains the response to a transaction.

Syntax

• C#
• VB.NET

public GlobalChargeResponse Response { get; }

Public ReadOnly Property Response As GlobalChargeResponse

Remarks

This property will contain the response returned from the Global Payments server. It should be inspected (and logged) after every transaction. The GlobalChargeResponse type contains the following fields:

This property is read-only.

Server Property (GlobalCharge Component)

Global Payments transaction server.

Syntax

• C#
• VB.NET

public string Server { get; set; }

Public Property Server As String

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

ServerId Property (GlobalCharge Component)

Unique server identification number.

Syntax

• C#
• VB.NET

public string ServerId { get; set; }

Public Property ServerId As String

Default Value

""

Remarks

This property is used to identify the unique server (waiter/waitress) making the transaction. This only applies to Restaurant (table service) transactions, and may be up to 4 alphanumeric characters in length.

SSLAcceptServerCert Property (GlobalCharge Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (GlobalCharge Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (GlobalCharge Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public GlobalchargeSSLProviders SSLProvider { get; set; }

enum GlobalchargeSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As GlobalchargeSSLProviders

Enum GlobalchargeSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (GlobalCharge Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

TaxAmount Property (GlobalCharge Component)

Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions.

Syntax

• C#
• VB.NET

public string TaxAmount { get; set; }

Public Property TaxAmount As String

Default Value

""

Remarks

This property may be up to 9 characters, in the format "DDDDDD.CC", and be left-justified with no fill. (eg: "1.99"). Note that the TaxAmount should be included in the total TransactionAmount. For example, if the sale price of the transaction is $10.00, and the tax on the transaction is $0.60 (for a grand total of $10.60), the TransactionAmount property should contain "10.60" and the TaxAmount property should contain "0.60".

Timeout Property (GlobalCharge Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransactionAmount Property (GlobalCharge Component)

Amount to be charged from (or refunded to) the card.

Syntax

• C#
• VB.NET

public string TransactionAmount { get; set; }

Public Property TransactionAmount As String

Default Value

""

Remarks

This is required for Sale, AuthOnly, Refund, and Force transactions. It is optional or ignored for all others. The transaction amount may be up to 11 characters in length, and must be in the format "DDDDDDDD.CC", and be left-justified with no fill (eg: "1.99"). This must always be a positive, non-zero value.

Note that the TransactionAmount should include any GratuityAmount and/or TaxAmount. For example, if the sale price of the transaction is $10.00, and the tip on the transaction is $3.00 (for a grand total of $13.00), the TransactionAmount property should contain "13.00" and the GratuityAmount property should contain "3.00".

UserId Property (GlobalCharge Component)

UserId for authentication with the Global Payments Server .

Syntax

• C#
• VB.NET

public string UserId { get; set; }

Public Property UserId As String

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

AuthOnly Method (GlobalCharge Component)

Sends an AuthOnly transaction to the host.

Syntax

• C#
• VB.NET

public void AuthOnly();

Public Sub AuthOnly()

Remarks

An Auth Only transaction is used to verify and reserve the cardholder's open-to-buy funds available at that time. This transaction is NOT added to the open batch. In order to settle (be paid) for this transaction, the merchant must run a Capture transaction using the original PNRef obtained during this Auth Only transaction. Only then will the transaction be added to the open batch. Typically any funds blocked with a Sale or Auth Only transaction are reserved for approximately seven (7) to ten (10) days. This may vary from issuer to issuer. Sample transactions follow.

AuthOnly transaction with Track 1 data: component.Card = new GlobalCard("5499990123456781=15125025432198712345"); component.TransactionAmount = "1.00"; component.AuthOnly();

Manually keyed AuthOnly transaction: component.Card = new GlobalCard("4444333322221111", 1, 2015); component.TransactionAmount = "1.00"; component.AuthOnly();

AVSOnly Method (GlobalCharge Component)

Performs AVS and CVV card validation checks without actually making a transaction.

Syntax

• C#
• VB.NET

public void AVSOnly();

Public Sub AVSOnly()

Remarks

Please note that an AVSOnly transaction will not place a hold on any funds and will not reduce the cardholder's limit to buy. Also, an AVSOnly transaction will not place a transaction in the batch and no money will be transferred from the cardholder's account to the merchant's account. An AVS Only transaction should be used if the amount of the transaction is unknown but the merchant would like to perform validation that the card is good and the address matches what is on file at the issuer.

Once the amount of the transaction is known, process either a new Sale transaction, a RepeatSale using the PNRef returned in the AVS-Only Response, or a AuthOnly and then a Capture. Do not process a Force or Capture to "finalize" an AVSOnly transaction.

Note: The AVSOnly transaction is not supported in the eCommerce market.

BalanceInquiry Method (GlobalCharge Component)

A Credit Card Balance Inquiry transaction displays the remaining balance on a pre-paid credit card.

Syntax

• C#
• VB.NET

public void BalanceInquiry();

Public Sub BalanceInquiry()

Remarks

The only fields required for this transaction are the Number, ExpMonth, and ExpYear, however you may submit the CustomerAddress and CustomerZip for Address Validation, and the CVVData field for CVV checking if so desired.

The balance of the prepaid card will be stored in Balance. If the card specified is not a pre-paid credit card, the Balance will either be empty or contain the text "BALANCE NOT AVAILABLE".

Capture Method (GlobalCharge Component)

Sends a capture transaction to the Global Payments Server.

Syntax

• C#
• VB.NET

public void Capture(string PNRef);

Public Sub Capture(ByVal PNRef As String)

Remarks

Capture (Post Auth Capture) transactions are typically used when a merchant has previously utilized the AuthOnly method. A Capture transaction adds the transaction to the current open batch. To process a capture, call Capture with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to capture and set the TransactionAmount to the amount you wish to capture. You may issue a partial capture for any value up to the original authorized amount. For example: Full Capture: component.TransactionAmount = "15.00"; // Original authorization was for $15.00, so this is a full capture component.Capture("1233513541"); // "1233513541" is the PNRef from the original transaction Partial Capture: component.TransactionAmount = "10.00"; // Original authorization was for $15.00, so this is a partial capture component.Capture("1233513541"); // PNRef from the original authorization response

Note: Only one Capture can be processed per AuthOnly. To process a second Capture on an AuthOnly you must first use VoidTransaction to Void the first Capture.

Config Method (GlobalCharge Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (GlobalCharge Component)

Credits a cardholder's account.

Syntax

• C#
• VB.NET

public void Credit();

Public Sub Credit()

Remarks

This transaction adds funds to the cardholder's account. This can be performed any time and in any batch, and unlike the Refund method, is not based on a previous transaction.

Manually keyed credit: component.Card = new GlobalCard("4444333322221111", 1, 2015); component.TransactionAmount = "1.00"; // credits $1.00 component.Credit();

Force Method (GlobalCharge Component)

Sends a Voice Authorization (Force) transaction to the Global Payments Server.

Syntax

• C#
• VB.NET

public void Force(string approvalCode);

Public Sub Force(ByVal ApprovalCode As String)

Remarks

Force transactions are typically used when a customer's card was declined, but the merchant was able to call the issuer and receive a voice authorization code. The Force method will add the transaction into the current open batch. The TransactionAmount, Card, and all other data must match exactly to the information given over the phone to receive the voice authorization, and the ApprovalCode parameter must be set with the authorization code you received. For example component.TransactionAmount = "1.00"; component.Force("123456"); // value from voice auth or previous AuthOnly trans

Interrupt Method (GlobalCharge Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Public Sub Interrupt()

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Refund Method (GlobalCharge Component)

Refunds a previous transaction.

Syntax

• C#
• VB.NET

public void Refund(string PNRef);

Public Sub Refund(ByVal PNRef As String)

Remarks

This method issues a refund based on a previously authorized and settled transaction (Either a Sale, Capture, or Force). A transaction can only be refunded if it exists in a previous batch. (If the transaction is in the current open batch, use VoidTransaction instead). To process a refund, call Refund with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to issue a refund and set the TransactionAmount to the amount you wish to refund. You may issue a partial refund for any value up to the original sale amount. For example:

Full Refund: component.TransactionAmount = "25.00"; // Original transaction was for $25.00, so this is a full refund component.Refund("123456"); // "123456" is the PNRef from the original transaction Partial Refund: component.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund component.Refund("123456"); // "123456" is the PNRef from the original transaction

If you do not know the PNRef from the original transaction, use Credit instead.

Note: Partial refunds are supported regardless of the time and date or batch status (open or closed). To perform a partial refunds, pass any TransactionAmount that is less than the original transaction amount to the Refund transaction as per the example above.

RepeatSale Method (GlobalCharge Component)

Used to submit a recurring transaction.

Syntax

• C#
• VB.NET

public void RepeatSale(string PNRef);

Public Sub RepeatSale(ByVal PNRef As String)

Remarks

The RepeatSale transaction can be used by merchants to enable simplified re-use of cards previously used by a customer, as well as for recurring transactions. By using the Global Transport Gateway's RepeatSale transaction instead of a new Sale transaction, sensitive cardholder data such as the card number and expiration date do not have to be stored locally by the merchant, which reduces the likelihood of that cardholder data being compromised. Because all sensitive cardholder data is stored by Global Payments, the merchant only needs to store PNRef numbers.

Keep in mind that the recurring logic (how often the transactions are processed, the length of contract, etc.) must be managed by the merchant and is not a function of the RepeatSale transaction feature of the Global Transport Gateway. Please note that PNRef numbers and cardholder data are only stored for 24 months from the date of the last activity on the Global Transport Gateway.

In order to perform a RepeatSale transaction, an initial Sale (or Partial Authorization) transaction must occur first. Once the original transaction is processed, the merchant should store the PNRef number that is returned in the transaction response. The merchant should always use the PNRef number of the most recent RepeatSale transaction Response for future re-use or recurring payments. An example is shown below: component.UserId = "4dpayments_ecom"; component.Password = "Passw0rd"; component.Card.Number = "4003000123456781"; component.Card.ExpMonth = 12; component.Card.ExpYear = 15; component.TransactionAmount = "8.00"; component.InvoiceNumber = "1234567890"; component.Sale("564474"); String pnref = component.Response.PNRef; component.Reset(); component.UserId = "4dpayments_ecom"; component.Password = "Passw0rd"; component.TransactionAmount = "8.00"; component.InvoiceNumber = "1234567890"; component.RepeatSale(pnref);

Reset Method (GlobalCharge Component)

Clears all properties to their default values.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Reverse Method (GlobalCharge Component)

Reverses a transaction in the current batch.

Syntax

• C#
• VB.NET

public void Reverse(string PNRef);

Public Sub Reverse(ByVal PNRef As String)

Remarks

A credit card Reversal transaction removes an unsettled, previously-submitted transaction. The PNRef parameter should be set to the PNRef from the transaction response of the transaction you wish to cancel.

A Reverse transaction differs from a VoidTransaction in one key way. A standard credit card sale puts a hold on the cardholder's open-to-buy funds until the batch is settled. If submitting a VoidTransaction, no money changes hands but a hold on the funds remains for a certain amount of time (usually around 7 days, depending on the issuing bank). A Reverse transaction releases the hold on the funds, and makes the funds available again immediately.

When two Reverse requests for the same transaction are submitted, a Reversal only occurs on the first transaction. If a Reversal request is submitted on a transaction which has already been reversed, Global Transport returns a "NO TRANS FOUND" message in the Response. Some standard card issuers may not support a Reversal. In this case, Global Transport returns a "DECLINE" response message. In this case, you should void it with the VoidTransaction method instead.

Sale Method (GlobalCharge Component)

Sends a Sale transaction to the host.

Syntax

• C#
• VB.NET

public void Sale();

Public Sub Sale()

Remarks

A basic Sale transaction. This transaction decrements the cardholder's open-to-buy funds for the sale amount. This transaction is automatically added to the current open batch, and will be settled after the current batch is settled. The batch settlement may be set up to occur automatically, or you can control when the batch settles with the GlobalBatchMgr component. Sample transactions follow.

Sale transaction with Track 1 data: component.Card = new GlobalCard("5499990123456781=15125025432198712345"); component.TransactionAmount = "1.00"; component.Sale();

Manually keyed Sale transaction: component.Card = new GlobalCard("4444333322221111", 1, 2015); component.TransactionAmount = "1.00"; component.Sale();

TipAdjustment Method (GlobalCharge Component)

This methods adds a tip to the original sale transaction.

Syntax

• C#
• VB.NET

public void TipAdjustment(string PNRef, string gratuityAmount);

Public Sub TipAdjustment(ByVal PNRef As String, ByVal GratuityAmount As String)

Remarks

To add a tip to a transaction simply call TipAdjustment with the PNRef parameter set to the PNRef of the transaction you wish to adjust, and the GratuityAmount to the amount you wish to add.

VoidTransaction Method (GlobalCharge Component)

Voids a transaction in the current batch.

Syntax

• C#
• VB.NET

public void VoidTransaction(string PNRef);

Public Sub VoidTransaction(ByVal PNRef As String)

Remarks

A Void removes transactions from an open batch prior to settlement, to correct same-day transaction mistakes. A transaction can only be voided if it exists in the current open batch. To do so, call VoidTransaction with the PNRef parameter set to the PNRef of the original transaction. This only works for transactions that are still in the current open batch. If the batch that contained the target transaction has already been settled, you must use the Refund or Credit methods instead.

Note that since AuthOnly transactions are not added to the current batch, they cannot be voided. Examples follow.

component.Card = new GlobalCard("4444333322221111", 1, 2015); component.TransactionAmount = "1.00"; component.Sale(); refNumToVoid = component.Response.PNRef; ... more sale transactions ... // All that's needed for a void: component.VoidTransaction(refNumToVoid);

Error Event (GlobalCharge Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, GlobalchargeErrorEventArgs e);

public class GlobalchargeErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As GlobalchargeErrorEventArgs)

Public Class GlobalchargeErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (GlobalCharge Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, GlobalchargeSSLServerAuthenticationEventArgs e);

public class GlobalchargeSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As GlobalchargeSSLServerAuthenticationEventArgs)

Public Class GlobalchargeSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (GlobalCharge Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, GlobalchargeSSLStatusEventArgs e);

public class GlobalchargeSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As GlobalchargeSSLStatusEventArgs)

Public Class GlobalchargeSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (GlobalCharge Component)

Shows the progress of the Global Payments connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, GlobalchargeStatusEventArgs e);

public class GlobalchargeStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As GlobalchargeStatusEventArgs)

Public Class GlobalchargeStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.

Fields

Constructors

• C#
• VB.NET

public CCCard();

Public CCCard()

• C#
• VB.NET

public CCCard(string number, int expMonth, int expYear);

Public CCCard(ByVal Number As String, ByVal ExpMonth As Integer, ByVal ExpYear As Integer)

• C#
• VB.NET

public CCCard(string magneticStripe, EntryDataSources entryDataSource);

Public CCCard(ByVal MagneticStripe As String, ByVal EntryDataSource As EntryDataSources)

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

GlobalChargeResponse Type

Contains the response to a transaction.

Remarks

This type contains the results of a transaction made with the GlobalCharge component. The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public GlobalChargeResponse();

Public GlobalChargeResponse()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (GlobalCharge Component)

GlobalCharge Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (GlobalCharge Component)

GlobalCharge Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors