PAYPAL商户集成指南－IPN&PDT变量列表

本页包含了所有可能出现在IPN或者PDT中的变量。变量“notify_version”是指IPN的版本号，在您的程序中可以不用存储该变量； 变量 verify_sign是一个加密串，用于验证交易的真实性。另外，在Sandbox测试环境下，IPN还增加了一个变量test_ipn（其值为1），用于区分测试环境和真实环境。

买家信息

变量名	可能的值	描述	长度
address_city		客户地址中的市/县	40
address_country		客户地址中的国家或地区	64
address_country_code		两位ISO 3166国家或地区代码	2
address_name		用于地址的名称（在客户提供礼品地址时包含在内）	128
address_state		客户地址中的省/直辖市/自治区	40
address_status	Confirmed	客户提供的是已确认的地址
	Unconfirmed	客户提供的是未确认的地址
address_street		客户的街道地址	200
address_zip		客户地址中的邮政编码	20
first_name		客户的名	64
last_name		客户的姓	64
payer_business_name		客户的公司名称，如果客户代表企业。	127
payer_email		客户的主要邮件地址。 使用该电子邮件提供所有信用记录。	127
payer_id		唯一客户号	13
payer_status	verified	客户有已认证的PayPal账户
	unverified	客户有未认证的PayPal账户
residence_country		两位ISO 3166国家或地区代码	2

基本信息

变量名	描述	长度
business	收款人（即商家）的电子邮件地址或账户号。如果付款发送至主账户，则等于receiver_email，尤其指“网站付款”按钮HTML代码中传递的business变量的返回值。	127
item_name	由您（商家）传递的物品名称。如果不是由您传递，则由您的客户输入。如果是购物车交易，PayPal 将附加物品号（例如，item_name1、item_name2）。	127
item_number	您用于跟踪购买的传递变量。在付款完成时，它会传回给您。如果省略，则将没有变量传回给您。	127
quantity	由您的客户输入或由您（商家）传递的数量。如果是购物车交易，PayPal将附加物品号（例如，quantity1、quantity2）。
receiver_email	收款人（即商家）的主要邮件地址。如果付款不是发送到PayPal账户上的主要邮件地址，则receiver_email依旧是主要邮件地址。	127
receiver_id	收款人（即商家）的唯一账户号。这与收款人的推荐号相同。	13

高级及自定义信息

变量名	描述	长度
custom	由您（商家）传递的自定义值。在任何情形下，都不会向您的客户显示这些传递变量。	255
invoice	可供您用来识别此次购物的帐单号码的转递变量。如果省略，则没有变量传回。	127
memo	您的客户在PayPal网站付款提示栏中输入的备忘信息。	255
option_name1	选项1名称（由您申请）	64
option_name2	选项2名称（由您申请）
option_selection1	选项1选择（由客户输入）	200
option_selection2	选项2选择（由客户输入）
tax	对付款收取的税费金额	2

购物车信息

变量名	可能的值	描述
auth_id	Transaction-specific	授权识别号
auth_exp	Transaction-specific	授权失效日期和时间
auth_status	Completed Pending Voided	授权状态
mc_gross_x	Transaction-specific for multiple currencies	所示金额所用币种为mc_currency ，其中x为购物车明细物品号。mc_gross_x总和应等于mc_gross。
mc_handling_x	Transaction-specific for multiple currencies	x代表购物车明细物品号。由于mc_handling变量中还包含handling_cart整个购物车范围内的网站付款变量，因此mc_handling_x总和不一定等于mc_handling。
num_cart_items		如果此交易是PayPal购物车交易，则为购物车中的物品数。
option_name1		PayPal将附加物品号，其中x代表购物车明细物品号（例如，option_name1、option_name2）。
option_name2		PayPal将附加物品号，其中x代表购物车明细物品号（例如，option_name2、option_name2）。
option_selection1_x		PayPal将附加物品号（例如，option_selection1 、 option_selection2），其中x代表购物车明细物品号。
option_selection2_x		PayPal将附加物品号（例如，option_selection1 、 option_selection2），其中x代表购物车明细物品号。
parent_txn_id		在退款、撤销或取消撤销的情况下，该变量包含原定交易的txn_id，而txn_id包含新交易的新识别号。字符长度和限制：17。
payment_date		PayPal生成的时间/日期戳记。格式：18:30:30 Jan 1, 2000 PST。
payment_status	Canceled-Reversal	这意味着已经取消了撤销。例如，您在与客户的争议中获胜，先前撤销的交易资金已退回给您。
	Completed	付款已完成，资金已成功增加到您的账户余额中。
	Denied	您拒绝了付款。只有该款项此前因。PendingReason元素说明的可能原因而待付时，才会发生此类情况。
	Expired	这个授权已经过期，无法捕获。
	Failed	付款失败。只有当付款来自于客户的银行账户时，才会发生此类情况。
	In-Progress	这笔交易处于授权认证中。
	Partially-Refunded	这笔交易被部分退款。
	Pending	款项待付。请查看PendingReason了解更多信息。
	Processed	付款已被接受。
	Refunded	您退还了付款。
	Reversed	付款由于扣款索偿或其他撤销类型而撤销。资金已从您的账户余额中扣除，并已退还给买家。reason_code变量指明了撤销原因。
	Voided	此授权无效。
payment_type	echeck	该款项通过电子支票支付
	instant	该项付款通过PayPal余额、信用卡或即时转帐支付
pending_reason （只有在payment_status=Pending时，才会设置此变量。）	address	款项待付，原因是客户未提供已确认的送货地址，而您的收款习惯设定设为允许手动接受或拒绝每笔此类付款。若要更改习惯设定，请前往您的用户信息中的习惯设定部分。
	authorization	您在SetExpressCheckoutRequest上设置了<PaymentAction> Authorization</PaymentAction> ，而尚未获取资金。
	echeck	款项待付，原因是其通过电子支票付款，而电子支票尚未结清。
	intl	款项待付，原因是您持有非美国账户，且没有提现机制。您必须在账户信息中手动接受或拒绝该笔付款。
	multi-currency	您在发送的货币中没有余额，并且未将收款习惯设定设为自动兑换和接受付款。您必须手动接受或拒绝该笔付款。
	unilateral	款项待付，原因是付款的接收电子邮件地址尚未注册或确认。
	upgrade	款项待付，原因是其通过信用卡付款，因此您必须将账户升级为企业账户或高级账户状态，方可接收资金。upgrade也可能表示您已达到账户的月交易限额。
	verify	款项待付，原因是您尚未经过认证。您必须先认证您的账户，才能接受该笔付款。
	other	款项待付，原因非以上所列各项。若要了解更多信息，请与贝宝客户服务联系。
reason_code （只有在payment_status = Reversed 或Refunded时，才会设置此变量。)	chargeback	由于客户提出扣款索偿，因此撤销这笔交易。
	guarantee	由于客户触发退款担保，因此撤销这笔交易。
	buyer-complaint	由于客户就交易提出投诉，因此撤销这笔交易。
	refund	由于您向客户退款，因此撤销这笔交易。
	other	由于上述原因以外的其他原因，撤销这笔交易。
remaining_settle	Transaction-specific	可以捕获的剩余金额
tax		PayPal将附加物品号（例如，item_name1、item_name2 ）。只有对个别购物车物品收取特定税费时，才会在其中包含tax_x变量。由于可能对购物车中其他物品收取用户信息税费，因此tax_x的总和不一定等于tax。
transaction_entity	auth reauth order payment	授权
txn_id		PayPal系统生成的唯一交易号。字符长度和限制：17。
txn_type	cart	交易由客户通过“PayPal购物车”功能创建。
	express_ checkout
	merch_pmt
	send_money	交易由客户从PayPal网站上的付款选项卡中创建
	virtual_ terminal
	web-accept	交易由客户通过“立即购买”、“捐赠”或“竞拍”智能标识创建
auth_amount	Transaction-specific	授权金额

货币及货币兑换信息

变量名	可能的值	描述
exchange_rate		进行货币兑换时所用的汇率
mc_currency	See table of supported currencies	对于付款IPN，这是付款货币。对于非付款租费IPN，这是租费货币。
mc_fee		与付款关联的交易费。mc_gross减去mc_fee等于存入 receiver_email账户的金额。等于美元付款payment_fee。如果该金额为负，则表示退款或撤销，原定交易费的全部或部分金额都可以是这两种付款状态之一。
mc_gross		扣除交易费之前的客户付款全部金额。等于美元付款payment_gross。如果该金额为负，则表示退款或撤销，原定交易费的全部或部分金额都可以是这两种付款状态之一。
mc_handling		这是与交易相关的手续费总额
mc_shipping		这是与交易相关的运费总额
payment_fee	Transaction-specific for USD payments only	与付款相关的美元交易费。payment_gross减去payment_fee等于存入收款人电子邮件账户的金额。对于非美元付款为空。这个旧字段已由mc_fee取代。如果该金额为负，则表示退款或撤销，原定交易费的全部或部分金额都可以是这两种付款状态之一。
payment_gross	Transaction-specific for USD payments only	扣除交易费之前的客户付款全部美元金额。对于非美元付款将为空。这个旧字段已由mc_gross取代。 如果该金额为负，则表示退款或撤销，原定交易费的全部或部分金额都可以是这两种付款状态之一。
settle_amount		通过您的收款习惯设定进行自动货币兑换，或通过手动接受付款进行手动货币兑换后，存入账户主要余额的金额。
settle_currency		settle_amount的币种

竞拍

变量名	可能的值	描述	长度
auction_buyer_id		客户的竞拍ID	64
auction_closing_date		竞拍的结束日期
auction_multi_item		以多物品竞拍付款购买的物品的数目。由于竞拍的每个物品都会产生一个即时付款通知，其中显示整个竞拍的金额，因此您可以计算您从多物品竞拍（auction_multi_item）收到的第一个IPN的mc_gross或payment_gross。
for_auction	true	竞拍付款（使用“为易趣物品付款”或“智能标识”付款，以及使用易趣物品或竞拍物品（非易趣物品）类型“付款”/“款项要求”付款）。

集中付款

变量名	可能的值	描述
masspay_txn_id_x		对于集中付款，这是PayPal系统生成的唯一交易号，其中x是集中付款物品记录号。
mc_currency_x	Transaction-specific for multiple currencies	对于集中付款，为金额和费用所用币种，其中x是集中付款物品记录号。
mc_fee_x	Transaction-specific for multiple currencies	对于集中付款，为与付款关联的交易费，其中x是集中付款物品记录号。
mc_gross_x	Transaction-specific for multiple currencies	这是金额的总额，其中x是集中付款物品记录号。
payment_date		对于集中付款，表示第一个IPN是记录集被处理的日期/时间，第二个IPN是所有付款结束/退回的日期/时间。
payment_fee_x	Transaction-specific for USD payments only	如果用美元付款，则该值与mc_fee_x的值相同，其中x是记录号；如果币种不是美元，即为空字符串。
payment_gross_x	Transaction-specific for USD payments only	如果用美元付款，则该值与mc_gross_x的值相同，其中x是集中付款物品记录号。如果币种不是美元，则为空字符串。
payment_status	Completed	对于集中付款，表示您的所有付款已认领，或在30天后，无主付款已退回给您。
	Denied	对于集中付款，表示您的资金未发送，而集中付款未开始，可能是由于资金不足所致。
	Processed	您的集中付款已处理，所有付款已发送。
reason_code （此变量只有当status=Failed时才有效。）	1001	Invalid UserID
	1003	Country of Residence check failure
	1004	Country of Funding Source check failure
receiver_email_x		对于集中付款，这是收款人的主要邮件地址，其中x是集中付款物品记录号。
status_x		对于集中付款，这是付款状态，其中x是记录号。
	Completed	付款已处理，不论其原来是否为单方付款。
	Failed	由于余额中资金不足，付款失败。
	Reversed	用于超过30天未认领并已被退回发送方的单方付款，或由于收款人账户已锁定，资金被退回。
	Unclaimed	Unclaimed
txn_type	masspay	该付款已通过集中付款发送
unique_id_x		对于集中付款，这是来自输入的唯一标识符，其中x是记录号。这样，商家可以交叉参考付款。

租用变量

变量名	可能的值	描述	长度
txn_type	subscr_failed	租费付款失败
	subscr_cancel	租用取消
	subscr_payment	租费付款
	subscr_signup	租用注册
	subscr_eot	租用期末
	subscr_modify	租用修改
subscr_date		开始日期或取消日期，视交易为subscr_signup或subscr_cancel而定。
subscr_effective		租费修改生效时的日期（仅适用于 txn_type = subscr_modify 的情况）。
period1		（可选）以天、周、月或年为单位的试租用时间间隔（示例：四天的时间间隔为“period1:4 D”）
period2		（可选）以天、周、月或年为单位的试租用时间间隔	64
period3		以天、周、月或年为单位的定期租用时间间隔
amount1		USD付款第1段试用期的付款金额；否则为空白（可选）
amount2		USD付款第2段试用期的付款金额；否则为空白（可选）
amount3		USD付款定期租用期的付款金额；否则为空白。
mc_amount1		第1段试用期的付款金额，与货币无关（可选）。
mc_amount2		第2段试用期的付款金额，与货币无关（可选）。
mc_amount3		定期租用期的付款金额，与货币无关。
mc_currency		对于付款IPN，此为付款货币 （即，txn_type=subscr_payment）。
recurring		指明定期汇率是否循环（1为“是”，保留空白则为“否”）
reattempt		指明在付款失败时是否应重新尝试（1为“是”，保留空白则为“否”）
retry_at		PayPal将重试失败租费付款的日期
recur_times		将按定期汇率进行分期付款的次数
username		（可选）由PayPal生成并提供给租用者用于访问租费的用户名	64
password		（可选）由PayPal生成并提供给租用者用于访问租费的密码（密码将被加密）
subscr_id		PayPal为租用者生成的ID	19

争议通告变量

变量名	可能的值	描述
txn_type	new_case	已注册新的事件
txn_id		商家从买家接受付款的原始交易号，事件是针对该交易号注册的。
case_id		事件识别号。格式：PP-nnn-nnn-nnn ，其中n为任何数字字符。
case_type	complaint	买家已通过贝宝争议处理中心提交投诉
	chargeback	买家已向其信用卡公司提出扣款索偿，该公司已将扣款索偿的原因通知PayPal。
case_creation_date	Transactionspecific	事件注册的日期和时间。格式：HH:mm:ss mon DD, YYYY TZ。其中TZ表示三字符的时区。
reason_code	Depends on value of case_type	事件原因
case_type 投诉的 reason_code 值	non_receipt	买家声称未收到货物或服务
	not_as_described	买家声称收到的货物或服务与商家描述不符
case_type 扣款索偿的 reason_code 值	unauthorized	买家声称其并未授权交易
	non_receipt	买家声称未收到货物或服务
	duplicate	买家声称可能向商家进行了重复付款
	merchandise	买家声称收到的商品无法令其满意、有瑕疵或已损坏。
	special	某些其他原因。通常，special表明信用卡处理错误，该错误不应由商家承担责任，因而不会对该商家扣款。PayPal必须核对信用卡公司发来的文档，确定争议性质，并尽可能联系商家以解决争议。