Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Agreement Transactions

An array of agreement transactions.

agreement_transaction_listobject<agreement_transaction>[]Optional

An array of agreement transactions.

agreement_transaction properties

10 properties

transaction_idstringOptional

The ID of the transaction.

statusenumOptional

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.

Value in"Completed" | "Partially_Refunded" | "Pending" | "Refunded" | "Denied"

transaction_typestringOptional

The type of transaction. Typically, `Recurring Payment`.

payer_emailstringOptional

The email ID of the customer.

payer_namestringOptional

The business name of the customer.

time_stampstringOptional

The date and time when the transaction occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

time_zonestringOptional

The time zone of the `update_time` field.

amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

fee_amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

net_amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

Back to top

Agreement Transactions

An array of agreement transactions.

agreement_transaction_listobject<agreement_transaction>[]Optional

An array of agreement transactions.

agreement_transaction properties

10 properties

transaction_idstringOptional

The ID of the transaction.

statusenumOptional

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.

Value in"Completed" | "Partially_Refunded" | "Pending" | "Refunded" | "Denied"

transaction_typestringOptional

The type of transaction. Typically, `Recurring Payment`.

payer_emailstringOptional

The email ID of the customer.

payer_namestringOptional

The business name of the customer.

time_stampstringOptional

The date and time when the transaction occurred, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).

time_zonestringOptional

The time zone of the `update_time` field.

amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

fee_amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

net_amountobject<currency>Required

The currency and amount for a transaction.

currency properties

2 properties

valuestringRequired

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](https://www.iso.org/iso-4217-currency-codes.html).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

currencyobject<currency_code>Required

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

Agreement Transactions

agreement_transaction properties

currency properties

currency properties

currency properties

Back to top

On this page

On this page

Agreement Transactions

agreement_transaction properties

currency properties

currency properties

currency properties

Back to top

On this page

Agreement Transactions

agreement_transaction properties

currency properties

currency properties

currency properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Agreement Transactions

agreement_transaction properties

currency properties

currency properties

currency properties

Back to top

On this page