Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iterapay.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to search and filter transactions for a merchant account. Unlike a simple list, this endpoint accepts a JSON request body with filter criteria, making it well-suited for building reporting dashboards, reconciliation tools, or transaction exports.

​
Path parameters

​
merchantID
string
required
The UUID of the merchant account to query transactions for.

​
Query parameters

​
limit
number
default:"20"
Maximum number of transactions to return per page.
​
page
number
default:"1"
Page number for pagination.
​
order
string
default:"desc"
Sort direction. Accepted values: asc, desc.
​
orderBy
string
Field to sort results by. Accepted values depend on the orderByTransactions enum (e.g., createdAt, amount).

​
Request body

All filter fields are optional. Omitting a field returns results regardless of that attribute.
​
states
string[]
Filter by transaction state. Example: ["confirmed", "pending"].
​
dateFrom
string
Return only transactions created on or after this ISO 8601 datetime.
​
dateTo
string
Return only transactions created on or before this ISO 8601 datetime.
​
tokens
number[]
Filter by payment method (token) ID. Example: [1, 2].
​
invoiceIDs
string[]
Filter by invoice UUID. Use this to retrieve all transactions for specific invoices.

​
Response

Returns a paginated list of transaction objects.
​
data
object[]
Array of transaction objects.
​
total
number
Total number of transactions matching the applied filters.
​
page
number
The current page number.
​
limit
number
The number of results returned per page.
curl --request POST \
  --url 'https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/transactions/list?limit=20&page=1&order=desc' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "states": ["confirmed"],
    "dateFrom": "2024-01-01T00:00:00Z",
    "dateTo": "2024-01-31T23:59:59Z",
    "tokens": [1, 2],
    "invoiceIDs": ["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
  }'

{
  "data": [
    {
      "id": "b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f",
      "invoiceID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": "100.00",
      "state": "confirmed",
      "createdAt": "2024-01-15T10:30:00Z",
      "confirmedAt": "2024-01-15T10:35:12Z",
      "txHash": "f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}