ExpressCheckout Class

Properties   Methods   Events   Config Settings   Errors  

Express Checkout allows customers the option to quickly pay through PayPal.

Class Name

InPay_ExpressCheckout

Procedural Interface

 inpay_expresscheckout_open();
 inpay_expresscheckout_close($res);
 inpay_expresscheckout_register_callback($res, $id, $function);
 inpay_expresscheckout_get_last_error($res);
 inpay_expresscheckout_get_last_error_code($res);
 inpay_expresscheckout_set($res, $id, $index, $value);
 inpay_expresscheckout_get($res, $id, $index);
 inpay_expresscheckout_do_addcustomfield($res, $name, $value);
 inpay_expresscheckout_do_capture($res, $authorizationid, $amount);
 inpay_expresscheckout_do_checkoutpayment($res);
 inpay_expresscheckout_do_config($res, $configurationstring);
 inpay_expresscheckout_do_doevents($res);
 inpay_expresscheckout_do_getcheckoutdetails($res);
 inpay_expresscheckout_do_getresponsevar($res, $name);
 inpay_expresscheckout_do_interrupt($res);
 inpay_expresscheckout_do_reset($res);
 inpay_expresscheckout_do_setcheckout($res);
 inpay_expresscheckout_do_voidtransaction($res, $authorizationid);

Remarks

The ExpressCheckout class allows you to integrate PayPal payments into your application by redirecting customers to the PayPal site. During the ExpressCheckout process, a token is generated which encodes transaction details and is used to identify the transaction on the PayPal network. After fetching a token, the customer must be redirected to PayPal's website to fill out payment information. PayPal will then redirect the customer to the URL specified by the class's ReturnURL property. PayPal will append the token to this URL so that it can be accessed after both redirects are complete. This token should then be used to verify details about the payment and finalize the transaction.

The first step in this process is to use the SetCheckout method to fetch a token from PayPal. If the Ack property indicates that this is successful, you should append the ResponseToken value to PayPal's express checkout URL and redirect the customer there. Redirection is not handled automatically by the component and requires external implementation. After the customer pays on PayPal's site, the customer will be automatically returned to the ReturnURL. If the customer declines to pay, PayPal will redirect to the CancelURL instead. Both of these properties must be set prior to calling SetCheckout. All of the remaining steps in the ExpressCheckout process must then be performed on the page given by ReturnURL.

The following is an example of fetching a token and redirecting to PayPal's site. Note that the PayPal credentials and URL (User, Password, Signature, and URL) are also required before calling SetCheckout. expresscheckout1.OrderTotal = "88.88"; expresscheckout1.ReturnURL = "http://localhost/example/return/url"; expresscheckout1.CancelURL = "http://localhost/example/cancel/url"; expresscheckout1.PaymentAction = ExpresscheckoutPaymentActions.aSale; expresscheckout1.SetCheckout(); // Now check for success and redirect the buyer: if (expresscheckout1.Ack == "Success") { // Redirect is not a component method and should be implemented externally Redirect("https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=" + expresscheckout1.ResponseToken) }

The following steps should now take place on the page indicated by ReturnURL.

Next, the PayPal token must be retrieved. PayPal automatically appends the token to the specified ReturnURL, so this value should be parsed and set as the Token property. The PayPal credentials and URL (User, Password, Signature, and URL) should also be set if they have not already been. Next, GetCheckoutDetails should be called so that Payer and Payment properties are automatically populated. The PayerId property is required before finalizing the transaction, but you may also want to check other fields under the Payer and Payment properties to ensure they are correct.

Finally, if all transaction details are correct, the CheckoutPayment method should be called to finalize the payment. If PaymentAction is set to aSale, this will finalize the transaction and transfer funds to your PayPal account. If instead the PaymentAction is set to aAuthorization, you will need to capture the transaction later.

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_ExpressCheckout Class)

Acknowledgement code received from PayPal.

Object Oriented Interface

public function getAck();

Procedural Interface

inpay_expresscheckout_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

BuyerEmail Property (InPay_ExpressCheckout Class)

Buyer's email address.

Object Oriented Interface

public function getBuyerEmail();


public function setBuyerEmail($value);

Procedural Interface

inpay_expresscheckout_get($res, 2 );


inpay_expresscheckout_set($res, 2, $value );

Default Value

''

Remarks

Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page.

This property is optional when calling the SetCheckout method.

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

Data Type

String

CancelURL Property (InPay_ExpressCheckout Class)

URL to which the customer is returned if he decides not to pay with PayPal.

Object Oriented Interface

public function getCancelURL();


public function setCancelURL($value);

Procedural Interface

inpay_expresscheckout_get($res, 3 );


inpay_expresscheckout_set($res, 3, $value );

Default Value

''

Remarks

If the user starts to pay with PayPal, and then changes his mind, his browser will be redirected to this URL on your server. This may be set to the original page on which the customer chose his payment method.

This property is required when calling the SetCheckout method.

Character length and limitations: no limit. Must be URL-encoded.

Data Type

String

ContactPhone Property (InPay_ExpressCheckout Class)

Payer's contact telephone number.

Object Oriented Interface

public function getContactPhone();

Procedural Interface

inpay_expresscheckout_get($res, 4 );

Default Value

''

Remarks

PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.

This property is returned after a call to the GetCheckoutDetails method.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (InPay_ExpressCheckout Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

inpay_expresscheckout_get($res, 5 );


inpay_expresscheckout_set($res, 5, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (InPay_ExpressCheckout Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

inpay_expresscheckout_get($res, 6 );


inpay_expresscheckout_set($res, 6, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (InPay_ExpressCheckout Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

inpay_expresscheckout_get($res, 7 );


inpay_expresscheckout_set($res, 7, $value );

Default Value

''

Remarks

This property contains the name or IP address of 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_ExpressCheckout Class)

This property contains 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_expresscheckout_get($res, 8 );


inpay_expresscheckout_set($res, 8, $value );

Default Value

''

Remarks

This property contains 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_ExpressCheckout Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

inpay_expresscheckout_get($res, 9 );


inpay_expresscheckout_set($res, 9, $value );

Default Value

0

Remarks

This property contains 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_ExpressCheckout Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

inpay_expresscheckout_get($res, 10 );


inpay_expresscheckout_set($res, 10, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property 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

Idle Property (InPay_ExpressCheckout Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

inpay_expresscheckout_get($res, 11 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

InvoiceNumber Property (InPay_ExpressCheckout Class)

Your own unique invoice or tracking number.

Object Oriented Interface

public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface

inpay_expresscheckout_get($res, 12 );


inpay_expresscheckout_set($res, 12, $value );

Default Value

''

Remarks

This property is optional when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

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

Data Type

String

ItemCount Property (InPay_ExpressCheckout Class)

The number of records in the Item arrays.

Object Oriented Interface

public function getItemCount();


public function setItemCount($value);

Procedural Interface

inpay_expresscheckout_get($res, 13 );


inpay_expresscheckout_set($res, 13, $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_ExpressCheckout Class)

Amount of charged on payment.

Object Oriented Interface

public function getItemAmount($itemindex);


public function setItemAmount($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 14 , $itemindex);


inpay_expresscheckout_set($res, 14, $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_ExpressCheckout Class)

Paypal item description for the shopping cart.

Object Oriented Interface

public function getItemDescription($itemindex);


public function setItemDescription($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 15 , $itemindex);


inpay_expresscheckout_set($res, 15, $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_ExpressCheckout Class)

Name of the item purchased.

Object Oriented Interface

public function getItemName($itemindex);


public function setItemName($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 16 , $itemindex);


inpay_expresscheckout_set($res, 16, $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_ExpressCheckout Class)

Item number set by the merchant.

Object Oriented Interface

public function getItemNumber($itemindex);


public function setItemNumber($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 17 , $itemindex);


inpay_expresscheckout_set($res, 17, $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_ExpressCheckout Class)

Paypal item options for the shopping cart.

Object Oriented Interface

public function getItemOptions($itemindex);


public function setItemOptions($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 18 , $itemindex);


inpay_expresscheckout_set($res, 18, $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_ExpressCheckout Class)

Quantity of items ordered.

Object Oriented Interface

public function getItemQuantity($itemindex);


public function setItemQuantity($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 19 , $itemindex);


inpay_expresscheckout_set($res, 19, $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_ExpressCheckout Class)

Amount of tax charged on payment.

Object Oriented Interface

public function getItemSalesTax($itemindex);


public function setItemSalesTax($itemindex, $value);

Procedural Interface

inpay_expresscheckout_get($res, 20 , $itemindex);


inpay_expresscheckout_set($res, 20, $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

Note Property (InPay_ExpressCheckout 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_expresscheckout_get($res, 21 );


inpay_expresscheckout_set($res, 21, $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_ExpressCheckout Class)

Description of items the customer is purchasing.

Object Oriented Interface

public function getOrderDescription();


public function setOrderDescription($value);

Procedural Interface

inpay_expresscheckout_get($res, 22 );


inpay_expresscheckout_set($res, 22, $value );

Default Value

''

Remarks

This property is optional.

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

This property is optional when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

Data Type

String

OrderTotal Property (InPay_ExpressCheckout Class)

The total cost of the order to the customer.

Object Oriented Interface

public function getOrderTotal();


public function setOrderTotal($value);

Procedural Interface

inpay_expresscheckout_get($res, 23 );


inpay_expresscheckout_set($res, 23, $value );

Default Value

''

Remarks

If shipping cost and tax charges are known, those should included in the OrderTotal if not, the value of this property is the current sub-total of the order.

This property is required when calling the CheckoutPayment method.

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_ExpressCheckout Class)

Password for communicating with PayPal.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

inpay_expresscheckout_get($res, 24 );


inpay_expresscheckout_set($res, 24, $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

PayerBusiness Property (InPay_ExpressCheckout Class)

Payer's business email address.

Object Oriented Interface

public function getPayerBusiness();

Procedural Interface

inpay_expresscheckout_get($res, 25 );

Default Value

''

Remarks

Payer's business email address.

This property is read-only.

Data Type

String

PayerCity Property (InPay_ExpressCheckout Class)

Payer's city name.

Object Oriented Interface

public function getPayerCity();

Procedural Interface

inpay_expresscheckout_get($res, 26 );

Default Value

''

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

This property is read-only.

Data Type

String

PayerCountryCode Property (InPay_ExpressCheckout Class)

Payer's country code.

Object Oriented Interface

public function getPayerCountryCode();

Procedural Interface

inpay_expresscheckout_get($res, 27 );

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.

This property is read-only.

Data Type

String

PayerEmail Property (InPay_ExpressCheckout Class)

Email address of the payer.

Object Oriented Interface

public function getPayerEmail();

Procedural Interface

inpay_expresscheckout_get($res, 28 );

Default Value

''

Remarks

Email address of the payer.

This property is optional.

This property is read-only.

Data Type

String

PayerFirstName Property (InPay_ExpressCheckout Class)

Payer's first name.

Object Oriented Interface

public function getPayerFirstName();

Procedural Interface

inpay_expresscheckout_get($res, 29 );

Default Value

''

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

This property is read-only.

Data Type

String

PayerLastName Property (InPay_ExpressCheckout Class)

Payer's last name.

Object Oriented Interface

public function getPayerLastName();

Procedural Interface

inpay_expresscheckout_get($res, 30 );

Default Value

''

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

This property is read-only.

Data Type

String

PayerState Property (InPay_ExpressCheckout Class)

Payer's state or province name.

Object Oriented Interface

public function getPayerState();

Procedural Interface

inpay_expresscheckout_get($res, 31 );

Default Value

''

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

This property is read-only.

Data Type

String

PayerStatus Property (InPay_ExpressCheckout Class)

Indicates whether the payer is verified or not.

Object Oriented Interface

public function getPayerStatus();

Procedural Interface

inpay_expresscheckout_get($res, 32 );

Default Value

''

Remarks

Indicates whether the payer is verified or not.

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

This property is read-only.

Data Type

String

PayerStreet1 Property (InPay_ExpressCheckout Class)

Payer's street address (first line).

Object Oriented Interface

public function getPayerStreet1();

Procedural Interface

inpay_expresscheckout_get($res, 33 );

Default Value

''

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

This property is read-only.

Data Type

String

PayerStreet2 Property (InPay_ExpressCheckout Class)

Payer's street address (second line).

Object Oriented Interface

public function getPayerStreet2();

Procedural Interface

inpay_expresscheckout_get($res, 34 );

Default Value

''

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

This property is read-only.

Data Type

String

PayerZip Property (InPay_ExpressCheckout Class)

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

Object Oriented Interface

public function getPayerZip();

Procedural Interface

inpay_expresscheckout_get($res, 35 );

Default Value

''

Remarks

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

Character length and limitations: 20 single-byte characters.

This property is read-only.

Data Type

String

PayerId Property (InPay_ExpressCheckout Class)

Unique encrypted PayPal customer account number.

Object Oriented Interface

public function getPayerId();


public function setPayerId($value);

Procedural Interface

inpay_expresscheckout_get($res, 36 );


inpay_expresscheckout_set($res, 36, $value );

Default Value

''

Remarks

This property is required when calling the CheckoutPayment method.

This property is returned after a call to the GetCheckoutDetails method.

Character length and limitations:17 single-byte characters maximum.

Data Type

String

PaymentDate Property (InPay_ExpressCheckout Class)

This is the time/date stamp of payment.

Object Oriented Interface

public function getPaymentDate();

Procedural Interface

inpay_expresscheckout_get($res, 37 );

Default Value

''

Remarks

This is the time/date stamp of payment.

This property is read-only.

Data Type

String

PaymentExchangeRate Property (InPay_ExpressCheckout Class)

Exchange rate if a currency conversion occurred.

Object Oriented Interface

public function getPaymentExchangeRate();

Procedural Interface

inpay_expresscheckout_get($res, 38 );

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_ExpressCheckout Class)

PayPal fee amount charged for the transaction.

Object Oriented Interface

public function getPaymentFeeAmount();

Procedural Interface

inpay_expresscheckout_get($res, 39 );

Default Value

''

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

Data Type

String

PaymentGrossAmount Property (InPay_ExpressCheckout Class)

The final amount charged.

Object Oriented Interface

public function getPaymentGrossAmount();

Procedural Interface

inpay_expresscheckout_get($res, 40 );

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_ExpressCheckout Class)

Indicates whether the payment is instant or delayed.

Object Oriented Interface

public function getPaymentType();

Procedural Interface

inpay_expresscheckout_get($res, 41 );

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_ExpressCheckout Class)

The reason the payment is pending.

Object Oriented Interface

public function getPaymentPendingReason();

Procedural Interface

inpay_expresscheckout_get($res, 42 );

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_ExpressCheckout Class)

Amount deposited in your PayPal account after a currency conversion.

Object Oriented Interface

public function getPaymentSettleAmount();

Procedural Interface

inpay_expresscheckout_get($res, 43 );

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_ExpressCheckout Class)

Status of the payment.

Object Oriented Interface

public function getPaymentStatus();

Procedural Interface

inpay_expresscheckout_get($res, 44 );

Default Value

''

Remarks

Status of the payment.

The current list of possible values for this property are:

Note: When the returned value of this property is...

- "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_ExpressCheckout Class)

Tax charged on the transaction.

Object Oriented Interface

public function getPaymentTaxAmount();

Procedural Interface

inpay_expresscheckout_get($res, 45 );

Default Value

''

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (InPay_ExpressCheckout Class)

Unique transaction ID of the payment.

Object Oriented Interface

public function getPaymentTransactionId();

Procedural Interface

inpay_expresscheckout_get($res, 46 );

Default Value

''

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (InPay_ExpressCheckout Class)

The type of transaction.

Object Oriented Interface

public function getPaymentTransactionType();

Procedural Interface

inpay_expresscheckout_get($res, 47 );

Default Value

''

Remarks

The type of transaction.

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

This property is read-only.

Data Type

String

PaymentAction Property (InPay_ExpressCheckout Class)

How you want to obtain payment.

Object Oriented Interface

public function getPaymentAction();


public function setPaymentAction($value);

Procedural Interface

inpay_expresscheckout_get($res, 48 );


inpay_expresscheckout_set($res, 48, $value );

Default Value

0

Remarks

This property is required when calling the CheckoutPayment method.

This property is required when calling the SetCheckout method.

Possible values of this property include:

Data Type

Integer

ProxyAuthScheme Property (InPay_ExpressCheckout Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

inpay_expresscheckout_get($res, 49 );


inpay_expresscheckout_set($res, 49, $value );

Default Value

0

Remarks

This property is used to tell the class which 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 component 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_ExpressCheckout Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

inpay_expresscheckout_get($res, 50 );


inpay_expresscheckout_set($res, 50, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (InPay_ExpressCheckout Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

inpay_expresscheckout_get($res, 51 );


inpay_expresscheckout_set($res, 51, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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_ExpressCheckout Class)

This property contains 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_expresscheckout_get($res, 52 );


inpay_expresscheckout_set($res, 52, $value );

Default Value

80

Remarks

This property contains 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_ExpressCheckout 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_expresscheckout_get($res, 53 );


inpay_expresscheckout_set($res, 53, $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_ExpressCheckout Class)

This property determines 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_expresscheckout_get($res, 54 );


inpay_expresscheckout_set($res, 54, $value );

Default Value

0

Remarks

This property determines 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_ExpressCheckout Class)

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

inpay_expresscheckout_get($res, 55 );


inpay_expresscheckout_set($res, 55, $value );

Default Value

''

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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

ResponseToken Property (InPay_ExpressCheckout Class)

The time-stamped token value.

Object Oriented Interface

public function getResponseToken();

Procedural Interface

inpay_expresscheckout_get($res, 56 );

Default Value

''

Remarks

This property is returned after all three kinds of Express Checkout requests: SetCheckout. GetCheckoutDetails, and CheckoutPayment. This token is used to reference a specific transaction in the PayPal network.

This value is used for several things:

• After calling the SetCheckout method, the value of this property should be appended to the PayPal login page, located here: https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=. The customer's browser should then be redirected to this location. This starts the PayPal payment process.
• After the customer successfully pays, this token is appended as a query string to the value sent in the ReturnURL property. The customer is redirected to this URL (which should reside on your server).
• You must then pass this value in the Token parameter of the GetCheckoutDetails method to continue the transaction.
• The Token property must be set with this value before calling CheckoutPayment.

This token expires after three hours.

This property is read-only.

Data Type

String

ReturnURL Property (InPay_ExpressCheckout Class)

URL to which the customer's browser is returned after choosing to pay with PayPal.

Object Oriented Interface

public function getReturnURL();


public function setReturnURL($value);

Procedural Interface

inpay_expresscheckout_get($res, 57 );


inpay_expresscheckout_set($res, 57, $value );

Default Value

''

Remarks

This is the page to which a customer is returned after he pays through PayPal. The PayPal server will append to this ReturnURL a query string containing a token which identifies this transaction in the PayPal network. This token should be sent as the Token parameter in the GetCheckoutDetails method.

This property is required when calling the SetCheckout method.

Character length and limitations: no limit. Must be URL-encoded.

Data Type

String

ShippingTotal Property (InPay_ExpressCheckout Class)

Total shipping costs for this order.

Object Oriented Interface

public function getShippingTotal();


public function setShippingTotal($value);

Procedural Interface

inpay_expresscheckout_get($res, 58 );


inpay_expresscheckout_set($res, 58, $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_ExpressCheckout Class)

Value to use with PayPal's Signature Authentication scheme.

Object Oriented Interface

public function getSignature();


public function setSignature($value);

Procedural Interface

inpay_expresscheckout_get($res, 59 );


inpay_expresscheckout_set($res, 59, $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

SSLAcceptServerCertEncoded Property (InPay_ExpressCheckout Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

inpay_expresscheckout_get($res, 61 );


inpay_expresscheckout_set($res, 61, $value );

Default Value

''

Remarks

This is 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

SSLCertEncoded Property (InPay_ExpressCheckout Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

inpay_expresscheckout_get($res, 89 );


inpay_expresscheckout_set($res, 89, $value );

Default Value

''

Remarks

This is 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

SSLCertStore Property (InPay_ExpressCheckout Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

inpay_expresscheckout_get($res, 105 );


inpay_expresscheckout_set($res, 105, $value );

Default Value

'MY'

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InPay_ExpressCheckout 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_expresscheckout_get($res, 106 );


inpay_expresscheckout_set($res, 106, $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_ExpressCheckout Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

inpay_expresscheckout_get($res, 107 );


inpay_expresscheckout_set($res, 107, $value );

Default Value

0

Remarks

This is 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

SSLCertSubject Property (InPay_ExpressCheckout Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

inpay_expresscheckout_get($res, 108 );


inpay_expresscheckout_set($res, 108, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

Data Type

String

SSLProvider Property (InPay_ExpressCheckout Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

inpay_expresscheckout_get($res, 116 );


inpay_expresscheckout_set($res, 116, $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:

Additional Notes

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

SSLServerCertEncoded Property (InPay_ExpressCheckout Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

inpay_expresscheckout_get($res, 118 );

Default Value

''

Remarks

This is 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_ExpressCheckout Class)

Sum of tax for all items included in this order.

Object Oriented Interface

public function getTaxTotal();


public function setTaxTotal($value);

Procedural Interface

inpay_expresscheckout_get($res, 145 );


inpay_expresscheckout_set($res, 145, $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_ExpressCheckout Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

inpay_expresscheckout_get($res, 146 );


inpay_expresscheckout_set($res, 146, $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

Token Property (InPay_ExpressCheckout Class)

This property is used to reference a specific Express Checkout transaction in the PayPal network.

Object Oriented Interface

public function getToken();


public function setToken($value);

Procedural Interface

inpay_expresscheckout_get($res, 147 );


inpay_expresscheckout_set($res, 147, $value );

Default Value

''

Remarks

PayPal will return a token in the ResponseToken property in response to each request. This value should be saved and passed in the Token property for a CheckoutPayment request, or to modify an existing transaction.

This token expires after three hours.

IMPORTANT: the value of this property can be used to modify an existing checkout session. Normally you call SetCheckout with an empty Token property, and get a ResponseToken back from the PayPal servers. Calling SetCheckout again with the Token property filled will edit that previous checkout session. For instance, this can be used should you want the customer to edit his shipping address on PayPal.

This property is required when calling the CheckoutPayment method.

This property is optional when calling the SetCheckout method.

Character length and limitations: 20 single-byte characters.

Data Type

String

URL Property (InPay_ExpressCheckout Class)

URL all PayPal payment transactions are posted to.

Object Oriented Interface

public function getURL();


public function setURL($value);

Procedural Interface

inpay_expresscheckout_get($res, 148 );


inpay_expresscheckout_set($res, 148, $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_ExpressCheckout Class)

User name for communicating with Paypal.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

inpay_expresscheckout_get($res, 149 );


inpay_expresscheckout_set($res, 149, $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_ExpressCheckout 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_expresscheckout_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.

Capture Method (InPay_ExpressCheckout Class)

Completely or partially settles a previously authorized transaction.

Object Oriented Interface

public function doCapture($authorizationid, $amount);

Procedural Interface

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

CheckoutPayment Method (InPay_ExpressCheckout Class)

Either obtain payment for a final sale, or request authorization for later capture of payment.

Object Oriented Interface

public function doCheckoutPayment();

Procedural Interface

inpay_expresscheckout_do_checkoutpayment($res);

Remarks

This method completes the sale or authorization. When this method is called, the following properties are required in the request:

• Token
• PaymentAction
• OrderTotal
• PayerId (returned after a call to GetCheckoutDetails)

To obtain payment for a final sale you will have to set the PaymentAction property to aSale. If you want to request an authorization, the PaymentAction property has to be set to aAuthorization. Then, you will need to use Capture to capture the transaction.

The following information may be optionally provided in the request:

• OrderDescription
• Custom (Config setting)
• InvoiceNumber
• NotifyURL (Config setting)
• Payment item details (ItemAmount, ItemName, ItemNumber, ItemQuantity, ItemSalesTax)

The Response and Payment properties may be returned in the response.

Config Method (InPay_ExpressCheckout Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_expresscheckout_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_ExpressCheckout Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

GetCheckoutDetails Method (InPay_ExpressCheckout Class)

Returns information about the customer, including name and address on file with PayPal.

Object Oriented Interface

public function doGetCheckoutDetails();

Procedural Interface

inpay_expresscheckout_do_getcheckoutdetails($res);

Remarks

After the customer pays via PayPal and is returned to your ReturnURL, use this method (along with the token returned in the ReturnURL query string) to retrieve payment details about this transaction. After calling this method, all of the fields under the Payer and Payment properties will be populated. Note that PayPal will only return these values if it has this information stored for the paying customer. The PayerId property is required to finalize the sale, but you may want to check other Payer and Payment details to make sure they are correct.

If everything looks good, you may then call CheckoutPayment to complete the transaction.

GetResponseVar Method (InPay_ExpressCheckout 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_expresscheckout_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_ExpressCheckout Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_expresscheckout_do_interrupt($res);

Remarks

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

Reset Method (InPay_ExpressCheckout Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_expresscheckout_do_reset($res);

Remarks

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

SetCheckout Method (InPay_ExpressCheckout Class)

Call this method to begin the Express Checkout process and fetch a token from PayPal which will encode transaction details.

Object Oriented Interface

public function doSetCheckout();

Procedural Interface

inpay_expresscheckout_do_setcheckout($res);

Remarks

This method queries PayPal for a ResponseToken and begins the Express Checkout process. This token is used to identify the transaction on the PayPal network.

The following properties are required before calling SetCheckout:

• URL
• User
• Password
• Signature
• OrderTotal
• ReturnURL
• CancelURL
• PaymentAction

After calling this method, you should check the Ack property to determine whether the request was successful. If so, append the ResponseToken value to the following PayPal URL, and redirect your customer there.

https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=

The customer will sign in and fill out payment details on PayPal's site. Afterwards PayPal will automatically redirect the customer back to the ReturnURL you specified, along with the updated token appended to the URL. This token should be parsed from the URL and set as the Token property. You may then proceed in calling GetCheckoutDetails and CheckoutPayment.

VoidTransaction Method (InPay_ExpressCheckout Class)

Voids a prior authorization.

Object Oriented Interface

public function doVoidTransaction($authorizationid);

Procedural Interface

inpay_expresscheckout_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_ExpressCheckout Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_expresscheckout_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_ExpressCheckout Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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_ExpressCheckout Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

Config Settings (ExpressCheckout Class)

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

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

Trappable Errors (ExpressCheckout Class)

ExpressCheckout Errors

	2201   Server error response.
	2202   You attempted to set a property with invalid data.
	2203   You must set additional properties before attempting this function.

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

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).