Skip to main content
GET
/
v1
/
matching
/
candidates
List match candidates for a transaction
curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/candidates \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "amountDelta": "<string>",
      "dateDeltaDays": 123,
      "ruleId": "<string>",
      "ruleType": "<string>",
      "score": 50,
      "transaction": {
        "amount": "<string>",
        "currency": "<string>",
        "date": "<string>",
        "id": "<string>",
        "sourceId": "<string>",
        "baseAmount": "<string>",
        "externalId": "<string>"
      },
      "why": {
        "amountMatch": true,
        "currencyMatch": true,
        "dateMatch": true,
        "referenceScore": 0.5,
        "matchedKeys": [
          {
            "agreed": true,
            "field": "<string>"
          }
        ]
      }
    }
  ],
  "targetTransactionId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

contextId
string<uuid>
required

Context ID the transaction belongs to

transactionId
string<uuid>
required

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

limit
integer<int64>
default:50

Maximum number of ranked proposals to return

Required range: 1 <= x <= 200

Response

OK

items
object[] | null
required

Ranked candidate proposals (highest score first)

Maximum array length: 200
targetTransactionId
string
required

The transaction counterparts were proposed for

Example:

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