Search: 
Available in: PAYPAL
ExpressCheckout Component [PayPal Integrator V3]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The ExpressCheckout component is used when a customer purchases an item from a merchant's website, and decides to use PayPal to pay for it. There are three different methods, SetCheckout, CheckoutPayment, and GetCheckoutDetails, which are used together to complete a transaction.

At the time of this writing, in order to use this component you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple.

The first thing a merchant does when a customer decides to pay by PayPal, is to send the customer's email address to PayPal, and receive a transaction token (returned in the ResponseToken property).

After receiving the token, you must redirect the customer to PayPal's express checkout URL, along with the ResponseToken you just received. After the customer pays, he will be returned to the ReturnURL you specified in the request. For example:

   
component.OrderTotal = "88.88"
component.ReturnURL = "http://localhost"
component.CancelURL = "http://localhost"
component.PaymentAction = aSale
component.BuyerEmail = "IBizTester@nsoftware.com"
component.SetCheckout()

'Now redirect the buyer:
If (component.Ack == "success") Then
  Redirect("https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=" + component.ResponseToken)
End If

After the buyer is returned to your ReturnURL, you must acquire the PayerId by calling the GetCheckoutDetails method with the token returned above. Additional data about the buyer will also be returned, such as name, address, status within the PayPal system, and phone number. For example:

   
component.GetCheckoutDetails("EC-9EN563578B985082M") ' token value from above

PayerId now contains the value required to complete the transaction, using the CheckoutPayment method. For example:

   
component.PaymentAction = aSale
component.Token = "EC-9EN563578B985082M" ' token value from above
component.OrderTotal = "88.88"
component.CheckoutPayment()

If you submitted a PaymentAction of aSale, this will finalize the transaction and transfer funds to your PayPal account. However, if the PaymentAction is set to aAuthorization you will need to use the REAUTHCAPTURE component to capture the transaction. If you submitted a PaymentAction of aSale, this will finalize the transaction and transfer funds to your PayPal account. However, if 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.
BillingAgreementsBillingAgreements 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.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
InvoiceNumberYour own unique invoice or tracking number.
ItemsThis is the collection of items being purchased.
OrderDescriptionDescription of items the customer is purchasing.
OrderTotalThe total cost of the order to the customer.
PasswordPassword for communicating with PayPal.
PayerThe person being billed for the current purchase.
PayerIdUnique encrypted PayPal customer account number.
PaymentThis contains details about the express checkout payment.
PaymentActionHow you want to obtain payment.
ProxyA set of properties related to proxy access.
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.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
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 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.
InterruptInterrupt the current method.
ResetReset the internal state of the component and all properties to their default values.
SetCheckoutIndicates to PayPal that you are using Express Checkout to obtain payment from your customer.

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.

ButtonSourceAdditional information for identifying transactions
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
LocaleCodeLocale of pages displayed by PayPal during Express Checkout
NotifyURLInstant Payment Notification (IPN) URL
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
AuthorizingAccountAuthorizing Account Email Address for third-party API access
BuildReturns the Build number contained in the response
RequestReturns the raw request sent to the server
ResponseReturns the full response
ResponseVersionReturns the Version number contained in the response
VersionAllows the user to set the Version number in the request
SendCustomRequestSends a custom request to the server
AcceptEncodingUsed to tell the server which types of content encodings the client supports
AllowHTTPCompressionThis property enables HTTP compression for receiving data
AuthorizationThe Authorization string to be sent to the server
EncodeURLIf set to true the URL will be encoded by the component
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
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
UsePlatformHTTPClientWhether or not to use the platform HTTP client
UserAgentInformation about the user agent (browser)
UseWinInetIf set, the WinInet API is used for retrieving the URL
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
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
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.