Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Matching

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.

get/v1/matching/candidates

Query parameters

contextIdstring uuid required

Context ID the transaction belongs to

Context ID the transaction belongs to

transactionIdstring uuid required

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

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

limitinteger

Maximum number of ranked proposals to return

Maximum number of ranked proposals to return

Response

OK

targetTransactionIdstring required

The transaction counterparts were proposed for

Example response

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