On this page
No Headings
The agreement transaction.
objecttransaction_idstringThe ID of the transaction.
statusstring"Completed", "Partially_Refunded", "Pending", "Refunded", "Denied"The current status of the transaction. Value is:
Completed. The transaction is complete and the money has been transferred to the payee.Partially_Refunded. A part of the transaction amount has been refunded to the payer.Pending. The transaction is pending settlement.Refunded. The transaction amount has been refunded to the payer.Denied. The transaction has been denied.transaction_typestringThe type of transaction. Typically, Recurring Payment.
payer_emailstringThe email ID of the customer.
payer_namestringThe business name of the customer.
time_stampstringThe date and time when the transaction occurred, in Internet date and time format.
time_zonestringThe time zone of the update_time field.
amountrequiredobjectThe currency and amount for a transaction.
The currency and amount of the transaction.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
fee_amountrequiredobjectThe currency and amount for a transaction.
The currency and amount of the transaction fee.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
net_amountrequiredobjectThe currency and amount for a transaction.
The currency and amount of the transaction net amount.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.