DirectPayment Class

Properties   Methods   Events   Config Settings   Errors  

Obtain payment through PayPal directly from a buyer's credit card.

Class Name

InPay_DirectPayment

Procedural Interface

 inpay_directpayment_open();
 inpay_directpayment_close($res);
 inpay_directpayment_register_callback($res, $id, $function);
 inpay_directpayment_get_last_error($res);
 inpay_directpayment_get_last_error_code($res);
 inpay_directpayment_set($res, $id, $index, $value);
 inpay_directpayment_get($res, $id, $index);
 inpay_directpayment_do_addcustomfield($res, $name, $value);
 inpay_directpayment_do_authorize($res);
 inpay_directpayment_do_capture($res, $authorizationid, $amount);
 inpay_directpayment_do_config($res, $configurationstring);
 inpay_directpayment_do_doevents($res);
 inpay_directpayment_do_getresponsevar($res, $name);
 inpay_directpayment_do_interrupt($res);
 inpay_directpayment_do_reset($res);
 inpay_directpayment_do_sale($res);
 inpay_directpayment_do_voidtransaction($res, $authorizationid);

Remarks

The DirectPayment class allows you to obtain payment for buyers who do not have a PayPal account. DirectPayment allows you to use your PayPal account as a gateway for any credit card. Your buyer no longer needs to have his own PayPal account.

At the time of this writing, in order to use this class you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple. First set the User to your API name, and Password to the password for that API. Set the Signature property to the API signature you received from PayPal. Then you may set the transaction properties, such as : OrderTotal, CardNumber, CardExpMonth, CardExpYear, etc. Then call either Sale or Authorize. The Ack property will indicate the success or failure of the transaction.

After an authorization, the ResponseTransactionId should be saved and logged. This value may be used to capture or void any previous uncompleted Authorize transactions (these functions will not work for a Sale transaction, which is already considered complete).

In addition, this class also provides the results to two anti-fraud measures: Address Verification Service (AVS) and Card Verification Value (CVV) tests. The results of these tests will be stored in the ResponseAVS and ResponseCVV, respectively. Although a transaction may be authorized, it is up to the merchant to inspect these properties and determine whether or not to honor the transaction.

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.

Ack Property (InPay_DirectPayment Class)

Acknowledgement code received from PayPal.

Object Oriented Interface

public function getAck();

Procedural Interface

inpay_directpayment_get($res, 1 );

Default Value

''

Remarks

This property will contain the acknowledgement code returned by PayPal that indicates the status of the transaction. It may contain one of the following values:

This property is read-only.

Data Type

String

CardType Property (InPay_DirectPayment Class)

This property specifies the type of the credit card specified in Number .

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 2 );
inpay_directpayment_set($res, 2, $value );

Default Value

0

Remarks

This property specifies the type of the credit card specified in CardNumber.

This property contains the type of the credit card (Visa, MasterCard, Amex, etc.) specified during the current transaction.

The valid card types for this property are listed below:

* Note: CurrencyCode must equal "GBP" to use this CardType. You may set the StartMonth, StartYear, and IssueNumber required for these cards via the Config method.

This property is required.

This property is not available at design time.

Data Type

Integer

CardCVV Property (InPay_DirectPayment Class)

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

Object Oriented Interface

public function getCardCVV();
public function setCardCVV($value);

Procedural Interface

inpay_directpayment_get($res, 3 );
inpay_directpayment_set($res, 3, $value );

Default Value

''

Remarks

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

This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVV data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the field and decide whether to honor the transaction or not.

Character length and limitations: Up to four single-byte numeric characters.

This property is optional.

This property is not available at design time.

Data Type

String

CardExpMonth Property (InPay_DirectPayment Class)

This property contains the expiration month of the customer's credit card.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 4 );
inpay_directpayment_set($res, 4, $value );

Default Value

1

Remarks

This field contains the expiration month of the customer's credit card.

The valid range for this property is between 1 and 12.

This property is required.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (InPay_DirectPayment Class)

This property contains the 4 digit expiration year of the customer's credit card.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 5 );
inpay_directpayment_set($res, 5, $value );

Default Value

2000

Remarks

This field contains the 4 digit expiration year of the customer's credit card.

This property is required.

This property is not available at design time.

Data Type

Integer

CardNumber Property (InPay_DirectPayment Class)

This property contains the customer's credit card number for this transaction.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 6 );
inpay_directpayment_set($res, 6, $value );

Default Value

''

Remarks

This field contains the customer's credit card number for this transaction.

Character length and limitations: numeric characters only - no spaces, dashes or punctuation. Must conform with modulo and length required by each credit card type.

This property is required.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (InPay_DirectPayment Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

inpay_directpayment_get($res, 7 );
inpay_directpayment_set($res, 7, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (InPay_DirectPayment Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

inpay_directpayment_get($res, 8 );
inpay_directpayment_set($res, 8, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (InPay_DirectPayment Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

inpay_directpayment_get($res, 9 );
inpay_directpayment_set($res, 9, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (InPay_DirectPayment Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

inpay_directpayment_get($res, 10 );
inpay_directpayment_set($res, 10, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (InPay_DirectPayment Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

inpay_directpayment_get($res, 11 );
inpay_directpayment_set($res, 11, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (InPay_DirectPayment Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

inpay_directpayment_get($res, 12 );
inpay_directpayment_set($res, 12, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (InPay_DirectPayment Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

inpay_directpayment_get($res, 13 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

InvoiceNumber Property (InPay_DirectPayment Class)

Your own invoice or tracking number.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 14 );
inpay_directpayment_set($res, 14, $value );

Default Value

''

Remarks

Character length and limitations: 127 single-byte alphanumeric characters.

This property is optional.

Data Type

String

ItemCount Property (InPay_DirectPayment Class)

The number of records in the Item arrays.

Object Oriented Interface

public function getItemCount();
public function setItemCount($value);

Procedural Interface

inpay_directpayment_get($res, 15 );
inpay_directpayment_set($res, 15, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAmount
• ItemDescription
• ItemName
• ItemNumber
• ItemOptions
• ItemQuantity
• ItemSalesTax

The array indices start at 0 and end at ItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemAmount Property (InPay_DirectPayment Class)

Amount of charged on payment.

Object Oriented Interface

public function getItemAmount($itemindex);
public function setItemAmount($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 16 , $itemindex);
inpay_directpayment_set($res, 16, $value , $itemindex);

Default Value

''

Remarks

Amount of charged on payment. It must have 2 decimal places, the decimal separator must be a period (.). An example Amount is "1010.10".

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (InPay_DirectPayment Class)

Paypal item description for the shopping cart.

Object Oriented Interface

public function getItemDescription($itemindex);
public function setItemDescription($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 17 , $itemindex);
inpay_directpayment_set($res, 17, $value , $itemindex);

Default Value

''

Remarks

Paypal item description for the shopping cart.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (InPay_DirectPayment Class)

Name of the item purchased.

Object Oriented Interface

public function getItemName($itemindex);
public function setItemName($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 18 , $itemindex);
inpay_directpayment_set($res, 18, $value , $itemindex);

Default Value

''

Remarks

Name of the item purchased.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemNumber Property (InPay_DirectPayment Class)

Item number set by the merchant.

Object Oriented Interface

public function getItemNumber($itemindex);
public function setItemNumber($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 19 , $itemindex);
inpay_directpayment_set($res, 19, $value , $itemindex);

Default Value

''

Remarks

Item number set by the merchant.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOptions Property (InPay_DirectPayment Class)

Paypal item options for the shopping cart.

Object Oriented Interface

public function getItemOptions($itemindex);
public function setItemOptions($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 20 , $itemindex);
inpay_directpayment_set($res, 20, $value , $itemindex);

Default Value

''

Remarks

Paypal item options for the shopping cart.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (InPay_DirectPayment Class)

Quantity of items ordered.

Object Oriented Interface

public function getItemQuantity($itemindex);
public function setItemQuantity($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 21 , $itemindex);
inpay_directpayment_set($res, 21, $value , $itemindex);

Default Value

0

Remarks

Quantity of items ordered.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemSalesTax Property (InPay_DirectPayment Class)

Amount of tax charged on payment.

Object Oriented Interface

public function getItemSalesTax($itemindex);
public function setItemSalesTax($itemindex, $value);

Procedural Interface

inpay_directpayment_get($res, 22 , $itemindex);
inpay_directpayment_set($res, 22, $value , $itemindex);

Default Value

''

Remarks

Amount of tax charged on payment.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTotal Property (InPay_DirectPayment Class)

Sum of all the Amount s.

Object Oriented Interface

public function getItemTotal();
public function setItemTotal($value);

Procedural Interface

inpay_directpayment_get($res, 23 );
inpay_directpayment_set($res, 23, $value );

Default Value

''

Remarks

This property contains the sum cost of all items in this order, and may not contain any sales tax or shipping and handling charges.

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

MerchantSessionId Property (InPay_DirectPayment Class)

Your customer session identification token.

Object Oriented Interface

public function getMerchantSessionId();
public function setMerchantSessionId($value);

Procedural Interface

inpay_directpayment_get($res, 24 );
inpay_directpayment_set($res, 24, $value );

Default Value

''

Remarks

PayPal records this optional session identification token as an additional means to detect possible fraud.

This property is optional.

Character length and limitations: 64 single-byte numeric characters.

Data Type

String

Note Property (InPay_DirectPayment Class)

An informational note about this settlement that will be displayed in the payer's transaction history.

Object Oriented Interface

public function getNote();
public function setNote($value);

Procedural Interface

inpay_directpayment_get($res, 25 );
inpay_directpayment_set($res, 25, $value );

Default Value

''

Remarks

Used during Capture or VoidTransaction.

This property is optional.

Character length and limits: 255 single-byte characters.

Data Type

String

OrderDescription Property (InPay_DirectPayment Class)

Description of items the customer is purchasing.

Object Oriented Interface

public function getOrderDescription();
public function setOrderDescription($value);

Procedural Interface

inpay_directpayment_get($res, 26 );
inpay_directpayment_set($res, 26, $value );

Default Value

''

Remarks

This property is optional.

Character length and limitations: 127 single-byte alphanumeric characters.

Data Type

String

OrderTotal Property (InPay_DirectPayment Class)

Total amount of the order.

Object Oriented Interface

public function getOrderTotal();
public function setOrderTotal($value);

Procedural Interface

inpay_directpayment_get($res, 27 );
inpay_directpayment_set($res, 27, $value );

Default Value

''

Remarks

This includes: sales tax applied (TaxTotal), shipping (ShippingTotal) and handling charges.

This property is required.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Password Property (InPay_DirectPayment Class)

Password for communicating with PayPal.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 28 );
inpay_directpayment_set($res, 28, $value );

Default Value

''

Remarks

This property is required to post messages to the PayPal URL. Do not confuse this property with your PayPal password. This password must match the API User you create from inside your PayPal account.

Data Type

String

PayerCity Property (InPay_DirectPayment Class)

Payer's city name.

Object Oriented Interface

public function getPayerCity();
public function setPayerCity($value);

Procedural Interface

inpay_directpayment_get($res, 29 );
inpay_directpayment_set($res, 29, $value );

Default Value

''

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerCountryCode Property (InPay_DirectPayment Class)

Payer's country code.

Object Oriented Interface

public function getPayerCountryCode();
public function setPayerCountryCode($value);

Procedural Interface

inpay_directpayment_get($res, 30 );
inpay_directpayment_set($res, 30, $value );

Default Value

'US'

Remarks

Payer's country code.

Payer's country of residence in the form of ISO standard 3166 two-character country codes.

This property is required.

Character limit: Two single-byte characters.

Data Type

String

PayerCountryName Property (InPay_DirectPayment Class)

Payer's country name.

Object Oriented Interface

public function getPayerCountryName();

Procedural Interface

inpay_directpayment_get($res, 31 );

Default Value

'US'

Remarks

Payer's country name.

This property has been deprecated.

This property is read-only.

Data Type

String

PayerEmail Property (InPay_DirectPayment Class)

Email address of the payer.

Object Oriented Interface

public function getPayerEmail();
public function setPayerEmail($value);

Procedural Interface

inpay_directpayment_get($res, 32 );
inpay_directpayment_set($res, 32, $value );

Default Value

''

Remarks

Email address of the payer.

This property is optional.

Data Type

String

PayerFirstName Property (InPay_DirectPayment Class)

Payer's first name.

Object Oriented Interface

public function getPayerFirstName();
public function setPayerFirstName($value);

Procedural Interface

inpay_directpayment_get($res, 33 );
inpay_directpayment_set($res, 33, $value );

Default Value

''

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerIPAddress Property (InPay_DirectPayment Class)

IP address of the payer's browser as recorded in its HTTP request to your website.

Object Oriented Interface

public function getPayerIPAddress();
public function setPayerIPAddress($value);

Procedural Interface

inpay_directpayment_get($res, 34 );
inpay_directpayment_set($res, 34, $value );

Default Value

''

Remarks

IP address of the payer's browser as recorded in its HTTP request to your website.

Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???

NOTE: PayPal records this IP address as a means to detect possible fraud.

This property is required.

Data Type

String

PayerLastName Property (InPay_DirectPayment Class)

Payer's last name.

Object Oriented Interface

public function getPayerLastName();
public function setPayerLastName($value);

Procedural Interface

inpay_directpayment_get($res, 35 );
inpay_directpayment_set($res, 35, $value );

Default Value

''

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerState Property (InPay_DirectPayment Class)

Payer's state or province name.

Object Oriented Interface

public function getPayerState();
public function setPayerState($value);

Procedural Interface

inpay_directpayment_get($res, 36 );
inpay_directpayment_set($res, 36, $value );

Default Value

''

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerStatus Property (InPay_DirectPayment Class)

Indicates whether the payer is verified or not.

Object Oriented Interface

public function getPayerStatus();
public function setPayerStatus($value);

Procedural Interface

inpay_directpayment_get($res, 37 );
inpay_directpayment_set($res, 37, $value );

Default Value

''

Remarks

Indicates whether the payer is verified or not.

Valid values for this property are "verified" or "unverified".

Data Type

String

PayerStreet1 Property (InPay_DirectPayment Class)

Payer's street address (first line).

Object Oriented Interface

public function getPayerStreet1();
public function setPayerStreet1($value);

Procedural Interface

inpay_directpayment_get($res, 38 );
inpay_directpayment_set($res, 38, $value );

Default Value

''

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerStreet2 Property (InPay_DirectPayment Class)

Payer's street address (second line).

Object Oriented Interface

public function getPayerStreet2();
public function setPayerStreet2($value);

Procedural Interface

inpay_directpayment_get($res, 39 );
inpay_directpayment_set($res, 39, $value );

Default Value

''

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerZip Property (InPay_DirectPayment Class)

Payer's United States ZIP code or other country-specific postal code.

Object Oriented Interface

public function getPayerZip();
public function setPayerZip($value);

Procedural Interface

inpay_directpayment_get($res, 40 );
inpay_directpayment_set($res, 40, $value );

Default Value

''

Remarks

Payer's United States ZIP code or other country-specific postal code.

This property is required.

Character length and limitations: 20 single-byte characters.

Data Type

String

PaymentDate Property (InPay_DirectPayment Class)

This is the time/date stamp of payment.

Object Oriented Interface

public function getPaymentDate();

Procedural Interface

inpay_directpayment_get($res, 41 );

Default Value

''

Remarks

This is the time/date stamp of payment.

This property is read-only.

Data Type

String

PaymentExchangeRate Property (InPay_DirectPayment Class)

Exchange rate if a currency conversion occurred.

Object Oriented Interface

public function getPaymentExchangeRate();

Procedural Interface

inpay_directpayment_get($res, 42 );

Default Value

''

Remarks

Exchange rate if a currency conversion occurred.

Relevant only if you are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer's account.

This property is read-only.

Data Type

String

PaymentFeeAmount Property (InPay_DirectPayment Class)

PayPal fee amount charged for the transaction.

Object Oriented Interface

public function getPaymentFeeAmount();

Procedural Interface

inpay_directpayment_get($res, 43 );

Default Value

''

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

Data Type

String

PaymentGrossAmount Property (InPay_DirectPayment Class)

The final amount charged.

Object Oriented Interface

public function getPaymentGrossAmount();

Procedural Interface

inpay_directpayment_get($res, 44 );

Default Value

''

Remarks

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

This property is read-only.

Data Type

String

PaymentType Property (InPay_DirectPayment Class)

Indicates whether the payment is instant or delayed.

Object Oriented Interface

public function getPaymentType();

Procedural Interface

inpay_directpayment_get($res, 45 );

Default Value

''

Remarks

Indicates whether the payment is instant or delayed.

Current list of return values: none, echeck, instant.

This property is read-only.

Data Type

String

PaymentPendingReason Property (InPay_DirectPayment Class)

The reason the payment is pending.

Object Oriented Interface

public function getPaymentPendingReason();

Procedural Interface

inpay_directpayment_get($res, 46 );

Default Value

''

Remarks

The reason the payment is pending.

The current list of possible return values for this property are:

This property is read-only.

Data Type

String

PaymentSettleAmount Property (InPay_DirectPayment Class)

Amount deposited in your PayPal account after a currency conversion.

Object Oriented Interface

public function getPaymentSettleAmount();

Procedural Interface

inpay_directpayment_get($res, 47 );

Default Value

''

Remarks

Amount deposited in your PayPal account after a currency conversion.

If there is no currency conversion, this property will remain empty.

This property is read-only.

Data Type

String

PaymentStatus Property (InPay_DirectPayment Class)

Status of the payment.

Object Oriented Interface

public function getPaymentStatus();

Procedural Interface

inpay_directpayment_get($res, 48 );

Default Value

''

Remarks

Status of the payment.

The current list of possible values for this property are:

- "Canceled-Reversal": it means that a reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.

- "Denied": this happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

- "Failed": this happens only if the payment was made from your customer's bank account.

- "Pending": see the PaymentPendingReason field for more information.

This property is read-only.

Data Type

String

PaymentTaxAmount Property (InPay_DirectPayment Class)

Tax charged on the transaction.

Object Oriented Interface

public function getPaymentTaxAmount();

Procedural Interface

inpay_directpayment_get($res, 49 );

Default Value

''

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (InPay_DirectPayment Class)

Unique transaction ID of the payment.

Object Oriented Interface

public function getPaymentTransactionId();

Procedural Interface

inpay_directpayment_get($res, 50 );

Default Value

''

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (InPay_DirectPayment Class)

The type of transaction.

Object Oriented Interface

public function getPaymentTransactionType();

Procedural Interface

inpay_directpayment_get($res, 51 );

Default Value

''

Remarks

The type of transaction.

Current list of return values: cart, express-checkout.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (InPay_DirectPayment Class)

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

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 52 );
inpay_directpayment_set($res, 52, $value );

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

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

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 53 );
inpay_directpayment_set($res, 53, $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 (InPay_DirectPayment Class)

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

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 54 );
inpay_directpayment_set($res, 54, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 55 );
inpay_directpayment_set($res, 55, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 56 );
inpay_directpayment_set($res, 56, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 57 );
inpay_directpayment_set($res, 57, $value );

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

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

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 58 );
inpay_directpayment_set($res, 58, $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

ResponseAmount Property (InPay_DirectPayment Class)

Amount returned in the response.

Object Oriented Interface

public function getResponseAmount();

Procedural Interface

inpay_directpayment_get($res, 59 );

Default Value

''

Remarks

Amount returned in the response.

This should always match the value sent in OrderTotal.

This property is read-only.

Data Type

String

ResponseAVS Property (InPay_DirectPayment Class)

The Address Verification System response code.

Object Oriented Interface

public function getResponseAVS();

Procedural Interface

inpay_directpayment_get($res, 60 );

Default Value

''

Remarks

The Address Verification System response code.

This one character field contains the Address Verification System (AVS) result code. This is always returned in the server response. The AVS service is used to help detect fraud. While PayPal may authorize a payment, it is up to the merchant to check the ResponseAVS and decide whether or not to honor the transaction.

The valid AVS codes are listed in the table below.

This property is read-only.

Data Type

String

ResponseCVV Property (InPay_DirectPayment Class)

Result of the CVV check by PayPal.

Object Oriented Interface

public function getResponseCVV();

Procedural Interface

inpay_directpayment_get($res, 61 );

Default Value

''

Remarks

Result of the CardCVV check by PayPal.

If a CVV value was present in the CardCVV property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. This is used to help detect fraud. It is up to the merchant to inspect this value and determine whether or not to honor the transaction.

The following is a list of current result codes:

This property is read-only.

Data Type

String

ResponseTransactionId Property (InPay_DirectPayment Class)

Unique Transaction Id of the payment.

Object Oriented Interface

public function getResponseTransactionId();

Procedural Interface

inpay_directpayment_get($res, 62 );

Default Value

''

Remarks

Unique Transaction Id of the payment.

The value of this property is returned by the server when either one of the following methods is called:

- Sale. In this case, the ResponseTransactionId is your record of the transaction.

- Authorize. You will need the value of ResponseTransactionId for use as a key when capturing funds.

Character length and limitations:17 single-byte characters.

This property is read-only.

Data Type

String

ShippingTotal Property (InPay_DirectPayment Class)

Total shipping costs for this order.

Object Oriented Interface

public function getShippingTotal();
public function setShippingTotal($value);

Procedural Interface

inpay_directpayment_get($res, 63 );
inpay_directpayment_set($res, 63, $value );

Default Value

''

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Signature Property (InPay_DirectPayment Class)

Value to use with PayPal's Signature Authentication scheme.

Object Oriented Interface

public function getSignature();
public function setSignature($value);

Procedural Interface

inpay_directpayment_get($res, 64 );
inpay_directpayment_set($res, 64, $value );

Default Value

''

Remarks

A PayPal-generated unique digital signature (a line of text, or hash) that you copy from PayPal's website and include in API calls made by this class. An alternative to API Certificate security. Your digital signature, your API username, and your API password all together are called three-token authentication. An API signature is suitable for use with Microsoft Windows web servers or other shared web server configurations, such as those used by web hosting services. Multiple API signatures can be associated with your API username and password. For security, every time you view your API credential/signature on https://www.paypal.com, a new signature is generated. In your API calls, you can use any of the signatures that PayPal generates for you. All the signatures are equally valid until you remove your credentials by clicking Remove on the View API Signature page.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (InPay_DirectPayment Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

inpay_directpayment_get($res, 65 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

inpay_directpayment_get($res, 66 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

inpay_directpayment_get($res, 67 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

inpay_directpayment_get($res, 68 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 69 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 70 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

inpay_directpayment_get($res, 71 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

inpay_directpayment_get($res, 72 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

inpay_directpayment_get($res, 73 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

inpay_directpayment_get($res, 74 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

inpay_directpayment_get($res, 75 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 76 );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

inpay_directpayment_get($res, 77 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

inpay_directpayment_get($res, 78 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 79 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 80 );
inpay_directpayment_set($res, 80, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 81 );
inpay_directpayment_set($res, 81, $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 (InPay_DirectPayment Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 82 );
inpay_directpayment_set($res, 82, $value );

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

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

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

inpay_directpayment_get($res, 83 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (InPay_DirectPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

inpay_directpayment_get($res, 84 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 85 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 86 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

inpay_directpayment_get($res, 87 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

inpay_directpayment_get($res, 88 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

inpay_directpayment_get($res, 89 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 90 );
inpay_directpayment_set($res, 90, $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=support@nsoftware.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 (InPay_DirectPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 91 );
inpay_directpayment_set($res, 91, $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 (InPay_DirectPayment Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

inpay_directpayment_get($res, 92 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

inpay_directpayment_get($res, 93 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

inpay_directpayment_get($res, 94 );

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

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

inpay_directpayment_get($res, 95 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 96 );

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

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 97 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

inpay_directpayment_get($res, 98 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

inpay_directpayment_get($res, 99 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

inpay_directpayment_get($res, 100 );

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

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

inpay_directpayment_get($res, 101 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

inpay_directpayment_get($res, 102 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 103 );

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

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

inpay_directpayment_get($res, 104 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

inpay_directpayment_get($res, 105 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 106 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 107 );
inpay_directpayment_set($res, 107, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 108 );
inpay_directpayment_set($res, 108, $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 (InPay_DirectPayment Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 109 );
inpay_directpayment_set($res, 109, $value );

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

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

inpay_directpayment_get($res, 110 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (InPay_DirectPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

inpay_directpayment_get($res, 111 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 112 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 113 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

inpay_directpayment_get($res, 114 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

inpay_directpayment_get($res, 115 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

inpay_directpayment_get($res, 116 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 117 );
inpay_directpayment_set($res, 117, $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=support@nsoftware.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 (InPay_DirectPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 118 );
inpay_directpayment_set($res, 118, $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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 119 );
inpay_directpayment_set($res, 119, $value );

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

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

inpay_directpayment_get($res, 120 );

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

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

inpay_directpayment_get($res, 121 );

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

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

inpay_directpayment_get($res, 122 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

inpay_directpayment_get($res, 123 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 124 );

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

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

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 125 );

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

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

inpay_directpayment_get($res, 126 );

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

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

inpay_directpayment_get($res, 127 );

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

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

inpay_directpayment_get($res, 128 );

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

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

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

inpay_directpayment_get($res, 129 );

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

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

inpay_directpayment_get($res, 130 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 131 );

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

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

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

inpay_directpayment_get($res, 132 );

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

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

inpay_directpayment_get($res, 133 );

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

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

inpay_directpayment_get($res, 134 );

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

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

inpay_directpayment_get($res, 135 );

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 (InPay_DirectPayment 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

inpay_directpayment_get($res, 136 );

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

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

inpay_directpayment_get($res, 137 );

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

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

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

inpay_directpayment_get($res, 138 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (InPay_DirectPayment Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

inpay_directpayment_get($res, 139 );

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

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

inpay_directpayment_get($res, 140 );

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

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

inpay_directpayment_get($res, 141 );

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

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

inpay_directpayment_get($res, 142 );

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

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

inpay_directpayment_get($res, 143 );

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

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

inpay_directpayment_get($res, 144 );

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

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

inpay_directpayment_get($res, 145 );

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=support@nsoftware.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 (InPay_DirectPayment Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inpay_directpayment_get($res, 146 );

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

TaxTotal Property (InPay_DirectPayment Class)

Sum of tax for all items included in this order.

Object Oriented Interface

public function getTaxTotal();
public function setTaxTotal($value);

Procedural Interface

inpay_directpayment_get($res, 147 );
inpay_directpayment_set($res, 147, $value );

Default Value

''

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Timeout Property (InPay_DirectPayment Class)

A timeout for the class.

Object Oriented Interface

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

Procedural Interface

inpay_directpayment_get($res, 148 );
inpay_directpayment_set($res, 148, $value );

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

URL Property (InPay_DirectPayment Class)

URL all PayPal payment transactions are posted to.

Object Oriented Interface

public function getURL();
public function setURL($value);

Procedural Interface

inpay_directpayment_get($res, 149 );
inpay_directpayment_set($res, 149, $value );

Default Value

'https://api-3t.paypal.com/nvp'

Remarks

This is the URL to which the class posts requests to, and receives responses from. The server you use depends on whether you are using the "API Certificate" or the "API Signature" authentication scheme. If you use the API Certificate authentication scheme, you must set the SSLCert with your client-side certificate. If using the Signature method, set the Signature property instead. The list of valid URLs is shown below:

Data Type

String

User Property (InPay_DirectPayment Class)

User name for communicating with Paypal.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

inpay_directpayment_get($res, 150 );
inpay_directpayment_set($res, 150, $value );

Default Value

''

Remarks

This property is required to post messages to the PayPal URL. This should not be the same username as your PayPal account login, but rather the name of the API service you've created in your account. If you allow PayPal to auto-generate the name, it is usually the first part of your email address plus "_api1." plus the last part of your email address. For instance, a PayPal Id of test@teststore.com would generate a user name test_api1.teststore.com.

Data Type

String

AddCustomField Method (InPay_DirectPayment Class)

This adds a custom name-value pair to be sent with the next request.

Object Oriented Interface

public function doAddCustomField($name, $value);

Procedural Interface

inpay_directpayment_do_addcustomfield($res, $name, $value);

Remarks

This method should be used to append a custom name-value pair to the next outgoing request to PayPal.

Note: The custom fields that have been added will be cleared by the class automatically after each request.

Authorize Method (InPay_DirectPayment Class)

This method sends an Authorization transaction to PayPal.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

inpay_directpayment_do_authorize($res);

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account.

However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

Capture Method (InPay_DirectPayment Class)

Completely or partially settles a previously authorized transaction.

Object Oriented Interface

public function doCapture($authorizationid, $amount);

Procedural Interface

inpay_directpayment_do_capture($res, $authorizationid, $amount);

Remarks

This method captures the transaction indicated by the AuthorizationId parameter for the amount specified in the Amount parameter. You may capture less than the authorized amount by setting the IsPartialCapture configuration setting to True.

Config Method (InPay_DirectPayment Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DoEvents Method (InPay_DirectPayment Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inpay_directpayment_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetResponseVar Method (InPay_DirectPayment Class)

It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.

Object Oriented Interface

public function doGetResponseVar($name);

Procedural Interface

inpay_directpayment_do_getresponsevar($res, $name);

Remarks

This method allows you to retrieve additional variables from the response. The value is returned by the method. Note that the variable name is case-sensitive. component.GetResponseVar("ACK")

Interrupt Method (InPay_DirectPayment Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_directpayment_do_interrupt($res);

Remarks

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

Reset Method (InPay_DirectPayment Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_directpayment_do_reset($res);

Remarks

This method clears all properties to their default values and returns the component to its default state.

Sale Method (InPay_DirectPayment Class)

This method sends a Sale transaction to PayPal.

Object Oriented Interface

public function doSale();

Procedural Interface

inpay_directpayment_do_sale($res);

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account. However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

VoidTransaction Method (InPay_DirectPayment Class)

Voids a prior authorization.

Object Oriented Interface

public function doVoidTransaction($authorizationid);

Procedural Interface

inpay_directpayment_do_voidtransaction($res, $authorizationid);

Remarks

This voids the transaction indicated by the AuthorizationId parameter.

Note: when the three-day authorization period expires, the authorization of a transaction is implicitly voided.

Error Event (InPay_DirectPayment Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

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

ErrorCode contains an error code and Description 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 (InPay_DirectPayment Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inpay_directpayment_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 (InPay_DirectPayment Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Config Settings (DirectPayment Class)

DirectPayment Config Settings

HTTP 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 (DirectPayment Class)

DirectPayment 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