List Transactions

Paginated list of transactions across the authenticated account hierarchy. This is the primary transaction search endpoint; every filter below is optional, and filters combine with AND. Repeatable filters (account_id, status, transaction_type) match any of the values supplied. account_id accepts either a merchant account ID or a parent (PSP/partner) ID — a parent matches every transaction belonging to its descendants. min_amount and max_amount are in cents and compare against total_amount. start_date and end_date bound created_at in milliseconds since epoch. Results are newest-first unless sort_by / sort_order say otherwise. Replaces the retired POST /v1/transactions/search. Send query parameters, not a JSON body. Repeat list filters and omit unused values instead of sending empty strings. The default page size is 50; set limit=100 to preserve the old POST default. The maximum page size is 200.

Query Parameters

account_id
Type: array of string | null

Filter transactions by account ID (repeatable, any-of). Each may be a direct merchant OR a parent (PSP/partner) id — a parent matches all of its descendants' transactions.
terminal_id
Type: string | null

Filter by terminal ID
processor_mid
Type: string | null

Filter by acquirer processor MID (contains match)
processor_tid
Type: string | null

Filter by acquirer processor TID (contains match)
status
Type: array of TransactionStatus | nullenum

Filter by transaction status
Type: enum

Current status of a transaction. The surcharge_pending status indicates the transaction is awaiting cardholder confirmation of a surcharge via the confirm endpoint. surcharge_declined_by_payer means the cardholder rejected the surcharge and the transaction was canceled.

values
pending
authorized
captured
settled
declined
refunded
reversed
canceled
error
surcharge_pending
surcharge_declined_by_payer
batch_id
Type: string | null

Filter by batch ID
transaction_type
Type: array of string | null

Filter by transaction type
location_id
Type: string | null

Filter by location ID
gateway_transaction_id
Type: string | null

Filter by processor gateway transaction ID
transaction_id
Type: string | null

Filter by transaction ID
event_id
Type: string | null

Filter by event ID
reader_identifier
Type: string | null

Filter by reader identifier
owner_id
Type: string | null

Filter by owner account ID (parent PSP/partner)
device_type
Type: string | null

Filter by device type (iphone, android_phone, ipad, android_tablet, other)
search_term
Type: string | null

Free-text search across common fields
min_amount
Type: integer | null
min:
0

Minimum total amount
max_amount
Type: integer | null
min:
0

Maximum total amount
start_date
Type: integer | null

Start of created_at range (epoch milliseconds)
end_date
Type: integer | null

End of created_at range (epoch milliseconds)
payment_method
Type: string | null

Filter by payment method
card_brand
Type: string | null

Filter by card brand
card_number
Type: string | null

Partial card number search
sort_by
Type: stringenum

Sort field (created_at, total_amount, transaction_id, status, card_brand)

values
created_attotal_amounttransaction_idstatuscard_brand
sort_order
Type: string

Sort order (asc or desc)

Sort order. Case-insensitive — asc, ASC, desc, and DESC are all accepted (unlike sort_by, which is case-sensitive).
limit
Type: integer
min:
1
max:
200

Page size
offset
Type: integer
min:
0

Items to skip

Headers

Accept
enum
const:
application/json
required

Response format. Must be application/json.

Responses

application/json
application/json
application/json
application/json

get/v2/transactions

curl 'https://api.uat.koard.com/v2/transactions?sort_by=created_at&sort_order=desc&limit=50&offset=0' \
  --header 'Accept: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN'

Show Schema

{
  "limit": 1,
  "offset": 1,
  "page": 1,
  "total": 1,
  "transactions": [
    {
      "account_id": "string",
      "additional_details": {},
      "apple_transaction_id": "string",
      "batch_id": null,
      "card": "string",
      "card_brand": "string",
      "card_type": "string",
      "created_at": 1,
      "currency": "string",
      "device_id": null,
      "event_id": "string",
      "gateway": null,
      "gateway_transaction_id": null,
      "gateway_transaction_response": null,
      "history": [],
      "location_id": null,
      "merchant_name": "",
      "mid": "string",
      "owner_id": null,
      "parent_account_ids": [
        "string"
      ],
      "payment_method": "string",
      "processor": null,
      "processor_mid": "string",
      "processor_response_code": null,
      "processor_response_message": null,
      "processor_tid": "string",
      "reader_identifier": "string",
      "refunded": null,
      "reversed": null,
      "status": null,
      "status_reason": "approved",
      "subtotal": 1,
      "surcharge_amount": null,
      "surcharge_applied": false,
      "surcharge_rate": null,
      "tax_amount": null,
      "tax_rate": null,
      "tid": "string",
      "tip_amount": null,
      "tip_type": "fixed",
      "total_amount": 1,
      "transaction_id": "string",
      "transaction_type": null,
      "surcharge_basis": "total",
      "surcharge_confirmation_required": null,
      "tax_basis": "total",
      "device_type": null,
      "psp": null,
      "surcharge_source": "transaction",
      "tax_source": "transaction",
      "terminal_details": null,
      "tip_capture_mode": "tip_at_sale"
    }
  ],
  "additionalProperty": "anything"
}

Successful Response