PayPal-PHP-Server-SDK/doc/models/transaction-information.md

Transaction Information

The transaction information.

Structure

TransactionInformation

Fields

Name	Type	Tags	Description	Getter	Setter
paypalAccountId	?string	Optional	The ID of the PayPal account of the counterparty. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[a-zA-Z0-9]*$	getPaypalAccountId(): ?string	setPaypalAccountId(?string paypalAccountId): void
transactionId	?string	Optional	The PayPal-generated transaction ID. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[a-zA-Z0-9]*$	getTransactionId(): ?string	setTransactionId(?string transactionId): void
paypalReferenceId	?string	Optional	The PayPal-generated base ID. PayPal exclusive. Cannot be altered. Defined as a related, pre-existing transaction or event. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[a-zA-Z0-9]*$	getPaypalReferenceId(): ?string	setPaypalReferenceId(?string paypalReferenceId): void
paypalReferenceIdType	?string(PaypalReferenceIdType)	Optional	The PayPal reference ID type. Constraints: Minimum Length: 3, Maximum Length: 3, Pattern: ^[a-zA-Z0-9]*$	getPaypalReferenceIdType(): ?string	setPaypalReferenceIdType(?string paypalReferenceIdType): void
transactionEventCode	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 5, Pattern: ^[a-zA-Z0-9]*$	getTransactionEventCode(): ?string	setTransactionEventCode(?string transactionEventCode): void
transactionInitiationDate	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[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})$	getTransactionInitiationDate(): ?string	setTransactionInitiationDate(?string transactionInitiationDate): void
transactionUpdatedDate	?string	Optional	The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional. Note: The regular expression provides guidance but does not reject all invalid dates. Constraints: Minimum Length: 20, Maximum Length: 64, Pattern: ^[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})$	getTransactionUpdatedDate(): ?string	setTransactionUpdatedDate(?string transactionUpdatedDate): void
transactionAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getTransactionAmount(): ?Money	setTransactionAmount(?Money transactionAmount): void
feeAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getFeeAmount(): ?Money	setFeeAmount(?Money feeAmount): void
discountAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getDiscountAmount(): ?Money	setDiscountAmount(?Money discountAmount): void
insuranceAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getInsuranceAmount(): ?Money	setInsuranceAmount(?Money insuranceAmount): void
salesTaxAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getSalesTaxAmount(): ?Money	setSalesTaxAmount(?Money salesTaxAmount): void
shippingAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getShippingAmount(): ?Money	setShippingAmount(?Money shippingAmount): void
shippingDiscountAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getShippingDiscountAmount(): ?Money	setShippingDiscountAmount(?Money shippingDiscountAmount): void
shippingTaxAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getShippingTaxAmount(): ?Money	setShippingTaxAmount(?Money shippingTaxAmount): void
otherAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getOtherAmount(): ?Money	setOtherAmount(?Money otherAmount): void
tipAmount	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getTipAmount(): ?Money	setTipAmount(?Money tipAmount): void
transactionStatus	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 1, Pattern: ^[a-zA-Z0-9]*$	getTransactionStatus(): ?string	setTransactionStatus(?string transactionStatus): void
transactionSubject	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 256, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$	getTransactionSubject(): ?string	setTransactionSubject(?string transactionSubject): void
transactionNote	?string	Optional	A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions. Constraints: Minimum Length: 1, Maximum Length: 4000, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$	getTransactionNote(): ?string	setTransactionNote(?string transactionNote): void
paymentTrackingId	?string	Optional	The payment tracking ID, which is a unique ID that partners specify to either get information about a payment or request a refund. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^[a-zA-Z0-9]*$	getPaymentTrackingId(): ?string	setPaymentTrackingId(?string paymentTrackingId): void
bankReferenceId	?string	Optional	The bank reference ID. The bank provides this value for an ACH transaction. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^[a-zA-Z0-9]*$	getBankReferenceId(): ?string	setBankReferenceId(?string bankReferenceId): void
endingBalance	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getEndingBalance(): ?Money	setEndingBalance(?Money endingBalance): void
availableBalance	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getAvailableBalance(): ?Money	setAvailableBalance(?Money availableBalance): void
invoiceId	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$	getInvoiceId(): ?string	setInvoiceId(?string invoiceId): void
customField	?string	Optional	The merchant-provided custom text. Note: Usually, this field includes the unique ID for payments made with MassPay type transaction. Constraints: Minimum Length: 1, Maximum Length: 127, Pattern: ^[a-zA-Z0-9_'\-., ":;\!?]*$	getCustomField(): ?string	setCustomField(?string customField): void
protectionEligibility	?string	Optional	Indicates whether the transaction is eligible for protection. Value is: 01. Eligible. 02. Not eligible 03. Partially eligible. Constraints: Minimum Length: 1, Maximum Length: 2, Pattern: ^[a-zA-Z0-9]*$	getProtectionEligibility(): ?string	setProtectionEligibility(?string protectionEligibility): void
creditTerm	?string	Optional	The credit term. The time span covered by the installment payments as expressed in the term length plus the length time unit code. Constraints: Minimum Length: 1, Maximum Length: 25, Pattern: ^[a-zA-Z0-9.]*$	getCreditTerm(): ?string	setCreditTerm(?string creditTerm): void
creditTransactionalFee	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getCreditTransactionalFee(): ?Money	setCreditTransactionalFee(?Money creditTransactionalFee): void
creditPromotionalFee	?Money	Optional	The currency and amount for a financial transaction, such as a balance or payment due.	getCreditPromotionalFee(): ?Money	setCreditPromotionalFee(?Money creditPromotionalFee): void
annualPercentageRate	?string	Optional	The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99. Constraints: Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$	getAnnualPercentageRate(): ?string	setAnnualPercentageRate(?string annualPercentageRate): void
paymentMethodType	?string	Optional	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. Constraints: Minimum Length: 1, Maximum Length: 20, Pattern: ^[a-zA-Z0-9-]*$	getPaymentMethodType(): ?string	setPaymentMethodType(?string paymentMethodType): void
instrumentType	?string	Optional	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, APPLE_PAY, BANK , VENMO ,Pay Upon Invoice, Pay Later or Alternative Payment Methods (APM). Constraints: Minimum Length: 1, Maximum Length: 64	getInstrumentType(): ?string	setInstrumentType(?string instrumentType): void
instrumentSubType	?string	Optional	A finer-grained classification of the financial instrument that was used to fund a payment. For example, Visa card or a Mastercard for a credit card, BANKCARD ,DISCOVER etc. The pattern is not provided because the value is defined by an external party. Constraints: Minimum Length: 1, Maximum Length: 64	getInstrumentSubType(): ?string	setInstrumentSubType(?string instrumentSubType): void

Example (as JSON)

{
  "paypal_account_id": "paypal_account_id6",
  "transaction_id": "transaction_id2",
  "paypal_reference_id": "paypal_reference_id4",
  "paypal_reference_id_type": "ODR",
  "transaction_event_code": "transaction_event_code8"
}