POST /merchants/{merchantID}/transactions/list

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

string

required

The UUID of the merchant account to query transactions for.

Query parameters

number

default:"20"

Maximum number of transactions to return per page.

number

default:"1"

Page number for pagination.

string

default:"desc"

Sort direction. Accepted values: asc, desc.

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.

string[]

Filter by transaction state. Example: ["confirmed", "pending"].

string

Return only transactions created on or after this ISO 8601 datetime.

string

Return only transactions created on or before this ISO 8601 datetime.

number[]

Filter by payment method (token) ID. Example: [1, 2].

string[]

Filter by invoice UUID. Use this to retrieve all transactions for specific invoices.

Response

Returns a paginated list of transaction objects.

object[]

Array of transaction objects.

Show transaction properties

string

The UUID of the transaction.

string

The UUID of the associated invoice.

string

The transaction amount as a decimal string.

string

The current state of the transaction.

string

ISO 8601 timestamp of when the transaction was created.

string

ISO 8601 timestamp of on-chain confirmation, or null if pending.

string

The on-chain transaction hash, or null if not yet broadcast.

number

Total number of transactions matching the applied filters.

number

The current page number.

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
}

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
}

Overview

Merchants

Invoices

Transactions & Withdrawals

Settings

POST /merchants/{merchantID}/transactions/list

Path parameters

Query parameters

Request body

Response

​Path parameters

​Query parameters

​Request body

​Response

Path parameters

Query parameters

Request body

Response