Get match run results

Use this endpoint to retrieve all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. The response uses cursor-based pagination.

GET /v1/matching/runs/{runId}/groups

Get match run results

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/runs/{runId}/groups \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "items": [
    {
      "confidence": {},
      "confirmedAt": "<string>",
      "contextId": "<string>",
      "createdAt": "<string>",
      "id": "<string>",
      "items": [
        {
          "allocatedAmount": 123,
          "allocatedCurrency": "<string>",
          "allowPartial": true,
          "createdAt": "<string>",
          "expectedAmount": 123,
          "id": "<string>",
          "matchGroupId": "<string>",
          "transactionId": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "rejectedReason": "<string>",
      "ruleId": "<string>",
      "runId": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Authorizations

Authorization · string · header · required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

Path Parameters

runId · string · required

Run ID

Query Parameters

contextId · string · required

Context ID

limit · integer · default: 20

The maximum number of items to include in the response.

Required range: 1 <= x <= 200

cursor · string

The cursor value for retrieving the next page of results.

sort_order · enum<string>

The order used to sort the results.

Available options: asc, desc

sort_by · enum<string>

The field used to sort the results.

Available options: id, created_at, status

Response

200

application/json

Indicates that the request was successful and the response contains the expected data.

Cursor-paginated list of match groups

hasMore · boolean

Example:

true

items · object[]

List of match groups

Show child attributes

limit · integer

Required range: 1 <= x <= 200

Example:

20

nextCursor · string

Example:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Example:

"eyJpZCI6IjEyMiJ9"