Retrieve Payer

Retrieve a single payer record by its Stedi payer ID.

GET/payer/{stediId}

You can use this endpoint to retrieve a specific payer record with the Stedi payer ID (stediId). You can find the Stedi payer ID for any supported payer in the Payer Network. Note that you must supply the Stedi payer ID - this endpoint doesn't support querying with the primary payer ID or payer ID aliases.

The payer record includes the payer's names, aliases, and supported use cases (medical, dental, or vision). It also contains supported transaction types and specifies whether transaction enrollment is required.

Payer records can change. If you store payer details in your own system, refresh them at least once a day.

Authorization
RequiredHeader

A Stedi API Key for authentication.

Path Parameters

stediId
StringRegex pattern: ^[A-Z]{5}$

The Stedi payer ID, a unique identifier Stedi assigns to each payer that will never change. You can find the Stedi payer ID for any supported payer in the Payer Network.

This must be the Stedi payer ID - querying with the primary payer ID or payer ID aliases isn't supported.

Response

application/json
payer
ObjectRequired

The payer record matching the provided Stedi payer ID. The record includes the payer's display name and aliases as well as supported transaction types and details about the payer's transaction enrollment process.

Show attributes