latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Payers

Replace a payer's full record by ID

Replaces the stored record for the payer identified by {id} with the supplied payload. This is a full replacement, not a partial update — confirmed against PayerService.mergeModelsForUpdate in the payer service, which overwrites externalPayerId, sourceId, and data wholesale from the request body. Any of these fields omitted from the request are cleared rather than preserved from the existing record, so always send the complete payer payload.

Requires the UPDATE_PAYER permission. The tenant-id header is required, but the payer catalog is not tenant-partitioned: any existing payer ID can be replaced regardless of which tenant-id value is supplied — the header is used only for audit-trail attribution. A missing or nonexistent id returns 404.

The request data field is validated against the same external JSON Schema used at creation (https://schemas.certifyos.com/entities/Payer.schema.json). Payloads that fail validation are rejected with 400.

On success, returns 200 with the updated PayerResponse.

put/payers/{id}

Path parameters

idstring required

Server-assigned payer identifier, returned by GET /payers or POST /payers.

Headers

tenant-idstring required

Tenant identifier, forwarded to the payer service for audit-trail attribution only — see the operation description.

Request body

externalPayerIdstring
sourceIdstring

Response

The updated payer.

idstring
externalPayerIdstring
sourceIdstring