DirectPayment Class

Properties Methods Events Configuration Settings Errors

Obtain payment through PayPal directly from a buyer's credit card.

Syntax

class inpay.DirectPayment

Remarks

The DirectPayment class allows you to obtain payment for buyers who do not have a PayPal account. DirectPayment allows you to use your PayPal account as a gateway for any credit card. Your buyer no longer needs to have his own PayPal account.

At the time of this writing, in order to use this class you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple. First set the user to your API name, and password to the password for that API. Set the signature property to the API signature you received from PayPal. Then you may set the transaction properties, such as : order_total, card_number, card_exp_month, card_exp_year, etc. Then call either sale or authorize. The ack property will indicate the success or failure of the transaction.

After an authorization, the response_transaction_id should be saved and logged. This value may be used to capture or void any previous uncompleted authorize transactions (these functions will not work for a sale transaction, which is already considered complete).

In addition, this class also provides the results to two anti-fraud measures: Address Verification Service (AVS) and Card Verification Value (CVV) tests. The results of these tests will be stored in the response_avs and response_cvv, respectively. Although a transaction may be authorized, it is up to the merchant to inspect these properties and determine whether or not to honor the transaction.

Property List

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


ack	Acknowledgement code received from PayPal.
card_type	This property specifies the type of the credit card specified in Number .
card_cvv	Three digit security code on back of card (optional).
card_exp_month	This property contains the expiration month of the customer's credit card.
card_exp_year	This property contains the 4 digit expiration year of the customer's credit card.
card_number	This property contains the customer's credit card number for this transaction.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
idle	The current status of the class.
invoice_number	Your own invoice or tracking number.
item_count	The number of records in the Item arrays.
item_amount	Amount of charged on payment.
item_description	Paypal item description for the shopping cart.
item_name	Name of the item purchased.
item_number	Item number set by the merchant.
item_options	Paypal item options for the shopping cart.
item_quantity	Quantity of items ordered.
item_sales_tax	Amount of tax charged on payment.
item_total	Sum of all the Amount s.
merchant_session_id	Your customer session identification token.
note	An informational note about this settlement that will be displayed in the payer's transaction history.
order_description	Description of items the customer is purchasing.
order_total	Total amount of the order.
password	Password for communicating with PayPal.
payer_city	Payer's city name.
payer_country_code	Payer's country code.
payer_country_name	Payer's country name.
payer_email	Email address of the payer.
payer_first_name	Payer's first name.
payer_ip_address	IP address of the payer's browser as recorded in its HTTP request to your website.
payer_last_name	Payer's last name.
payer_state	Payer's state or province name.
payer_status	Indicates whether the payer is verified or not.
payer_street1	Payer's street address (first line).
payer_street2	Payer's street address (second line).
payer_zip	Payer's United States ZIP code or other country-specific postal code.
payment_date	This is the time/date stamp of payment.
payment_exchange_rate	Exchange rate if a currency conversion occurred.
payment_fee_amount	PayPal fee amount charged for the transaction.
payment_gross_amount	The final amount charged.
payment_type	Indicates whether the payment is instant or delayed.
payment_pending_reason	The reason the payment is pending.
payment_settle_amount	Amount deposited in your PayPal account after a currency conversion.
payment_status	Status of the payment.
payment_tax_amount	Tax charged on the transaction.
payment_transaction_id	Unique transaction ID of the payment.
payment_transaction_type	The type of transaction.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the TCP port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use SSL for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
response_amount	Amount returned in the response.
response_avs	The Address Verification System response code.
response_cvv	Result of the CVV check by PayPal.
response_transaction_id	Unique Transaction Id of the payment.
shipping_total	Total shipping costs for this order.
signature	Value to use with PayPal's Signature Authentication scheme.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
tax_total	Sum of tax for all items included in this order.
timeout	A timeout for the class.
url	URL all PayPal payment transactions are posted to.
user	User name for communicating with Paypal.

Method List

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


add_custom_field	This adds a custom name-value pair to be sent with the next request.
authorize	This method sends an Authorization transaction to PayPal.
capture	Completely or partially settles a previously authorized transaction.
config	Sets or retrieves a configuration setting.
do_events	Processes events from the internal message queue.
get_response_var	It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
interrupt	Interrupt the current method.
reset	Clears all properties to their default values.
sale	This method sends a Sale transaction to PayPal.
void_transaction	Voids a prior authorization.

Event List

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


on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.

Configuration Settings

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


AuthAccessToken	The access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationId	The Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeader	The PayPal Permissions Service authentication header.
AuthAuthHeaderName	The name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURL	The URL where PayPal will post the RequestToken and VerificationCode.
AuthorizationId	The authorization identification number of the last payment.
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.
HandlingTotal	Total handling costs for this order.
IsPartialCapture	Indicates if this capture is for the full amount of payment you authorized.
IssueNumber	Issue number of Maestro or Solo card.
ItemTotal	Sum of cost of all items in this order.
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.
StartMonth	Month that Maestro or Solo card was issued.
StartYear	Year that Maestro or Solo card was issued.
Version	Allows the user to set the Version number in the request.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.