Update a reconciliation source

Use this endpoint to update the fields of a specific reconciliation source by its identifier. A side change is refused with 409 once the context has carried a partial balance, or while a match run is in progress.

PATCH /v1/contexts/{contextId}/sources/{sourceId}

Update a reconciliation source

cURL

curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/sources/{sourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "camt053": {},
    "dialect": {},
    "duplicate_key": [],
    "fail_on_error_rate_percent": 50
  },
  "name": "Secondary Bank Account",
  "side": "RIGHT",
  "type": "LEDGER"
}
'

200

Example

{
  "config": {
    "blank_external_id": "REJECT",
    "camt053": {
      "date_basis": "booking",
      "external_id_source": "ntry_ref"
    },
    "dialect": {
      "date_style": "iso",
      "decimal_style": "dot",
      "delimiter": "comma",
      "encoding": "utf-8"
    },
    "duplicate_key": [
      "external_id"
    ],
    "duplicate_key_changed_at": "2023-11-07T05:31:56Z",
    "duplicate_policy": "FLAG_AS_EXCEPTION",
    "fail_on_error_rate_percent": 50
  },
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Primary Bank Account",
  "side": "LEFT",
  "type": "BANK",
  "updatedAt": "2025-01-15T10:30:00Z",
  "archivedAt": "2025-01-15T10:30:00Z"
}

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

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

sourceId · string<uuid> · requerido

The unique identifier of the reconciliation source. Source ID

Cuerpo

application/json

Source updates

config · object

Source-specific configuration object. Cross-key rules the schema cannot express: a duplicate_key component this source's field map does not fill is refused, because a key over an always-empty field makes every row a duplicate of every other; a source bound to an aggregator connection (reserved key connection_config_name) cannot carry a duplicate_key of its own, and a config holding both is refused in either direction; and editing duplicate_key governs later imports only — rows already imported keep the key they were deduplicated under, so a duplicate straddling the change is knowingly not detected.

Show child attributes

name · string

New human-readable name of the source.

Maximum string length: 50

Ejemplo:

"Secondary Bank Account"

side · enum<string>

Matching side this source feeds. LEFT and RIGHT are the two sides reconciled against each other. A change is refused with a 409 once the context has carried a partial balance, or while a match run is in progress.

Opciones disponibles: LEFT, RIGHT

Ejemplo:

"RIGHT"

type · enum<string>

Origin of the source data. LEDGER is the internal ledger; BANK is a bank statement feed; GATEWAY is a payment gateway; CUSTOM is a bespoke feed; FETCHER is a discovery-engine pull.

Opciones disponibles: LEDGER, BANK, GATEWAY, CUSTOM, FETCHER

Ejemplo:

"LEDGER"

Respuesta

200

application/json

Successfully updated source.

config · object · requerido

Source-specific configuration object. Cross-key rules the schema cannot express: a duplicate_key component this source's field map does not fill is refused, because a key over an always-empty field makes every row a duplicate of every other; a source bound to an aggregator connection (reserved key connection_config_name) cannot carry a duplicate_key of its own, and a config holding both is refused in either direction; and editing duplicate_key governs later imports only — rows already imported keep the key they were deduplicated under, so a duplicate straddling the change is knowingly not detected.

Show child attributes

contextId · string · requerido

Identifier of the context this source belongs to.

Ejemplo:

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

createdAt · string · requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

id · string · requerido

Unique identifier of the source.

Ejemplo:

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

name · string · requerido

Human-readable name of the source.

Ejemplo:

"Primary Bank Account"

side · enum<string> · requerido

Matching side this source feeds. LEFT and RIGHT are the two sides reconciled against each other.

Opciones disponibles: LEFT, RIGHT

Ejemplo:

"LEFT"

type · enum<string> · requerido

Origin of the source data. LEDGER is the internal ledger; BANK is a bank statement feed; GATEWAY is a payment gateway; CUSTOM is a bespoke feed; FETCHER is a discovery-engine pull.

Opciones disponibles: LEDGER, BANK, GATEWAY, CUSTOM, FETCHER

Ejemplo:

"BANK"

updatedAt · string · requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

archivedAt · string

RFC 3339 timestamp when the source was archived; absent when the source is live.

Ejemplo:

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