DirectPayment Class

Properties   Methods   Events   Config 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.

Method List

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

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.

Config Settings

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

ack Property

Acknowledgement code received from PayPal.

Syntax

def get_ack() -> str: ...

ack = property(get_ack, None)

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:

This property is read-only.

card_type Property

This property specifies the type of the credit card specified in Number .

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

This property specifies the type of the credit card specified in card_number.

This property contains the type of the credit card (Visa, MasterCard, Amex, etc.) specified during the current transaction.

The valid card types for this property are listed below:

* Note: CurrencyCode must equal "GBP" to use this card_type. You may set the StartMonth, StartYear, and IssueNumber required for these cards via the config method.

This property is required.

card_cvv Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv() -> str: ...
def set_card_cvv(value: str) -> None: ...

card_cvv = property(get_card_cvv, set_card_cvv)

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric field contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVV data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the field and decide whether to honor the transaction or not.

Character length and limitations: Up to four single-byte numeric characters.

This property is optional.

card_exp_month Property

This property contains the expiration month of the customer's credit card.

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

This field contains the expiration month of the customer's credit card.

The valid range for this property is between 1 and 12.

This property is required.

card_exp_year Property

This property contains the 4 digit expiration year of the customer's credit card.

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

This field contains the 4 digit expiration year of the customer's credit card.

This property is required.

card_number Property

This property contains the customer's credit card number for this transaction.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

This field contains the customer's credit card number for this transaction.

Character length and limitations: numeric characters only - no spaces, dashes or punctuation. Must conform with modulo and length required by each credit card type.

This property is required.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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 fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

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

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

invoice_number Property

Your own invoice or tracking number.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

Character length and limitations: 127 single-byte alphanumeric characters.

This property is optional.

item_count Property

The number of records in the Item arrays.

Syntax

def get_item_count() -> int: ...
def set_item_count(value: int) -> None: ...

item_count = property(get_item_count, set_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• item_amount
• item_description
• item_name
• item_number
• item_options
• item_quantity
• item_sales_tax

The array indices start at 0 and end at item_count - 1.

item_amount Property

Amount of charged on payment.

Syntax

def get_item_amount(item_index: int) -> str: ...
def set_item_amount(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_description Property

Paypal item description for the shopping cart.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Paypal item description for the shopping cart.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_name Property

Name of the item purchased.

Syntax

def get_item_name(item_index: int) -> str: ...
def set_item_name(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Name of the item purchased.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_number Property

Item number set by the merchant.

Syntax

def get_item_number(item_index: int) -> str: ...
def set_item_number(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Item number set by the merchant.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_options Property

Paypal item options for the shopping cart.

Syntax

def get_item_options(item_index: int) -> str: ...
def set_item_options(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Paypal item options for the shopping cart.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_quantity Property

Quantity of items ordered.

Syntax

def get_item_quantity(item_index: int) -> int: ...
def set_item_quantity(item_index: int, value: int) -> None: ...

Default Value

0

Remarks

Quantity of items ordered.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_sales_tax Property

Amount of tax charged on payment.

Syntax

def get_item_sales_tax(item_index: int) -> str: ...
def set_item_sales_tax(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

Amount of tax charged on payment.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_total Property

Sum of all the Amount s.

Syntax

def get_item_total() -> str: ...
def set_item_total(value: str) -> None: ...

item_total = property(get_item_total, set_item_total)

Default Value

""

Remarks

This property contains the sum cost of all items in this order, and may not contain any sales tax or shipping and handling charges.

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.

merchant_session_id Property

Your customer session identification token.

Syntax

def get_merchant_session_id() -> str: ...
def set_merchant_session_id(value: str) -> None: ...

merchant_session_id = property(get_merchant_session_id, set_merchant_session_id)

Default Value

""

Remarks

PayPal records this optional session identification token as an additional means to detect possible fraud.

This property is optional.

Character length and limitations: 64 single-byte numeric characters.

note Property

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

Syntax

def get_note() -> str: ...
def set_note(value: str) -> None: ...

note = property(get_note, set_note)

Default Value

""

Remarks

Used during capture or void_transaction.

This property is optional.

Character length and limits: 255 single-byte characters.

order_description Property

Description of items the customer is purchasing.

Syntax

def get_order_description() -> str: ...
def set_order_description(value: str) -> None: ...

order_description = property(get_order_description, set_order_description)

Default Value

""

Remarks

This property is optional.

Character length and limitations: 127 single-byte alphanumeric characters.

order_total Property

Total amount of the order.

Syntax

def get_order_total() -> str: ...
def set_order_total(value: str) -> None: ...

order_total = property(get_order_total, set_order_total)

Default Value

""

Remarks

This includes: sales tax applied (tax_total), shipping (shipping_total) and handling charges.

This property is required.

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

Password for communicating with PayPal.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

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_city Property

Payer's city name.

Syntax

def get_payer_city() -> str: ...
def set_payer_city(value: str) -> None: ...

payer_city = property(get_payer_city, set_payer_city)

Default Value

""

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

payer_country_code Property

Payer's country code.

Syntax

def get_payer_country_code() -> str: ...
def set_payer_country_code(value: str) -> None: ...

payer_country_code = property(get_payer_country_code, set_payer_country_code)

Default Value

"US"

Remarks

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.

payer_country_name Property

Payer's country name.

Syntax

def get_payer_country_name() -> str: ...

payer_country_name = property(get_payer_country_name, None)

Default Value

"US"

Remarks

Payer's country name.

This property has been deprecated.

This property is read-only.

payer_email Property

Email address of the payer.

Syntax

def get_payer_email() -> str: ...
def set_payer_email(value: str) -> None: ...

payer_email = property(get_payer_email, set_payer_email)

Default Value

""

Remarks

Email address of the payer.

This property is optional.

payer_first_name Property

Payer's first name.

Syntax

def get_payer_first_name() -> str: ...
def set_payer_first_name(value: str) -> None: ...

payer_first_name = property(get_payer_first_name, set_payer_first_name)

Default Value

""

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

payer_ip_address Property

IP address of the payer's browser as recorded in its HTTP request to your website.

Syntax

def get_payer_ip_address() -> str: ...
def set_payer_ip_address(value: str) -> None: ...

payer_ip_address = property(get_payer_ip_address, set_payer_ip_address)

Default Value

""

Remarks

IP address of the payer's browser as recorded in its HTTP request to your website.

Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???

NOTE: PayPal records this IP address as a means to detect possible fraud.

This property is required.

payer_last_name Property

Payer's last name.

Syntax

def get_payer_last_name() -> str: ...
def set_payer_last_name(value: str) -> None: ...

payer_last_name = property(get_payer_last_name, set_payer_last_name)

Default Value

""

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

payer_state Property

Payer's state or province name.

Syntax

def get_payer_state() -> str: ...
def set_payer_state(value: str) -> None: ...

payer_state = property(get_payer_state, set_payer_state)

Default Value

""

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

payer_status Property

Indicates whether the payer is verified or not.

Syntax

def get_payer_status() -> str: ...
def set_payer_status(value: str) -> None: ...

payer_status = property(get_payer_status, set_payer_status)

Default Value

""

Remarks

Indicates whether the payer is verified or not.

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

payer_street1 Property

Payer's street address (first line).

Syntax

def get_payer_street1() -> str: ...
def set_payer_street1(value: str) -> None: ...

payer_street1 = property(get_payer_street1, set_payer_street1)

Default Value

""

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

payer_street2 Property

Payer's street address (second line).

Syntax

def get_payer_street2() -> str: ...
def set_payer_street2(value: str) -> None: ...

payer_street2 = property(get_payer_street2, set_payer_street2)

Default Value

""

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

payer_zip Property

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

Syntax

def get_payer_zip() -> str: ...
def set_payer_zip(value: str) -> None: ...

payer_zip = property(get_payer_zip, set_payer_zip)

Default Value

""

Remarks

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

This property is required.

Character length and limitations: 20 single-byte characters.

payment_date Property

This is the time/date stamp of payment.

Syntax

def get_payment_date() -> str: ...

payment_date = property(get_payment_date, None)

Default Value

""

Remarks

This is the time/date stamp of payment.

This property is read-only.

payment_exchange_rate Property

Exchange rate if a currency conversion occurred.

Syntax

def get_payment_exchange_rate() -> str: ...

payment_exchange_rate = property(get_payment_exchange_rate, None)

Default Value

""

Remarks

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.

This property is read-only.

payment_fee_amount Property

PayPal fee amount charged for the transaction.

Syntax

def get_payment_fee_amount() -> str: ...

payment_fee_amount = property(get_payment_fee_amount, None)

Default Value

""

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

payment_gross_amount Property

The final amount charged.

Syntax

def get_payment_gross_amount() -> str: ...

payment_gross_amount = property(get_payment_gross_amount, None)

Default Value

""

Remarks

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

This property is read-only.

payment_type Property

Indicates whether the payment is instant or delayed.

Syntax

def get_payment_type() -> str: ...

payment_type = property(get_payment_type, None)

Default Value

""

Remarks

Indicates whether the payment is instant or delayed.

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

This property is read-only.

payment_pending_reason Property

The reason the payment is pending.

Syntax

def get_payment_pending_reason() -> str: ...

payment_pending_reason = property(get_payment_pending_reason, None)

Default Value

""

Remarks

The reason the payment is pending.

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

This property is read-only.

payment_settle_amount Property

Amount deposited in your PayPal account after a currency conversion.

Syntax

def get_payment_settle_amount() -> str: ...

payment_settle_amount = property(get_payment_settle_amount, None)

Default Value

""

Remarks

Amount deposited in your PayPal account after a currency conversion.

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

This property is read-only.

payment_status Property

Status of the payment.

Syntax

def get_payment_status() -> str: ...

payment_status = property(get_payment_status, None)

Default Value

""

Remarks

Status of the payment.

The current list of possible values for this property are:

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

This property is read-only.

payment_tax_amount Property

Tax charged on the transaction.

Syntax

def get_payment_tax_amount() -> str: ...

payment_tax_amount = property(get_payment_tax_amount, None)

Default Value

""

Remarks

Tax charged on the transaction.

This property is read-only.

payment_transaction_id Property

Unique transaction ID of the payment.

Syntax

def get_payment_transaction_id() -> str: ...

payment_transaction_id = property(get_payment_transaction_id, None)

Default Value

""

Remarks

Unique transaction ID of the payment.

This property is read-only.

payment_transaction_type Property

The type of transaction.

Syntax

def get_payment_transaction_type() -> str: ...

payment_transaction_type = property(get_payment_transaction_type, None)

Default Value

""

Remarks

The type of transaction.

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

This property is read-only.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

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

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

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

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

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

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

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

response_amount Property

Amount returned in the response.

Syntax

def get_response_amount() -> str: ...

response_amount = property(get_response_amount, None)

Default Value

""

Remarks

Amount returned in the response.

This should always match the value sent in order_total.

This property is read-only.

response_avs Property

The Address Verification System response code.

Syntax

def get_response_avs() -> str: ...

response_avs = property(get_response_avs, None)

Default Value

""

Remarks

The Address Verification System response code.

This one character field contains the Address Verification System (AVS) result code. This is always returned in the server response. The AVS service is used to help detect fraud. While PayPal may authorize a payment, it is up to the merchant to check the response_avs and decide whether or not to honor the transaction.

The valid AVS codes are listed in the table below.

This property is read-only.

response_cvv Property

Result of the CVV check by PayPal.

Syntax

def get_response_cvv() -> str: ...

response_cvv = property(get_response_cvv, None)

Default Value

""

Remarks

Result of the card_cvv check by PayPal.

If a CVV value was present in the card_cvv property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. This is used to help detect fraud. It is up to the merchant to inspect this value and determine whether or not to honor the transaction.

The following is a list of current result codes:

This property is read-only.

response_transaction_id Property

Unique Transaction Id of the payment.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

Default Value

""

Remarks

Unique Transaction Id of the payment.

The value of this property is returned by the server when either one of the following methods is called:

- sale. In this case, the response_transaction_id is your record of the transaction.

- authorize. You will need the value of response_transaction_id for use as a key when capturing funds.

Character length and limitations:17 single-byte characters.

This property is read-only.

shipping_total Property

Total shipping costs for this order.

Syntax

def get_shipping_total() -> str: ...
def set_shipping_total(value: str) -> None: ...

shipping_total = property(get_shipping_total, set_shipping_total)

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

Value to use with PayPal's Signature Authentication scheme.

Syntax

def get_signature() -> str: ...
def set_signature(value: str) -> None: ...

signature = property(get_signature, set_signature)

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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform-dependent.

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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is 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:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

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:

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

tax_total Property

Sum of tax for all items included in this order.

Syntax

def get_tax_total() -> str: ...
def set_tax_total(value: str) -> None: ...

tax_total = property(get_tax_total, set_tax_total)

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

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

30

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

url Property

URL all PayPal payment transactions are posted to.

Syntax

def get_url() -> str: ...
def set_url(value: str) -> None: ...

url = property(get_url, set_url)

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 ssl_cert with your client-side certificate. If using the Signature method, set the signature property instead. The list of valid URLs is shown below:

user Property

User name for communicating with Paypal.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

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.

add_custom_field Method

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

Syntax

def add_custom_field(name: str, value: str) -> None: ...

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.

authorize Method

This method sends an Authorization transaction to PayPal.

Syntax

def authorize() -> None: ...

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account.

However, in the case of an authorization (using the authorize method), funds are not automatically captured. You must manually capture the funds with the capture method.

capture Method

Completely or partially settles a previously authorized transaction.

Syntax

def capture(authorization_id: str, amount: str) -> None: ...

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.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_response_var Method

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

def get_response_var(name: str) -> str: ...

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

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

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

sale Method

This method sends a Sale transaction to PayPal.

Syntax

def sale() -> None: ...

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account. However, in the case of an authorization (using the authorize method), funds are not automatically captured. You must manually capture the funds with the capture method.

void_transaction Method

Voids a prior authorization.

Syntax

def void_transaction(authorization_id: str) -> None: ...

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.

on_error Event

Information about errors during data delivery.

Syntax

class DirectPaymentErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class DirectPayment:
@property
def on_error() -> Callable[[DirectPaymentErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[DirectPaymentErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class DirectPaymentSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class DirectPayment:
@property
def on_ssl_server_authentication() -> Callable[[DirectPaymentSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[DirectPaymentSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class DirectPaymentSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class DirectPayment:
@property
def on_ssl_status() -> Callable[[DirectPaymentSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[DirectPaymentSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

DirectPayment Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

DirectPayment Errors

DirectPayment Errors

	2201   Server error response.
	2202   You attempted to set a property with invalid data.
	2203   You must set additional properties before attempting this function.

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in url
	153   Specified url_scheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

	100   You cannot change the remote_port at this time. A connection is in progress.
	101   You cannot change the remote_host (Server) at this time. A connection is in progress.
	102   The remote_host address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the local_port at this time. A connection is in progress.
	107   You cannot change the local_host at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   remote_port cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).