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

Example

{
  "hasMore": true,
  "items": [
    {
      "confidence": 85,
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "items": [
        {
          "allocatedAmount": "1000.00",
          "allocatedCurrency": "USD",
          "allowPartial": false,
          "createdAt": "2025-01-15T10:30:00Z",
          "expectedAmount": "1000.00",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
          "transactionId": "550e8400-e29b-41d4-a716-446655440000",
          "updatedAt": "2025-01-15T10:30:00Z",
          "side": "LEFT",
          "sourceId": "550e8400-e29b-41d4-a716-446655440000",
          "sourceName": "Bank statement"
        }
      ],
      "runId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PROPOSED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "confirmedAt": "2025-01-15T10:35:00Z",
      "reasonCodes": [
        "FX_RATE_VARIANCE"
      ],
      "rejectedReason": "amounts do not match within tolerance",
      "ruleId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Autorizaciones

Authorization · string · header · requerido

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

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

runId · string<uuid> · requerido

Run ID

Parámetros de consulta

contextId · string<uuid> · requerido

Context ID Context ID the run belongs to

limit · integer<int64> · predeterminado: 20

The maximum number of items to include in the response. Maximum number of records to return

Rango requerido: 1 <= x <= 200

cursor · string

The cursor value for retrieving the next page of results. Opaque pagination cursor

sort_order · enum<string>

The order used to sort the results. Sort order

Opciones disponibles: asc, desc

sort_by · enum<string>

The field used to sort the results. Sort field

Opciones disponibles: id, created_at, status

status · enum<string>

Filter by match-group lifecycle status. Applied server-side so the filter is honest across all pages, not just the loaded one.

Opciones disponibles: PROPOSED, CONFIRMED, REJECTED, REVOKED

Respuesta

200

application/json

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

hasMore · boolean · requerido

Ejemplo:

true

items · object[] | null · requerido

Page of match groups

Maximum array length: 200

Show child attributes

limit · integer<int64> · requerido

Rango requerido: 1 <= x <= 200

Ejemplo:

20

nextCursor · string

Ejemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Ejemplo:

"eyJpZCI6IjEyMiJ9"