Paypal-IPN & PDT Variable list

The page contains all variables that may appear in IPN or PDT. The variable "policy_version" refers to the version number of IPN. You do not need to store this variable in your program. The variable verify_sign is an encrypted string used to verify the authenticity of the transaction. In addition, in the Sandbox test environment, IPN also adds a variable test_ipn (whose value is 1) to distinguish the test environment from the real environment.

Buyer Information

Variable name	Possible Value	Description	Length
Address_city		City/County in customer address	40
Address_country		Country or region in the customer address	64
Address_country_code		Two ISO 3166 country or region codes	2
Address_name		Name used for address (included when the customer provides the gift address)	128
Address_state		Province/Municipality/Autonomous Region in the customer address	40
Address_status	Confirmed	The customer provides confirmed addresses.
	Unconfirmed	The customer provides Unconfirmed addresses.
Address_street		Customer street address	200
Address_zip		Zip code in customer address	20
First_name		CUSTOMER NAME	64
Last_name		Customer's surname	64
Payer_business_name		Company Name of the customer, if the customer represents the Enterprise.	127
Payer_email		The customer's main email address. Use this email to provide all credit records.	127
Payer_id		Unique customer ID	13
Payer_status	Verified	The customer has an authenticated PayPal account
	Unverified	The customer has an unauthenticated PayPal account
Residence_country		Two ISO 3166 country or region codes	2

Basic Information

Variable name	Description	Length
Business	The recipient's email address or account number. If the payment is sent to the primary account, it is equal to receiver_email, especially the return value of the business variable passed in the HTML code of the "website payment" button.	127
Item_name	The name of the item that is passed by you (merchant. If it is not passed by you, it is entered by your customer. For a shopping cart transaction, PayPal attaches the item number (for example, item_name1 and item_name2 ).	127
Item_number	You are used to track purchase transfer variables. When the payment is complete, it will be sent back to you. If this parameter is omitted, no variable is returned to you.	127
Quantity	The quantity entered by your customer or transferred by you (seller. For a shopping cart transaction, PayPal attaches the item number (for example, quantity1 and quantity2 ).
Receiver_email	The main email address of the recipient (that is, the merchant. If payment is not the primary email address sent to the PayPal account, receiver_email is still the primary email address.	127
Receiver_id	The unique account number of the recipient (that is, the merchant. This is the same as the Recommendation Number of the recipient.	13

Advanced and custom information

Variable name	Description	Length
Custom	The custom value passed by you (merchant. Under no circumstances will these variables be displayed to your customers.	255
Invoice	You can use it to identify the transfer variable of the billing number for this purchase. If omitted, no variables are returned.	127
Memo	The memo that your customer entered in the payment prompt bar of the PayPal website.	255
Option_name1	Option 1 Name (applied by you)	64
Option_name2	Option 2 Name (applied by you)
Option_selection1	Option 1 (input by the customer)	200
Option_selection2	Option 2 (input by the customer)
Tax	Tax Amount charged for payment	2

Shopping Cart Information

Variable name	Possible Value	Description
Auth_id	Transaction-specific	Authorization ID
Auth_exp	Transaction-specific	Authorization expiration date and time
Auth_status	Completed Pending Voided	Authorization status
Mc_gross_x	Transaction-specific for multiple currencies	The currency shown in the amount is mc_currency, and x is the shopping cart detail item number. The sum of mc_gross_x should be equal to mc_gross.
Mc_handling_x	Transaction-specific for multiple currencies	X indicates the shopping cart detail item number. Because the mc_handling variable also contains the website payment variable in the whole shopping cart range of handling_cart, the sum of mc_handling_x is not necessarily equal to mc_handling.
Num_cart_items		If this transaction is a PayPal Shopping Cart transaction, it is the number of items in the shopping cart.
Option_name1		PayPal will append the item number, where x represents the detailed item number of the shopping cart (for example, option_name1 and option_name2 ).
Option_name2		PayPal will append the item number, where x represents the detailed item number of the shopping cart (for example, option_name2 and option_name2 ).
Option_selection1_x		PayPal attaches the item number (for example, option_selection1 and option_selection2). x indicates the detail item number of the shopping cart.
Option_selection2_x		PayPal attaches the item number (for example, option_selection1 and option_selection2). x indicates the detail item number of the shopping cart.
Parent_txn_id		When a refund, cancellation, or cancellation is made, the variable contains the txn_id of the original transaction, and the txn_id contains the new identification number of the new transaction. Character length and limit: 17.
Payment_date		The time/date stamp generated by PayPal. Formats: 18: 30: 30 Jan 1, 2000 PST.
Payment_status	Canceled-Reversal	This means that the cancellation has been canceled. For example, if you win in a dispute with the customer, the previously withdrawn transaction funds have been returned to you.
	Completed	The payment has been completed and the funds have been successfully added to your account balance.
	Denied	You have rejected the payment. This payment is only due to the previous payment. This happens only when the PendingReason element specifies the possible cause and is pending.
	Expired	This authorization has expired and cannot be captured.
	Failed	Payment failed. This happens only when the payment comes from the customer's bank account.
	In-Progress	The transaction is in authorization authentication.
	Partially-Refunded	This transaction was partially refunded.
	Pending	The amount to be paid. For more information, see PendingReason.
	Processed	Payment accepted.
	Refunded	You have refunded the payment.
	Reversed	Payment is revoked due to deduction claims or other revocation types. The funds have been deducted from your account balance and are returned to the buyer. The reason_code variable specifies the reason for cancellation.
	Voided	This authorization is invalid.
Payment_type	Echeck	Payment by electronic check
	Instant	Payment by PayPal balance, credit card or instant transfer
Pending_reason (This variable is set only when payment_status = Pending .)	Address	The amount to be paid is due to the customer's failure to provide a confirmed delivery address, and your receipt habit is set to allow manual acceptance or rejection of each such payment. To change the habits, go to the habits Settings section in your user information.
	Authorization	In SetExpressCheckoutReques<PaymentAction> Authorization </PaymentAction> is set on t, but no funds have been obtained.
	Echeck	The amount to be paid is due to its payment by electronic check, which has not yet been settled.
	Intl	The amount to be paid is because you have a non-U.S. account and there is no withdrawal mechanism. You must manually accept or reject the payment in your account information.
	Multi-currency	You do not have a balance in the currency you send, and you have not set the receipt habits to auto exchange and accept payment. You must manually accept or reject the payment.
	Unilateral	The payment is pending because the payment recipient email address has not been registered or confirmed.
	Upgrade	The amount to be paid is because it is paid by credit card. Therefore, you must upgrade your account to the enterprise account or advanced account status to receive funds. Upgrade may also indicate that you have reached the monthly transaction quota of your account.
	Verify	The payment is pending because you have not been certified. You must first authenticate your account to accept the payment.
	Other	The amount to be paid is not due to any of the above. For more information, contact the PayPal customer service.
Reason_code (This variable is set only when payment_status = Reversed or Refunded .)	Chargeback	The transaction was canceled because the customer proposed a claim for deduction.
	Guarantee	The transaction is canceled because the customer triggers a refund guarantee.
	Buyer-complaint	The transaction was canceled because the customer complained about the transaction.
	Refund	The transaction is canceled because you refund the customer.
	Other	The transaction is canceled for any reason other than the above.
Remaining_settle	Transaction-specific	Remaining amount that can be captured
Tax		PayPal attaches the item number (for example, item_name1 and item_name2 ). The tax_x variable is included only when a specific tax is collected for a certain shopping cart item. Because user information taxes and fees may be collected for other items in the shopping cart, the sum of tax_x is not necessarily equal to tax.
Transaction_entity	Auth Reauth Order Payment	Authorization
Txn_id		The unique transaction number generated by the PayPal system. Character length and limit: 17.
Txn_type	Cart	Transactions are created by the customer through the "PayPal Shopping Cart" function.
	Express _ checkout
	Merch_pmt
	Send_money	The transaction is created by the customer from the payment tab on the PayPal website.
	Virtual _ terminal
	Web-accept	Transactions are created by the customer using the "Buy now", "Donate", or "Bidding" smart logo.
Auth_amount	Transaction-specific	Authorization amount

Currency and currency exchange information

Variable name	Possible Value	Description
Exchange_rate		Exchange rate used for currency exchange
Mc_currency	See table of supported currencies	For IPN payment, This is the payment currency. For non-paid rental fee IPN, This is the rental fee currency.
Mc_detail		The transaction fee associated with the payment. The value of mc_gross minus mc_detail is equal to the amount in the receiver_email account. It is equal to the USD payment payment_amount. If this amount is negative, it indicates a refund or cancellation. The full or partial amount of the original transaction fee can be one of the two payment statuses.
Mc_gross		The total amount paid by the customer before the transaction fee is deducted. Payment_gross payment equals to USD. If this amount is negative, it indicates a refund or cancellation. The full or partial amount of the original transaction fee can be one of the two payment statuses.
Mc_handling		This is the total transaction-related fees
Mc_shipping		This is the total freight related to the transaction
Payment_fee	Transaction-specific for USD payments only	USD transaction fee associated with payment. Payment_gross minus payment_amount is equal to the amount saved to the recipient's email account. For non-USD payment, it is null. This old field has been replaced by mc_detail. If this amount is negative, it indicates a refund or cancellation. The full or partial amount of the original transaction fee can be one of the two payment statuses.
Payment_gross	Transaction-specific for USD payments only	The total USD paid by the customer before the transaction fee is deducted. Non-USD payment will be blank. This old field has been replaced by mc_gross. If this amount is negative, it indicates a refund or cancellation. The full or partial amount of the original transaction fee can be one of the two payment statuses.
Settle_amount		You can use your collection habits to enable automatic currency exchange, or manually accept the payment for manual currency exchange, and then save the amount of the Main Balance in your account.
Settle_currency		Currency of settle_amount

Bidding

Variable name	Possible Value	Description	Length
Auction_buyer_id		Customer's bidding ID	64
Auction_closing_date		End date of the auction
Auction_multi_item		The number of items purchased by bidding for multiple items. Because each item in a bid generates an instant payment notification, the entire bid amount is displayed. Therefore, you can calculate the amount of your bid from multiple items (auction_multi_item) mc_gross or payment_gross of the first ipn received.
For_auction	True	Bidding payment (use "payment for ebay items" or "smart identification", and use ebay items or bidding items (non-ebay items) type "Payment"/"Payment Requirement ).

Centralized payment

Variable name	Possible Value	Description
Masspay_txn_id_x		For centralized payment, this is the only transaction number generated by the PayPal system, where x is the centralized payment item record number.
Mc_currency_x	Transaction-specific for multiple currencies	For centralized payment, the payment amount and currency are used. x is the record number of centralized payment items.
Mc_fee_x	Transaction-specific for multiple currencies	For centralized payment, it is the transaction fee associated with the payment, where x is the centralized payment item record number.
Mc_gross_x	Transaction-specific for multiple currencies	This is the total amount, where x is the recording number of centralized payment items.
Payment_date		For centralized payment, the first IPN is the date/time when the set is processed, and the second IPN is the date/time when all payment ends/returns.
Payment_fee_x	Transaction-specific for USD payments only	If you pay in USD, the value is the same as that of mc_fee_x, where x is the record number. If the currency is not USD, It is a null string.
Payment_gross_x	Transaction-specific for USD payments only	If you pay in USD, the value is the same as that of mc_gross_x, where x is the centralized payment item record number. If the currency is not USD, It is a null string.
Payment_status	Completed	For centralized payment, it means that all your payment has been claimed, or after 30 days, the unowned payment has been returned to you.
	Denied	For centralized payment, it indicates that your funds have not been sent, and the centralized payment has not started, possibly due to insufficient funds.
	Processed	Your centralized payment has been processed, and all payments have been sent.
Reason_code (This variable is valid only when status = Failed .)	1001	Invalid UserID
	1003	Country of Residence check failure
	1004	Country of Funding Source check failure
Receiver_email_x		For centralized payment, This is the recipient's main email address, where x is the centralized payment item record number.
Status_x		For centralized payment, This is the payment status, where x is the record number.
	Completed	The payment has been processed, regardless of whether it was originally a unilateral payment.
	Failed	Payment failed due to insufficient funds in the balance.
	Reversed	Used for the unilateral payment that has not been claimed and has been returned to the sender within 30 days, or because the recipient's account is locked, the funds are returned.
	Unclaimed	Unclaimed
Txn_type	Masspay	The payment has been sent through centralized payment
Unique_id_x		For centralized payment, this is a unique identifier from the input, where x is the record number. In this way, the seller can cross-reference payment.

Lease variable

Variable name	Possible Value	Description	Length
Txn_type	Subscr_failed	Payment for rental fee failed
	Subscr_cancel	Cancel lease
	Subscr_payment	Rental fee payment
	Subscr_signup	Lease registration
	Subscr_eot	Lease end
	Subscr_modify	Lease Modification
Subscr_date		The start date or cancellation date, depending on the transaction as subscr_signup or subscr_cancel.
Subscr_effective		The date when the lease fee is modified (only when txn_type = subscr_modify ).
Period1		(Optional) trial lease interval in days, weeks, months, or years (for example, the four-day interval is "period1: 4 D ")
Period2		(Optional) trial lease interval in the unit of day, week, month, or year	64
Period3		Time Interval of regular lease by day, week, month or year
Amount1		Payment amount for the trial period in USD 1st; otherwise blank (optional)
Amount2		Payment amount for the trial period in USD 2nd; otherwise blank (optional)
Amount3		USD payment for the regular lease period; otherwise, it is blank.
Mc_amount1		The payment amount for the trial period, which is irrelevant to the currency (optional ).
Mc_amount2		The payment amount for the trial period, which is irrelevant to the currency (optional ).
Mc_amount3		The payment amount for the regular lease period, regardless of the currency.
Mc_currency		For IPN payment, This is the payment currency (that is, txn_type = subscr_payment ).
Recurring		Indicates whether the regular exchange rate is cyclical (1 is "yes", and if it is left blank, it is "no ")
Reattempt		Specifies whether to try again when payment fails (1 is "yes", and if it is left blank, it is "no ")
Retry_at		PayPal will retry the date of payment for the failed rental fee
Recur_times		Number of installments at the regular exchange rate
Username		(Optional) User Name generated by PayPal and provided to the tenant for accessing the rental fee	64
Password		(Optional) password generated by PayPal and provided to the tenant for accessing the rental fee (the password will be encrypted)
Subscr_id		ID generated by PayPal FOR THE TENANT	19

Dispute announcement variable

Variable name	Possible Value	Description
Txn_type	New_case	A new event has been registered.
Txn_id		The original transaction number that the merchant accepts from the buyer. The event is registered for the transaction number.
Case_id		Event Identification Number. Format: PP-nnn, where n is a number character.
Case_type	Complaint	The buyer has submitted a complaint through the PayPal dispute handling center
	Chargeback	The buyer has filed a claim for fee deduction with his/her credit card company, and the company has notified PayPal of the reason for the claim.
Case_creation_date	Transactionspecific	Date and time of event registration. Format: HH: mm: ss mon DD, yyyy tz. TZ indicates the Three-character time zone.
Reason_code	Depends on value of case_type	Event reason
Reason_code value of case_type complaint	Non_receipt	The buyer claims that the goods or services have not been received
	Not_as_described	The goods or services claimed by the buyer do not match the seller's description
Reason_code value of case_type claim	Unauthorized	The buyer claims that it has not authorized the transaction
	Non_receipt	The buyer claims that the goods or services have not been received
	Duplicate	The buyer claims that he may have made repeated payment to the seller
	Merchandise	The buyer claims that the goods received cannot be satisfied, defective, or damaged.
	Special	For some other reasons. Generally, special indicates that the credit card is incorrectly handled. The seller shall not be liable for this error and will not be charged for it. PayPal must verify the documents sent from the credit card company, determine the nature of the dispute, and try to contact the seller to resolve the dispute.