List match candidates for a transaction

Returns a ranked list of opposite-side unmatched transactions the engine considers plausible counterparts for the target transaction, each with a confidence score, the rule that drove it, a per-component rationale (the “why”), and amount/date deltas. Powers the exception-resolution and manual-match candidate pickers. Scope: proposals are scored by the deterministic rule engine over raw transaction amounts and do NOT apply run-time fee normalization or the FX-variance band; only 1:1 pairwise counterparts are returned. A target that is not UNMATCHED (for example an exception raised on an already matched leg) has no counterpart and returns an empty list.

GET /v1/matching/candidates

List match candidates for a transaction

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/candidates \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "items": [
    {
      "amountDelta": "0.00",
      "dateDeltaDays": 0,
      "ruleId": "550e8400-e29b-41d4-a716-446655440000",
      "ruleType": "EXACT",
      "score": 90,
      "transaction": {
        "amount": "100.50",
        "currency": "USD",
        "date": "2025-01-15T10:30:00Z",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "sourceId": "550e8400-e29b-41d4-a716-446655440001",
        "baseAmount": "100.50",
        "externalId": "INV-1234"
      },
      "why": {
        "amountMatch": true,
        "currencyMatch": true,
        "dateMatch": true,
        "referenceScore": 1,
        "matchedKeys": [
          {
            "agreed": true,
            "field": "payment_id"
          }
        ]
      }
    }
  ],
  "targetTransactionId": "550e8400-e29b-41d4-a716-446655440000"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de consulta

contextId · string<uuid> · requerido

Context ID the transaction belongs to

transactionId · string<uuid> · requerido

Target transaction to find counterparts for. For an exception, resolve its transaction id first, then pass it here.

limit · integer<int64> · predeterminado: 50

Maximum number of ranked proposals to return

Rango requerido: 1 <= x <= 200

Respuesta

200

application/json

OK

items · object[] | null · requerido

Ranked candidate proposals (highest score first)

Maximum array length: 200

Show child attributes

targetTransactionId · string · requerido

The transaction counterparts were proposed for

Ejemplo:

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