Get Account Cards

get

https://s3partnerapi-staging.solutran.com/2.2/accounts/{acctid}/cards

Returns a collection of Cards for the account specified.
The ID parameter handling depends on the ID-Type header: if set to 'Client', the ID is treated as a ClientAccountId; otherwise, it's treated as a server/internal ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

acctid

string

required

The id of the account to return cards for

Query Params

AccountId

int64

The account identifier to filter cards by associated account.

int64

The unique card identifier to filter by.

ProgramId

string

The program identifier.

Status

string

The card status to filter by. Can include multiple comma-separated values.
Supports ACTIVE, INACTIVE, and WAITING statuses.

PlanYear

string

The plan year to filter cards by specific benefit plan year.

DefaultSort

string

The default sorting criteria for card searches, ordered by card identifier.

IncludeActiveStatus

boolean

Indicates whether active status cards are included in the search results.
Set internally based on Status property via SetStatus method.

IncludeInactiveStatus

boolean

Indicates whether inactive status cards are included in the search results.
Set internally based on Status property via SetStatus method.

IncludeWaitingStatus

boolean

Indicates whether waiting status cards are included in the search results.
Set internally based on Status property via SetStatus method.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty, or non-zero 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: digital. 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.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content