GlobalCharge Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalCharge class is used to authorize credit card transactions with the Global Payments system, using the Global Transport Direct API. This class 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 class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Class Name

DPaymentsSDK_GlobalCharge

Procedural Interface

 dpaymentssdk_globalcharge_open();
 dpaymentssdk_globalcharge_close($res);
 dpaymentssdk_globalcharge_register_callback($res, $id, $function);
 dpaymentssdk_globalcharge_get_last_error($res);
 dpaymentssdk_globalcharge_get_last_error_code($res);
 dpaymentssdk_globalcharge_set($res, $id, $index, $value);
 dpaymentssdk_globalcharge_get($res, $id, $index);
 dpaymentssdk_globalcharge_do_authonly($res);
 dpaymentssdk_globalcharge_do_avsonly($res);
 dpaymentssdk_globalcharge_do_balanceinquiry($res);
 dpaymentssdk_globalcharge_do_capture($res, $pnref);
 dpaymentssdk_globalcharge_do_config($res, $configurationstring);
 dpaymentssdk_globalcharge_do_credit($res);
 dpaymentssdk_globalcharge_do_force($res, $approvalcode);
 dpaymentssdk_globalcharge_do_interrupt($res);
 dpaymentssdk_globalcharge_do_refund($res, $pnref);
 dpaymentssdk_globalcharge_do_repeatsale($res, $pnref);
 dpaymentssdk_globalcharge_do_reset($res);
 dpaymentssdk_globalcharge_do_reverse($res, $pnref);
 dpaymentssdk_globalcharge_do_sale($res);
 dpaymentssdk_globalcharge_do_tipadjustment($res, $pnref, $gratuityamount);
 dpaymentssdk_globalcharge_do_voidtransaction($res, $pnref);

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 CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For swiped transactions (Retail and Restaurant industries) the CardEntryDataSource should be set to edsMagneticStripe and, the CardMagneticStripe property 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 status of the authorization request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.

You may also use this class 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 class to capture the transactions in the batch.

Property List

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

Method List

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

Event List

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

Config Settings

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

CardType Property (DPaymentsSDK_GlobalCharge Class)

Type of credit card being used in this transaction.

Object Oriented Interface

public function getCardType();
public function setCardType($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 1 );
dpaymentssdk_globalcharge_set($res, 1, $value );

Possible Values

GLOBALCHARGE_CARDTYPE_UNKNOWN(0), 
GLOBALCHARGE_CARDTYPE_VISA(1), 
GLOBALCHARGE_CARDTYPE_MASTER_CARD(2), 
GLOBALCHARGE_CARDTYPE_AMEX(3), 
GLOBALCHARGE_CARDTYPE_DISCOVER(4), 
GLOBALCHARGE_CARDTYPE_DINERS(5), 
GLOBALCHARGE_CARDTYPE_JCB(6), 
GLOBALCHARGE_CARDTYPE_VISA_ELECTRON(7), 
GLOBALCHARGE_CARDTYPE_MAESTRO(8), 
GLOBALCHARGE_CARDTYPE_LASER(10)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_GlobalCharge Class)

Three digit security code on back of card (optional).

Object Oriented Interface

public function getCardCVVData();
public function setCardCVVData($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 2 );
dpaymentssdk_globalcharge_set($res, 2, $value );

Default Value

''

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_GlobalCharge Class)

Indicates the presence of the card verification value.

Object Oriented Interface

public function getCardCVVPresence();
public function setCardCVVPresence($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 3 );
dpaymentssdk_globalcharge_set($res, 3, $value );

Possible Values

GLOBALCHARGE_CARDCVVPRESENCE_NOT_PROVIDED(0), 
GLOBALCHARGE_CARDCVVPRESENCE_PROVIDED(1), 
GLOBALCHARGE_CARDCVVPRESENCE_ILLEGIBLE(2), 
GLOBALCHARGE_CARDCVVPRESENCE_NOT_ON_CARD(3)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_GlobalCharge Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface

public function getCardEntryDataSource();
public function setCardEntryDataSource($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 4 );
dpaymentssdk_globalcharge_set($res, 4, $value );

Possible Values

GLOBALCHARGE_CARDENTRYDATASOURCE_TRACK_1(0), 
GLOBALCHARGE_CARDENTRYDATASOURCE_TRACK_2(1), 
GLOBALCHARGE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
GLOBALCHARGE_CARDENTRYDATASOURCE_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
GLOBALCHARGE_CARDENTRYDATASOURCE_MANUAL_ENTRY_NO_CARD_READER(4), 
GLOBALCHARGE_CARDENTRYDATASOURCE_TRACK_1CONTACTLESS(5), 
GLOBALCHARGE_CARDENTRYDATASOURCE_TRACK_2CONTACTLESS(6), 
GLOBALCHARGE_CARDENTRYDATASOURCE_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
GLOBALCHARGE_CARDENTRYDATASOURCE_IVR(8), 
GLOBALCHARGE_CARDENTRYDATASOURCE_KIOSK(9)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_GlobalCharge Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface

public function getCardExpMonth();
public function setCardExpMonth($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 5 );
dpaymentssdk_globalcharge_set($res, 5, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_GlobalCharge Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface

public function getCardExpYear();
public function setCardExpYear($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 6 );
dpaymentssdk_globalcharge_set($res, 6, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_GlobalCharge Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface

public function getCardIsEncrypted();
public function setCardIsEncrypted($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 7 );
dpaymentssdk_globalcharge_set($res, 7, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_GlobalCharge Class)

Track data read off of the card's magnetic stripe.

Object Oriented Interface

public function getCardMagneticStripe();
public function setCardMagneticStripe($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 8 );
dpaymentssdk_globalcharge_set($res, 8, $value );

Default Value

''

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_GlobalCharge Class)

Customer's credit card number for the transaction.

Object Oriented Interface

public function getCardNumber();
public function setCardNumber($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 9 );
dpaymentssdk_globalcharge_set($res, 9, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CustomerAddress Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getCustomerAddress();
public function setCustomerAddress($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 10 );
dpaymentssdk_globalcharge_set($res, 10, $value );

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.

Data Type

String

CustomerId Property (DPaymentsSDK_GlobalCharge Class)

Contains a merchant-assigned number to identify the customer.

Object Oriented Interface

public function getCustomerId();
public function setCustomerId($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 11 );
dpaymentssdk_globalcharge_set($res, 11, $value );

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.

Data Type

String

CustomerName Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getCustomerName();
public function setCustomerName($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 12 );
dpaymentssdk_globalcharge_set($res, 12, $value );

Default Value

''

Remarks

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

Data Type

String

CustomerZip Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getCustomerZip();
public function setCustomerZip($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 13 );
dpaymentssdk_globalcharge_set($res, 13, $value );

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".

Data Type

String

GratuityAmount Property (DPaymentsSDK_GlobalCharge Class)

Tip portion of the TransactionAmount .

Object Oriented Interface

public function getGratuityAmount();
public function setGratuityAmount($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 14 );
dpaymentssdk_globalcharge_set($res, 14, $value );

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".

Data Type

String

InvoiceNumber Property (DPaymentsSDK_GlobalCharge Class)

Optional invoice tracking number.

Object Oriented Interface

public function getInvoiceNumber();
public function setInvoiceNumber($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 15 );
dpaymentssdk_globalcharge_set($res, 15, $value );

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.

Data Type

String

Password Property (DPaymentsSDK_GlobalCharge Class)

Password for authentication with the Global Payments Server .

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 16 );
dpaymentssdk_globalcharge_set($res, 16, $value );

Default Value

''

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_GlobalCharge Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 17 );
dpaymentssdk_globalcharge_set($res, 17, $value );

Possible Values

GLOBALCHARGE_PROXYAUTHSCHEME_BASIC(0), 
GLOBALCHARGE_PROXYAUTHSCHEME_DIGEST(1), 
GLOBALCHARGE_PROXYAUTHSCHEME_PROPRIETARY(2), 
GLOBALCHARGE_PROXYAUTHSCHEME_NONE(3), 
GLOBALCHARGE_PROXYAUTHSCHEME_NTLM(4), 
GLOBALCHARGE_PROXYAUTHSCHEME_NEGOTIATE(5)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_GlobalCharge Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 18 );
dpaymentssdk_globalcharge_set($res, 18, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_GlobalCharge Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 19 );
dpaymentssdk_globalcharge_set($res, 19, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DPaymentsSDK_GlobalCharge Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 20 );
dpaymentssdk_globalcharge_set($res, 20, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (DPaymentsSDK_GlobalCharge Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 21 );
dpaymentssdk_globalcharge_set($res, 21, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (DPaymentsSDK_GlobalCharge Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 22 );
dpaymentssdk_globalcharge_set($res, 22, $value );

Possible Values

GLOBALCHARGE_PROXYSSL_AUTOMATIC(0), 
GLOBALCHARGE_PROXYSSL_ALWAYS(1), 
GLOBALCHARGE_PROXYSSL_NEVER(2), 
GLOBALCHARGE_PROXYSSL_TUNNEL(3)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (DPaymentsSDK_GlobalCharge Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 23 );
dpaymentssdk_globalcharge_set($res, 23, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

PurchaseOrderNum Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getPurchaseOrderNum();
public function setPurchaseOrderNum($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 24 );
dpaymentssdk_globalcharge_set($res, 24, $value );

Default Value

''

Remarks

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

Data Type

String

RegisterNumber Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getRegisterNumber();
public function setRegisterNumber($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 25 );
dpaymentssdk_globalcharge_set($res, 25, $value );

Default Value

''

Remarks

This may be up to 10 alphanumeric characters in length.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the transaction authorization code from the card issuer.

Object Oriented Interface

public function getResponseApprovalCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 26 );

Default Value

''

Remarks

Contains the transaction authorization code from the card issuer.

For approved transaction responses (ResponseCode 0 or 200) the Global Transport Gateway sends a 6-character approval code in the ResponseApprovalCode property and a human-readable approval message in the ResponseMessage property. In the case of a decline, the ResponseApprovalCode will contain an error message. Your application should display the ResponseApprovalCode as part of the approval message for an approved transaction. For declined responses, the ResponseHostCode property will contain an additional code that provides detail on the reason for the decline.

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_GlobalCharge Class)

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

Object Oriented Interface

public function getResponseAuthorizedAmount();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 27 );

Default Value

''

Remarks

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

Data Type

String

ResponseAVSResultCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the address verification result code from the card issuer.

Object Oriented Interface

public function getResponseAVSResultCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 28 );

Default Value

''

Remarks

Contains the address verification result code from the card issuer.

When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted ResponseAVSResultMessage describing the result. The following table lists the possible AVS result codes:

* These values are Visa specific.

** These values are returned by the Global Transport Gateway and not the issuing bank.

This property is read-only.

Data Type

String

ResponseAVSResultMessage Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted and human-readable response message describing the AVSResultCode .

Object Oriented Interface

public function getResponseAVSResultMessage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 29 );

Default Value

''

Remarks

Contains a formatted and human-readable response message describing the ResponseAVSResultCode.

Do NOT use this when programmatically validating a transaction's AVS result; Use the ResponseAVSResultCode property instead.

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_GlobalCharge Class)

Available balance remaining on a pre-paid credit card.

Object Oriented Interface

public function getResponseBalance();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 30 );

Default Value

''

Remarks

Available balance remaining on a pre-paid credit card.

If this value is returned in the transaction response, print the value on the receipt. If the card in question is not a pre-paid credit card, this property will contain the text "BALANCE NOT AVAILABLE".

This property is read-only.

Data Type

String

ResponseBalanceDue Property (DPaymentsSDK_GlobalCharge Class)

In the case of a partial authorization, indicates the amount the customer still owes the merchant.

Object Oriented Interface

public function getResponseBalanceDue();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 31 );

Default Value

''

Remarks

In the case of a partial authorization, indicates the amount the customer still owes the merchant.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_GlobalCharge Class)

The number of the batch this transaction is currently contained in.

Object Oriented Interface

public function getResponseBatchNumber();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 32 );

Default Value

''

Remarks

The number of the batch this transaction is currently contained in. If this is a reply to an AuthOnly transaction, the ResponseBatchNumber property will be blank, as auth-onlys are not added to the open batch until a Capture is performed.

This property is read-only.

Data Type

String

ResponseCardType Property (DPaymentsSDK_GlobalCharge Class)

Indicates the card type or payment method.

Object Oriented Interface

public function getResponseCardType();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 33 );

Default Value

''

Remarks

Indicates the card type or payment method.

For credit card transactions, this property will contain the name of the credit card type. For instance, "VISA", "MASTERCARD", "AMEX", etc. For Debit or Electronic Benefit transactions, this property will contain "DEBIT" or "EBT".

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the transaction result code from the Global Transport Gateway.

Object Oriented Interface

public function getResponseCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 34 );

Default Value

''

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, etc). When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

Data Type

String

ResponseCommercialCard Property (DPaymentsSDK_GlobalCharge Class)

Indicates if the card that was just authorized was a commercial card.

Object Oriented Interface

public function getResponseCommercialCard();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 35 );

Default Value

false

Remarks

Indicates if the card that was just authorized was a commercial card.

This value is only applicable to credit card transactions.

This property is read-only.

Data Type

Boolean

ResponseCVVResultCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the card verification result code from the card issuer.

Object Oriented Interface

public function getResponseCVVResultCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 36 );

Default Value

''

Remarks

Contains the card verification result code from the card issuer.

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result, contained in the ResponseCVVResultMessage property.

The following table lists the possible result codes for this property:

This property is read-only.

Data Type

String

ResponseCVVResultMessage Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted and human-readable response message describing the CVVResultCode .

Object Oriented Interface

public function getResponseCVVResultMessage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 37 );

Default Value

''

Remarks

Contains a formatted and human-readable response message describing the ResponseCVVResultCode.

This value is only applicable to credit card transactions. Do NOT use this when programmatically validating a transaction's CV result; Use the ResponseCVVResultCode property instead.

This property is read-only.

Data Type

String

ResponseData Property (DPaymentsSDK_GlobalCharge Class)

Contains the raw response data from the Global Payments host.

Object Oriented Interface

public function getResponseData();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 38 );

Default Value

''

Remarks

Contains the raw response data from the Global Payments host.

This property is read-only.

Data Type

String

ResponseHostCode Property (DPaymentsSDK_GlobalCharge Class)

Action code returned by Global Payments.

Object Oriented Interface

public function getResponseHostCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 39 );

Default Value

''

Remarks

Action code returned by Global Payments.

Typically, if the transaction is approved, this will be the batch reference number. If the transaction is declined, the ResponseHostCode will indicate the reason for the decline. The table below lists the possible ResponseHostCode and ResponseMessage combinations for error conditions.

IMPORTANT: When programmatically validating a transaction's result, the ResponseCode value should ALWAYS be used instead of any other response messages describing the result. For example, do not use ResponseHostCode, ResponseMessage, ResponseMessageDetail, or any other responses, as these values may vary. This tables is included for informational purposes only.

This property is read-only.

Data Type

String

ResponseInvoiceNumber Property (DPaymentsSDK_GlobalCharge Class)

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway.

Object Oriented Interface

public function getResponseInvoiceNumber();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 40 );

Default Value

''

Remarks

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway. This field has a maximum length of 25 alphanumeric characters.

This property is read-only.

Data Type

String

ResponseMerchantCode Property (DPaymentsSDK_GlobalCharge Class)

Merchant Id code which must be printed on all receipts.

Object Oriented Interface

public function getResponseMerchantCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 41 );

Default Value

''

Remarks

Merchant Id code which must be printed on all receipts.

This property will contain a 15-character code that identifies the merchant on the Global Payments host.

This property is read-only.

Data Type

String

ResponseMessage Property (DPaymentsSDK_GlobalCharge Class)

Contains a human-readable response message concerning the processed transaction.

Object Oriented Interface

public function getResponseMessage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 42 );

Default Value

''

Remarks

Contains a human-readable response message concerning the processed transaction.

This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the ResponseCode property instead.

This property is read-only.

Data Type

String

ResponseMessageDetail Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted response message concerning the processed transaction.

Object Oriented Interface

public function getResponseMessageDetail();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 43 );

Default Value

''

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the ResponseMessage property alone. For approved transactions this property will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the ResponseCode property instead.

Note: For Debit Card Sales and Refund, the string value in ResponseMessageDetail includes non-printable characters. Global Transport removes all non-printable characters from the returned ResponseMessageDetail.

This property is read-only.

Data Type

String

ResponsePNRef Property (DPaymentsSDK_GlobalCharge Class)

Contains a number which uniquely identifies the transaction in the Global Transport system.

Object Oriented Interface

public function getResponsePNRef();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 44 );

Default Value

''

Remarks

Contains a number which uniquely identifies the transaction in the Global Transport system.

This value should be stored by the POS to enable the processing transactions based on a previous transaction. For instance, Capture, Void, Refund, TipAdjustment, etc.

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_GlobalCharge Class)

Card issuer's Transaction Reference Number.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 45 );

Default Value

''

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet Reference Number, American Express Transaction Id, or Discover STAN Id. If returned in the response, this property must be printed on the receipt. Note that this ResponseTransactionId is not used by Global Payments to reference the transaction. The ResponsePNRef property is used to track and modify transactions made on the Global Payments system.

This property is read-only.

Data Type

String

ResponseValidationCode Property (DPaymentsSDK_GlobalCharge Class)

Visa Validation code.

Object Oriented Interface

public function getResponseValidationCode();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 46 );

Default Value

''

Remarks

Visa Validation code.

If this value is returned in the transaction response it must be printed on the receipt. It will only be returned for the Visa ResponseCardType.

This property is read-only.

Data Type

String

Server Property (DPaymentsSDK_GlobalCharge Class)

Global Payments transaction server.

Object Oriented Interface

public function getServer();
public function setServer($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 47 );
dpaymentssdk_globalcharge_set($res, 47, $value );

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.

Data Type

String

ServerId Property (DPaymentsSDK_GlobalCharge Class)

Unique server identification number.

Object Oriented Interface

public function getServerId();
public function setServerId($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 48 );
dpaymentssdk_globalcharge_set($res, 48, $value );

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.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 49 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 50 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (DPaymentsSDK_GlobalCharge Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 51 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 52 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 53 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 54 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (DPaymentsSDK_GlobalCharge Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 55 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (DPaymentsSDK_GlobalCharge Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 56 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalCharge Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 57 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (DPaymentsSDK_GlobalCharge Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 58 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (DPaymentsSDK_GlobalCharge Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 59 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 60 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (DPaymentsSDK_GlobalCharge Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 61 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (DPaymentsSDK_GlobalCharge Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 62 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 63 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (DPaymentsSDK_GlobalCharge Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 64 );
dpaymentssdk_globalcharge_set($res, 64, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (DPaymentsSDK_GlobalCharge Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 65 );
dpaymentssdk_globalcharge_set($res, 65, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (DPaymentsSDK_GlobalCharge Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 66 );
dpaymentssdk_globalcharge_set($res, 66, $value );

Possible Values

GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
GLOBALCHARGE_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_GlobalCharge Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 67 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_GlobalCharge Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 68 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 69 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 70 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (DPaymentsSDK_GlobalCharge Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 71 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (DPaymentsSDK_GlobalCharge Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 72 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (DPaymentsSDK_GlobalCharge Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 73 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (DPaymentsSDK_GlobalCharge Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 74 );
dpaymentssdk_globalcharge_set($res, 74, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 75 );
dpaymentssdk_globalcharge_set($res, 75, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 76 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 77 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (DPaymentsSDK_GlobalCharge Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 78 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 79 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 80 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 81 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (DPaymentsSDK_GlobalCharge Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 82 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (DPaymentsSDK_GlobalCharge Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 83 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalCharge Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 84 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (DPaymentsSDK_GlobalCharge Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 85 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (DPaymentsSDK_GlobalCharge Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 86 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 87 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (DPaymentsSDK_GlobalCharge Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 88 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (DPaymentsSDK_GlobalCharge Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 89 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 90 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (DPaymentsSDK_GlobalCharge Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 91 );
dpaymentssdk_globalcharge_set($res, 91, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_GlobalCharge Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 92 );
dpaymentssdk_globalcharge_set($res, 92, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_GlobalCharge Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 93 );
dpaymentssdk_globalcharge_set($res, 93, $value );

Possible Values

GLOBALCHARGE_SSLCERTSTORETYPE_USER(0), 
GLOBALCHARGE_SSLCERTSTORETYPE_MACHINE(1), 
GLOBALCHARGE_SSLCERTSTORETYPE_PFXFILE(2), 
GLOBALCHARGE_SSLCERTSTORETYPE_PFXBLOB(3), 
GLOBALCHARGE_SSLCERTSTORETYPE_JKSFILE(4), 
GLOBALCHARGE_SSLCERTSTORETYPE_JKSBLOB(5), 
GLOBALCHARGE_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALCHARGE_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALCHARGE_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALCHARGE_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALCHARGE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALCHARGE_SSLCERTSTORETYPE_P7BFILE(11), 
GLOBALCHARGE_SSLCERTSTORETYPE_P7BBLOB(12), 
GLOBALCHARGE_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALCHARGE_SSLCERTSTORETYPE_PPKFILE(14), 
GLOBALCHARGE_SSLCERTSTORETYPE_PPKBLOB(15), 
GLOBALCHARGE_SSLCERTSTORETYPE_XMLFILE(16), 
GLOBALCHARGE_SSLCERTSTORETYPE_XMLBLOB(17), 
GLOBALCHARGE_SSLCERTSTORETYPE_JWKFILE(18), 
GLOBALCHARGE_SSLCERTSTORETYPE_JWKBLOB(19), 
GLOBALCHARGE_SSLCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALCHARGE_SSLCERTSTORETYPE_BCFKSFILE(21), 
GLOBALCHARGE_SSLCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALCHARGE_SSLCERTSTORETYPE_PKCS11(23), 
GLOBALCHARGE_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_GlobalCharge Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 94 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_GlobalCharge Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 95 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 96 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 97 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (DPaymentsSDK_GlobalCharge Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 98 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (DPaymentsSDK_GlobalCharge Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 99 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (DPaymentsSDK_GlobalCharge Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 100 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (DPaymentsSDK_GlobalCharge Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 101 );
dpaymentssdk_globalcharge_set($res, 101, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 102 );
dpaymentssdk_globalcharge_set($res, 102, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (DPaymentsSDK_GlobalCharge Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 103 );
dpaymentssdk_globalcharge_set($res, 103, $value );

Possible Values

GLOBALCHARGE_SSLPROVIDER_AUTOMATIC(0), 
GLOBALCHARGE_SSLPROVIDER_PLATFORM(1), 
GLOBALCHARGE_SSLPROVIDER_INTERNAL(2)

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 class 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 as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 104 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (DPaymentsSDK_GlobalCharge Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 105 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (DPaymentsSDK_GlobalCharge Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 106 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 107 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 108 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 109 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (DPaymentsSDK_GlobalCharge Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 110 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (DPaymentsSDK_GlobalCharge Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 111 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalCharge Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 112 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (DPaymentsSDK_GlobalCharge Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 113 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (DPaymentsSDK_GlobalCharge Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 114 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 115 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (DPaymentsSDK_GlobalCharge Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 116 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (DPaymentsSDK_GlobalCharge Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 117 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (DPaymentsSDK_GlobalCharge Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 118 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (DPaymentsSDK_GlobalCharge Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 119 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (DPaymentsSDK_GlobalCharge Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 120 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (DPaymentsSDK_GlobalCharge Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 121 );

Possible Values

GLOBALCHARGE_SSLSERVERCERTSTORETYPE_USER(0), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_MACHINE(1), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_PKCS11(23), 
GLOBALCHARGE_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_GlobalCharge Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 122 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_GlobalCharge Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 123 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 124 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_GlobalCharge Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 125 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_GlobalCharge Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 126 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_GlobalCharge Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 127 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_GlobalCharge Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 128 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_GlobalCharge Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 129 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_globalcharge_get($res, 130 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

TaxAmount Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getTaxAmount();
public function setTaxAmount($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 131 );
dpaymentssdk_globalcharge_set($res, 131, $value );

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".

Data Type

String

Timeout Property (DPaymentsSDK_GlobalCharge Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 132 );
dpaymentssdk_globalcharge_set($res, 132, $value );

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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.

Data Type

Integer

TransactionAmount Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function getTransactionAmount();
public function setTransactionAmount($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 133 );
dpaymentssdk_globalcharge_set($res, 133, $value );

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".

Data Type

String

UserId Property (DPaymentsSDK_GlobalCharge Class)

UserId for authentication with the Global Payments Server .

Object Oriented Interface

public function getUserId();
public function setUserId($value);

Procedural Interface

dpaymentssdk_globalcharge_get($res, 134 );
dpaymentssdk_globalcharge_set($res, 134, $value );

Default Value

''

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

AuthOnly Method (DPaymentsSDK_GlobalCharge Class)

Sends an AuthOnly transaction to the host.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

dpaymentssdk_globalcharge_do_authonly($res);

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 ResponsePNRef 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: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "5499990123456781=15125025432198712345" class.TransactionAmount = "1.00" class.AuthOnly() Manually keyed AuthOnly transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.AuthOnly()

AVSOnly Method (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function doAVSOnly();

Procedural Interface

dpaymentssdk_globalcharge_do_avsonly($res);

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 (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function doBalanceInquiry();

Procedural Interface

dpaymentssdk_globalcharge_do_balanceinquiry($res);

Remarks

The only properties required for this transaction are the CardNumber, CardExpMonth, and CardExpYear, however you may submit the CustomerAddress and CustomerZip for Address Validation, and the CardCVVData property for CVV checking if so desired.

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

Capture Method (DPaymentsSDK_GlobalCharge Class)

Sends a capture transaction to the Global Payments Server.

Object Oriented Interface

public function doCapture($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_capture($res, $pnref);

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: class.TransactionAmount = "15.00"; // Original authorization was for $15.00, so this is a full capture class.Capture("1233513541"); // "1233513541" is the PNRef from the original transaction Partial Capture: class.TransactionAmount = "10.00"; // Original authorization was for $15.00, so this is a partial capture class.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 (DPaymentsSDK_GlobalCharge Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_globalcharge_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (DPaymentsSDK_GlobalCharge Class)

Credits a cardholder's account.

Object Oriented Interface

public function doCredit();

Procedural Interface

dpaymentssdk_globalcharge_do_credit($res);

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: class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.CardEntryDataSource = edsManuallyEntered class.TransactionAmount = "1.00" 'credits $1.00 class.Credit()

Force Method (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface

public function doForce($approvalcode);

Procedural Interface

dpaymentssdk_globalcharge_do_force($res, $approvalcode);

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 class.TransactionAmount = "1.00"; class.Force("123456"); // value from voice auth or previous AuthOnly trans

Interrupt Method (DPaymentsSDK_GlobalCharge Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_globalcharge_do_interrupt($res);

Remarks

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

Refund Method (DPaymentsSDK_GlobalCharge Class)

Refunds a previous transaction.

Object Oriented Interface

public function doRefund($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_refund($res, $pnref);

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: class.TransactionAmount = "25.00"; // Original transaction was for $25.00, so this is a full refund class.Refund("123456"); // "123456" is the PNRef from the original transaction Partial Refund: class.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund class.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 (DPaymentsSDK_GlobalCharge Class)

Used to submit a recurring transaction.

Object Oriented Interface

public function doRepeatSale($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_repeatsale($res, $pnref);

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: class.UserId = "4dpayments_ecom"; class.Password = "Passw0rd"; class.Card.Number = "4003000123456781"; class.Card.ExpMonth = 12; class.Card.ExpYear = 15; class.TransactionAmount = "8.00"; class.InvoiceNumber = "1234567890"; class.Sale("564474"); String pnref = class.Response.PNRef; class.Reset(); class.UserId = "4dpayments_ecom"; class.Password = "Passw0rd"; class.TransactionAmount = "8.00"; class.InvoiceNumber = "1234567890"; class.RepeatSale(pnref);

Reset Method (DPaymentsSDK_GlobalCharge Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_globalcharge_do_reset($res);

Remarks

This method clears all properties to their default values.

Reverse Method (DPaymentsSDK_GlobalCharge Class)

Reverses a transaction in the current batch.

Object Oriented Interface

public function doReverse($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_reverse($res, $pnref);

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 (DPaymentsSDK_GlobalCharge Class)

Sends a Sale transaction to the host.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_globalcharge_do_sale($res);

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 class. Sample transactions follow.

Sale transaction with Track 1 data: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "5499990123456781=15125025432198712345" class.TransactionAmount = "1.00" class.Sale() Manually keyed Sale transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.TransactionAmount = "1.00" class.Sale()

TipAdjustment Method (DPaymentsSDK_GlobalCharge Class)

This methods adds a tip to the original sale transaction.

Object Oriented Interface

public function doTipAdjustment($pnref, $gratuityamount);

Procedural Interface

dpaymentssdk_globalcharge_do_tipadjustment($res, $pnref, $gratuityamount);

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 (DPaymentsSDK_GlobalCharge Class)

Voids a transaction in the current batch.

Object Oriented Interface

public function doVoidTransaction($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_voidtransaction($res, $pnref);

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.

class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.TransactionAmount = "1.00" class.Sale() refNumToVoid = class.ResponsePNRef ... more sale transactions ... 'All that's needed for a void: class.VoidTransaction(refNumToVoid)

Error Event (DPaymentsSDK_GlobalCharge Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (DPaymentsSDK_GlobalCharge Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (DPaymentsSDK_GlobalCharge Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_GlobalCharge Class)

Shows the progress of the Global Payments connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (GlobalCharge Class)

GlobalCharge Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (GlobalCharge Class)

GlobalCharge Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors