v1

latestOpenAPI 3.0.02026-07-263118119.8 KB

Create & Manage Transactions

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>

post/v2/transactionSearch

Headers

authorizationstring required

Merchant scoped token.

Content-Typestring required

Request body

timezonestring

Timezone of dates transactions are filtered on

pagestring

perPagestring

sortBystring

orderBystring

startDatestring

Format: MM-DD-YYYY HH:mm:ss

endDatestring

Format: MM-DD-YYYY HH:mm:ss

Type of transaction attribute searched for (transactionId, userId, etc...)

Example request

{
  "timezone": "America/Chicago",
  "page": "1",
  "perPage": "50",
  "sortBy": "id",
  "orderBy": "asc",
  "filters": {
    "paymentType": "payment"
  }
}

Response

Success - List of matching transactions