> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://build.andel.org/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://build.andel.org/_mcp/server. # Get a single purchase GET https://api.andel.org/exchange/v1/purchases/{purchase_id} Reference: https://build.andel.org/dataexchange/data-exchange-api/purchases/get-purchase ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: dataexchange version: 1.0.0 paths: /purchases/{purchase_id}: get: operationId: get-purchase summary: Get a single purchase tags: - subpackage_purchases parameters: - name: purchase_id in: path required: true schema: type: string format: uuid - name: Authorization in: header description: Production machine-to-machine flow. Tokens issued by Descope. required: true schema: type: string responses: '200': description: A single purchase. content: application/json: schema: $ref: '#/components/schemas/Purchase' '401': description: Missing or invalid token. content: application/json: schema: $ref: '#/components/schemas/Problem' '403': description: >- Token lacks the required scope, or is not authorized for the requested `plan_id`. content: application/json: schema: $ref: '#/components/schemas/Problem' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/Problem' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/Problem' servers: - url: https://api.andel.org/exchange/v1 description: Production - url: https://7403d846-765d-4d63-9e5c-b7f0ab21a354.mock.pstmn.io/exchange/v1 description: Postman mock server (sandbox; auth is not enforced) components: schemas: PurchaseProviderType: type: string enum: - ncpdp - npi - dea - copay_assist description: >- Qualifier describing which provider identifier is carried in the provider slot. title: PurchaseProviderType PurchaseNetworkInd: type: string enum: - in_network - out_of_network - both - inn_house description: Whether the fill adjudicated in- or out-of-network. title: PurchaseNetworkInd PurchaseEventType: type: string enum: - claim - reversal - adjustment - hra_initial_load - hra_rollover - hra_incentive default: claim description: >- 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. title: PurchaseEventType PurchaseStatus: type: string enum: - accepted - rejected - pended - reversed description: Processing status of the purchase. title: PurchaseStatus PurchaseGender: type: string enum: - unknown - male - female - non_binary description: Member gender as carried to the PBM. title: PurchaseGender PurchaseRelationship: type: string enum: - subscriber - spouse - dependent - student - disabled_dependent - adult_dependent - domestic_partner description: Member's relationship to the subscriber. title: PurchaseRelationship AccumulatorTypeOfBenefitAccount: type: string enum: - hra - deductible - oop - cap - lifetime_cap - drug_cap - benefit_deductible - benefit_oop - base_deductible - base_oop - tmoop description: Which benefit accumulator this delta applies to. title: AccumulatorTypeOfBenefitAccount AccumulatorParticipationType: type: string enum: - in_network - out_of_network - combined - inn_house description: Network level this accumulator tracks (may differ per accumulator). title: AccumulatorParticipationType AccumulatorCrDbIndicator: type: string enum: - debit - credit - replace - bypass description: >- `debit` consumes the accumulator, `credit` restores it (a reversal), `replace` overwrites the running total, `bypass` ignores this accumulator for this transaction. title: AccumulatorCrDbIndicator Accumulator: type: object properties: type_of_benefit_account: $ref: '#/components/schemas/AccumulatorTypeOfBenefitAccount' description: Which benefit accumulator this delta applies to. participation_type: $ref: '#/components/schemas/AccumulatorParticipationType' description: Network level this accumulator tracks (may differ per accumulator). amount: type: number format: double description: >- (Proposed - provenance pending) Dollars applied to this accumulator on this purchase, USD. cr_db_indicator: $ref: '#/components/schemas/AccumulatorCrDbIndicator' description: >- `debit` consumes the accumulator, `credit` restores it (a reversal), `replace` overwrites the running total, `bypass` ignores this accumulator for this transaction. accumulated_amount: type: number format: double description: >- (Proposed - provenance pending) Running total applied to date, USD. Required by ESI for `replace`. remaining_amount: type: number format: double description: >- (Proposed - provenance pending) Amount left before the accumulator cap is met, USD. met_this_transaction: type: boolean description: >- True when this purchase drove `remaining_amount` to zero (e.g., deductible met on this fill). required: - type_of_benefit_account - amount - cr_db_indicator description: >- A per-accumulator delta applied by a purchase. A single fill can apply against up to six accumulators at once. title: Accumulator PurchaseOriginCode: type: string enum: - E - R description: >- 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. title: PurchaseOriginCode EsiIdentityTransmissionType: type: string enum: - DQ - DR description: Data Request (sent) vs Data Response (acknowledged). title: EsiIdentityTransmissionType EsiIdentityRequestCode: type: string enum: - '01' - '02' - '04' description: Claim / Reversal / Adjustment request code. title: EsiIdentityRequestCode EsiIdentity: type: object properties: sender_id: type: string description: ESI-assigned trading-partner sender identifier. receiver_id: type: string description: Receiver identifier; `MHS` when sending to ESI. signature: type: string description: >- 26-character composite transaction key (date + milliseconds + sequence + source-app code). claim_id: type: string description: ESI claim identifier. claim_xref_id: type: string description: >- Original-transaction reference on a reversal or adjustment. Mirrors `original_purchase_id`. transmission_type: $ref: '#/components/schemas/EsiIdentityTransmissionType' description: Data Request (sent) vs Data Response (acknowledged). request_code: $ref: '#/components/schemas/EsiIdentityRequestCode' description: Claim / Reversal / Adjustment request code. response_code: type: string description: ESI Data Response code; `00` is accepted, otherwise an error code. reason_code: type: string description: Granular reason detail beyond the response code. description: >- ESI wire-protocol identifiers, populated when a purchase is exchanged via the ESI CDH format. All fields optional. title: EsiIdentity Purchase: type: object properties: purchase_id: type: string format: uuid description: Andel-issued unique identifier. member_id: type: string description: Plan or PBM member identifier. plan_id: type: string description: >- 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_at: type: string format: date-time description: ISO 8601 UTC timestamp from the pharmacy point-of-sale. ndc: type: string description: 11-digit National Drug Code. prescriber_spi: type: string description: Surescripts Prescriber ID. member_purchase_amount: type: number format: double description: >- (Proposed - provenance pending) Total amount the member paid at point-of-sale, USD. oop_amount: type: number format: double description: (Proposed - provenance pending) Member out-of-pocket portion, USD. plan_contribution: type: number format: double description: >- (Proposed - provenance pending) Plan's portion of the purchase (the plan contribution), USD. quantity: type: integer description: Units dispensed. currency: type: string default: USD description: ISO 4217 currency code. date_of_service: type: string format: date description: >- The actual fill date used for eligibility validation. Distinct from `purchased_at`, which is the point-of-sale timestamp. days_supply: type: integer description: Days of therapy the dispensed quantity covers. provider_type: $ref: '#/components/schemas/PurchaseProviderType' description: >- Qualifier describing which provider identifier is carried in the provider slot. pharmacy_npi: type: string description: Dispensing pharmacy identifier, when provided. network_ind: $ref: '#/components/schemas/PurchaseNetworkInd' description: Whether the fill adjudicated in- or out-of-network. event_type: $ref: '#/components/schemas/PurchaseEventType' description: >- 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. original_purchase_id: type: - string - 'null' format: uuid description: >- For reversals or adjustments, the `purchase_id` of the purchase being corrected. Null for new purchases. status: $ref: '#/components/schemas/PurchaseStatus' description: Processing status of the purchase. deductible_applied: type: number format: double description: >- (Proposed - provenance pending) Amount of this purchase applied to the member's deductible, USD. subscriber_id: type: string description: >- The member's subscriber identifier at the PBM's eligibility system. Distinct from `member_id`. first_name: type: string description: Member first name. last_name: type: string description: Member last name. date_of_birth: type: string format: date description: Member date of birth. gender: $ref: '#/components/schemas/PurchaseGender' description: Member gender as carried to the PBM. relationship: $ref: '#/components/schemas/PurchaseRelationship' description: Member's relationship to the subscriber. accumulators: type: array items: $ref: '#/components/schemas/Accumulator' description: >- (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_code: $ref: '#/components/schemas/PurchaseOriginCode' description: >- 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_year: type: integer description: Plan year the balance applies to. Used for HRA balance events. esi: $ref: '#/components/schemas/EsiIdentity' required: - purchase_id - member_id - plan_id - purchased_at - currency - date_of_service - event_type title: Purchase Problem: type: object properties: type: type: string format: uri title: type: string status: type: integer detail: type: string instance: type: string andel_request_id: type: string description: Pass to support to trace this request. required: - type - title - status description: RFC 9457 problem details with Andel extensions. title: Problem securitySchemes: andelDescopeClientCredentials: type: http scheme: bearer description: Production machine-to-machine flow. Tokens issued by Descope. andelDescopeAuthCode: type: http scheme: bearer description: Developer-exploration flow with PKCE. Used by Postman Guided Auth. ``` ## Examples ### An enriched in-network purchase **Response** ```json { "purchase_id": "7e3a3c5e-3b7f-4f0a-9e65-1c9c3a8b1234", "member_id": "M-987654321", "plan_id": "PLN-0001", "purchased_at": "2026-05-13T18:24:01Z", "currency": "USD", "date_of_service": "2026-05-13", "event_type": "claim", "ndc": "00093005301", "prescriber_spi": "1234567890", "member_purchase_amount": 42.5, "oop_amount": 10, "plan_contribution": 32.5, "quantity": 30, "days_supply": 30, "provider_type": "npi", "network_ind": "in_network", "status": "accepted", "deductible_applied": 32.5, "subscriber_id": "SUB-4471902", "first_name": "Maria", "last_name": "Lopez", "date_of_birth": "1984-07-02", "gender": "female", "relationship": "subscriber", "accumulators": [ { "type_of_benefit_account": "deductible", "amount": 32.5, "cr_db_indicator": "debit", "participation_type": "in_network", "accumulated_amount": 532.5, "remaining_amount": 967.5, "met_this_transaction": false }, { "type_of_benefit_account": "oop", "amount": 10, "cr_db_indicator": "debit", "participation_type": "in_network", "accumulated_amount": 410, "remaining_amount": 2590, "met_this_transaction": false }, { "type_of_benefit_account": "hra", "amount": 32.5, "cr_db_indicator": "debit", "participation_type": "in_network", "accumulated_amount": 132.5, "remaining_amount": 367.5, "met_this_transaction": false } ], "esi": { "sender_id": "ANDEL-TPO-0001", "receiver_id": "MHS", "signature": "20260513182401512A1B2C3D", "claim_id": "CLM-0009912837", "transmission_type": "DQ", "request_code": "01", "response_code": "00" } } ``` **SDK Code** ```python An enriched in-network purchase import requests url = "https://api.andel.org/exchange/v1/purchases/purchase_id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript An enriched in-network purchase const url = 'https://api.andel.org/exchange/v1/purchases/purchase_id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go An enriched in-network purchase package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.andel.org/exchange/v1/purchases/purchase_id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby An enriched in-network purchase require 'uri' require 'net/http' url = URI("https://api.andel.org/exchange/v1/purchases/purchase_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java An enriched in-network purchase import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.andel.org/exchange/v1/purchases/purchase_id") .header("Authorization", "Bearer ") .asString(); ``` ```php An enriched in-network purchase request('GET', 'https://api.andel.org/exchange/v1/purchases/purchase_id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp An enriched in-network purchase using RestSharp; var client = new RestClient("https://api.andel.org/exchange/v1/purchases/purchase_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift An enriched in-network purchase import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.andel.org/exchange/v1/purchases/purchase_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### A reversal restoring a prior purchase **Response** ```json { "purchase_id": "c8d2f6a0-9b1e-4d7c-8a3f-2e6b4c9d0011", "member_id": "M-987654321", "plan_id": "PLN-0001", "purchased_at": "2026-05-20T09:02:14Z", "currency": "USD", "date_of_service": "2026-05-13", "event_type": "reversal", "ndc": "00093005301", "prescriber_spi": "1234567890", "member_purchase_amount": 42.5, "oop_amount": 10, "plan_contribution": 32.5, "quantity": 30, "provider_type": "npi", "network_ind": "in_network", "original_purchase_id": "7e3a3c5e-3b7f-4f0a-9e65-1c9c3a8b1234", "status": "accepted", "deductible_applied": 32.5, "subscriber_id": "SUB-4471902", "first_name": "Maria", "last_name": "Lopez", "date_of_birth": "1984-07-02", "gender": "female", "relationship": "subscriber", "accumulators": [ { "type_of_benefit_account": "deductible", "amount": 32.5, "cr_db_indicator": "credit", "participation_type": "in_network", "accumulated_amount": 500, "remaining_amount": 1000, "met_this_transaction": false }, { "type_of_benefit_account": "oop", "amount": 10, "cr_db_indicator": "credit", "participation_type": "in_network", "accumulated_amount": 400, "remaining_amount": 2600, "met_this_transaction": false }, { "type_of_benefit_account": "hra", "amount": 32.5, "cr_db_indicator": "credit", "participation_type": "in_network", "accumulated_amount": 100, "remaining_amount": 400, "met_this_transaction": false } ], "esi": { "sender_id": "ANDEL-TPO-0001", "receiver_id": "MHS", "signature": "20260520090214733B2C3D4E", "claim_id": "CLM-0009913004", "claim_xref_id": "CLM-0009912837", "transmission_type": "DQ", "request_code": "02", "response_code": "00" } } ``` **SDK Code** ```python A reversal restoring a prior purchase import requests url = "https://api.andel.org/exchange/v1/purchases/purchase_id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript A reversal restoring a prior purchase const url = 'https://api.andel.org/exchange/v1/purchases/purchase_id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go A reversal restoring a prior purchase package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.andel.org/exchange/v1/purchases/purchase_id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby A reversal restoring a prior purchase require 'uri' require 'net/http' url = URI("https://api.andel.org/exchange/v1/purchases/purchase_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java A reversal restoring a prior purchase import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.andel.org/exchange/v1/purchases/purchase_id") .header("Authorization", "Bearer ") .asString(); ``` ```php A reversal restoring a prior purchase request('GET', 'https://api.andel.org/exchange/v1/purchases/purchase_id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp A reversal restoring a prior purchase using RestSharp; var client = new RestClient("https://api.andel.org/exchange/v1/purchases/purchase_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift A reversal restoring a prior purchase import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.andel.org/exchange/v1/purchases/purchase_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ``` ### An initial annual HRA load **Response** ```json { "purchase_id": "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9", "member_id": "M-987654321", "plan_id": "PLN-0001", "purchased_at": "2026-01-01T00:00:00Z", "currency": "USD", "date_of_service": "2026-01-01", "event_type": "hra_initial_load", "status": "accepted", "accumulators": [ { "type_of_benefit_account": "hra", "amount": 500, "cr_db_indicator": "credit", "participation_type": "in_network", "accumulated_amount": 500, "remaining_amount": 0, "met_this_transaction": false } ], "origin_code": "E", "plan_year": 2026 } ``` **SDK Code** ```python An initial annual HRA load import requests url = "https://api.andel.org/exchange/v1/purchases/purchase_id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript An initial annual HRA load const url = 'https://api.andel.org/exchange/v1/purchases/purchase_id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go An initial annual HRA load package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.andel.org/exchange/v1/purchases/purchase_id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby An initial annual HRA load require 'uri' require 'net/http' url = URI("https://api.andel.org/exchange/v1/purchases/purchase_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java An initial annual HRA load import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.andel.org/exchange/v1/purchases/purchase_id") .header("Authorization", "Bearer ") .asString(); ``` ```php An initial annual HRA load request('GET', 'https://api.andel.org/exchange/v1/purchases/purchase_id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp An initial annual HRA load using RestSharp; var client = new RestClient("https://api.andel.org/exchange/v1/purchases/purchase_id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift An initial annual HRA load import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.andel.org/exchange/v1/purchases/purchase_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```