Data Exchange APIPurchases

Get a single purchase

View as Markdown

Authentication

AuthorizationBearer

Production machine-to-machine flow. Tokens issued by Descope.

OR
AuthorizationBearer

Developer-exploration flow with PKCE. Used by Postman Guided Auth.

Path parameters

purchase_idstringRequiredformat: "uuid"

Response

A single purchase.
purchase_idstringformat: "uuid"

Andel-issued unique identifier.

member_idstring
Plan or PBM member identifier.
plan_idstring

Plan that the member belongs to. Each member belongs to exactly one plan. Tokens are scoped to a set of allowed plan IDs; purchases for plans outside that set are not returned.

purchased_atdatetime

ISO 8601 UTC timestamp from the pharmacy point-of-sale.

currencystringformat: "^[A-Z]{3}$"Defaults to USD
ISO 4217 currency code.
date_of_servicedate

The actual fill date used for eligibility validation. Distinct from purchased_at, which is the point-of-sale timestamp.

event_typeenumDefaults to claim

The kind of accumulator event. claim is a normal fill; reversal restores accumulators for a returned or voided fill; adjustment is a flat or paired correction.

ndcstringformat: "^\d{11}$"

11-digit National Drug Code.

prescriber_spistring
Surescripts Prescriber ID.
member_purchase_amountdouble

(Proposed - provenance pending) Total amount the member paid at point-of-sale, USD.

oop_amountdouble

(Proposed - provenance pending) Member out-of-pocket portion, USD.

plan_contributiondouble

(Proposed - provenance pending) Plan’s portion of the purchase (the plan contribution), USD.

quantityinteger>=1
Units dispensed.
days_supplyinteger>=1
Days of therapy the dispensed quantity covers.
provider_typeenum
Qualifier describing which provider identifier is carried in the provider slot.
pharmacy_npistring
Dispensing pharmacy identifier, when provided.
network_indenum

Whether the fill adjudicated in- or out-of-network.

original_purchase_idstring or nullformat: "uuid"

For reversals or adjustments, the purchase_id of the purchase being corrected. Null for new purchases.

statusenum
Processing status of the purchase.
deductible_applieddouble

(Proposed - provenance pending) Amount of this purchase applied to the member’s deductible, USD.

subscriber_idstring

The member’s subscriber identifier at the PBM’s eligibility system. Distinct from member_id.

first_namestring<=25 characters
Member first name.
last_namestring<=35 characters
Member last name.
date_of_birthdate
Member date of birth.
genderenum
Member gender as carried to the PBM.
relationshipenum
Member's relationship to the subscriber.
accumulatorslist of objects

(Proposed - provenance pending) Per-accumulator deltas this purchase applies (deductible, out-of-pocket, HRA, caps). A single fill can apply against up to six accumulators at once.

origin_codeenum

ESI origin code for HRA balance events (hra_initial_load, hra_rollover, hra_incentive); E is a non-shared pharmacy dollars load. Omitted for pharmacy fills.

plan_yearinteger
Plan year the balance applies to. Used for HRA balance events.
esiobject

ESI wire-protocol identifiers, populated when a purchase is exchanged via the ESI CDH format. All fields optional.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error