latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Payers

Fetch a payer by ID

Retrieves the full record for the payer identified by {id}. Use this once you already have a specific payer ID; use GET /payers to discover or browse payers.

Requires the READ_PAYER permission. The tenant-id header is required, but the payer catalog is not tenant-partitioned: any existing payer ID is returned regardless of which tenant-id value is supplied — the header is not used to authorize or scope the lookup, only for audit-trail attribution.

Returns a PayerResponse with id, externalPayerId, sourceId, and data (shaped per https://schemas.certifyos.com/entities/Payer.schema.json). This operation is read-only and has no side effects.

get/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.

Response

The requested payer.

idstring
externalPayerIdstring
sourceIdstring