On this page
No Headings
An array of transaction detail objects.
arrayitemsobjectThe transaction details.
transaction_infoobjectThe transaction information.
paypal_account_idstring^[a-zA-Z0-9_]*$The ID of the PayPal account of the counterparty.
transaction_idstring^[a-zA-Z0-9_]*$The PayPal-generated transaction ID.
paypal_reference_idstring^[a-zA-Z0-9_-]*$The PayPal-generated base ID. PayPal exclusive. Cannot be altered. Defined as a related, pre-existing transaction or event.
paypal_reference_id_typestring"ODR", "TXN", "SUB", "PAP"^[a-zA-Z0-9]*$The PayPal reference ID type.
transaction_event_codestring^[a-zA-Z0-9]*$A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit. For example, T0001. See Transaction event codes.
transaction_initiation_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when work on a transaction began in the PayPal system, as expressed in the time zone of the account on this side of the payment.
transaction_updated_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the transaction was last changed, as expressed in the time zone of the account on this side of the payment.
transaction_amountobjectThe all-inclusive gross transaction amount that was transferred between the sender and receiver through PayPal.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.fee_amountobjectThe PayPal fee amount. All transaction fees are included in this amount, which is the record of fee associated with the transaction.
Note: This field contains a value only when a transaction fee is applied and processed for this transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discount_amountobjectThe reduction in price offered for goods or services purchased.
Note: This discount is for a price reduction that is offered for other than that at a individual item level.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.insurance_amountobjectAn insurance charge. Guarantees the quality or delivery of a product.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.sales_tax_amountobjectThe PayPal- or merchant-reported sales tax amount for the transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_amountobjectThe PayPal- or merchant-reported shipping amount for the transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_discount_amountobjectThe discount on the shipping amount.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_tax_amountobjectThe tax on the shipping service.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.other_amountobjectThe special amount that is added to the transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tip_amountobjectThe tip.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transaction_statusstring^[a-zA-Z0-9]*$A code that indicates the transaction status. Value is:
| Status code | Description |
|---|---|
D | PayPal or merchant rules denied the transaction. |
P | The transaction is pending. The transaction was created but waits for another payment process to complete, such as an ACH transaction, before the status changes to S. |
S | The transaction successfully completed without a denial and after any pending statuses. |
V | A successful transaction was fully reversed and funds were refunded to the original sender. |
transaction_subjectstring^[a-zA-Z0-9_'\-., ":;\!?]*$The subject of payment. The payer passes this value to the payee. The payer controls this data through the interface through which he or she sends the data.
transaction_notestring^[a-zA-Z0-9_'\-., ":;\!?]*$A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions.
payment_tracking_idstring^[a-zA-Z0-9_]*$The payment tracking ID, which is a unique ID that partners specify to either get information about a payment or request a refund.
bank_reference_idstring^[a-zA-Z0-9_]*$The bank reference ID. The bank provides this value for an ACH transaction.
ending_balanceobjectThe ending balance.
Note: If you specify one or more optional query parameters, the ending_balance response field is empty.currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.available_balanceobjectThe available amount of transaction currency during the completion of this transaction.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.invoice_idstring^[a-zA-Z0-9_'\-., ":;\!?]*$The invoice ID that is sent by the merchant with the transaction.
Note: If an invoice ID was sent with the capture request, the value is reported. Otherwise, the invoice ID of the authorizing transaction is reported.
custom_fieldstring^[a-zA-Z0-9_'\-., ":;!?|]*$The merchant-provided custom text.
Note: Usually, this field includes the unique ID for payments made with MassPay type transaction.
protection_eligibilitystring^[a-zA-Z0-9]*$Indicates whether the transaction is eligible for protection. Value is:
01. Eligible.02. Not eligible03. Partially eligible.credit_termstring^[a-zA-Z0-9.]*$The credit term. The time span covered by the installment payments as expressed in the term length plus the length time unit code.
credit_transactional_feeobjectThe overall amount of the credit transaction fee.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.credit_promotional_feeobjectThe overall amount of the credit promotional fee.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.annual_percentage_ratestringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The annual percentage rate (APR). Determines the amount of interest a consumer pays to finance a purchase at a merchant.
payment_method_typestring^[a-zA-Z0-9-]*$The payment method that was used for a transaction. Value is PUI, installment, or mEFT.
Note: Appears only for pay upon invoice (PUI), installment, and mEFT transactions. Merchants and partners in the EMEA region can use this attribute to note transactions that attract turn-over tax.
instrument_typestring^[a-zA-Z0-9-]*$A high-level classification of the type of financial instrument that was used to fund a payment. The pattern is not provided because the value is defined by an external party. E.g. PayPal, Credit Card, Debit Card, Venmo or Alternative Payment Methods (APM).
instrument_sub_typestringA finer-grained classification of the financial instrument that was used to fund a payment. For example, PayPal wallet for PayPal, American Express for a credit card, Visa for a Debit Card, Venmo Wallet for Venmo, etc. The pattern is not provided because the value is defined by an external party.
decline_codestring^[a-zA-Z0-9_'\-., ":;\!?]*$UDD SEPA Payment Type external decline codes. Value is defined by an external party. UDD SEPA Decline Code.
payer_infoobjectThe payer information.
account_idstring^[a-zA-Z0-9_]*$The PayPal` customer account ID.
email_addressstringppaas_common_email_address_v2^.+@[^"\-].+$The email address of the payer.
phone_numberobjectThe primary phone number of the payer.
country_coderequiredstring^[0-9]{1,3}?$The country calling code (CC), in its canonical international E.164 numbering plan format. The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
national_numberrequiredstring^[0-9]{1,14}?$The national number, in its canonical international E.164 numbering plan format. The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
extension_numberstring^[0-9]{1,15}?$The extension number.
address_statusstring^[N|Y]$The address status of the payer. Value is either:
Y. Verified.N. Not verified.payer_statusstring^[N|Y]$The status of the payer. Value is Y or N.
payer_nameobjectThe payer name.
prefixstringThe prefix, or title, to the party's name.
given_namestringWhen the party is a person, the party's given, or first, name.
surnamestringWhen the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
middle_namestringWhen the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
suffixstringThe suffix for the party's name.
alternate_full_namestringDEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
full_namestringWhen the party is a person, the party's full name.
country_codestringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region of the payer.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
addressobjectThe payer address.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
shipping_infoobjectThe shipping information.
namestring^[a-zA-Z0-9_'\-., ":;\!?]*$The recipient's name.
methodstring^[a-zA-Z0-9_'\-., ":;\!?]*$The shipping method that is associated with this order.
addressobjectThe shipping address that is associated with this order.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
secondary_shipping_addressobjectThe secondary shipping address that is associated with this order.
line1requiredstringThe first line of the address. For example, number or street.
line2stringThe second line of the address. For example, suite or apartment number.
cityrequiredstringThe city name.
statestringcountry_coderequiredstringppaas_common_country_code_v2^([A-Z]{2}|C2)$The two-character ISO 3166-1 code that identifies the country or region.
Note: The country code for Great Britain isGBand notUKas used in the top-level domain names for that country. Use theC2country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.
postal_codestringThe postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See postal code.
cart_infoobjectThe cart information.
item_detailsarrayAn array of item details.
itemsobjectThe item details.
item_codestring^[a-zA-Z0-9_'\-., ":;\!?]*$An item code that identifies a merchant's goods or service.
item_namestring^[a-zA-Z0-9_'\-., ":;\!?]*$The item name.
item_descriptionstring^[a-zA-Z0-9_'\-., ":;\!?]*$The item description.
item_optionsstring^[a-zA-Z0-9_'\-., ":;\!?]*$The item options. Describes option choices on the purchase of the item in some detail.
item_quantitystring^[a-zA-Z0-9_'\-., ":;\!?]*$The number of purchased units of goods or a service.
item_unit_priceobjectThe cost for each instance of goods or a service.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.item_amountobjectThe amount of the payment for the item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discount_amountobjectThe reduction in price associated with goods or a service.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.adjustment_amountobjectAn increment or decrement to a purchase amount.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.gift_wrap_amountobjectThe amount of money charged for gift wrapping an item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_percentagestringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$A rate, expressed in hundreds, that is used to calculate a levy for the purchase of goods or services.
tax_amountsarrayAn array of tax amounts levied by a government on the purchase of goods or services.
itemsobjectThe tax levied by a government on the purchase of goods or services.
tax_amountobjectThe tax levied by a government on the purchase of goods or services.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.basic_shipping_amountobjectThe delivery cost.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.extra_shipping_amountobjectThe cost for expedited delivery of the goods.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.handling_amountobjectA charge for processing the purchase of goods or services.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.insurance_amountobjectA charge for guaranteeing the quality of a product or delivery of a product.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.total_item_amountobjectThe sum of all factors, item cost, discounts, tax, shipping, and so on, that goes into the cost of an item.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.invoice_numberstring^[a-zA-Z0-9_'\-., ":;\!?]*$The invoice number. An alphanumeric string that identifies a billing for a merchant.
checkout_optionsarrayAn array of checkout options. Each option has a name and value.
itemsobjectA checkout option as a name-and-value pair.
checkout_option_namestring^[a-zA-Z0-9_'\-., ":;\!?]*$The checkout option name, such as color or texture.
checkout_option_valuestring^[a-zA-Z0-9_'\-., ":;\!?]*$The checkout option value. For example, the checkout option color might be blue or red while the checkout option texture might be smooth or rippled.
tax_inclusivebooleanfalseIndicates whether the item amount or the shipping amount already includes tax.
paypal_invoice_idstring^[a-zA-Z0-9_'\-., ":;\!?]*$The ID of the invoice. Appears for only PayPal-generated invoices.
store_infoobjectThe store information.
store_idstring^[a-zA-Z0-9_'\-., ":;!?]*$The ID of a store for a merchant in the system of record.
terminal_idstring^[a-zA-Z0-9_'\-., ":;!?]*$The terminal ID for the checkout stand in a merchant store. For example, 45678,FPTestStore1.
auction_infoobjectThe auction information.
auction_sitestring^[a-zA-Z0-9_'\-., ":;\!?]*$The name of the auction site.
auction_item_sitestringuriThe auction site URL.
auction_buyer_idstring^[a-zA-Z0-9_'\-., ":;\!?]*$The ID of the buyer who makes the purchase in the auction. This ID might be different from the payer ID provided for the payment.
auction_closing_datestringppaas_date_time_v3^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time when the auction closes.
incentive_infoobjectThe incentive information.
incentive_detailsarrayAn array of incentive details.
itemsobjectThe incentive details.
incentive_typestring^[a-zA-Z0-9_'\-., ":;\!?]*$The type of incentive, such as a special offer or coupon.
incentive_codestring^[a-zA-Z0-9_'\-., ":;\!?]*$The code that identifies an incentive, such as a coupon.
incentive_amountobjectThe incentive amount.
currency_coderequiredstringppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.incentive_program_codestring^[a-zA-Z0-9_'\-., ":;\!?]*$The incentive program code that identifies a merchant loyalty or incentive program.