Break/Unmatch a match group

Use this endpoint to break an incorrect match group. Send the reason in the request. The transactions of the group return to UNMATCHED status. When you reject a PROPOSED group, a transaction that was force-matched separately stays MATCHED. If a manual or automatic match closed an exception, the exception is re-stamped UNMATCH_WITHDRAWN and the next break on its transaction reopens it.

DELETE /v1/matching/groups/{matchGroupId}

Break/Unmatch a match group

cURL

curl --request DELETE \
  --url https://matcher.sandbox.lerian.net/v1/matching/groups/{matchGroupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "incorrect match - amounts do not match"
}
'

204

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 ruta

matchGroupId · string<uuid> · requerido

Match Group ID

Parámetros de consulta

contextId · string<uuid> · requerido

Context ID Context ID the group belongs to

Cuerpo

application/json

Unmatch payload with rejection reason

reason · string · requerido

Reason the match group is being broken

Minimum string length: 1

Ejemplo:

"incorrect match - amounts do not match"

Respuesta

204

Indicates that the operation was successful with no content to return.