DirectPayment Class
Properties Methods Events Configuration Settings Errors
Obtain payment through PayPal directly from a buyer's credit card.
Syntax
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. 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 : OrderTotal, CardNumber, CardExpMonth, CardExpYear, etc. Then call either Sale or Authorize. The Ack property will indicate the success or failure of the transaction.
After an authorization, the ResponseTransactionId should be saved and logged. This value may be used in conjunction with the ReAuthCapture class to capture, void, or re-authorize any previous uncompleted Authorize transaction (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 ResponseAVS and ResponseCVV, 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. |
| CardType | This property specifies the type of the credit card specified in Number . |
| CardCVV | Three digit security code on back of card (optional). |
| CardExpMonth | This property contains the expiration month of the customer's credit card. |
| CardExpYear | This property contains the 4 digit expiration year of the customer's credit card. |
| CardNumber | This property contains the customer's credit card number for this transaction. |
| CurrencyCode | Type of currency in which you are accepting payments. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| Idle | The current status of the component. |
| InvoiceNumber | Your own invoice or tracking number. |
| ItemCount | The number of records in the Item arrays. |
| ItemAmount | Amount of charged on payment. |
| ItemDescription | Paypal item description for the shopping cart. |
| ItemName | Name of the item purchased. |
| ItemNumber | Item number set by the merchant. |
| ItemOptions | Paypal item options for the shopping cart. |
| ItemQuantity | Quantity of items ordered. |
| ItemSalesTax | Amount of tax charged on payment. |
| ItemTotal | Sum of all the Amount s. |
| MerchantSessionId | Your customer session identification token. |
| OrderDescription | Description of items the customer is purchasing. |
| OrderTotal | Total amount of the order. |
| Password | Password for communicating with PayPal. |
| PayerCity | Payer's city name. |
| PayerCountryCode | Payer's country code. |
| PayerCountryName | Payer's country name. |
| PayerEmail | Email address of the payer. |
| PayerFirstName | Payer's first name. |
| PayerIPAddress | IP address of the payer's browser as recorded in its HTTP request to your website. |
| PayerLastName | Payer's last name. |
| PayerState | Payer's state or province name. |
| PayerStatus | Indicates whether the payer is verified or not. |
| PayerStreet1 | Payer's street address (first line). |
| PayerStreet2 | Payer's street address (second line). |
| PayerZip | Payer's United States ZIP code or other country-specific postal code. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| ResponseAmount | Amount returned in the response. |
| ResponseAVS | The Address Verification System response code. |
| ResponseCVV | Result of the CVV check by PayPal. |
| ResponseTransactionId | Unique Transaction Id of the payment. |
| ShippingTotal | Total shipping costs for this order. |
| Signature | Value to use with PayPal's Signature Authentication scheme. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| TaxTotal | Sum of tax for all items included in this order. |
| Timeout | A timeout for the component. |
| URL | URL all PayPal payment transactions are posted to. |
| User | User name for communicating with Paypal. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddCustomField | This adds a custom name-value pair to be sent with the next request. |
| Authorize | This method sends an Authorization transaction to PayPal. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| GetResponseVar | It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties. |
| Interrupt | Interrupt the current method. |
| Reset | Reset the internal state of the component and all properties to their default values. |
| Sale | This method sends a Sale transaction to PayPal. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| ButtonSource | Additional information for identifying transactions. |
| HandlingTotal | Total handling costs for this order. |
| IssueNumber | Issue number of Maestro or Solo card. |
| ItemTotal | Sum of cost of all items in this order. |
| NotifyURL | Instant Payment Notification (IPN) URL. |
| 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. |
| AuthorizingAccount | Authorizing Account Email Address for third-party API access. |
| 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. |
| 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. |
| RawRequest | Returns the raw request sent to the server. |
| RawResponse | Returns the full response. |
| ResponseVersion | Returns the Version number contained in the response. |
| 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. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| 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. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| 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. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| 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). |
| 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. |