---
title: "transactionSearch"
method: POST
path: "/v2/transactionSearch"
tags: ["Create & Manage Transactions"]
---

# transactionSearch

`POST /v2/transactionSearch`

Search and retrieve a paginated list of transactions for the authorized merchant.

Supports advanced filtering (e.g., `paymentType`), sorting (`sortBy`, `orderBy`), and pagination (`page`, `perPage`).

The response includes a `paging` object with total counts and a `transactions` array containing the results.

<details>
<summary><strong>Error Glossary</strong> (click to expand)</summary>

| Code | HTTP Status | Message |
|------|-------------|-------------|
| `AP006` | 401 | Client not authorized for this scope |
| `AP101` | 401 | No authenticated user |
| `AP605` | 200 | Merchant is required |
| `AP700` | 400 | Missing or invalid required parameter |
| `AP701` | 400 | Improperly formatted parameter |
| `AP1000` | 200 | Invalid API |

</details>

## Headers

- `authorization` string, required
- `Content-Type` string, required

## Request body

- object
  - `timezone` string — Timezone of dates transactions are filtered on
  - `page` string
  - `perPage` string
  - `sortBy` string
  - `orderBy` string
  - `startDate` string — Format: MM-DD-YYYY HH:mm:ss
  - `endDate` string — Format: MM-DD-YYYY HH:mm:ss
  - `searchType` 'transactionId' | 'uuid' | 'userId' | 'name' | 'phone' | 'email' | 'locationId' | 'merchantId' | 'default' — Type of transaction attribute searched for (transactionId, userId, etc...)
  - `filters` object
    - `paymentType` string
    - `referenceId` string — Merchant reference id of transaction

## Response `200`

Success - List of matching transactions

- object
  - `transactions` object[]
    - `id` string
    - `amount` object
    - `status` string
    - `paymentType` string
    - `attributes` unknown[]
      - unknown
    - `userId` string
    - `title` string
    - `createdDate` string
    - `modifiedDate` string
    - `apFee` string
    - `isRtp` boolean
    - `merchantId` integer
    - `locationId` integer
    - `userAccountId` integer
    - `customerName` string
    - `locationName` string
    - `merchantName` string
  - `paging` object
    - `totalPages` integer
    - `totalItems` integer
    - `currentPage` integer
    - `itemsPerPage` integer

## Other responses

- `400` — Bad Request - Validation Errors

---

[API](https://skmtc.net/aero/apis/aeropay-v2-api.md) · [All operations](https://skmtc.net/aero/apis/aeropay-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aero/aeropay-v2-api/revisions/4700c4ceeaad/schema)
