Skip to main content
GET
/
v1
/
reporting
/
transactions
List transactions
curl --request GET \
  --url https://api-m.sandbox.paypal.com/v1/reporting/transactions \
  --header 'Authorization: Bearer <token>'
{
  "transaction_details": [
    {
      "transaction_info": {
        "paypal_account_id": "<string>",
        "transaction_id": "<string>",
        "paypal_reference_id": "<string>",
        "paypal_reference_id_type": "ODR",
        "transaction_event_code": "<string>",
        "transaction_initiation_date": "<string>",
        "transaction_updated_date": "<string>",
        "transaction_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "fee_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "discount_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "insurance_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "sales_tax_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping_discount_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "shipping_tax_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "other_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "tip_amount": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "transaction_status": "<string>",
        "transaction_subject": "<string>",
        "transaction_note": "<string>",
        "payment_tracking_id": "<string>",
        "bank_reference_id": "<string>",
        "ending_balance": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "available_balance": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "invoice_id": "<string>",
        "custom_field": "<string>",
        "protection_eligibility": "<string>",
        "credit_term": "<string>",
        "credit_transactional_fee": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "credit_promotional_fee": {
          "currency_code": "<string>",
          "value": "<string>"
        },
        "annual_percentage_rate": "<string>",
        "payment_method_type": "<string>",
        "instrument_type": "<string>",
        "instrument_sub_type": "<string>"
      },
      "payer_info": {
        "account_id": "<string>",
        "email_address": "<string>",
        "phone_number": {
          "country_code": "<string>",
          "national_number": "<string>",
          "extension_number": "<string>"
        },
        "address_status": "<string>",
        "payer_status": "<string>",
        "payer_name": {
          "prefix": "<string>",
          "given_name": "<string>",
          "surname": "<string>",
          "middle_name": "<string>",
          "suffix": "<string>",
          "alternate_full_name": "<string>",
          "full_name": "<string>"
        },
        "country_code": "<string>",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country_code": "<string>",
          "postal_code": "<string>"
        }
      },
      "shipping_info": {
        "name": "<string>",
        "method": "<string>",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country_code": "<string>",
          "postal_code": "<string>"
        },
        "secondary_shipping_address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country_code": "<string>",
          "postal_code": "<string>"
        }
      },
      "cart_info": {
        "item_details": [
          {
            "item_code": "<string>",
            "item_name": "<string>",
            "item_description": "<string>",
            "item_options": "<string>",
            "item_quantity": "<string>",
            "item_unit_price": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "item_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "discount_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "adjustment_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "gift_wrap_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "tax_percentage": "<string>",
            "tax_amounts": [
              {
                "tax_amount": {
                  "currency_code": "<string>",
                  "value": "<string>"
                }
              }
            ],
            "basic_shipping_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "extra_shipping_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "handling_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "insurance_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "total_item_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "invoice_number": "<string>",
            "checkout_options": [
              {
                "checkout_option_name": "<string>",
                "checkout_option_value": "<string>"
              }
            ]
          }
        ],
        "tax_inclusive": false,
        "paypal_invoice_id": "<string>"
      },
      "store_info": {
        "store_id": "<string>",
        "terminal_id": "<string>"
      },
      "auction_info": {
        "auction_site": "<string>",
        "auction_item_site": "<string>",
        "auction_buyer_id": "<string>",
        "auction_closing_date": "<string>"
      },
      "incentive_info": {
        "incentive_details": [
          {
            "incentive_type": "<string>",
            "incentive_code": "<string>",
            "incentive_amount": {
              "currency_code": "<string>",
              "value": "<string>"
            },
            "incentive_program_code": "<string>"
          }
        ]
      }
    }
  ],
  "account_number": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "last_refreshed_datetime": "<string>",
  "page": 1073741823,
  "total_items": 1073741823,
  "total_pages": 1073741823,
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Oauth 2.0 authentication

Query Parameters

​
transaction_id
string

Filters the transactions in the response by a PayPal transaction ID. A valid transaction ID is 17 characters long, except for an <a href="/docs/api/payments/v1/#definition-order">order ID</a>, which is 19 characters long.<blockquote><strong>Note:</strong> A transaction ID is not unique in the reporting system. The response can list two transactions with the same ID. One transaction can be balance affecting while the other is non-balance affecting.</blockquote>

Required string length: 17 - 19
​
transaction_type
string

Filters the transactions in the response by a PayPal transaction event code. See Transaction event codes.

​
transaction_status
string

Filters the transactions in the response by a PayPal transaction status code. Value is:<table><thead><tr><th>Status 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 reversed and funds were refunded to the original sender.</td></tr></tbody></table>

​
transaction_amount
string

Filters the transactions in the response by a gross transaction amount range. Specify the range as <start-range> TO <end-range>, where <start-range> is the lower limit of the gross PayPal transaction amount and <end-range> is the upper limit of the gross transaction amount. Specify the amounts in lower denominations. For example, to search for transactions from $5.00 to $10.05, specify [500 TO 1005].<blockquote><strong>Note:</strong>The values must be URL encoded.</blockquote>

​
transaction_currency
string

Filters the transactions in the response by a three-character ISO-4217 currency code for the PayPal transaction currency.

​
start_date
string
required

Filters the transactions in the response by a start date and time, in Internet date and time format. Seconds are required. Fractional seconds are optional.

Required string length: 20 - 64
​
end_date
string
required

Filters the transactions in the response by an end date and time, in Internet date and time format. Seconds are required. Fractional seconds are optional. The maximum supported range is 31 days.

Required string length: 20 - 64
​
payment_instrument_type
string

Filters the transactions in the response by a payment instrument type. Value is either:<ul><li><code>CREDITCARD</code>. Returns a direct credit card transaction with a corresponding value.</li><li><code>DEBITCARD</code>. Returns a debit card transaction with a corresponding value.</li></ul>If you omit this parameter, the API does not apply this filter.

​
store_id
string

Filters the transactions in the response by a store ID.

​
terminal_id
string

Filters the transactions in the response by a terminal ID.

​
fields
string
default:transaction_info

Indicates which fields appear in the response. Value is a single field or a comma-separated list of fields. The <code>transaction_info</code> value returns only the transaction details in the response. To include all fields in the response, specify <code>fields=all</code>. Valid fields are:<ul><li><a href="/docs/api/transaction-search/v1/#definition-transaction_info"><code>transaction_info</code></a>. The transaction information. Includes the ID of the PayPal account of the payee, the PayPal-generated transaction ID, the PayPal-generated base ID, the PayPal reference ID type, the transaction event code, the date and time when the transaction was initiated and was last updated, the transaction amounts including the PayPal fee, any discounts, insurance, the transaction status, and other information about the transaction.</li><li><a href="/docs/api/transaction-search/v1/#definition-payer_info"><code>payer_info</code></a>. The payer information. Includes the PayPal customer account ID and the payer's email address, primary phone number, name, country code, address, and whether the payer is verified or unverified.</li><li><a href="/docs/api/transaction-search/v1/#definition-shipping_info"><code>shipping_info</code></a>. The shipping information. Includes the recipient's name, the shipping method for this order, the shipping address for this order, and the secondary address associated with this order.</li><li><a href="/docs/api/transaction-search/v1/#definition-auction_info"><code>auction_info</code></a>. The auction information. Includes the name of the auction site, the auction site URL, the ID of the customer who makes the purchase in the auction, and the date and time when the auction closes.</li><li><a href="/docs/api/transaction-search/v1/#definition-cart_info"><code>cart_info</code></a>. The cart information. Includes an array of item details, whether the item amount or the shipping amount already includes tax, and the ID of the invoice for PayPal-generated invoices.</li><li><a href="/docs/api/transaction-search/v1/#definition-incentive_info"><code>incentive_info</code></a>. An array of incentive detail objects. Each object includes the incentive, such as a special offer or coupon, the incentive amount, and the incentive program code that identifies a merchant loyalty or incentive program.</li><li><a href="/docs/api/transaction-search/v1/#definition-store_info"><code>store_info</code></a>. The store information. Includes the ID of the merchant store and the terminal ID for the checkout stand in the merchant store.</li></ul>

​
balance_affecting_records_only
string
default:Y

Indicates whether the response includes only balance-impacting transactions or all transactions. Value is either:<ul><li><code>Y</code>. The default. The response includes only balance transactions.</li><li><code>N</code>. The response includes all transactions.</li></ul>

​
page_size
integer
default:100

The number of items to return in the response. So, the combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns the next 20 items.

Required range: 1 <= x <= 500
​
page
integer
default:1

The zero-relative start index of the entire list of items that are returned in the response. So, the combination of page=1 and page_size=20 returns the first 20 items.

Required range: 1 <= x <= 2147483647

Response

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

The search response information.

​
transaction_details
Transaction Details · object[]

An array of transaction detail objects.

Required array length: 1 - 2147483647 elements
​
account_number
string

The merchant account number.

Required string length: 1 - 255
​
start_date
string<ppaas_date_time_v3>

The start date and time, in Internet date and time format.

Required string length: 20 - 64
​
end_date
string<ppaas_date_time_v3>

The end date and time or the last date when the data can be served, in Internet date and time format.

Required string length: 20 - 64
​
last_refreshed_datetime
string<ppaas_date_time_v3>

The date and time when the data was last refreshed, in Internet date and time format.

Required string length: 20 - 64
​
page
integer

A zero-relative index of transactions.

Required range: 0 <= x <= 2147483647
​
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.

Required range: 0 <= x <= 2147483647
​
total_pages
integer

The total number of pages, as an integer, when the total_items is divided into pages of the specified page_size.

Required range: 0 <= x <= 2147483647
​
links
Link Description · object[]

An array of request-related HATEOAS links.

Required array length: 1 - 32767 elements
⌘I