Skip to main content

CardsForHsaPayload

The CardsForHsaPayload models all cards provisioned for an account. Due to the nature of cards, the nature of the underlying API, and the needs of the client, this response matches the legacy response and returns all cards, segmented by whether they are for the HSA holder or for a dependent. Due to this, the response is not paged. If paging is required in the future, a new model should be evaluated.

type CardsForHsaPayload {
  dependents: [HsaCard!]!
  pending: [PendingHsaCard!]!
  primary: [HsaCard!]!
}

Fields​

CardsForHsaPayload.dependents ● [HsaCard!]! non-null object​

All of the cards provisioned for dependents (authorized users) across the lifecycle of the account.

CardsForHsaPayload.pending ● [PendingHsaCard!]! non-null object​

Cards for which the user has applied, but have not been issued (likely due to KYC failure).

CardsForHsaPayload.primary ● [HsaCard!]! non-null object​

All of the cards provisioned for the primary account holder across the lifecycle of the account.

Returned by​

cardsForHsa query