Get Payers

get

https://sandbox-apigw.optum.com/medicalnetwork/payerlist/v1/payers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The PayerList API helps you select the correct payer list based on the clearinghouse.

❗️
Please do not submit PHI or PII data in the Try It interface.

Query Params

system

string

required

Source system. Example values from collection: exch, imn, IMN, EXCH, IEDI, RPA, DENTAL.

transactionType

string

Transaction type filter.

pageSize

integer

Maximum number of records to return.

lastUpdatedAfter

string

Return records updated after this date. Format: YYYY-MM-DD.

exchangeInstClaimPayerId

string

Exchange institutional claim payer ID.

exchangeProfClaimPayerId

string

Exchange professional claim payer ID.

iediInstClaimPayerId

string

IEDI institutional claim payer ID.

iediProfClaimPayerId

string

IEDI professional claim payer ID.

status

string

Payer status filter.

payerNotes

string

Payer notes filter.

enrollmentNotes

string

Enrollment notes filter.

claimSubmissionRequiredThroughExchange

string

Indicates whether claim submission is required through exchange.

additionalLCHCPayerId

string

Additional LCHC payer ID.

activationDate

string

Activation date. Format: YYYY-MM-DD.

standInIndicator

string

Stand-in indicator.

serviceRestored

string

Service restored indicator.

payerType

string

Payer type.

payerPlanName

string

Payer plan name.

stateDoingBusiness

string

State where payer does business.

chiPayer

boolean

Indicates whether this is a CHI payer.

payerId

string

Payer ID.

additionalPayerIDs

string

Additional payer IDs. Repeat parameter or comma-separated value may be accepted depending on implementation.

Headers

X-CHC-PayerList-SubmitterId

string

Optional submitter ID header shown in the source collection.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

❗️Please do not submit PHI or PII data in the Try It interface.

200Successful payer list response

400Bad request

401Unauthorized

500Internal server error

❗️
Please do not submit PHI or PII data in the Try It interface.