PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

ExpressCheckout Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

TiblExpressCheckout

Remarks

The ExpressCheckout component 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 component'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 use the ReAuthCapture component to capture the transaction.

Property List


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

AckAcknowledgement code received from PayPal.
BillingAgreementCountThe number of records in the BillingAgreement array.
BillingAgreementBillingAgreements is an array that contains a list of billing agreements to be created.
BuyerEmailBuyer's email address.
CancelURLURL to which the customer is returned if he decides not to pay with PayPal.
ContactPhonePayer's contact telephone number.
CurrencyCodeType of currency in which you are accepting payments.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
InvoiceNumberYour own unique invoice or tracking number.
ItemCountThe number of records in the Item arrays.
ItemAmountAmount of charged on payment.
ItemDescriptionPaypal item description for the shopping cart.
ItemNameName of the item purchased.
ItemNumberItem number set by the merchant.
ItemOptionsPaypal item options for the shopping cart.
ItemQuantityQuantity of items ordered.
ItemSalesTaxAmount of tax charged on payment.
OrderDescriptionDescription of items the customer is purchasing.
OrderTotalThe total cost of the order to the customer.
PasswordPassword for communicating with PayPal.
PayerBusinessPayer's business email address.
PayerCityPayer's city name.
PayerCountryCodePayer's country code.
PayerEmailEmail address of the payer.
PayerFirstNamePayer's first name.
PayerLastNamePayer's last name.
PayerStatePayer's state or province name.
PayerStatusIndicates whether the payer is verified or not.
PayerStreet1Payer's street address (first line).
PayerStreet2Payer's street address (second line).
PayerZipPayer's United States ZIP code or other country-specific postal code.
PayerIdUnique encrypted PayPal customer account number.
PaymentDateThis is the time/date stamp of payment.
PaymentExchangeRateExchange rate if a currency conversion occurred.
PaymentFeeAmountPayPal fee amount charged for the transaction.
PaymentGrossAmountThe final amount charged.
PaymentTypeIndicates whether the payment is instant or delayed.
PaymentPendingReasonThe reason the payment is pending.
PaymentSettleAmountAmount deposited in your PayPal account after a currency conversion.
PaymentStatusStatus of the payment.
PaymentTaxAmountTax charged on the transaction.
PaymentTransactionIdUnique transaction ID of the payment.
PaymentTransactionTypeThe type of transaction.
PaymentActionHow you want to obtain payment.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
ResponseTokenThe time-stamped token value.
ReturnURLURL to which the customer's browser is returned after choosing to pay with PayPal.
ShippingTotalTotal shipping costs for this order.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TaxTotalSum of tax for all items included in this order.
TimeoutA timeout for the component.
TokenThis property is used to reference a specific Express Checkout transaction in the PayPal network.
URLURL all PayPal payment transactions are posted to.
UserUser name for communicating with Paypal.

Method List


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

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
CheckoutPaymentEither obtain payment for a final sale, or request authorization for later capture of payment.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetCheckoutDetailsReturns information about the customer, including name and address on file with PayPal.
GetResponseVarIt is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
InterruptInterrupt the current method.
ResetReset the internal state of the component and all properties to their default values.
SetCheckoutCall this method to begin the Express Checkout process and fetch a token from PayPal which will encode transaction details.

Event List


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

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

AuthorizationIdAuthorization Id used when capturing an order payment.
AuthorizeOrderPaymentAuthorize an order payment.
ButtonSourceAdditional information for identifying transactions.
CaptureOrderPaymentCapture a previously authorized order payment.
CurrencyCodeType of currency in which you are accepting payments.
CustomA free-form field for your own use.
HandlingTotalTotal handling costs for this order.
ItemTotalSum of cost of all items in this order.
LastPaymentWhether or not this payment is the last order payment.
LocaleCodeLocale of pages displayed by PayPal during Express Checkout.
NotifyURLInstant Payment Notification (IPN) URL.
TransactionIdTransaction Id used for authorizing and capturing order payments.
ShipToCityPayer's shipping city.
ShipToCountryCodePayer's shipping country code.
ShipToNamePayer's shipping name.
ShipToPayerAddressShipping address same as billing address.
ShipToPhoneNumberPayer's shipping phone number.
ShipToStatePayer's shipping state.
ShipToStreetFirst line of the payer's shipping street address.
ShipToStreet2Second line of the payer's shipping street address.
ShipToZipPayer's shipping postal code.
PaymentProtectionEligibilityIf the PaymentPendingReason is PaymentReview this will return the protection in force for the transaction.
AuthorizingAccountAuthorizing Account Email Address for third-party API access.
AuthAccessTokenThe access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationIdThe Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeaderThe PayPal Permissions Service authentication header.
AuthAuthHeaderNameThe name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURLThe URL where PayPal will post the RequestToken and VerificationCode.
AuthPasswordAPI Password for the PayPal Permissions Service.
AuthRequestTokenThe request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
AuthRequestURLThe URL for the PayPal Permissions Service operation being requested.
AuthScopeScope of permissions to be requested for PayPal Permissions Service.
AuthSignatureAPI Signature for the PayPal Permissions Service.
AuthTokenSecretThe token secret returned by the PayPal Permission Service's GetAccessToken operation.
AuthUsernameAPI Username for the PayPal Permissions Service.
AuthVerificationCodeThe verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
BuildReturns the Build number contained in the response.
RawRequestReturns the raw request sent to the server.
RawResponseReturns the full response.
ResponseVersionReturns the Version number contained in the response.
VersionAllows the user to set the Version number in the request.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0