HTML Variables for Payment Transactions
HTML variables for payment transactions provide information about entire transactions, regardless of the individual items involved with the payment. You can use these variables with Add to Cart buttons and the Cart Upload command.
Table 4. HTML Variables for Payment Transactions
Name | Required or Optional | Description | Character Length |
address_ override | Optional | 1 – The address specified in prepopulation variables overrides the PayPal member's stored address. The payer is shown the passed-in address but cannot edit it. No address is shown if the address is not valid, such as missing required fields like country, or is not included at all. For more information, see the HTML Variables for Prepopulating PayPal Checkout Pages table. | 1 |
currency_ code | Optional | The currency of the payment. The default is USD. For allowable values, see Currency Codes. | 3 |
custom | Optional | Passthrough variable never presented to the payer. Default – No variable is passed back to you. | 256 |
handling | Optional | Handling charges. This is not quantity-specific. The same handling cost applies, regardless of the number of items on the order. Default – No handling charges are included. | |
invoice | Optional | Passthrough variable you can use to identify your invoice number for this purchase. Default – No variable is passed back to you. | 127 |
shipping | Optional | The cost of shipping the entire order contained in third-party shopping carts. This use of the shipping variable is valid only for the Cart Upload command. Default – If profile-based shipping rates are configured, buyers are charged an amount according to the shipping methods they choose. | |
tax_cart | Optional | Cart-wide tax, overriding any individual item tax_ | |
weight_cart | Optional | If profile-based shipping rates are configured with a basis of weight, PayPal uses this value to calculate the shipping charges for the transaction. This value overrides the weight values of individual items. | |
weight_unit | Optional | The unit of measure if weight_cart is specified. Allowable values:
The default value is lbs. |