Returns the Level 3 commercial-card payload stored on a session.

GET /api/hostedpaymentpages/sessions/{sessionId}/level3-data deprecated

Requires: HostedPaymentPage.HppSessions, HostedPaymentPage.HppSessions.Create, merchant scope.

Requires API key scope: transactions:read (Read transactions)

Lets an integrating merchant verify field-by-field exactly what the gateway holds: the stored payload is returned verbatim (no sanitization or redaction). Because it returns full, unredacted values, it requires the `HppSessions.Create` permission, and a merchant caller can only read sessions in its own merchant scope.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/level3-data" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/level3-data' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, HostedPaymentPagesApi } from '@winkpg/winkpg-api';

const api = new HostedPaymentPagesApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.hppSessionGetLevel3Data("3fa85f64-5717-4562-b3fc-2c963f66afa6");

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/level3-data', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new HostedPaymentPagesApi(config);
var result = await api.HppSessionGetLevel3DataAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));

C# (raw HTTP)

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/hostedpaymentpages/sessions/{sessionId}/level3-data");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.HostedPaymentPagesApi(client)
    result = api.hpp_session_get_level3_data("3fa85f64-5717-4562-b3fc-2c963f66afa6")

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/hostedpaymentpages/sessions/{sessionId}/level3-data",
    headers=headers,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

sessionId required

path

string (uuid)

The session whose stored Level 3 data should be returned.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.

Responses

200 OK

Body: Level3Data Level3Data Each item has these fields.

Field Type Description

shipFromZip required

string

The ZIP code from where the item is shipped. Conditional: When ShipFromZip is not null. Max length: 10. nullablemax length 10

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

destinationZip required

string

The destination ZIP code for the shipment. Conditional: When DestinationZip is not null. Max length: 10. nullablemax length 10

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

destinationCountryCode required

string

The destination country code for the shipment (ISO 3166-1 alpha-3 format). Conditional: When DestinationCountryCode is not empty. Pattern: ^[A-Z]{3}$. nullablemax length 3

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceNumber required

string

The invoice number associated with the transaction. Conditional: When InvoiceNumber is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

orderNumber required

string

The order number for the transaction. Conditional: When OrderNumber is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dutyAmount required

number (double)

The total duty amount for the transaction. Must be non-negative. Conditional: When DutyAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

freightAmount required

number (double)

The total freight/shipping amount for the transaction. Must be non-negative. Conditional: When FreightAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

discountAmount required

number (double)

The total discount amount applied at the header level. Must be non-negative. Conditional: When DiscountAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineItems required

array of Level3LineItem array of Level3LineItem

The list of line items associated with the transaction. nullablemax items 250

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each Level3LineItem:

Field Type Description

id required

string (uuid)

The unique identifier for the line item.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productCode required

string

The product code. Maximum length is 25 characters. Conditional: When ProductCode is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

commodityCode required

string

The commodity code. Maximum length is 25 characters. Conditional: When CommodityCode is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

The description of the item. Maximum length is 25 characters. Conditional: When Description is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

upc required

string

The Universal Product Code (UPC). Maximum length is 25 characters. Conditional: When Upc is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceNumber required

string

The invoice number. Maximum length is 25 characters. Conditional: When InvoiceNumber is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxType required

string

The tax type. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

quantity required

number (double)

The quantity of the item. Must be non-negative. Conditional: When Quantity is not null. Must be > 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitOfMeasure required

string

The unit of measure. Maximum length is 30 characters. Conditional: When UnitOfMeasure is not null. Max length: 30. nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitPrice required

number (double)

The unit price of the item. Must be positive. Conditional: When UnitPrice is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

discountAmount required

number (double)

The discount amount. Must be non-negative. Conditional: When DiscountAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

totalAmount required

number (double)

The total amount for the line item. Must be positive. Conditional: When TotalAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxAmount required

number (double)

The tax amount. Must be non-negative. Conditional: When TaxAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRate required

number (double)

The tax rate. Must be non-negative. Conditional: When TaxRate is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

extendedAmount required

number (double)

The extended amount. Must be non-negative. Conditional: When ExtendedAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

freightAmount required

number (double)

The freight amount. Must be non-negative. Conditional: When FreightAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dutyAmount required

number (double)

The duty amount. Must be non-negative. Conditional: When DutyAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxIncluded required

boolean

Value indicating whether tax is included in the price. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicFoodCategoryCode required

string

The USDA WIC food category code for the item (e.g. the 2-digit category in the WIC Authorized Product List). Optional; only populated for eWIC line items. Maximum length is 25 characters. Conditional: When WicFoodCategoryCode is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicSubcategoryCode required

string

The USDA WIC food subcategory code for the item, where the category is further subdivided. Optional; only populated for eWIC line items. Maximum length is 25 characters. Conditional: When WicSubcategoryCode is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicBenefitType required

WicBenefitType WicBenefitType

The coarse eWIC benefit mechanism this line redeems against. See `WicBenefitType`. Optional; only populated for eWIC line items. Conditional: When WicBenefitType is not null. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Unspecified`	Benefit mechanism not specified. Default for line items that carry other eWIC data (e.g. a category code) without an explicit mechanism classification.
`FoodBenefit`	Standard fixed-quantity food benefit, redeemed by USDA food category/subcategory against the cardholder's remaining prescribed balance for that category.
`CashValueBenefit`	Cash Value Benefit (CVB) / Cash Value Voucher (CVV): a dollar-denominated benefit for fruits and vegetables, redeemed against a remaining dollar balance rather than a fixed quantity.
`InfantFormula`	Infant formula. Handled distinctly from standard food benefits because of contract-brand restrictions and manufacturer rebate accounting.

voucherReference required

string

The processor-issued voucher / benefit reference this line redeems against. Optional; only populated for eWIC line items. Maximum length is 25 characters. Format is not enforced here because it is processor-specific (the initial eWIC processor is selected later in the epic). Conditional: When VoucherReference is not null. Max length: 25. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicUnitOfMeasure required

string

The WIC-specific unit of measure for the item, which can differ from the generic `unitOfMeasure` (WIC programs prescribe benefits in program-specific units). Optional; only populated for eWIC line items. Maximum length is 30 characters. Conditional: When WicUnitOfMeasure is not null. Max length: 30. nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicEligibleQuantity required

number (double)

The quantity of this line that is WIC-eligible, which can be less than the cart-line `quantity` when only part of the purchased quantity falls within the cardholder's benefit. Must be non-negative. Optional; only populated for eWIC line items. Conditional: When WicEligibleQuantity is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

wicEligibleAmount required

number (double)

The amount of this line that is WIC-eligible, which can be less than the cart-line `totalAmount` when only part of the line is covered by the benefit. Must be non-negative. Optional; only populated for eWIC line items. Conditional: When WicEligibleAmount is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

The API reference isn't available right now

No such operation

This reference may be out of date

Returns the Level 3 commercial-card payload stored on a session.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication