# Transaction Search API

> Transaction Search API on Apizie: 2 endpoints (List transactions, List all balances) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:paypal-reporting/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:paypal-reporting`
- Category: Payments
- Status: byok
- Source: https://paypal
- Page: https://apizie.tech/api/payments/paypal-reporting
- OpenAPI: https://apizie.tech/api/payments/paypal-reporting/openapi.json

Use the Transaction Search API to get the history of transactions for a PayPal account. To use the API on behalf of third parties, you must be part of the PayPal partner network. Reach out to your partner manager for…

## Endpoints

### List transactions
`GET https://apizie.tech/v1/payments:paypal-reporting/search-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| transaction_id | string | no | Filters the transactions in the response by a PayPal transaction ID. A valid transaction ID is 17 characters long, except for an order ID… |
| transaction_type | string | no | Filters the transactions in the response by a PayPal transaction event code. See [Transaction event… |
| transaction_status | string | no | Filters the transactions in the response by a PayPal transaction status code. Value is: Status code Description D PayPal or merchant… |
| transaction_amount | string | no | Filters the transactions in the response by a gross transaction amount range. Specify the range as ` TO `, where ` ` is the lower limit of… |
| transaction_currency | string | no | Filters the transactions in the response by a [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) for the PayPal… |
| start_date | string | yes | Filters the transactions in the response by a start date and time, in [Internet date and time… |
| end_date | string | yes | Filters the transactions in the response by an end date and time, in [Internet date and time… |
| payment_instrument_type | string | no | Filters the transactions in the response by a payment instrument type. Value is either: CREDITCARD . Returns a direct credit card… |
| store_id | string | no | Filters the transactions in the response by a store ID. |
| terminal_id | string | no | Filters the transactions in the response by a terminal ID. |
| fields | string | no | Indicates which fields appear in the response. Value is a single field or a comma-separated list of fields. The transaction_info value… |
| balance_affecting_records_only | string | no | Indicates whether the response includes only balance-impacting transactions or all transactions. Value is either: Y . The default. The… |
| page_size | integer | no | 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… |
| page | integer | no | The zero-relative start index of the entire list of items that are returned in the response. So, the combination of `page=1` and… |

### List all balances
`GET https://apizie.tech/v1/payments:paypal-reporting/balances-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| as_of_time | string | no | List balances in the response at the date time provided, will return the last refreshed balance in the system when not provided. |
| currency_code | string | no | Filters the transactions in the response by a [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) for the PayPal… |

## Example
```
curl "https://apizie.tech/v1/payments:paypal-reporting/search-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Transaction Search API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:paypal-reporting/search-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Transaction Search API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Transaction Search itself also needs your own key from paypal.

### Can AI agents use the Transaction Search API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:paypal-reporting.

### What is the status of the Transaction Search API?
Needs your own provider key (bring your own key)