Confirm a proposed match group

Use this endpoint to approve one PROPOSED match group in a single transaction. The group becomes CONFIRMED and keeps the engine’s rule and confidence. Its transactions become MATCHED, and fee variances, open-item residuals and break closures are recorded exactly as for an auto-confirmed group. A later unmatch reverses it. A group that is no longer PROPOSED returns 409.

POST /v1/matching/groups/{matchGroupId}/confirm

Confirm a proposed match group

cURL

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

200

Example

{
  "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"
}

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

matchGroupId · string<uuid> · requerido

Match Group ID

Parámetros de consulta

contextId · string<uuid> · requerido

Context ID Context ID the group belongs to

Respuesta

200

application/json

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

confidence · integer<int64> · requerido

Match confidence score from 0 (lowest) to 100 (exact); manual matches are 100

Rango requerido: 0 <= x <= 100

Ejemplo:

85

contextId · string · requerido

Reconciliation context ID this group belongs to

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

createdAt · string · requerido

Creation timestamp (RFC 3339)

Ejemplo:

"2025-01-15T10:30:00Z"

id · string · requerido

Unique identifier for the group

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

items · object[] | null · requerido

Transaction allocations that make up this match group

Maximum array length: 500

Show child attributes

runId · string · requerido

Identifier of the match run that created this group

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

status · enum<string> · requerido

Current status of the group: PROPOSED (awaiting review), CONFIRMED (accepted), REJECTED (a proposed group discarded before confirmation), or REVOKED (a confirmed group whose confirmation was later undone by an unmatch; the original confirmation timestamp is kept for audit)

Opciones disponibles: PROPOSED, CONFIRMED, REJECTED, REVOKED

Ejemplo:

"PROPOSED"

updatedAt · string · requerido

Last update timestamp (RFC 3339)

Ejemplo:

"2025-01-15T10:30:00Z"

confirmedAt · string

When the group was confirmed (RFC 3339); present only once confirmed

Ejemplo:

"2025-01-15T10:35:00Z"

reasonCodes · string[] | null

Rationale reason codes attached to this group's member transactions (e.g. FX_RATE_VARIANCE, FEE_VARIANCE, AGED_BREAK, OVER_SETTLED), resolved by joining member exceptions. Absent for a clean match with no recorded rationale

Maximum array length: 32

Ejemplo:

["FX_RATE_VARIANCE"]

rejectedReason · string

Reason the group was rejected; present only when the status is REJECTED

Ejemplo:

"amounts do not match within tolerance"

ruleId · string

Identifier of the rule used for matching; null for manual matches

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"