---
title: "List transactions"
method: GET
path: "/v1/reporting/transactions"
tags: ["transactions"]
---

# List transactions

`GET /v1/reporting/transactions`

Lists transactions. Specify one or more query parameters to filter the transaction that appear in the response.<blockquote><strong>Notes:</strong> <ul><li>If you specify one or more optional query parameters, the <code>ending_balance</code> response field is empty.</li><li>It takes a maximum of three hours for executed transactions to appear in the list transactions call.</li><li>This call lists transaction for the previous three years.</li></ul></blockquote>

## Query parameters

- `transaction_id` string
- `transaction_type` string
- `transaction_status` string
- `transaction_amount` string
- `transaction_currency` string
- `start_date` string, required
- `end_date` string, required
- `payment_instrument_type` string
- `store_id` string
- `terminal_id` string
- `fields` string
- `balance_affecting_records_only` string
- `page_size` integer
- `page` integer

## Response `200`

A successful request returns the HTTP `200 OK` status code and a JSON response body that lists transactions .

- SearchResponse — The search response information.
  - `transaction_details` TransactionDetail[] — An array of transaction detail objects.
    - `transaction_info` TransactionInfo — The transaction information.
      - `paypal_account_id` string — The ID of the PayPal account of the counterparty.
      - `transaction_id` string — The PayPal-generated transaction ID.
      - `paypal_reference_id` string — The PayPal-generated base ID. PayPal exclusive. Cannot be altered. Defined as a related, pre-existing transaction or event.
      - `paypal_reference_id_type` 'ODR' | 'TXN' | 'SUB' | 'PAP' — The PayPal reference ID type.
      - `transaction_event_code` string — A five-digit transaction event code that classifies the transaction type based on money movement and debit or credit. For example, <code>T0001</code>. See [Transaction event codes](/docs/integration/direct/transaction-search/transaction-event-codes/).
      - `transaction_initiation_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
      - `transaction_updated_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
      - `transaction_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `fee_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `discount_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `insurance_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `sales_tax_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `shipping_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `shipping_discount_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `shipping_tax_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `other_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `tip_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `transaction_status` string — A code that indicates the transaction status. Value is:<table><thead><tr><th>Status&nbsp;code</th><th>Description</th></tr></thead><tbody><tr><td><code>D</code></td><td>PayPal or merchant rules denied the transaction.</td></tr><tr><td><code>P</code></td><td>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 <code>S</code>.</td></tr><tr><td><code>S</code></td><td>The transaction successfully completed without a denial and after any pending statuses.</td></tr><tr><td><code>V</code></td><td>A successful transaction was fully reversed and funds were refunded to the original sender.</td></tr></tbody></table>
      - `transaction_subject` string — 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_note` string — A special note that the payer passes to the payee. Might contain special customer requests, such as shipping instructions.
      - `payment_tracking_id` string — 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_id` string — The bank reference ID. The bank provides this value for an ACH transaction.
      - `ending_balance` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `available_balance` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `invoice_id` string — The invoice ID that is sent by the merchant with the transaction.<blockquote><strong>Note:</strong> If an invoice ID was sent with the capture request, the value is reported. Otherwise, the invoice ID of the authorizing transaction is reported.</blockquote>
      - `custom_field` string — The merchant-provided custom text.<blockquote><strong>Note:</strong> Usually, this field includes the unique ID for payments made with MassPay type transaction.</blockquote>
      - `protection_eligibility` string — Indicates whether the transaction is eligible for protection. Value is:<ul><li><code>01</code>. Eligible.</li><li><code>02</code>. Not eligible</li><li><code>03</code>. Partially eligible.</li></ul>
      - `credit_term` string — 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_fee` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `credit_promotional_fee` Money — The currency and amount for a financial transaction, such as a balance or payment due.
        - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
        - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
      - `annual_percentage_rate` string, ppaas_common_percentage_v2 — The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.
      - `payment_method_type` string — The payment method that was used for a transaction. Value is <code>PUI</code>, <code>installment</code>, or <code>mEFT</code>.<blockquote><strong>Note:</strong> 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.</blockquote>
      - `instrument_type` string — 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 <a href="https://developer.paypal.com/docs/checkout/integration-features/alternative-payment-methods/" title="Link to available APM list">Alternative Payment Methods (APM)</a>.
      - `instrument_sub_type` string — 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.
    - `payer_info` PayerInfo — The payer information.
      - `account_id` string — The PayPal` customer account ID.
      - `email_address` string, ppaas_common_email_address_v2 — The internationalized email address.<blockquote><strong>Note:</strong> Up to 64 characters are allowed before and 255 characters are allowed after the <code>@</code> sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted <code>@</code> sign exists.</blockquote>
      - `phone_number` Phone — The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
        - `country_code` string, required — The country calling code (CC), in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the CC and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
        - `national_number` string, required — The national number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). The combined length of the country calling code (CC) and the national number must not be greater than 15 digits. The national number consists of a national destination code (NDC) and subscriber number (SN).
        - `extension_number` string — The extension number.
      - `address_status` string — The address status of the payer. Value is either:<ul><li><code>Y</code>. Verified.</li><li><code>N</code>. Not verified.</li></ul>
      - `payer_status` string — The status of the payer. Value is `Y` or `N`.
      - `payer_name` Name — The name of the party.
        - `prefix` string — The prefix, or title, to the party's name.
        - `given_name` string — When the party is a person, the party's given, or first, name.
        - `surname` string — When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname.
        - `middle_name` string — When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name.
        - `suffix` string — The suffix for the party's name.
        - `alternate_full_name` string — DEPRECATED. The party's alternate name. Can be a business name, nickname, or any other name that cannot be split into first, last name. Required when the party is a business.
        - `full_name` string — When the party is a person, the party's full name.
      - `country_code` string, ppaas_common_country_code_v2 — The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote>
      - `address` Address — A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
        - `line1` string, required — The first line of the address. For example, number or street.
        - `line2` string — The second line of the address. For example, suite or apartment number.
        - `city` string, required — The city name.
        - `state` string — The [code](/docs/api/reference/state-codes/) for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: [Argentina](/docs/api/reference/state-codes/#argentina), [Brazil](/docs/api/reference/state-codes/#brazil), [Canada](/docs/api/reference/state-codes/#canada), [China](/docs/api/reference/state-codes/#china), [India](/docs/api/reference/state-codes/#india), [Italy](/docs/api/reference/state-codes/#italy), [Japan](/docs/api/reference/state-codes/#japan), [Mexico](/docs/api/reference/state-codes/#mexico), [Thailand](/docs/api/reference/state-codes/#thailand), or [United States](/docs/api/reference/state-codes/#usa). Maximum length is 40 single-byte characters.
        - `country_code` string, ppaas_common_country_code_v2, required — The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote>
        - `postal_code` string — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).
    - `shipping_info` ShippingInfo — The shipping information.
      - `name` string — The recipient's name.
      - `method` string — The shipping method that is associated with this order.
      - `address` Address — A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
        - `line1` string, required — The first line of the address. For example, number or street.
        - `line2` string — The second line of the address. For example, suite or apartment number.
        - `city` string, required — The city name.
        - `state` string — The [code](/docs/api/reference/state-codes/) for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: [Argentina](/docs/api/reference/state-codes/#argentina), [Brazil](/docs/api/reference/state-codes/#brazil), [Canada](/docs/api/reference/state-codes/#canada), [China](/docs/api/reference/state-codes/#china), [India](/docs/api/reference/state-codes/#india), [Italy](/docs/api/reference/state-codes/#italy), [Japan](/docs/api/reference/state-codes/#japan), [Mexico](/docs/api/reference/state-codes/#mexico), [Thailand](/docs/api/reference/state-codes/#thailand), or [United States](/docs/api/reference/state-codes/#usa). Maximum length is 40 single-byte characters.
        - `country_code` string, ppaas_common_country_code_v2, required — The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote>
        - `postal_code` string — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).
      - `secondary_shipping_address` Address — A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
        - `line1` string, required — The first line of the address. For example, number or street.
        - `line2` string — The second line of the address. For example, suite or apartment number.
        - `city` string, required — The city name.
        - `state` string — The [code](/docs/api/reference/state-codes/) for a US state or the equivalent for other countries. Required for transactions if the address is in one of these countries: [Argentina](/docs/api/reference/state-codes/#argentina), [Brazil](/docs/api/reference/state-codes/#brazil), [Canada](/docs/api/reference/state-codes/#canada), [China](/docs/api/reference/state-codes/#china), [India](/docs/api/reference/state-codes/#india), [Italy](/docs/api/reference/state-codes/#italy), [Japan](/docs/api/reference/state-codes/#japan), [Mexico](/docs/api/reference/state-codes/#mexico), [Thailand](/docs/api/reference/state-codes/#thailand), or [United States](/docs/api/reference/state-codes/#usa). Maximum length is 40 single-byte characters.
        - `country_code` string, ppaas_common_country_code_v2, required — The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.</blockquote>
        - `postal_code` string — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).
    - `cart_info` CartInfo — The cart information.
      - `item_details` ItemDetail[] — An array of item details.
        - `item_code` string — An item code that identifies a merchant's goods or service.
        - `item_name` string — The item name.
        - `item_description` string — The item description.
        - `item_options` string — The item options. Describes option choices on the purchase of the item in some detail.
        - `item_quantity` string — The number of purchased units of goods or a service.
        - `item_unit_price` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `item_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `discount_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `adjustment_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `gift_wrap_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `tax_percentage` string, ppaas_common_percentage_v2 — The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as `19.99`.
        - `tax_amounts` ItemDetailTaxAmount[] — An array of tax amounts levied by a government on the purchase of goods or services.
          - `tax_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
            - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
            - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `basic_shipping_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `extra_shipping_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `handling_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `insurance_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `total_item_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `invoice_number` string — The invoice number. An alphanumeric string that identifies a billing for a merchant.
        - `checkout_options` CheckoutOption[] — An array of checkout options. Each option has a name and value.
          - `checkout_option_name` string — The checkout option name, such as `color` or `texture`.
          - `checkout_option_value` string — The checkout option value. For example, the checkout option `color` might be `blue` or `red` while the checkout option `texture` might be `smooth` or `rippled`.
      - `tax_inclusive` boolean — Indicates whether the item amount or the shipping amount already includes tax.
      - `paypal_invoice_id` string — The ID of the invoice. Appears for only PayPal-generated invoices.
    - `store_info` StoreInfo — The store information.
      - `store_id` string — The ID of a store for a merchant in the system of record.
      - `terminal_id` string — The terminal ID for the checkout stand in a merchant store.
    - `auction_info` AuctionInfo — The auction information.
      - `auction_site` string — The name of the auction site.
      - `auction_item_site` string — The auction site URL.
      - `auction_buyer_id` string — The ID of the buyer who makes the purchase in the auction. This ID might be different from the payer ID provided for the payment.
      - `auction_closing_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
    - `incentive_info` IncentiveInfo — The incentive details.
      - `incentive_details` IncentiveDetail[] — An array of incentive details.
        - `incentive_type` string — The type of incentive, such as a special offer or coupon.
        - `incentive_code` string — The code that identifies an incentive, such as a coupon.
        - `incentive_amount` Money — The currency and amount for a financial transaction, such as a balance or payment due.
          - `currency_code` string, ppaas_common_currency_code_v2, required — The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
          - `value` string, required — The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).
        - `incentive_program_code` string — The incentive program code that identifies a merchant loyalty or incentive program.
  - `account_number` string — The merchant account number.
  - `start_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
  - `end_date` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
  - `last_refreshed_datetime` string, ppaas_date_time_v3 — The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>
  - `page` integer — A zero-relative index of transactions.
  - `total_items` integer — The total number of transactions as an integer beginning with the specified `page` in the full result and not just in this response.
  - `total_pages` integer — The total number of pages, as an `integer`, when the `total_items` is divided into pages of the specified `page_size`.
  - `links` LinkDescription[] — An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).
    - `href` string, required — The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.
    - `rel` string, required — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
    - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD' | 'CONNECT' | 'OPTIONS' | 'PATCH' — The HTTP method required to make the related call.

## Other responses

- `default` — The default response.

---

[API](https://skmtc.net/paypal/apis/payments.md) · [All operations](https://skmtc.net/paypal/apis/payments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paypal/payments/revisions/672aceee1190/schema)
