Create a manual match

Use this endpoint to manually link multiple transactions (at least 2) into a match group with 100% confidence. Transactions must be UNMATCHED and belong to the specified context. When exceptionId names the exception being paired, the same write resolves it.

POST /v1/matching/manual

Create a manual match

cURL

curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/matching/manual \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transactionIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ],
  "exceptionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "notes": "<string>"
}
'

201

Example

{
  "matchGroup": {
    "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.

X-Idempotency · string

Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in X-Idempotency-Key or Idempotency-Key is refused with 400 (MTCH-0015), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with X-Idempotency-Replayed: true. A malformed key returns 400, a key whose first request is still in progress returns 409 (MTCH-0018), a key whose earlier attempt already ran but whose answer cannot be replayed returns 409 (MTCH-0022), and an idempotency storage failure returns 500. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents.

Parámetros de consulta

contextId · string<uuid> · requerido

Context ID Context ID the transactions belong to

Cuerpo

application/json

Manual match payload

transactionIds · string[] | null · requerido

Transaction IDs to link (UUIDs)

Required array length: 2 - 50 elements

Ejemplo:

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

exceptionId · string<uuid>

Optional exception the operator is pairing. Its transaction must be one of transactionIds; confirming the match resolves it in the same write, unless it is no longer open or is under an active dispute

notes · string

Optional note for the manual match

Respuesta

201

application/json

Indicates that the resource was successfully created.

matchGroup · object · requerido

The match group created by linking the supplied transactions

Show child attributes