ExpressCheckout Class
Properties Methods Events Configuration 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.
Ack | Acknowledgement code received from PayPal. |
BuyerEmail | Buyer's email address. |
CancelURL | URL to which the customer is returned if he decides not to pay with PayPal. |
ContactPhone | Payer's contact telephone number. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
Idle | The current status of the class. |
InvoiceNumber | Your own unique invoice or tracking number. |
ItemCount | The number of records in the Item arrays. |
ItemAmount | Amount of charged on payment. |
ItemDescription | Paypal item description for the shopping cart. |
ItemName | Name of the item purchased. |
ItemNumber | Item number set by the merchant. |
ItemOptions | Paypal item options for the shopping cart. |
ItemQuantity | Quantity of items ordered. |
ItemSalesTax | Amount of tax charged on payment. |
Note | An informational note about this settlement that will be displayed in the payer's transaction history. |
OrderDescription | Description of items the customer is purchasing. |
OrderTotal | The total cost of the order to the customer. |
Password | Password for communicating with PayPal. |
PayerBusiness | Payer's business email address. |
PayerCity | Payer's city name. |
PayerCountryCode | Payer's country code. |
PayerEmail | Email address of the payer. |
PayerFirstName | Payer's first name. |
PayerLastName | Payer's last name. |
PayerState | Payer's state or province name. |
PayerStatus | Indicates whether the payer is verified or not. |
PayerStreet1 | Payer's street address (first line). |
PayerStreet2 | Payer's street address (second line). |
PayerZip | Payer's United States ZIP code or other country-specific postal code. |
PayerId | Unique encrypted PayPal customer account number. |
PaymentDate | This is the time/date stamp of payment. |
PaymentExchangeRate | Exchange rate if a currency conversion occurred. |
PaymentFeeAmount | PayPal fee amount charged for the transaction. |
PaymentGrossAmount | The final amount charged. |
PaymentType | Indicates whether the payment is instant or delayed. |
PaymentPendingReason | The reason the payment is pending. |
PaymentSettleAmount | Amount deposited in your PayPal account after a currency conversion. |
PaymentStatus | Status of the payment. |
PaymentTaxAmount | Tax charged on the transaction. |
PaymentTransactionId | Unique transaction ID of the payment. |
PaymentTransactionType | The type of transaction. |
PaymentAction | How you want to obtain payment. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
ResponseToken | The time-stamped token value. |
ReturnURL | URL to which the customer's browser is returned after choosing to pay with PayPal. |
ShippingTotal | Total shipping costs for this order. |
Signature | Value to use with PayPal's Signature Authentication scheme. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
TaxTotal | Sum of tax for all items included in this order. |
Timeout | A timeout for the class. |
Token | This property is used to reference a specific Express Checkout transaction in the PayPal network. |
URL | URL all PayPal payment transactions are posted to. |
User | User name for communicating with Paypal. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddCustomField | This adds a custom name-value pair to be sent with the next request. |
Capture | Completely or partially settles a previously authorized transaction. |
CheckoutPayment | Either obtain payment for a final sale, or request authorization for later capture of payment. |
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
GetCheckoutDetails | Returns information about the customer, including name and address on file with PayPal. |
GetResponseVar | It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties. |
Interrupt | Interrupt the current method. |
Reset | Clears all properties to their default values. |
SetCheckout | Call this method to begin the Express Checkout process and fetch a token from PayPal which will encode transaction details. |
VoidTransaction | Voids a prior authorization. |
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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AuthAccessToken | The access token returned by the PayPal Permission Service's GetAccessToken operation. |
AuthApplicationId | The Application ID for the application making a request to the PayPal Permissions Service. |
AuthAuthHeader | The PayPal Permissions Service authentication header. |
AuthAuthHeaderName | The name of the authentication header generated with the PayPal Permissions Service. |
AuthCallbackURL | The URL where PayPal will post the RequestToken and VerificationCode. |
AuthorizationId | The authorization identification number of the last payment. |
AuthorizeOrderPayment | Authorize an order payment. |
AuthorizingAccount | Authorizing Account Email Address for third-party API access. |
AuthPassword | API Password for the PayPal Permissions Service. |
AuthRequestToken | The request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service. |
AuthRequestURL | The URL for the PayPal Permissions Service operation being requested. |
AuthScope | Scope of permissions to be requested for PayPal Permissions Service. |
AuthSignature | API Signature for the PayPal Permissions Service. |
AuthTokenSecret | The token secret returned by the PayPal Permission Service's GetAccessToken operation. |
AuthUsername | API Username for the PayPal Permissions Service. |
AuthVerificationCode | The verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service. |
Build | Returns the Build number contained in the response. |
ButtonSource | Additional information for identifying transactions. |
CurrencyCode | Sets the type of currency in which you are accepting payments. |
Custom | A free-form field for your own use. |
HandlingTotal | Total handling costs for this order. |
IsPartialCapture | Indicates if this capture is for the full amount of payment you authorized. |
ItemTotal | Sum of cost of all items in this order. |
LocaleCode | Locale of pages displayed by PayPal during Express Checkout. |
PaymentProtectionEligibility | If the PaymentPendingReason is PaymentReview this will return the protection in force for the transaction. |
RawRequest | Returns the raw request sent to the server. |
RawResponse | Returns the full response. |
ResponseVersion | Returns the Version number contained in the response. |
ShipToCity | Payer's shipping city. |
ShipToCountryCode | Payer's shipping country code. |
ShipToName | Payer's shipping name. |
ShipToPayerAddress | Shipping address same as billing address. |
ShipToPhoneNumber | Payer's shipping phone number. |
ShipToState | Payer's shipping state. |
ShipToStreet | First line of the payer's shipping street address. |
ShipToStreet2 | Second line of the payer's shipping street address. |
ShipToZip | Payer's shipping postal code. |
TransactionId | Transaction Id used for authorizing and capturing order payments. |
Version | Allows the user to set the Version number in the request. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |