标准变量列表
变量 cmd 的值
cmd 的值 | 说明 | |
_xclick | “立即购买”和“捐赠”按钮。 | |
_cart | “购物车” 按钮。 | |
_ext-enter | 预填充您的客户的PayPal注册表单。需要一个redirect_cmd 变量,其值应为 _xclick 。 |
用于IPN的变量: notify_url
变量名 | 说明 | 必填/选填 | 字段长度 |
notify_url | 用于接受PayPal发送的关于即时付款通知的交易信息的URL。必须是有效的URL。 | 选填 | 255 |
表单变量: 物品信息
amount | 购物价格或金额,不包括运费、手续费或税费。如果在“立即购买”或者“捐赠”交易情况下省略,则由客户在购买时填写此值。 • 立即“购买”或者“捐赠”交易情况下是选填 | 请参考本行说明 |
|
item_name | 物品描述。如果在“立即购买”或者“捐赠”交易情况下省略,则客户将看到一个可以选择输入物品名称的栏目。 • 立即“购买”或者“捐赠”交易情况下是选填 | 请参考本行说明. | 127 |
item_number | 可用于跟踪购买或捐赠的传递变量,在付款完成时传回给您。如果在“立即购买”或者“捐赠”交易情况下省略,则将没有变量传回给您。 | 选填 | 127 |
quantity | 物品数量。将金额、运费和税费乘以数量将得出付款总额。如果这是购物车交易,PayPal将附加物品数量(例如, quantity1、quantity2)。 提示:数量的值必须是正整数。不允许为空、零或负数。 | 选填 |
|
undefined_quantity | 如果设置为 1,则允许买家修改数量。 | 选填 | 1 |
on0 | 第一选项栏名称。如果省略,则将没有变量传回给您. | 选填 | 64 |
on1 | 第二选项栏名称。如果省略,则将没有变量传回给您。 | 选填 | 64 |
os0 | 第一组选项值。如果此选项通过文本框或单选按钮选中,则每个值均应不超过 64 个字符。如果该值由客户通过文本框输入,则上限为 200 个字符。如果省略,则不会传回给您任何变量。 提示:必须对 on0 进行定义,才能识别 os0。 | 选填 | 64 or 200 |
os1 | 第二组选项值。如果此选项通过文本框或单选按钮选中,则每个值均应不超过 64 个字符。如果该值由客户通过文本框输入,则上限为 200 个字符。如果省略,则不会传回给您任何变量。 提示:必须对 on1 进行定义,才能识别 os1。 | 选填 | 64 or 200 |
表单变量:显示信息
名字 | 说明 | 必填/选填 | 字段长度 |
add | 添加一个物品到PayPal购物车 | 必填 | 1 |
cancel_return | 指在付款取消的情况下,客户浏览器返回到的 URL 。例如,您的网站上显示“付款已取消”页面的 URL。如果省略,则用户将被带到PayPal网站。 | 选填 |
|
cbt | 设置“PayPal付款完成”页面上的“继续”按钮的文本。 提示:return 变量也需要被设置。 | 选填 | 60 |
cn | 提示栏上的标签。该值不保存,而且不会出现在任何给您的通告中。如果省略,则将没有变量传回给您。 | 选填 | 40 |
cpp_header_image | 将 您选择的图片设置为显示在付款页面的左上角。该图片的最大尺寸为 750像素宽、90 像素高。有效的字符集为 URL 安全字符。由于图片不存储在我们的数据库上,所以 cpp_header_image 变量没有字符限制。建议您只提供存储在安全 (https) 服务器上的图片。 | 选填 | 无限制 |
cpp_headerback_color | 为付款页面标题设置背景色。有效的字符集为 6 字符 HTML 十六进制 ASCII代码。此变量不区分大小写。 | 选填 |
|
cpp_headerborder_color | 设置付款页面标题四周的边框颜色。边框是位于标题空间四周,粗细为 2 像素的方框,方框最大尺寸为 750 像素宽、90 像素高。有效的字符集为 6 字符HTML 十六进制 ASCII 代码。此变量不区分大小写。 | 选填 |
|
cpp_payflow_color | 为付款页面的标题以下区域设置背景色。有效的字符集为 6 字符 HTML 十六进制 ASCII 代码。此变量不区分大小写。 提示:不允许使用与贝宝错误信息相冲突的背景色。默认颜色为白色。 | 选填 |
|
cs | 设置您的付款页面的背景色。如果设为“1”,背景色将为黑色。如果省略 或设为“0”,背景色则为白色。 | 选填 |
|
display | 显示当前PayPal购物车的物品信息。 | 选填 | 1 |
image_url | 您希望在PayPal付款页面左上角的用作标识的 150x50 像素图片的 URL。必须是有效的URL。 如果省略,则客户看到的是您的商家名称(如果您有企业账户)或您的电子邮件地址(如果您有高级账户)。 | 选填 |
|
no_note | 为付款加入说明。如果省略或设为“0”,则会提示您的客户输入说明。如果设为“1”,则不会提示您的客户输入说明。 | 选填 | 1 |
no_shipping | 买家的送货地址。 省略或设为 0 = 提示客户输入收货地址。 1 = 不要求客户提供收货地址。 2 = 客户必须提供收货地址。 | 选填 | 1 |
page_style | 为与此按钮/ 链接相关的付款页面设置“自定义付款页面的样式”。 page_style 的值与添加或编辑页面样式时您选择的页面样式名称相同。 page_style 变量的最大长度为 30 个字符。 有效的字符集只能为小写 7 位字母数字 ASCII 字符,加下划线。不能包含空格。 如果您希望按钮/ 链接始终引用您设置为首选的样式,请将该变量设置为 "primary"。 如果您希望该按钮/ 链接始终引用默认的贝宝页面样式,请将该变量设置为 "paypal"。 | 选填 | 30 |
return | 指完成付款后客户的浏览器返回到的 URL 。 例如,在您的站点上显示“感谢您的付款” 的页面的 URL。 如果省略,则您的买家将被带到PayPal网站。 | 选填 |
|
rm | 付款完成后的返回 URL 的行为(“返回方法”)。 提示:rm变量只有在return变量被设置后才能生效。 如果省略或为 0,则 GET 方法用于没有启用即时付款通知的所有购物车交易,而 POST 方法用于所有其他交易。 如果为 1 并设置了 return,则客户的浏览器由 GET 方法返回至返回 URL,并且不提交任何交易变量。 如果为 2 并设置了 return,则客户的浏览器由 POST 方法返回至返回URL,同时将所有可用交易变量发送至该 URL。 | 选填 |
|
表单变量: 交易信息
名字 | 说明 | 必填/选填 | 字段长度 |
address_override | 如果设置为 1,通过预填充栏传送的地址将会覆盖用户的已存储地址。用户可以看到传送的地址,但是无法进行编辑。如果地址无效(例如,缺少必需的栏,包括国家或地区)或者没有包括地址,则不会显示地址。 | 选填 | 1 |
currency_code | 付款货币。定义币种以标示货币变量(amount、shipping、shipping2、handling、tax)。如果省略,则所有货币字段将解释为美元。 | 选填 |
|
custom | 永远不会向您的客户显示的传递变量。如果省略,则不会传回给您任何变量。 | 选填 | 256 |
handling | 手续费。并非根据数量而定。无论所购物品数量多少,均收取相同手续费。 如果省略,则不收取手续费。 | 选填 |
|
invoice | 您可以用于识别此次购物的帐单号码的传递变量。如果省略,则不会传回给您任何变量。 | 选填 | 127 |
redirect_cmd | 只有在cmd的值为“_ext-enter”,即账户注册的预填充时才有效。 redirect_cmd 的唯一有效值是 _xclick. | 选填 | 40 |
shipping | 在您启用了特定于物品的运费时,运送此物品的成本。如果使用了shipping 而未定义 shipping2 ,则无论所购物品数量多少,都将收取该固定金额。 提示:如果您使用的是基于物品的运费,请确保选中您的用户信息中的覆盖复选框。 如果省略,并启用了基于用户信息的运费,则将向您的客户收取您的用户信息中定义的金额或百分比。 | 选填 |
|
shipping2 | 每增加一件物品所需的运送成本。如果省略,并启用了基于用户信息的运费,则将向您的客户收取您的用户信息中定义的金额或百分比。 | 选填 |
|
tax | 基于交易的税费覆盖变量。将该变量设置为您希望应用于交易的固定税额,而不论买家所处的位置。如果存在,该值将覆盖可能已在您的用户信息中设定的任何税费设置。如果省略,则适用用户信息税费设置(如有)。 | 选填 |
|
tax_cart | 整个购物车的税费。而不是单个物品的税额。 | 选填 |
|
表单变量: 购物车特有
名字 | 必填/选填 | 说明 | 允许的值 |
amount | 必填 | 物品的价格(购物车中所有物品的总价格)。 | 任何有效货币金额 |
business | 必填 | 您PayPal账户上的电子邮件地址。 | 您PayPal账户上的电子邮件地址 |
handling_cart | 选填 | 对整个购物车收取的单笔手续费。如果在多个“添加到购物车”按钮中使用handling_cart,将使用第一件物品的handling_cart 值。 | 任何有效货币金额 |
item_name | 必填 | 物品名称(或购物车名称)。 |
|
paymentaction | 选填 | 指明交易是否是稍后在https://www.paypal.com/ 上通过PayPal授权与捕获进行捕获的授权。 |
|
upload | 必填 | 上传第三方购物车 | 1 |
表单变量:第三方购物车中单个物品的变量
名字 | 说明 | 必填/选填 | 字段长度 |
amount_x | 物品 #x 的价格。 | 必填 |
|
handling_x | 物品 #x 的手续费。 | 选填 |
|
item_name_x | 购物车中的物品 #x 的名称。必须为字母数字字符。 | 必填 | 127 |
item_number_x | 可用于跟踪购买 或捐赠的传递变量,在付款完成时传回给您。 如果省略,则将没有变量传回给您。 | 选填 | 127 |
on0_x | 物品 #x 的第一选项栏名称。 | 选填 | 64 |
on1_x | 物品 #x 的第二选项栏名称。 | 选填 | 64 |
os0_x | 物品 #x 的第一组选项值。 | 选填 | 200 |
os1_x | 物品 #x 的第二组选项值。 必须对 on1_x 进行定义,才能识别 os1_x 。 | 选填 | 200 |
quantity_x | 物品 #x 的数量。quantity_x 的值必须是正整数。不允许为空、零或负数。 | 选填 |
|
shipping_x | 运送物品 #x 的第一件(数量 1)的成本。 | 选填 |
|
shipping2_x | 每增加一件运送物品 #x (数量 2 或更多)所需的运送成本。 | 选填 |
|
tax_x | 物品 #x 的税额。 | 选填 |
|
表单变量:网站付款的预填充变量
变量名 | 说明 | 要求 | 字段长度 |
address1 | 街道(第 1 栏,共 2 栏) | 字母数字字符 | 100 |
address2 | 街道(第 2 栏,共 2 栏) | 字母数字字符 | 100 |
city | 市/ 县 | 字母数字字符 | 40 |
country | 设置运送和开单国家或地区。请查看附录6,以了解允许的国家或地区代码。 | 字母 | 2 |
| 客户的电子邮件地址 | 字母数字字符 | 127 |
first_name | 名 | 字母 | 32 |
last_name | 姓 | 字母 | 32 |
lc | 定义买家的交易方式确认流程的语言 | 字母 | 2 |
night_phone_a | 美国电话号码的区号,或非美国电话号码的国家或地区代码。它会预填充买家的家庭电话。 | 数字 | 3 |
night_phone_b | 美国电话号码的 3 位数前缀,或非美国电话号码的完整电话号码(不包括国家或地区代码)。它会预填充买家的家庭电话。 | 数字 | 3 |
night_phone_c | 美国电话号码的 4 位数电话号码。它会预填充买家的家庭电话。 | 数字 | 4 |
state | 省/ 直辖市/ 自治区 | 必须为两个字符的正式缩写 | 2 |
zip | 邮编 | 数字 | 32 |
表单变量: 账户注册的预填充变量
变量名 | 说明 | 要求 | 字段长度 |
business_address1 | 客户所在的街道 | 字母数字字符 | 128 |
business_address2 | 客户所在的街道 | 字母数字字符 | 128 |
business_city | 客户所在的市/ 县 | 字母数字字符 | 128 |
business_state | 客户所在的省/ 直辖市/ 自治区 | 必须为两个字符的正式缩写 | 2 |
business_country | 客户所在的国家 | 字母 | 2 |
business_cs_email | 客户的email地址 | 字母数字字符 | 128 |
business_cs_phone_a | 客户的客服电话所在的美国电话号码的区号,或非美国电话号码的国家或地区代码。 | 数字 | 3 |
business_cs_phone_b | 客户的客服电话所在的美国电话号码的 3 位数前缀,或非美国电话号码的完整电话号码(不包括国家或地区代码)。它会预填充买家的家庭电话。 | 数字 | 3 |
business_cs_phone_c | 客户的客服电话所在的美国电话号码的 4 位数电话号码。它会预填充买家的家庭电话。 | 数字 | 4 |
business_url | 客户网站的URL | 字母数字字符. 必须是有效的. | 128 |
night_phone_b | 美国电话号码的 3 位数前缀,或非美国电话号码的完整电话号码(不包括国家或地区代码)。它会预填充买家的家庭电话。 | 数字 | 3 |
business_night_phone_a | 客户所在的美国电话号码的区号,或非美国电话号码的国家或地区代码。它会预填充买家的家庭电话。 | 数字 | 3 |
business_night_phone_b | 客户所在的美国电话号码的 3 位数前缀,或非美国电话号码的完整电话号码(不包括国家或地区代码)。它会预填充买家的家庭电话。 | 数字 | 3 |
business_night_phone_c | 客户所在的美国电话号码的 4 位数电话号码。它会预填充买家的家庭电话。 | 数字 | 4 |