The transaction ID, where [n] is a number from 0 to 5. For simple, single receiver payments, this number will be 0. Numbers larger than 0 indicate the payment to a particular receiver in chained and parallel payments.

transaction[n].status

The transaction status, where [n] is a number from 0 to 5. For simple single-receiver payments, this number will be 0. Numbers larger than 0 indicate the payment to a particular receiver in chained and parallel payments. Value is:

Completed

Pending

Refunded

transaction[n].id_for_sender

The transaction ID for the sender, where [n] is a number from 0 to 5. For simple, single receiver payments, this number will be 0. Numbers larger than 0 indicate the payment to a particular receiver in chained and parallel payments.

transaction[n].status_for_sender_txn

The transaction status, where [n] is a number from 0 to 5. For simple single-receiver payments, this number will be 0. Numbers larger than 0 indicate the payment to a particular receiver in chained and parallel payments. Value is:

COMPLETED — The sender's transaction has completed

PENDING — The transaction is awaiting further processing

CREATED — The payment request was received; funds will be transferred once approval is received

PARTIALLY_REFUNDED— Transaction was partially refunded

DENIED — The transaction was rejected by the receiver

PROCESSING — The transaction is in progress

REVERSED — The payment was returned to the sender

REFUNDED — The payment was refunded

FAILED — The payment failed

transaction[n].refund_id

The identification number for the refund

transaction[n].refund_amount

The amount that was refunded.

transaction[n].refund_account_charged

The email address of the debit account of the refund.

transaction[n].receiver

The receiver's email address for the transaction

transaction[n].invoiceId

The invoice number for this transaction

transaction[n].amount

The payment amount of the transaction

transaction[n].is_primary_receiver

Whether there is a primary receiver for this transaction, which indicates whether the transaction is a chained payment. Value is:

true — There is a primary receiver (chained payment)

false — There is no primary receiver (simple or parallel payment)

return_url

The URL to which the sender's browser is redirected after approving a payment on paypal.com. Use the pay key to identify the payment as follows: payKey=${payKey}.

cancel_url

The URL to which the sender's browser is redirected if the sender cancels the approval for a payment on paypal.com. Use the pay key to identify the payment as follows: payKey=${payKey}.

ipn_notification_url

The URL to which all IPN messages for this payment are sent.

pay_key

The pay key that identifies this payment. This is a token that is assigned by the Pay API after a PayRequest message is received and can be used in other Adaptive Payments APIs as well as the cancelURL and returnURL to identify this payment. The pay key is valid for 3 hours.

memo

A note associated with the payment.

fees_payer

The payer of PayPal fees. Value is:

SENDER — Sender pays all fees (for personal, implicit simple/parallel payments; do not use for chained or unilateral payments)

EACHRECEIVER — Each receiver pays their own fee (default, personal and unilateral payments)

SECONDARYONLY — Secondary receivers pay all fees (use only for chained payments with one secondary receiver)

trackingId

The tracking ID that was specified for this payment in the PaymentDetailsRequest message.

preapproval_key

The preapproval key returned after a PreapprovalRequest, or the preapproval key that identifies the preapproval key sent with a PayRequest.

reason_code

Whether this transaction is a chargeback, partial, or reversal. Value is:

Chargeback
Settlement — Transaction is a chargeback

Admin reversal — Transaction was reversed by PayPal administrators

Refund — Transaction was partially or fully refunded

Preapproval Message Variables

PayPal generates an IPN message that contains information about a preapproval in response to the Adaptive Payments Preapproval API operation.

Variable

Description

transaction_type

The type of transaction. For a preapproval, this variable returns Adaptive Payment Preapproval.

Note: If this variable is set to Adaptive Payment Pay or Adjustment, refer to the Pay Message Variable section.

preapproval_key

The preapproval key returned after a PreapprovalRequest.

approved

Whether the preapproval request was approved. Value is:

true — The preapproval was approved

false — The preapproval was denied

cancel_url

The URL to which the sender's browser is redirected if the sender decides to cancel the preapproval as requested. Use the preapproval key to identify the payment as follows: preapprovalKey=${preapprovalKey}

current_number_of_payments

The current number of payments made for this preapproval.

current_total_amount_of_all_payments

The current total of payments made for this preapproval.

current_period_attempts

The current number of attempts this period for this preapproval.

currencyCode

The currency code. Value is:

Australian Dollar — AUD

Brazilian Real — BRL

Note: This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only. If the receiver of funds is not from Brazil, then PayPal converts funds into the primary holding currency of the account with the applicable currency conversion rate. The currency conversion rate includes PayPal's applicable spread or fee.

Canadian Dollar — CAD

Czech Koruna — CZK

Danish Krone — DKK

Euro — EUR

Hong Kong Dollar — HKD

Hungarian Forint — HUF

Israeli New Sheqel — ILS

Japanese Yen — JPY

Malaysian Ringgit — MYR

Note: The Ringgit is supported as a payment currency and currency balance only for Malaysian PayPal accounts.

Mexican Peso — MXN

Norwegian Krone — NOK

New Zealand Dollar — NZD

Philippine Peso — PHP

Polish Zloty — PLN

Pound Sterling — GBP

Singapore Dollar — SGD

Swedish Krona — SEK

Swiss Franc — CHF

Taiwan New Dollar — TWD

Thai Baht — THB

U.S. Dollar — USD

date_of_month

The day of the month on which a monthly payment is to be made. A number between 1 and 31 indicates the day of the month. A value of 0 indicates that the payment can be made on any day.

day_of_week

The day of the week that a weekly payment is to be made. Value is:

NO_DAY_SPECIFIED

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

starting_date

First date for which the preapproval is valid.

ending_date

Last date for which the preapproval is valid. Time is currently not supported.