---
title: "Get payer details (FHIR Aggregator or Payer)"
method: GET
path: "/v1/internal/payer"
tags: ["Internal"]
---

# Get payer details (FHIR Aggregator or Payer)

`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`

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.

## Query parameters

- `ClientId` string, required: Client ID (mandatory)
- `XApiKey` string, required: API key (mandatory)

## Response `200`

Successful Response

- PayerDetailsResponse: Response for GET /internal/payer: aggregator client, first active mapping as payer context.
  - `Message` string
  - `ClientId` string
  - `XApiKey` string
  - `BaseUrl` string, nullable
  - `PayerId` integer, nullable
  - `UserId` integer
  - `UserName` string
  - `Environment` string
  - `GlobalPayerId` string, uuid, nullable
  - `Validation` object

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-01** `f754b29e3de5`: 1 info
  - added the optional property `GlobalPayerId` to the response with the `200` status

[Operation history](https://skmtc.dev/hhaexchange/apis/hhaexchange-api/changes/v1/internal/payer/get.md)

---

[API](https://skmtc.dev/hhaexchange/apis/hhaexchange-api.md) - [All operations](https://skmtc.dev/hhaexchange/apis/hhaexchange-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hhaexchange/apis/hhaexchange-api/revisions/f754b29e3de5?raw)