Query

The Query type is a special type that defines the entry point of every GraphQL query. Queries are used to request and retrieve data. Unlike REST, GraphQL queries define what fields will be included in their response. In the Highnote API, data is most often retrieved using the node query, which can fetch any type by its globally unique id.

applicationContracts

A paginated list of ApplicationContracts.

Output:ApplicationContractConnectionPayload

Input Arguments

first: Int

The number of ApplicationContracts to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ApplicationContractFilterInput

Filter results to specific authorized user.

businessAccountHolders

A paginated list of businessAccountHolders.

For information on Highnote's Search API, see our Search guide.

Output:USBusinessAccountHolderConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: BusinessAccountHolderFilterInput

Filter results to specific business account holder.

businessOrganizations

A paginated list of business Organizations.

For information on Highnote's Search API, see our Search guide.

Output:BusinessOrganizationConnectionPayload

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: BusinessOrganizationFilterInput

Filter results to specific business Organizations.

cardProductApplicationBusinessMetric

Finds application metrics that match the given filter.

Output:CardProductApplicationBusinessMetricResult

Input Arguments

filterBy: CardProductApplicationBusinessMetricFilterInput

cardProducts

A paginated list of Card Products.

Output:CardProductConnection

Input Arguments

first: Int

Default Value: 10

after: String

cardProfileSets

A paginated list of all card profile sets filtered by name, status and card product.

For information on Highnote's Search API, see our Search guide.

Output:CardProfileSetConnectionPayload

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: FilteredCardProfileSetsInput!

customer

Find a customer

Output:CustomerPayload

Input Arguments

customerIdentifier: String!

An identifier that uniquely identifies the customer associated with the payment method in the subscriber system.

Optionally, pass a Highnote AccountHolder ID to associate this payment method with an existing AccountHolder.

feeTransferEvents

A paginated list of FeeTransferEvents.

For information on Highnote's Search API, see our Search guide.

Output:FeeTransferEventConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: FeeTransferEventFilterInput

Filter results to specific Fee Transfer Event.

installmentEligibilityForTransactionEvents

Determine whether TransactionEvents are eligible for any available InstallmentOffers. These must be AuthorizationAndClearEvents or ClearingEvents, and they must have an Amount within the range defined by an active CreditPlan with a CreditBalanceType of INSTALLMENT.

Output:InstallmentEligibilityForTransactionEventsPayload

Input Arguments

input: InstallmentEligibilityForTransactionEventsInput

installmentOffersForTransactionEvent

Retrieve the available InstallmentOffers for a Transaction by providing a TransactionEvent. This must be either an AuthorizationAndClearEvent or a ClearingEvent.

Output:InstallmentOffersForTransactionEventPayload

Input Arguments

input: InstallmentOffersForTransactionEventInput

merchantCategories

A list of merchant categories.

Output:MerchantCategoryDetailsContainer

merchantCategoryCodeSankeyDataPoints

Obtains data points formatted for a Sankey diagram, illustrating flows between account holders and merchant categories.

Output:MerchantCategoryCodeSankeyDataPointsPayload

Input Arguments

input: MerchantCategoryCodeSankeyDataPointsFilterInput!

merchantDrilldownSankeyDataPoints

Retrieves detailed Sankey diagram data points, including flows between account holders, merchant categories, and merchants.

Output:MerchantDrilldownSankeyDataPointsPayload

Input Arguments

input: MerchantDrilldownSankeyDataPointsFilterInput!

node

Query to fetch any type by its globally unique ID.

Output:Node

Input Arguments

id: ID!

notificationEvents

A paginated list of notification events.

Output:NotificationEventsConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: NotificationEventsFilterInput

The filter parameter for this connection.

organizationBusinessRelationships

A paginated list of Organizations that have an existing business relationship. For information on Highnote's Search API, see our Search guide.

Output:OrganizationBusinessRelationshipConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: OrganizationBusinessRelationshipFilterInput

Filter results to specific relationships.

organizations

A list of organizations.

Output:[Organization!]

paymentCardTransactionBusinessMetric

Finds transaction metrics that match the given filter.

Output:PaymentCardTransactionBusinessMetricResult

Input Arguments

filterBy: PaymentCardTransactionBusinessMetricFilterInput

paymentTransactions

A paginated list of PaymentTransactions.

Output:PaymentTransactionsConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PaymentTransactionFilterInput

personAccountHolders

A paginated list of personAccountHolders.

For information on Highnote's Search API, see our Search guide.

Output:USPersonAccountHolderConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PersonAccountHolderFilterInput

Filter results to specific account holder.

personAuthorizedUsersDeprecated

A paginated list of personAuthorizedUsers.

For information on Highnote's Search API, see our Search guide.

No longer supported.

Output:AuthorizedUserConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PersonAuthorizedUserFilterInput

Filter results to specific authorized user.

ping

Simple query that returns a static value of pong

Output:String!

productApplications

A paginated list of ProductApplication.

Output:ProductApplicationConnectionPayload

Input Arguments

first: Int

Default Value: 20

after: String

reports

Finds reports that match the given filter.

Output:ReportConnection

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: ReportFilterInput

reportUsage

Finds report usage metrics for the current Organization.

Output:[ReportUsage!]

riskGeolocationDensity

Provides density data points for geolocation visualization, showing the distribution of locations on a map.

Output:RiskGeolocationDensityPayload

Input Arguments

input: RiskGeolocationDensityFilterInput!

riskGeolocationPaths

Retrieves paths of geolocation data points for visualizing account holder movements on a map.

Output:RiskGeolocationPathsPayload

Input Arguments

input: RiskGeolocationPathsFilterInput!

riskScatterDataPoints

Fetches scatter plot data for risk analysis, allowing visualization of data points in two-dimensional space.

Output:RiskScatterDataPointsPayload

Input Arguments

input: RiskScatterDataPointsFilterInput!

schemaChangelogs

A paginated list of schema changelogs

Output:SchemaChangelogConnection

Input Arguments

first: Int

Default Value: 10

after: String