On this page
No Headings
The transaction information.
objectpaypal_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.