List recorded adjustments

Use this endpoint to list the balancing entries recorded against a context, newest first. Use matchGroupId to narrow the list to one match group.

GET /v1/matching/contexts/{contextId}/adjustments

List recorded adjustments

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/contexts/{contextId}/adjustments \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "hasMore": true,
  "items": [
    {
      "amount": "10.50",
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "createdBy": "[e-mail]",
      "currency": "USD",
      "description": "Bank wire fee adjustment",
      "direction": "DEBIT",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "reason": "Variance due to bank processing fee",
      "type": "BANK_FEE",
      "updatedAt": "2025-01-15T10:30:00Z",
      "matchGroupId": "550e8400-e29b-41d4-a716-446655440000",
      "transactionId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

contextId · string<uuid> · requerido

Context ID whose adjustments to list

Parámetros de consulta

matchGroupId · string<uuid>

Narrow to the entries balancing one match group. Omit to read the whole context.

limit · integer<int64> · predeterminado: 20

Maximum number of records to return

Rango requerido: 1 <= x <= 200

cursor · string

Opaque pagination cursor

sort_order · enum<string>

Sort order

Opciones disponibles: asc, desc

Respuesta

200

application/json

OK

hasMore · boolean · requerido

Ejemplo:

true

items · object[] | null · requerido

Page of recorded adjustments

Maximum array length: 200

Show child attributes

limit · integer<int64> · requerido

Rango requerido: 1 <= x <= 200

Ejemplo:

20

nextCursor · string

Ejemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Ejemplo:

"eyJpZCI6IjEyMiJ9"