v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Matching

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.

post/v1/matching/manual

Query parameters

contextIdstring required

Context ID

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Request body

notesstring
transactionIdsstring[] required

Example request

{
  "notes": "Manual match for Q4 reconciliation",
  "transactionIds": [
    "019c96a0-10ce-75fc-a273-dc799079a99c"
  ]
}

Response

Indicates that the resource was successfully created.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.