Get Benefit Inquiry

get

https://s3partnerapi-staging.solutran.com/2.2/benefits/inquiry

Returns a collection of Benefits and future issuances for the account specified.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ClientAccountId

string

length ≤ 100

The client-specific account identifier used to retrieve balance information.
Cannot exceed 100 characters. Either this or HouseholdId must be provided.
This gets used if you provide Id-Type = client in headers.

HouseholdId

string

length ≤ 100

The household identifier used to retrieve balance information for household-based accounts.
Cannot exceed 100 characters. Either this or ClientAccountId must be provided.

ProgramId

string

The program identifier to filter balances by specific program.

ZipCode

string

^\d{5}$

The ZIP code for geographical filtering of retailer locations.
Must be exactly 5 digits if provided.

RetailerDistance

int32

0 to 1000

The maximum distance in miles from the ZIP code for retailer location filtering.
Valid range is 0 to 1000 miles.

PromotionId

string

The promotion identifier to filter balances by specific promotion.

DefaultSort

string

The default sorting criteria for balance searches, ordered by benefit identifier.

Status

string

The benefit status to filter by. Can include multiple comma-separated values.
Automatically wrapped in parentheses for proper query formatting.

IncludeActiveStatus

boolean

Indicates whether active status benefits are included in the search results.
Set internally based on Status property.

IncludeFutureStatus

boolean

Indicates whether future status benefits are included in the search results.
Set internally based on Status property.

IncludeExpiredStatus

boolean

Indicates whether expired status benefits are included in the search results.
Set internally based on Status property.

IncludeInternalBenefits

boolean

Indicates whether internal benefits should be included in the search results.

SearchCriteria

string

Generates a query string representation of the search criteria.
Prioritizes ClientAccountId over HouseholdId if both are provided.
Only includes parameters that have non-null, non-empty values.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Allowed values for this resource: issuance, discounts. Multiple values can be comma-separated.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

programId

int32

ProgramId

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

422Unprocessable Content