TransactionsTransactions

Search transactions by order identifier

post/v1/transactions/by-order-id

Looks up all transactions matching an identifier, keyed by searchBy (order ID by default, or merchant reference, reseller order ID, or merchant ID). The merchantId search is bounded by fromDate/toDate, defaulting to yesterday through today in the caller's timezone.

Endpoint destination URL

https://sandbox-portal.datmanlabs.com/api/v1/transactions/by-order-id

Authorization

ApiKeyAuth
headerapi_key<token>

Partner API key issued by Datman.

Request Parameters

Request Body

application/json
  1. body
query*string

The value to search for (trimmed). The legacy field name orderId is accepted when query is absent.

Length1 <= length <= 200
searchBy?string

Which identifier query is matched against. For merchantId, query must be numeric.

Default"orderId"
Value in"orderId""merchantReference""resellerOrderId""merchantId"
cursor?string

The pagination.nextCursor value from a previous page.

limit?number

Page size. Values outside 1-100 fall back to 25.

Range1 <= value <= 100
Default25
status?array<>

Only return transactions with these statuses.

timezone?string

IANA timezone used to render timestamps (and the merchantId date window).

fromDate?string

searchBy merchantId only. Start calendar date; defaults to yesterday.

Match^\d{4}-\d{2}-\d{2}$
toDate?string

searchBy merchantId only. End calendar date; defaults to today.

Match^\d{4}-\d{2}-\d{2}$

Response parameters & Errors

Response Body

Matching transactions. No match (or no reseller configuration) returns an empty page. For a liable merchant (searchBy merchantId) the body carries isLiable: true and a top-level timezone instead of data.timezone.

application/json
  1. response
data*
pagination*
isLiable?boolean

Present (true) only for a liable-merchant result.

timezone?string

Present only on liable-merchant results with rows, in place of data.timezone.