Transactions

Search transactions for a merchant with filtering and sorting

Changed on Jun 17, 2026

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

Request

Base URL
https://core.quidkey.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/merchants/:id/transactions/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

The unique identifier of the merchant

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

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
    }
  ]
}

Changes

Jun 17, 2026b372e7d5563d Revision changes
- breaking
  the // request property's minLength was increased from 0 to 3
- breaking
  the / response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to number for status
- warning
  the // request property's maxLength was set to 3
- warning
  changed the pattern of the request property // from ^[A-Z]{3}$ to ^[A-Za-z]{3}$
- warning
  removed the optional property / from the response with the status
- warning
  added the new converted enum value to the // response property for the response status
- warning
  added the new converted_amount enum value to the /// response property for the response status
- warning
  added the new fee_paid enum value to the // response property for the response status
- warning
  added the new received enum value to the // response property for the response status
- warning
  added the new reversal enum value to the // response property for the response status
- warning
  added the new unknown enum value to the // response property for the response status
- info
  added the new optional request property
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  the request property // became optional
- info
  the request property // became optional
- info
  added the new converted_amount enum value to the request property //
- info
  added the new fully_refunded enum value to the request property //
- info
  added the new partially_refunded enum value to the request property //
- info
  added the new refunding enum value to the request property //
- info
  added the new refunding_failed enum value to the request property //
- info
  added the new refunding_stuck enum value to the request property //
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  added subschema #1 subschema #2 to the / response property allOf list for the response status
- info
  removed the processing enum value from the // response property for the response status
- info
  the /// response's property pattern ^[A-Za-z]{3}$ was added for the status
- info
  the // response's property pattern was changed from ^[A-Z]{3}$ to ^[A-Za-z]{3}$ for the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
Nov 5, 20256637b341d86d Revision changes
- info
  endpoint added

Operation history (3 revisions)

Search transactions for a merchant with filtering and sorting

Request

Path parameters

Request body

Example request

Response 200OK

Example response

Changes

Response