Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Transactions

Search transactions for a merchant with filtering and sorting

Search transactions for a merchant with filtering and sorting

post/api/v1/merchants/{id}/transactions

Path parameters

idstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the merchant

Request body

include_all_statusesboolean

When true, includes all transaction statuses (including in-progress states like fee_paid, converted). Useful for debugging. Default: false (only shows received, completed, failed).

Example request

{
  "search": {
    "amount": {
      "gte": 1000,
      "lte": 5000
    },
    "status": {
      "eq": "completed"
    },
    "customer_email": {
      "contains": "gmail"
    }
  },
  "pagination": {
    "page": 1,
    "limit": 25
  },
  "sort": [
    {
      "field": "created_at",
      "direction": "desc"
    }
  ]
}

Response

Success

successboolean required

Example response

{
  "data": [
    {
      "currency": {
        "code": "GBP",
        "symbol": "€",
        "name": "Euro",
        "minor_unit": 2
      },
      "payout_currency": {
        "code": "GBP",
        "symbol": "€",
        "name": "Euro",
        "minor_unit": 2
      },
      "payment_request": {
        "order_id": "ORD-2025-00123",
        "payment_token": "tok_abc123def456"
      },
      "fees": {
        "currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "items": [
          {
            "currency": {
              "code": "GBP",
              "symbol": "€",
              "name": "Euro",
              "minor_unit": 2
            }
          }
        ]
      },
      "refunds": [
        {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "payout_currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "payment_request": {
            "order_id": "ORD-2025-00123",
            "payment_token": "tok_abc123def456"
          },
          "fees": {
            "currency": {
              "code": "GBP",
              "symbol": "€",
              "name": "Euro",
              "minor_unit": 2
            },
            "items": [
              {
                "currency": {
                  "code": "GBP",
                  "symbol": "€",
                  "name": "Euro",
                  "minor_unit": 2
                }
              }
            ]
          }
        }
      ],
      "reversals": [
        {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "payout_currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "payment_request": {
            "order_id": "ORD-2025-00123",
            "payment_token": "tok_abc123def456"
          },
          "fees": {
            "currency": {
              "code": "GBP",
              "symbol": "€",
              "name": "Euro",
              "minor_unit": 2
            },
            "items": [
              {
                "currency": {
                  "code": "GBP",
                  "symbol": "€",
                  "name": "Euro",
                  "minor_unit": 2
                }
              }
            ]
          }
        }
      ]
    }
  ],
  "search_metadata": {
    "sort_applied": [
      {
        "field": "created_at",
        "direction": "desc"
      }
    ]
  },
  "totals": [
    {
      "currency": "EUR",
      "total_amount": 3034
    },
    {
      "currency": "GBP",
      "total_amount": 534
    },
    {
      "currency": "DKK",
      "total_amount": 2034
    }
  ]
}