HHhhaexchange
Internal

Get payer details (FHIR Aggregator or Payer)

Changed on

Validates ClientId and XApiKey against FHIR.Clients. The client must have ClientType Aggregator or Payer. Provider clients receive 400 with "One of ProviderTaxId, VendorId, or GlobalProviderId is required" (use GET /v1/internal/provider). Returns the first active ClientMappings row (lowest Id): PayerId and Validation.PayerID are AgencyId (payer/agency in HHA), Environment is derived from the mapping Env, and GlobalPayerId is the GlobalEntityId UUID. BaseUrl is always null.

get/v1/internal/payer

Request

  • Base URL
    https://api.hhaexchange.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.hhaexchange.com/v1/internal/payer
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.hhaexchange.com/v1/fhir/auth/token scopes: read

Query parameters

ClientIdstring required

Client ID (mandatory)

XApiKeystring required

API key (mandatory)

Response

Successful Response

Messagestring
ClientIdstring
XApiKeystring
BaseUrlstring nullable
PayerIdinteger nullable
UserIdinteger
UserNamestring
Environmentstring
GlobalPayerIdstring uuid nullable
Validationobject

Changes