ExpressCheckout Module

Properties Methods Events Config Settings Errors

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

Syntax

InPay.ExpressCheckout

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 module 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.
Firewall	A set of properties related to firewall access.
Idle	The current status of the module.
InvoiceNumber	Your own unique invoice or tracking number.
Items	This is the collection of items being purchased.
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.
Payer	The person being billed for the current purchase.
PayerId	Unique encrypted PayPal customer account number.
Payment	This contains details about the express checkout payment.
PaymentAction	How you want to obtain payment.
Proxy	A set of properties related to proxy access.
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.
SSLAcceptServerCert	Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
TaxTotal	Sum of tax for all items included in this order.
Timeout	A timeout for the module.
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 module 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	This method 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	This method interrupts 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 module 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	Fired when secure connection progress messages are available.

Config Settings

The following is a list of config settings for the module 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 module.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the module 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 module.
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.
StatusCode	The status code of the last response from the server.
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 module.
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.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the module 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 module 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.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
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.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
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.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Ack Property (ExpressCheckout Module)

Acknowledgement code received from PayPal.

public var ack: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=ack) NSString* ack;

- (NSString*)ack;

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:


Success	Request processing succeeded.
Failure	Request processing failed.
SuccessWithWarning	Request processing completed successfully, but with some warning information that could be useful for the requesting application to process or record.
FailureWithWarning	Request processing failed with some error and warning information that the requesting application should process to determine causes of failure.
CustomCode	Reserved for internal or future use.

This property is read-only.

BuyerEmail Property (ExpressCheckout Module)

Buyer's email address.

Syntax

Swift
Objective-C

public var buyerEmail: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=buyerEmail,setter=setBuyerEmail:) NSString* buyerEmail;

- (NSString*)buyerEmail;
- (void)setBuyerEmail :(NSString*)newBuyerEmail;

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.

CancelURL Property (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public var cancelURL: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=cancelURL,setter=setCancelURL:) NSString* cancelURL;

- (NSString*)cancelURL;
- (void)setCancelURL :(NSString*)newCancelURL;

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.

ContactPhone Property (ExpressCheckout Module)

Payer's contact telephone number.

Syntax

Swift
Objective-C

public var contactPhone: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=contactPhone) NSString* contactPhone;

- (NSString*)contactPhone;

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.

Firewall Property (ExpressCheckout Module)

A set of properties related to firewall access.

Syntax

Swift
Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

Default Value

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Idle Property (ExpressCheckout Module)

The current status of the module.

Syntax

Swift
Objective-C

public var idle: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

InvoiceNumber Property (ExpressCheckout Module)

Your own unique invoice or tracking number.

Syntax

Swift
Objective-C

public var invoiceNumber: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

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.

Items Property (ExpressCheckout Module)

This is the collection of items being purchased.

Syntax

Swift
Objective-C

public var items: Array<PayPalPaymentItem> {
  get {...}
}


@property (nonatomic,readwrite,assign,getter=itemCount,setter=setItemCount:) int itemCount;

- (int)itemCount;
- (void)setItemCount :(int)newItemCount;

- (NSString*)itemAmount:(int)itemIndex;
- (void)setItemAmount:(int)itemIndex :(NSString*)newItemAmount;

- (NSString*)itemDescription:(int)itemIndex;
- (void)setItemDescription:(int)itemIndex :(NSString*)newItemDescription;

- (NSString*)itemName:(int)itemIndex;
- (void)setItemName:(int)itemIndex :(NSString*)newItemName;

- (NSString*)itemNumber:(int)itemIndex;
- (void)setItemNumber:(int)itemIndex :(NSString*)newItemNumber;

- (NSString*)itemOptions:(int)itemIndex;
- (void)setItemOptions:(int)itemIndex :(NSString*)newItemOptions;

- (int)itemQuantity:(int)itemIndex;
- (void)setItemQuantity:(int)itemIndex :(int)newItemQuantity;

- (NSString*)itemSalesTax:(int)itemIndex;
- (void)setItemSalesTax:(int)itemIndex :(NSString*)newItemSalesTax;

Default Value

Remarks

This property should contain all the items being sent in the express checkout payment.

Note Property (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public var note: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=note,setter=setNote:) NSString* note;

- (NSString*)note;
- (void)setNote :(NSString*)newNote;

Default Value

Remarks

Used during Capture or VoidTransaction.

This property is optional.

Character length and limits: 255 single-byte characters.

OrderDescription Property (ExpressCheckout Module)

Description of items the customer is purchasing.

Syntax

Swift
Objective-C

public var orderDescription: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=orderDescription,setter=setOrderDescription:) NSString* orderDescription;

- (NSString*)orderDescription;
- (void)setOrderDescription :(NSString*)newOrderDescription;

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.

OrderTotal Property (ExpressCheckout Module)

The total cost of the order to the customer.

Syntax

Swift
Objective-C

public var orderTotal: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=orderTotal,setter=setOrderTotal:) NSString* orderTotal;

- (NSString*)orderTotal;
- (void)setOrderTotal :(NSString*)newOrderTotal;

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.

Password Property (ExpressCheckout Module)

Password for communicating with PayPal.

Syntax

Swift
Objective-C

public var password: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

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.

Payer Property (ExpressCheckout Module)

The person being billed for the current purchase.

Syntax

Swift
Objective-C

public var payer: ExpressCheckoutPayer {
  get {...}
}


@property (nonatomic,readonly,assign,getter=payerBusiness) NSString* payerBusiness;

- (NSString*)payerBusiness;

@property (nonatomic,readonly,assign,getter=payerCity) NSString* payerCity;

- (NSString*)payerCity;

@property (nonatomic,readonly,assign,getter=payerCountryCode) NSString* payerCountryCode;

- (NSString*)payerCountryCode;

@property (nonatomic,readonly,assign,getter=payerEmail) NSString* payerEmail;

- (NSString*)payerEmail;

@property (nonatomic,readonly,assign,getter=payerFirstName) NSString* payerFirstName;

- (NSString*)payerFirstName;

@property (nonatomic,readonly,assign,getter=payerLastName) NSString* payerLastName;

- (NSString*)payerLastName;

@property (nonatomic,readonly,assign,getter=payerState) NSString* payerState;

- (NSString*)payerState;

@property (nonatomic,readonly,assign,getter=payerStatus) NSString* payerStatus;

- (NSString*)payerStatus;

@property (nonatomic,readonly,assign,getter=payerStreet1) NSString* payerStreet1;

- (NSString*)payerStreet1;

@property (nonatomic,readonly,assign,getter=payerStreet2) NSString* payerStreet2;

- (NSString*)payerStreet2;

@property (nonatomic,readonly,assign,getter=payerZip) NSString* payerZip;

- (NSString*)payerZip;

Default Value

Remarks

This property will contain details about the payer of the of the express checkout after a call to GetCheckoutDetails.

PayerId Property (ExpressCheckout Module)

Unique encrypted PayPal customer account number.

Syntax

Swift
Objective-C

public var payerId: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=payerId,setter=setPayerId:) NSString* payerId;

- (NSString*)payerId;
- (void)setPayerId :(NSString*)newPayerId;

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.

Payment Property (ExpressCheckout Module)

This contains details about the express checkout payment.

Syntax

Swift
Objective-C

public var payment: PayPalPayment {
  get {...}
}


@property (nonatomic,readonly,assign,getter=paymentDate) NSString* paymentDate;

- (NSString*)paymentDate;

@property (nonatomic,readonly,assign,getter=paymentExchangeRate) NSString* paymentExchangeRate;

- (NSString*)paymentExchangeRate;

@property (nonatomic,readonly,assign,getter=paymentFeeAmount) NSString* paymentFeeAmount;

- (NSString*)paymentFeeAmount;

@property (nonatomic,readonly,assign,getter=paymentGrossAmount) NSString* paymentGrossAmount;

- (NSString*)paymentGrossAmount;

@property (nonatomic,readonly,assign,getter=paymentType) NSString* paymentType;

- (NSString*)paymentType;

@property (nonatomic,readonly,assign,getter=paymentPendingReason) NSString* paymentPendingReason;

- (NSString*)paymentPendingReason;

@property (nonatomic,readonly,assign,getter=paymentSettleAmount) NSString* paymentSettleAmount;

- (NSString*)paymentSettleAmount;

@property (nonatomic,readonly,assign,getter=paymentStatus) NSString* paymentStatus;

- (NSString*)paymentStatus;

@property (nonatomic,readonly,assign,getter=paymentTaxAmount) NSString* paymentTaxAmount;

- (NSString*)paymentTaxAmount;

@property (nonatomic,readonly,assign,getter=paymentTransactionId) NSString* paymentTransactionId;

- (NSString*)paymentTransactionId;

@property (nonatomic,readonly,assign,getter=paymentTransactionType) NSString* paymentTransactionType;

- (NSString*)paymentTransactionType;

Default Value

Remarks

This property will be populated with payment details after a call to GetCheckoutDetails, CheckoutPayment, or Capture.

Note: If the PaymentAction property was set to aAuthorization for this transaction, the may be used with the Capture method to later settle the transaction.

PaymentAction Property (ExpressCheckout Module)

How you want to obtain payment.

Syntax

Swift
Objective-C

public var paymentAction: ExpressCheckoutPaymentActions {
  get {...}
  set {...}
}

public enum ExpressCheckoutPaymentActions: Int32 {
  case aSale = 0
  case aAuthorization = 1
  case aOrder = 2
}


@property (nonatomic,readwrite,assign,getter=paymentAction,setter=setPaymentAction:) int paymentAction;

- (int)paymentAction;
- (void)setPaymentAction :(int)newPaymentAction;

Default Value

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:


Value	Meaning
aSale (0)	Sale means all funds will be automatically deposited in your merchant PayPal account when the transaction is complete.
aAuthorization (1)	An Authorization transaction is used when you wish to authorize a card, but not necessarily transfer the funds yet. For instance, you may wish to authorize the card when a customer orders items through your website, and then settle the transaction once the items actually ship. You may use Capture to settle any outstanding authorizations. Authorizations enable you to capture up to 115% or USD $75 more than the amount you specify when CheckoutPayment is called. Authorizations hold the customer's funds for up to 3 days. The authorization is valid however for 29 days. Authorizations may be reauthorized only once during this period.
aOrder (2)	An Order transaction is very similar to an Authorization transaction, but it may contain more than one authorizations in the 29 day period. The Order transaction cannot be reauthorized, instead you must wait until the authorization period expires. This type of transaction should be used for different types of split orders where there are multiple deliverable times and thus portions of the payment will be made at various times.

Proxy Property (ExpressCheckout Module)

A set of properties related to proxy access.

Syntax

Swift
Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

Default Value

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

ResponseToken Property (ExpressCheckout Module)

The time-stamped token value.

Syntax

Swift
Objective-C

public var responseToken: String {
  get {...}
}


@property (nonatomic,readonly,assign,getter=responseToken) NSString* responseToken;

- (NSString*)responseToken;

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.

ReturnURL Property (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public var returnURL: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=returnURL,setter=setReturnURL:) NSString* returnURL;

- (NSString*)returnURL;
- (void)setReturnURL :(NSString*)newReturnURL;

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.

ShippingTotal Property (ExpressCheckout Module)

Total shipping costs for this order.

Syntax

Swift
Objective-C

public var shippingTotal: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=shippingTotal,setter=setShippingTotal:) NSString* shippingTotal;

- (NSString*)shippingTotal;
- (void)setShippingTotal :(NSString*)newShippingTotal;

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.

Signature Property (ExpressCheckout Module)

Value to use with PayPal's Signature Authentication scheme.

Syntax

Swift
Objective-C

public var signature: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=signature,setter=setSignature:) NSString* signature;

- (NSString*)signature;
- (void)setSignature :(NSString*)newSignature;

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.

SSLAcceptServerCert Property (ExpressCheckout Module)

Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

Swift
Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (ExpressCheckout Module)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

Swift
Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (ExpressCheckout Module)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

Swift
Objective-C

public var sslProvider: ExpressCheckoutSSLProviders {
  get {...}
  set {...}
}

public enum ExpressCheckoutSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}


@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

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, the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCert Property (ExpressCheckout Module)

The server certificate for the last established connection.

Syntax

Swift
Objective-C

public var sslServerCert: Certificate {
  get {...}
}


@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

TaxTotal Property (ExpressCheckout Module)

Sum of tax for all items included in this order.

Syntax

Swift
Objective-C

public var taxTotal: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=taxTotal,setter=setTaxTotal:) NSString* taxTotal;

- (NSString*)taxTotal;
- (void)setTaxTotal :(NSString*)newTaxTotal;

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.

Timeout Property (ExpressCheckout Module)

A timeout for the module.

Syntax

Swift
Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

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

Token Property (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public var token: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=token,setter=setToken:) NSString* token;

- (NSString*)token;
- (void)setToken :(NSString*)newToken;

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.

URL Property (ExpressCheckout Module)

URL all PayPal payment transactions are posted to.

Syntax

Swift
Objective-C

public var url: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL;

- (NSString*)URL;
- (void)setURL :(NSString*)newURL;

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:


URL	Description
https://api.paypal.com/nvp	Live server for use with the API Certificate authentication scheme.
https://api-3t.paypal.com/nvp	Live server for use with the 3-token API Signature authentication scheme.
https://api.sandbox.paypal.com/nvp	Test server for use with the API Certificate authentication scheme.
https://api-3t.sandbox.paypal.com/nvp	Test server for use with the 3-token API Signature authentication scheme.

User Property (ExpressCheckout Module)

User name for communicating with Paypal.

Syntax

Swift
Objective-C

public var user: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

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.

AddCustomField Method (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public func addCustomField(name: String, value: String) throws -> Void

- (void)addCustomField:(NSString*)name :(NSString*)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 (ExpressCheckout Module)

Completely or partially settles a previously authorized transaction.

Syntax

Swift
Objective-C

public func capture(authorizationId: String, amount: String) throws -> Void

- (void)capture:(NSString*)authorizationId :(NSString*)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 (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public func checkoutPayment() throws -> Void

- (void)checkoutPayment;

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 (ItemsAmount, ItemsName, ItemsNumber, ItemsQuantity, ItemsSalesTax)

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

Config Method (ExpressCheckout Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (ExpressCheckout Module)

This method processes events from the internal message queue.

Syntax

Swift
Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

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 (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public func getCheckoutDetails() throws -> Void

- (void)getCheckoutDetails;

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 (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public func getResponseVar(name: String) throws -> String

- (NSString*)getResponseVar:(NSString*)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 (ExpressCheckout Module)

This method interrupts the current method.

Syntax

Swift
Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (ExpressCheckout Module)

Clears all properties to their default values.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

SetCheckout Method (ExpressCheckout Module)

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

Syntax

Swift
Objective-C

public func setCheckout() throws -> Void

- (void)setCheckout;

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 (ExpressCheckout Module)

Voids a prior authorization.

Syntax

Swift
Objective-C

public func voidTransaction(authorizationId: String) throws -> Void

- (void)voidTransaction:(NSString*)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 (ExpressCheckout Module)

Information about errors during data delivery.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 (ExpressCheckout Module)

Fired after the server presents its certificate to the client.

Syntax

Swift
Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (ExpressCheckout Module)

Fired when secure connection progress messages are available.

Syntax

Swift
Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

effectiveDate
String (read-only)
Default Value: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

expirationDate
String (read-only)
Default Value: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

extendedKeyUsage
String (read-only)
Default Value: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

fingerprint
String (read-only)
Default Value: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

fingerprintSHA1
String (read-only)
Default Value: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

fingerprintSHA256
String (read-only)
Default Value: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

issuer
String (read-only)
Default Value: ""

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

privateKey
String (read-only)
Default Value: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The may be available but not exportable. In this case, returns an empty string.

privateKeyAvailable
Bool (read-only)
Default Value: False

Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication).

privateKeyContainer
String (read-only)
Default Value: ""

The name of the container for the certificate (if available). This functionality is available only on Windows platforms.

publicKey
String (read-only)
Default Value: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

publicKeyAlgorithm
String (read-only)
Default Value: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

publicKeyLength
Int32 (read-only)
Default Value: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

serialNumber
String (read-only)
Default Value: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

signatureAlgorithm
String (read-only)
Default Value: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

storeB
Data
Default Value: "MY"

The name of the certificate store for the client certificate.

The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in .

is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

storePassword
String
Default Value: ""

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

storeType
CertStoreTypes
Default Value: 0

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:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

subjectAltNames
String (read-only)
Default Value: ""

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

thumbprintMD5
String (read-only)
Default Value: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

thumbprintSHA1
String (read-only)
Default Value: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

thumbprintSHA256
String (read-only)
Default Value: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

usage
String (read-only)
Default Value: ""

The text description of .

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

usageFlags
Int32 (read-only)
Default Value: 0

The flags that show intended use for the certificate. The value of is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

version
String (read-only)
Default Value: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

subject
String
Default Value: ""

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

encodedB
Data
Default Value: ""

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string.

encoded
String
Default Value: ""

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate.

Constructors

public init()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

public init(encoded: )

Parses Encoded as an X.509 public key.

public init(storeType: , store: , storePassword: , subject: )

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

public init(storeType: , store: , storePassword: , subject: )

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

ExpressCheckoutPayer Type

The payer of the express checkout.

Remarks

This type describes information about the payer that will be charged for the current checkout.

The following fields are available:

Business
City
CountryCode
Email
FirstName
LastName
State
Status
Street1
Street2
Zip

Fields

business
String
Default Value: ""

Payer's business email address.

city
String
Default Value: ""

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

countryCode
String
Default Value: "US"

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.

email
String
Default Value: ""

Email address of the payer.

This property is optional.

firstName
String
Default Value: ""

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

lastName
String
Default Value: ""

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

state
String
Default Value: ""

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

status
String
Default Value: ""

Indicates whether the payer is verified or not.

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

street1
String
Default Value: ""

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

street2
String
Default Value: ""

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

zip
String (read-only)
Default Value: ""

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

Character length and limitations: 20 single-byte characters.

Constructors

public init()

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

The following fields are available:

AutoDetect
FirewallType
Host
Password
Port
User

Fields

autoDetect
Bool
Default Value: False

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

firewallType
FirewallTypes
Default Value: 0

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


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. is set to 1080.

host
String
Default Value: ""

The name or IP address of the firewall (optional). If a 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 .

password
String
Default Value: ""

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

port
Int32
Default Value: 0

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

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

user
String
Default Value: ""

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

Constructors

public init()

PayPalPayment Type

This type describes the payment that has been processed with PayPal.

Remarks

The type is readonly and will be populated after a response from the server that contains payment information.

The following fields are available:

Date
ExchangeRate
FeeAmount
GrossAmount
PaymentType
PendingReason
SettleAmount
Status
TaxAmount
TransactionId
TransactionType

Fields

date
String (read-only)
Default Value: ""

This is the time/date stamp of payment.

exchangeRate
String (read-only)
Default Value: ""

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.

feeAmount
String (read-only)
Default Value: ""

PayPal fee amount charged for the transaction.

grossAmount
String (read-only)
Default Value: ""

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

paymentType
String (read-only)
Default Value: ""

Indicates whether the payment is instant or delayed.

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

pendingReason
String (read-only)
Default Value: ""

The reason the payment is pending.

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


Response	Description
none	No pending reason.
address	The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
echeck	The payment is pending because it was made by an eCheck that has not yet cleared.
intl	The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.
multi-currency	You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.
PaymentReview	The payment is under review by PayPal. Check PaymentProtectionEligibility for protection eligibility status.
verify	The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
other	The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service.

settleAmount
String (read-only)
Default Value: ""

Amount deposited in your PayPal account after a currency conversion.

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

status
String (read-only)
Default Value: ""

Status of the payment.

The current list of possible values for this property are:


Response	Description
None	No status.
Canceled-Reversal	A reversal has been canceled.
Completed	The payment has been completed and the funds have been added successfully to your account balance.
Denied	You denied the payment.
Failed	The payment has failed.
Pending	The payment is pending.
Refunded	You refunded the payment.
Reversed	A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer.
Processed	A payment has been accepted.

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 field for more information.

taxAmount
String (read-only)
Default Value: ""

Tax charged on the transaction.

transactionId
String (read-only)
Default Value: ""

Unique transaction ID of the payment.

transactionType
String (read-only)
Default Value: ""

The type of transaction.

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

Constructors

public init()

PayPalPaymentItem Type

The item being purchased.

Remarks

This type describes the item that is being purchased from the merchant.

For example, the following code adds one item to a transaction.

Example: Setting the fields: PayPalPaymentItem item = new PayPalPaymentItem(); item.Amount = "30.00" item.Name = "Motorcycle handlebars" item.Number = "12345678" item.Quantity = 1 item.SalesTax = "0" class.Items.Add(item);

Example: Using the Constructors: class.Items.Add(new PayPalPaymentItem("Motorcycle handlebars", "12345678", "30.00", 1));

The following fields are available:

Amount
Description
Name
Number
Options
Quantity
SalesTax

Fields

amount
String
Default Value: ""

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

description_
String
Default Value: ""

Paypal item description for the shopping cart.

name
String
Default Value: ""

Name of the item purchased.

number
String
Default Value: ""

Item number set by the merchant.

options
String
Default Value: ""

Paypal item options for the shopping cart.

quantity
Int32
Default Value: 0

Quantity of items ordered.

salesTax
String
Default Value: ""

Amount of tax charged on payment.

Constructors

public init()

public init(name: )

public init(name: , number: )

public init(name: , number: , amount: )

public init(name: , number: , amount: , quantity: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

authScheme
ProxyAuthSchemes
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

should be set to authNone (3) when no authentication is expected.

By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication.

If is set to authDigest (1), digest authentication will be attempted instead.

If 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 is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of and .

autoDetect
Bool
Default Value: False

Whether to automatically detect and use proxy system settings, if available. The default value is .

password
String
Default Value: ""

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

If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

port
Int32
Default Value: 80

The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.

server
String
Default Value: ""

If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.

ssl
ProxySSLTypes
Default Value: 0

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

user
String
Default Value: ""

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

If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Config Settings (ExpressCheckout Module)

The class accepts one or more of the following configuration settings. Configuration 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.

ExpressCheckout Config Settings

AuthAccessToken: The access token returned by the PayPal Permission Service's GetAccessToken operation.

After a call to the PayPal Permission Service's GetAccessToken operation, this configuration option will contain the returned Access Token. This value is required to create the PayPal Permissions Service authentication header.

AuthApplicationId: The Application ID for the application making a request to the PayPal Permissions Service.

The Application ID provided by PayPal for your application. In the sandbox environment the static value "APP-80W284485P519543T" can be used.

AuthAuthHeader: The PayPal Permissions Service authentication header.

After specifying a valid AuthAccessToken and AuthTokenSecret, this configuration option will contain the authentication header granting you permissions to perform the designated operations on behalf of the granting account.

AuthAuthHeaderName: The name of the authentication header generated with the PayPal Permissions Service.

This configuration option should be set to correct header name for the PayPal Permission Service's authentication header for the desired operation. This value will usually be one of the following:


	X-PP-AUTHORIZATION (default)
	X-PAYPAL-AUTHORIZATION

AuthCallbackURL: The URL where PayPal will post the RequestToken and VerificationCode.

The URL that PayPal will post the RequestToken and VerificationCode to in response to a RequestPermissions request using the PayPal Permissions Service.

AuthorizationId: The authorization identification number of the last payment.

This value is returned in response to a Capture or VoidTransaction request. It should match the value sent in the AuthorizationId parameter of the Capture or VoidTransaction method. This config setting is read-only.

AuthorizeOrderPayment: Authorize an order payment.

This config will authorize a payment for a transaction that uses the order payment action. When used, OrderTotal should be set to the amount of the payment being authorized and TransactionId should be set to the transaction ID returned when confirming the order authorization using CheckoutPayment.

AuthorizingAccount: Authorizing Account Email Address for third-party API access.

The email address of a third party for whom you are sending requests to the PayPal Web Services API. Your API username must have been granted permission by this third party in order to make a PayPal API request.

AuthPassword: API Password for the PayPal Permissions Service.

The API password that is to be used when submitting requests to the PayPal Permissions Service.

AuthRequestToken: The request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.

After a call to the RequestPermissions operation, PayPal will post this value to the AuthCallbackURL. The value posted back to the AuthCallbackURL must be set in this configuration option prior to calling the GetAccessToken operation of the PayPal Permissions Service.

AuthRequestURL: The URL for the PayPal Permissions Service operation being requested.

The URL for the PayPal Permissions Service operation that is being requested. Examples are:


Request Permission	https://svcs.sandbox.paypal.com/Permissions/RequestPermissions
Get Access Token	https://svcs.sandbox.paypal.com/Permissions/GetAccessToken

AuthScope: Scope of permissions to be requested for PayPal Permissions Service.

The type of permissions that you are requesting from from a PayPal user. The following is an example of the types of permissions that can be requested, but this is not a complete list:


	EXPRESS_CHECKOUT
	DIRECT_PAYMENT
	SETTLEMENT_CONSOLIDATION
	SETTLEMENT_REPORTING
	AUTH_CAPTURE
	MOBILE_CHECKOUT
	BILLING_AGREEMENT
	REFERENCE_TRANSACTION
	AIR_TRAVEL
	MASS_PAY
	TRANSACTION_DETAILS
	TRANSACTION_SEARCH
	RECURRING_PAYMENTS
	ACCOUNT_BALANCE
	ENCRYPTED_WEBSITE_PAYMENTS
	REFUND
	NON_REFERENCED_CREDIT
	BUTTON_MANAGER
	ACCESS_BASIC_PERSONAL_DATA
	ACCESS_ADVANCED_PERSONAL_DATA
	MANAGE_PENDING_TRANSACTION_STATUS
	"RECURRING_PAYMENT_REPORT
	EXTENDED_PRO_PROCESSING_REPORT
	EXCEPTION_PROCESSING_REPORT
	ACCOUNT_MANAGEMENT_PERMISSION
	INVOICING

AuthSignature: API Signature for the PayPal Permissions Service.

The API signature that is to be used when submitting requests to the PayPal Permissions Service.

AuthTokenSecret: The token secret returned by the PayPal Permission Service's GetAccessToken operation.

After a call to the PayPal Permission Service's GetAccessToken operation, this configuration option will contain the returned Token Secret. This value is required to create the PayPal Permissions Service authentication header.

AuthUsername: API Username for the PayPal Permissions Service.

The API username that is to be used when submitting requests to 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.

Contains the build number returned in the response from Paypal. This config setting is read-only.

ButtonSource: Additional information for identifying transactions.

The "BN" identification code given to you by your PayPal Account Manager for identifying transactions.

CurrencyCode: Sets the type of currency in which you are accepting payments.

This configuration setting is used to determine the type of currency to be used for a payment. The default is "USD".

Custom: A free-form field for your own use.

This property can be anything, such as a tracking number or other value you want PayPal to return in the response.

HandlingTotal: Total handling costs for this order.

IsPartialCapture: Indicates if this capture is for the full amount of payment you authorized.

If this configuration setting is set to False (default), and the Amount of the Capture is less than the originally authorized amount, any remaining amount of the original transaction is automatically voided.

ItemTotal: Sum of cost of all items in this order.

If not specified, this value will be calculated for you by the component based on the ItemAmount and ItemQuantity specified.

LocaleCode: Locale of pages displayed by PayPal during Express Checkout.

The following two-character country codes are supported by PayPal:

Any other value (or no value) will default the pages to the US locale.

PaymentProtectionEligibility: If the PaymentPendingReason is PaymentReview this will return the protection in force for the transaction.

This value is only applicable when the PaymentPendingReason is "PaymentReview". It indicates the kind of protection in place for the transaction. Possible values are:


Eligible	Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received
PartiallyEligible	Seller is protected by PayPal's Seller Protection Policy for Item Not Received.
Ineligible	Seller is not protected under the Seller Protection Policy

RawRequest: Returns the raw request sent to the server.

Contains the full request that was sent to PayPal in the previous call.

RawResponse: Returns the full response.

This configuration setting will return the entire previous response as returned from the PayPal server.

ResponseVersion: Returns the Version number contained in the response.

The server may return a different version number than was sent to it. This config setting is available for informational purposes, and is read-only.

ShipToCity: Payer's shipping city.