Saltar al contenido principal
POST
Confirm a proposed match group

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.

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

Respuesta

Indicates that the request was successful and the response contains the expected data.

confidence
integer<int64>
requerido

Match confidence score from 0 (lowest) to 100 (exact); manual matches are 100

Rango requerido: 0 <= x <= 100
Ejemplo:

85

contextId
string
requerido

Reconciliation context ID this group belongs to

Ejemplo:

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

createdAt
string
requerido

Creation timestamp (RFC 3339)

Ejemplo:

"2025-01-15T10:30:00Z"

id
string
requerido

Unique identifier for the group

Ejemplo:

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

items
object[] | null
requerido

Transaction allocations that make up this match group

Maximum array length: 500
runId
string
requerido

Identifier of the match run that created this group

Ejemplo:

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

status
enum<string>
requerido

Current status of the group: PROPOSED (awaiting review), CONFIRMED (accepted), REJECTED (a proposed group discarded before confirmation), or REVOKED (a confirmed group whose confirmation was later undone by an unmatch; the original confirmation timestamp is kept for audit)

Opciones disponibles:
PROPOSED,
CONFIRMED,
REJECTED,
REVOKED
Ejemplo:

"PROPOSED"

updatedAt
string
requerido

Last update timestamp (RFC 3339)

Ejemplo:

"2025-01-15T10:30:00Z"

confirmedAt
string

When the group was confirmed (RFC 3339); present only once confirmed

Ejemplo:

"2025-01-15T10:35:00Z"

reasonCodes
string[] | null

Rationale reason codes attached to this group's member transactions (e.g. FX_RATE_VARIANCE, FEE_VARIANCE, AGED_BREAK, OVER_SETTLED), resolved by joining member exceptions. Absent for a clean match with no recorded rationale

Maximum array length: 32
Ejemplo:
rejectedReason
string

Reason the group was rejected; present only when the status is REJECTED

Ejemplo:

"amounts do not match within tolerance"

ruleId
string

Identifier of the rule used for matching; null for manual matches

Ejemplo:

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