Object

Fields

id: ID!

The ID of the document uploaded

status: ApplicationDocumentUploadStatus

The status of the document uploaded by the applicant

type: DocumentType

The document type uploaded

revisions: [AccountHolderApplicationDocumentRevision]

Revisions on the applicant's document

createdAt: String

The date and time, in ISO 8601 format, this application document was created.

updatedAt: String

The date and time, in ISO 8601 format, this application document was last updated.

fileReviewReasons: [ApplicationDocumentReviewReason!]

The given reasons for the file review status.

AccountHolderApplicationDocumentRevision

A revision of an uploaded document for an application

Output:OBJECT

Fields

status: ApplicationDocumentUploadStatus

The status of the document uploaded by the applicant

type: DocumentType

The document type uploaded

createdAt: String

The date and time, in ISO 8601 format, this application document revision was created.

updatedAt: String

The date and time, in ISO 8601 format, this application document revision was last updated.

fileReviewReasons: [ApplicationDocumentReviewReason!]

The given reasons for the file review status.

AccountHolderApplicationDocumentToVerificationResultCodeContext

A context describing the impact of a DocumentType presented on the USAccountHolderApplicationDocumentUploadSession to the AccountHolderVerificationResultCodes

referenceIdentifier: ID

A reference identifier for the account holder application document session **Note: ** This is not a Global ID

documentUploadSession: AccountHolderApplicationDocumentUploadSession

A document upload session

status: ApplicationDocumentUploadSessionStatus

The status of the application's document upload session

uploadedDocuments: [ApplicationDocument]

Documents submitted for the application

createdAt: String

The date and time, in ISO 8601 format, this application document was created.

verificationResultCode: AccountHolderVerificationResultCode

The AccountHolderVerificationResultCode on the AccountHolderCardProductApplication

documents: [DocumentType!]

A list of DocumentType

AccountHolderCardProductApplication

An AccountHolderCardProductApplication.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the application in operations.

applicationState: AccountHolderApplicationState

The current state of the application.

adverseActionReasons: [AdverseActionReason!]

A prioritized list of Adverse Action Reasons explaining the Application Deal.

applicationDenialReason: ApplicationDenialReason

The Denial Reason for an Application

applicationConfiguration: ApplicationConfiguration

Optional application-level configuration provided by the applicant at the start of the application, such as billing cycle preferences.

accountHolderSnapshot: AccountHolderSnapshot

The account holder's data at the time of application.

cardProduct: CardProduct

The Card Product to which the account holder is applying.

applicationHistory: AccountHolderCardProductApplicationSnapshotConnection

Past states of the application

Input Arguments

first: Int

The number of application snapshots to return.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the application was created.

updatedAt: String

The date and time, in ISO 8601 format, the application was last updated.

financialAccounts: FinancialAccountConnection

The financial accounts associated with this account holder application.

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

Input Arguments

first: Int

The number of financial accounts to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: AccountHolderFinancialAccountsFilterInput

Filter results to specific financial accounts.

offers: AccountHolderCardProductApplicationOfferConnection

A paginated list of AccountHolderCardProductApplicationOffer associated with the AccountHolderCardProductApplication

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

Input Arguments

first: Int

The number of offers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: AccountHolderCardProductApplicationOfferFilterByInput

The search filters available on offers

creditReportFraudAlertVerificationResult: CreditReportFraudAlertVerificationResult

Fields that were verified in response to a fraud alert on the applicant's credit report. Only present in the case of a fraud alert.

applicationWorkflows: [ProductApplicationWorkflow!]

The workflows this application must go through before reaching the APPROVED state

decisionedAt: String

The date and time, in ISO 8601 format, the application was decisioned.

expiresAt: String

The approximate date and time, in ISO 8601 format, the application is set to expire if not decisioned.

reevaluationEdition: UnsignedInt

Indicates the number of reevaluations this application has gone through

sourceApplication: AccountHolderCardProductApplication

If a reevaluation has taken place, this will be the application that existed prior to this one. Otherwise this will be undefined.

previousApplications: PreviousProductApplicationConnection

Previous editions of this application that have since been replaced through the reevaluation process For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of previous applications to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: PreviousProductApplicationFilterInput

Filter results to specific applications.

globalNotes: GlobalNoteConnectionPayload

All global notes for this AccountHolderCardProductApplication.

Fields

id: ID!

The global ID used to reference the AccountHolderCardProductApplicationOffer.

The offer name.

status: CardProductApplicationOfferStatus

The offer status.

category: CardProductApplicationOfferCategory

The offer category

AccountHolderCardProductApplicationOfferConnection

Represents the provisioning process for an account holder.

This type includes information about the provisioning request, its current and next actions, outcomes, and timestamps, as well as the sequence of workflow actions involved.

Output:OBJECT

Interfaces

Fields

idempotencyKey: IdempotencyKey

A UUIDv4 string used to uniquely identify requests. This field ensures that duplicate requests are not processed more than once and provides idempotency for the request.

id: ID!

A unique identifier for this provisioning instance. This field helps to uniquely identify and reference a specific provisioning request.

accountHolder: AccountHolder

The account holder associated with this provisioning request. This field provides details about the account holder being provisioned.

outcome: AccountHolderProvisioningOutcome

The outcome of the provisioning process. This field provides details about the result of the provisioning, including any errors or completion status.

nextAction: AccountHolderProvisioningWorkflowAction

The next action to be performed in the provisioning workflow. This field specifies what action is scheduled to follow the current one.

currentAction: AccountHolderProvisioningWorkflowAction

The current action being executed in the provisioning workflow. This field provides details about the ongoing action in the provisioning process.

createdAt: String

The date and time when this provisioning request was created, represented in ISO 8601 format. This timestamp indicates when the record was initially created.

updatedAt: String

The date and time when this provisioning request was last updated, represented in ISO 8601 format. This timestamp reflects the most recent modification to the record.

workflowActions: [AccountHolderProvisioningWorkflowAction!]

A list of workflow actions associated with this provisioning request. This field includes all actions performed or scheduled during the provisioning process.

AccountHolderProvisioningOutcome

Represents the outcome of the account holder provisioning process.

It includes both the current status of the process and the specific reason or result of that status.

Output:OBJECT

Fields

status: AccountHolderProvisioningStatus

The current status of the provisioning process, such as whether it is in progress, completed, or in error.

AccountHolderProvisioningWorkflowAction

Represents an action in the workflow for provisioning an account holder.

This type includes details about the action performed, its outcome, associated inputs, the order of execution, and related nodes.

Output:OBJECT

Interfaces

Fields

id: ID!

Globally unique ID to fetch a Node. This field provides a unique identifier for the node, allowing for its retrieval and reference.

accountHolderProvisioning: AccountHolderProvisioning

The AccountHolderProvisioning this action belongs to.

action: ProvisionAccountHolderAction

The specific action being performed in the provisioning workflow. This field specifies the type of provisioning action executed, such as creating an application or setting a credit limit.

outcome: AccountHolderProvisioningWorkflowActionDetail

The outcome of the provisioning workflow action. This field provides details about the result of the action, indicating whether it was successful or encountered issues.

actionInput: ProvisionAccountHolderActionDetail

Input related to the provisioning action. This field contains details about the input parameters used for the action, such as application details or configuration settings.

executionOrder: UnsignedInt

The order in which the action was executed within the workflow. This field specifies the sequence of the action to maintain the correct processing order.

node: AccountHolderProvisioningActionNode

The node associated with the provisioning action. This field can be one of several types, including account applications, financial accounts, payment cards, or workflow action results, providing additional context about the action.

AccountHolderProvisioningWorkflowActionDetail

Represents the outcome of the account holder provisioning process. It includes both the current status of the process and the specific reason or result of that status.

Output:OBJECT

Fields

status: AccountHolderProvisioningWorkflowActionStatus

The current status of the provisioning process, such as whether it is in progress, completed, or in error.

AccountHolderRiskScore

A list of account holder risk scores

Output:OBJECT

Fields

id: ID!

The ID used to reference the risk scores

identityRiskScores: [AccountHolderIdentityRiskScore!]

A list of identity risk scores from all the possible vendors

AccountHolderVerification

Type representing a verification attempt on an Account Holder. Not all attempts are successful.

Output:OBJECT

Fields

status: AccountHolderVerificationStatusCode

Current status of the verification attempt.

riskStatus: AccountHolderRiskVerificationStatusCode

Current status of the risk verification attempt.

reason: AccountHolderVerificationStatusReasonCode

The reason for the current status of the verification attempt.

results: [AccountHolderVerificationResult!]

Results from the verification attempt.

requiredDocuments: [AccountHolderApplicationRequiredDocument]

Documents required to support manual verification of the application.

adverseActionReasons: [AdverseActionReason!]

A list of Adverse Action Reasons explaining the Application Denial.

riskScores: AccountHolderRiskScore

A list of risk scores associated with the account holder.

requestedUpdates: [RequestedIdentityUpdate!]

Requested Updates to the Identity

AccountHolderVerificationResult

Type representing one result on a verification.

Output:OBJECT

Fields

code: AccountHolderVerificationResultCode

The specific result of a verification requirement.

description: String

A description for the resulting code of a verification requirement.

AccountRelationship

Represents a relationship between two financial accounts.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Account Relationship in operations.

fromFinancialAccount: FinancialAccount

The source financial account in this relationship.

toFinancialAccount: FinancialAccount

The target financial account in this relationship.

Fields

id: ID!

Global ID used to reference the AccountSpendRule in operations.

The name assigned to the rule.

allowed: [ID!]

The Account IDs to allow during authorizations.

blocked: [ID!]

The Account IDs to block during authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

AccountSpendRuleResult

The result of applying an AccountSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [ID!]

The ID of the Account used in the event.

spendRule: AccountSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

AccountStatusActiveEvent

The AccountStatusActiveEvent notifies when an FinancialAccount is set to the Active Status.

Output:OBJECT

Interfaces

AccountStatusEvent

Fields

Fields

id: ID!

Global ID used to reference the AccountTransactionCountSpendRule in operations.

The name assigned to the rule.

maximumAccountTransactionCount: UnsignedInt

The maximum number of transactions allowed for an account before transactions are declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

AccountTransactionCountSpendRuleResult

The result of applying a AccountTransactionCountSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

accountTransactionCount: UnsignedInt

The current number of transactions on the account at the time of evaluation.

spendRule: AccountTransactionCountSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated.

Output:OBJECT

Fields

yearToDateAccumulatedInterestDebit: Amount

The interest debit balance that has accumulated year to date, across all balance types.

yearToDateAccumulatedInterestCredit: Amount

The interest credit balance that has accumulated year to date, across all balance types.

yearToDateAccumulatedFeesDebit: Amount

The fee debit balance that has accumulated year to date, across all balance types.

yearToDateAccumulatedFeesCredit: Amount

The fee credit balance that has accumulated year to date, across all balance types.

AchCapableFinancialAccountFeature

Whether or not the Financial Account is a Non Verified account

Output:OBJECT

Interfaces

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

The Company Identifier is a 10-position alphameric code used to identify an Originator of the ACH transaction. It may begin with an ANSI one-digit Identification Code Designator (ICD), followed by the Identification Number.

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

externallyInitatedDepositACHReasonCode: ExternallyInitiatedACHStatusReasonCode

Additional details about why an AchExternallyInitatedDeposit failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use externallyInitatedDepositACHReasonCode instead

AchExternallyInitatedDepositProcessedEvent

The AchExternallyInitatedDepositProcessedEvent event will be triggered when an incoming NACHA file transaction has been processed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AchExternallyInitatedDepositProcessedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

financialAccountId: ID

The ID of the financial account receiving funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

AchExternallyInitatedDepositReceivedEvent

The AchExternallyInitatedDepositReceivedEvent event will be triggered when an incoming NACHA file transaction has been received.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AchExternallyInitatedDepositReceivedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

financialAccountId: ID

The ID of the financial account receiving funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

AchExternallyInitiatedWithdrawalFailedEvent

The AchExternallyInitiatedWithdrawalFailedEvent event will be triggered when processing an incoming NACHA file transaction has failed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AchExternallyWithdrawalDepositFailedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

financialAccountId: ID

The ID of the Financial account that is the source of the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

externallyInitiatedWithdrawalACHReasonCode: ExternallyInitiatedACHStatusReasonCode

Additional details about why an AchExternallyInitiatedWithdrawal failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use ExternallyInitiatedWithdrawalAchReasonCode instead

AchExternallyInitiatedWithdrawalProcessedEvent

The AchExternallyInitiatedWithdrawalProcessedEvent event will be triggered when an incoming NACHA file transaction has been processed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AchExternallyInitiatedWithdrawalProcessedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

financialAccountId: ID

The ID of the Financial account that is the source of the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

AchExternallyInitiatedWithdrawalReceivedEvent

The AchExternallyInitiatedWithdrawalReceivedEvent event will be triggered when an incoming NACHA file transaction has been received.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AchExternallyInitiatedWithdrawalReceivedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

financialAccountId: ID

The ID of the Financial account that is the source of the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

AchHoldAddedEvent

The AchHoldAddedEvent notifies when an ach transaction is put on hold.

Output:OBJECT

Interfaces

AchHoldEvent

Fields

id: ID!

The global ID to reference the AchHoldAddedEvent.

transactionId: ID

The ID of the ACH Transaction related to this event.

fromStatus: AchHoldStatus

The previous hold status.

holdType: AchHoldType

The hold type.

sourceAccountId: ID

The account that the money is going out of. Will not exist for non-originating credit transactions.

receivingAccountId: ID

The account that the money is going to. Will not exist for non-originating debit transactions.

companyName: String

The company name.

companyIdentifier: String

The company identifier.

createdAt: String

The date and time, in ISO 8601 format, the ach transaction was created.

updatedAt: String

The date and time, in ISO 8601 format, the ach transaction was last updated.

AchHoldRemovedEvent

The AchHoldRemovedEvent notifies when the hold on an ach transaction is removed.

Output:OBJECT

Interfaces

AchHoldEvent

Fields

id: ID!

The global ID to reference the AchHoldRemovedEvent.

transactionId: ID

The ID of the ACH Transaction related to this event.

fromStatus: AchHoldStatus

The previous hold status.

holdType: AchHoldType

The hold type.

sourceAccountId: ID

The account that the money is going out of. Will not exist for non-originating credit transactions.

receivingAccountId: ID

The account that the money is going to. Will not exist for non-originating debit transactions.

companyName: String

The company name.

Fields

id: ID!

Uniquely identifies the AchTransferHoldAddedEvent.

fromHoldStatus: AchHoldStatus

The previous hold status.

fromHoldType: AchHoldType

The previous hold type.

holdStatusAddedAt: String

The date the transfer hold was added by Highnote, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

transfer: AchTransfer!

Detains about the ACH transfer that had a hold added by Highnote.

AchTransferHoldRemovedEvent

An event that occurs when an OriginatedAchTransfer or NonOriginatedTransfer has a hold removed by Highnote.

Output:OBJECT

Interfaces

Fields

id: ID!

Uniquely identifies the AchTransferHoldRemovedEvent.

fromHoldStatus: AchHoldStatus

The previous hold status.

fromHoldType: AchHoldType

The previous hold type.

holdStatusRemovedAt: String

The date the transfer hold was removed by Highnote, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

transfer: AchTransfer!

Detains about the ACH transfer that had a hold removed by Highnote.

Address

Type representing the parts of an address.

Output:OBJECT

Fields

streetAddress: String

The number and street of the address.

extendedAddress: String

Additional data about the address, e.g. apartment, unit, floor, or place name.

postalCode: String

The postal code of the address.

region: String

A region for the address.

token: ValidatedAddressToken

The validated address token.

AddressValidatedWithChangesResult

Address validation result type returned when address is validated with changes.

Output:OBJECT

Fields

componentsChanged: [AddressComponent!]

List of address components that were changed.

token: ValidatedAddressToken

The validated address token.

AddressValidationResult

Result of validatedAddress.

Output:OBJECT

Fields

outcome: AddressValidationOutcome

Outcome of the address validation.

AdjustmentEvent

A Adjustment Event for a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event.

responseCode: TransactionEventResponseCode

The Highnote response code.

transaction: Transaction

The Transaction for this event.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this AdjustmentEvent and posted in the settlement currency. Does not include fees.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this AdjustmentEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this AdjustmentEvent.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the AdjustmentEvent.

cardProduct: CardProduct

The CardProduct associated to this AdjustmentEvent.

merchantDetails: MerchantDetails

Not used for this AdjustmentEvent

currentFinancialAccountAvailableToSpendAmount: Amount

The Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

AdminAgentOrganization

Organization that an Admin Agent can access.

Output:OBJECT

Interfaces

Fields

id: ID!

ID of the Organization

tenantId: ID!

ID of the Tenant

profile: OrganizationProfile!

Details of the Organization

businessDetail: BusinessDetail

Detailed information about the organization

AdverseActionReason

An explanation given as to why the application was denied.

Output:OBJECT

Fields

code: AdverseActionCode

The reason why the application was denied.

description: String

A human friendly description for the code.

AdviceDetail

Details about an advice message for a transaction.

Output:OBJECT

Fields

responseCode: TransactionAdviceEventResponseCode

The provided response code provided by advice message.

Amount

Monetary amount where the currency is used to express the expectations for the number of decimal places. See ISO Standard Currency Codes for more information.

Output:OBJECT

Fields

value: UnsignedInt

Value of the amount as an integer. The number of decimal places varies by currency so the value will be an integer accounting for the minor units.

For example, a US dollar value of $10.99 will be returned as 1099. A US dollar value of $10 will be returned as 1000.

Currencies with zero decimal places (such as JPY) or those with more than 2 (such as JOD) will be returned as 1099 and 10990 respectively.

Currency	Value
USD	1099
JPY	1099
JOD	10990

currencyCode: String

Three-character ISO 4217 currency code

Examples: "USD", "EUR", "GBP"

decimalPlaces: UnsignedInt

The number of decimal places for this Amount. This value is used to determine the decimal place for the value field. This value will always be at least the number of decimal places for the currencyCode provided. Standard transactions use 2 decimal places (cents), while interchange fees, splits, and percentage-based calculations may use up to 6 decimal places for sub-cent precision.

Examples: A value of 1099, a currencyCode of USD, and a decimalPlaces of 2 as a string representation would be $10.99. A value of 1099, a currencyCode of USD, and a decimalPlaces of 3 as a string representation would be $1.099.

AmountFeeCondition

The logical condition which compares amount in account holder activity.

Output:OBJECT

Fields

value: AmountFeeConditionValue

The amount value against which amount in account holder activity is compared.

operator: FeeChargeOperator

The fee charge condition comparison operator.

AmountFeeConditionValue

Amount Condition value.

Output:OBJECT

Fields

amount: Amount

The fee charge condition amount used with AMOUNT condition type.

maximumAmount: Amount

The fee charge condition maximum amount used with AMOUNT condition type. Used with BETWEEN condition operator.

AmountImpact

Output:OBJECT

Fields

amount: Amount

The Amount for this entry.

impact: AccountingDirection

Indicates how this amount impacts the account balance.

DEBIT decreases the balance.
CREDIT increases the balance.

AmountLimitCheckRule

A CheckRule that will put a check on hold if the amount is exceeded.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the AmountLimitCheckRule in operations.

The name assigned to the rule.

maximumAmount: Amount

The maximum amount to allow for a check.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

revisions: CheckRuleConnection

The list of revisions for this check rule.

Input Arguments

first: Int

The number of revisions to return. Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the rule was last updated.

AmountLimitInterFinancialAccountTransferRule

An InterFinancialAccountTransferRule that will result in the decline of an inter financial account transfer if the maximum amount is exceeded.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the AmountLimitInterFinancialAccountTransferRule in operations.

The name assigned to the rule.

maximumAmount: Amount

The maximum amount to allow for an inter financial account transfer.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

interFinancialAccountTransferAccountType: InterFinancialAccountTransferAccountType

Indicates the account type to monitor.

revisions: InterFinancialAccountTransferRuleConnection

The list of revisions for this transfer rule.

Input Arguments

first: Int

The number of revisions to return.

Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the transfer rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer rule was last updated.

AmountLimitInterFinancialAccountTransferRuleResult

Result of AmountLimitInterFinancialAccountTransferRule

Output:OBJECT

Interfaces

Fields

status: InterFinancialAccountTransferRuleResultStatus

A status representing the result of the rule’s evaluation.

message: String

A message describing the result.

interFinancialAccountTransferRule: AmountLimitInterFinancialAccountTransferRule

Amount limit inter financial account transfer rule

AmountLimitSpendRule

A Spend Control rule that limits the dollar amount during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Merchant Category Spend Rule in operations.

The name assigned to the rule.

maximumAmount: Amount

The maximum amount to allow for a single authorization.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

AmountLimitSpendRuleResult

The result of applying an amount limit spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [Amount!]

The tested amounts of the event.

spendRule: AmountLimitSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

AmountRange

The range type for Amount.

Output:OBJECT

Fields

minimumInclusive: Amount

The minimum value (inclusive).

minimumExclusive: Amount

The minimum value (exclusive).

maximumInclusive: Amount

The maximum value (inclusive).

maximumExclusive: Amount

The maximum value (exclusive).

APIKey

Details of an API Key.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID

Name given to the API Key.

key: String

Non-redacted, secret value. Will only be present after the initial call to create the API Key.

redactedKey: String

Redacted, or masked, secret value.

protected: String!

Base64URL-encoded protected header.

payload: String!

Base64URL-encoded payload.

signature: String!

Base64URL-encoded signature.

header: AppleWebPushProvisioningJWSHeader!

Unprotected header containing additional information.

AppleWebPushProvisioningJWSHeader

JWS header for Apple Pay Web Push Provisioning.

Output:OBJECT

Fields

kid: String!

Key identifier used for signature verification.

AppleWebPushProvisioningToken

Apple Pay Web Push Provisioning token response.

Output:OBJECT

Fields

jws: AppleWebPushProvisioningJWS!

The JSON Web Signature (JWS) object containing the provisioning token.

state: String!

The provisioning session state identifier.

expiresAt: String!

The token expiration time in ISO 8601 format.

ApplicationConfiguration

Application-level configuration provided by the applicant at the start of the application.

Output:OBJECT

Fields

applicantBillingCycleOverride: BillingCycleOverride

Optional override of the billing cycle configuration requested by the applicant.

ApplicationContract

A contract on an ApplicationProduct

Output:OBJECT

Interfaces

Fields

id: ID!

The Global ID of the contract.

product: ApplicationProduct

The associated Product.

effectiveStartDate: String

The date and time, in ISO 8601 format, when the contract starts.

effectiveThroughDate: String

The date and time, in ISO 8601 format, through which this contract is valid.

The name of the ATM.

description: String

A description representing details about the ATM.

logo: ATMLocationLogoDetails

Details about the ATM location logo.

features: [ATMLocationFeature!]

Features available at the ATM.

address: Address

The physical address of the ATM.

coordinates: Coordinates

The coordinates of the ATM.

distance: Distance

The relative distance of the ATM.

ATMLocationLogoDetails

Details about the ATM location Logo.

Output:OBJECT

Fields

brand: ATMLocationBrand

The brand of the ATM location.

ATMLocations

A result of ATM locations for a Payment Card.

Output:OBJECT

Fields

atmLocations: [ATMLocation!]

A list of ATM locations.

AuthorizationAndClearEvent

A Authorization and Clear Event for a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event.

responseCode: TransactionEventResponseCode

The Highnote response code.

transaction: Transaction

The Transaction for this event.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this AuthorizationAndClearEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this AuthorizationAndClearEvent.

originalAmount: Amount

The original Amount of the AuthorizationAndClearEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this AuthorizationAndClearEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this AuthorizationAndClearEvent.

cardProduct: CardProduct

The CardProduct associated to this AuthorizationAndClearEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization and clear.

collaborativeAuthorizationDetails: CollaborativeAuthorizationDetails

Details if transaction supported collaborative auth.

spendRuleResults: SpendRuleResultConnection

The triggered spend rules and the results for the authorization and clear.

Input Arguments

first: Int

The number of results to return.

Default Value: 20

after: String

The cursor to start the page.

accountHolderId: ID

ID of the account holder for the card account.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

disputes: [PaymentCardTransactionDispute!]

Disputes on this AuthorizationAndClearEvent.

partial: Boolean

Determines whether this authorization and clear was approved for partial or full amount.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the AuthorizationAndClearEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

currencyConversionRate: Float

Conversion rate applied to the requestedAmount to get the requestedAmountInSettlementCurrency for this AuthorizationAndClearEvent.

Can be up to 7 decimal places, e.g. 1.2345678.

requestedAmountInSettlementCurrency: Amount

The Amount requested to be approved for this AuthorizationAndClearEvent converted to the settlement currency.

cashbackAmount: Amount

The Amount of cashback requested.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetails

The details of the CardDigitalWalletToken at the time of this AuthorizationAndClearEvent event.

AuthorizationEvent

An AuthorizationEvent for a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this AuthorizationEvent or correlate it with other events on this Transaction.

transactionId: IDDeprecated

ID of the transaction

Use transaction instead

transaction: Transaction

The Transaction for this event.

responseCode: TransactionEventResponseCode

The Highnote response code.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this AuthorizationEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this AuthorizationEvent and displayed in the transaction's (local) currency. Does not include fees.

originalAmount: Amount

The original Amount of this AuthorizationEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this AuthorizationEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this AuthorizationEvent.

cardProduct: CardProduct

The CardProduct associated to this AuthorizationEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

collaborativeAuthorizationDetails: CollaborativeAuthorizationDetails

Details if transaction supported collaborative auth

authorizationExpiration: String

The date and time, in ISO 8601 format, the authorization will expire.

spendRuleResults: SpendRuleResultConnection

The triggered spend rules and the results for the authorization.

Input Arguments

first: Int

The number of results to return.

Default Value: 20

after: String

The cursor to start the page.

currentFinancialAccountAvailableToSpendAmount: Amount

The Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

partial: Boolean

Determines whether this authorization was approved for partial or full amount.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the AuthorizationEvent.

additionalTransactionData: [AdditionalTransactionData!]

Additional transaction data for this transaction

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

currencyConversionRate: Float

Conversion rate applied to the requestedAmount to get the requestedAmountConvertedToSettlementCurrency for this AuthorizationEvent.

Can be up to 7 decimal places, e.g. 1.2345678.

requestedAmountInSettlementCurrency: Amount

The Amount requested to be approved for this AuthorizationEvent converted to the settlement currency.

cashbackAmount: Amount

The Amount of cashback requested.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetails

The details of the CardDigitalWalletToken at the time of this AuthorizationEvent event.

AuthorizedAccountHolderPersonRelationship

Represents an authorized relationship where the account holder is a person.

Fields

enabled: Boolean

Whether or not the feature is enabled for the FinancialAccount.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

primaryAccountHolderAccount: FinancialAccount

The FinancialAccount of primary account holder.

primaryAccountAccountHolderParty: AccountHolder

A reference to the primary account holder.

AuthorizedUserApplicationState

A type representing a state of the authorized user application.

Output:OBJECT

Fields

status: AuthorizedUserApplicationStatusCode!

Status of application.

AuthorizedUserCardProductApplication

An AuthorizedUserCardProductApplication.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the application in operations.

applicationState: AuthorizedUserApplicationState

The current state of the application.

adverseActionReasons: [AdverseActionReason!]

A prioritized list of Adverse Action Reasons explaining the Application Deal.

applicationDenialReason: ApplicationDenialReason

The Denial Reason for an Application

authorizedUserSnapshot: AuthorizedUserSnapshot

The authorized user's data at the time of application.

accountHolderCardProductApplication: AccountHolderCardProductApplication

The linked Account Holder Application to which authorized user is applying.

financialAccount: FinancialAccount

The Financial Account to which the account holder is applying.

applicationHistory: AuthorizedUserCardProductApplicationSnapshotConnection

Past states of the application

Input Arguments

first: Int

The number of application snapshots to return.

Default Value: 20

after: String

The cursor to start the page.

applicationWorkflows: [ProductApplicationWorkflow!]

The workflows this application must go through before reaching the APPROVED state

applicationState: AuthorizedUserApplicationState!

The current state of the application.

adverseActionReasons: [AdverseActionReason!]

A list of Adverse Action Reasons explaining the Application Denial.

authorizedUserSnapshot: AuthorizedUserSnapshot

The authorized user's data at the time of application.

accountHolderCardProductApplication: AccountHolderCardProductApplication

The linked Account Holder Application to which authorized user is applying.

financialAccount: FinancialAccount

The Financial Account to which the account holder is applying.

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

Fields

id: ID!

The ID of the transaction event.

responseCode: TransactionEventResponseCode

The Highnote response code.

transaction: Transaction

The Transaction for this event.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this BalanceInquiryEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this BalanceInquiryEvent.

originalAmount: Amount

The original Amount of the BalanceInquiryEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this BalanceInquiryEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this BalanceInquiryEvent.

cardProduct: CardProduct

The CardProduct associated to this BalanceInquiryEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the balance inquiry.

spendRuleResults: SpendRuleResultConnection

The triggered spend rules and the results for the balance inquiry.

Input Arguments

first: Int

The number of results to return.

Default Value: 20

after: String

The cursor to start the page.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the BalanceInquiryEvent.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetails

The details of the CardDigitalWalletToken at the time of the BalanceInquiryEvent event.

BankDetails

The details about the backing bank.

Output:OBJECT

Fields

The name of the financial institution.

address: Address

The address of the financial institution.

BillingCycle

A billing cycle for a credit product.

Output:OBJECT

Fields

currentCycleState: CurrentFinancialAccountDelinquencyState

The delinquency state of this FinancialAccount for this cycle, as of now. Can be CURRENT, DELINQUENT, or CLOSING.

The statement for this BillingCycle.

totalDaysDelinquent: UnsignedInt

If the BillingCycle has a terminal state of DELINQUENT or CLOSING, the number of days since the delinquency started. If the BillingCycle has a terminal state of CURRENT, this value is 0.

amountDelinquent: Amount

The amount delinquent, including any interest or fees, at the close of this cycle.

stateTransitionHistory: [DelinquencyStateTransition]

A list of DelinquencyStateTransitions that overlap with this BillingCycle.

repayments: [CreditRepaymentStatementApplication!]

A list of repayments applied to this billing cycle. Please note that only the first 20 repayments for a cycle will be returned.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was updated.

BillingCycleConfiguration

Billing cycle configuration for account

Output:OBJECT

Fields

id: ID!

Global Id used to reference this billing configuration.

paymentDueDayOfMonth: Int

Payment due day of the month.

Min: 1 Max: 21

billingCycleStartDayOfMonth: Int

Billing cycle start day of the month. The billing cycle starts the day the Financial Account is created.

The billingCycleStartDayOfMonth range is between 1 and 31.

billingCycleEndDayOfMonth: Int

Billing cycle end day of the month.

Min: 4 Max: 24

from: String

The date and time, in ISO 8601 format, from which the billing cycle configuration is valid.

through: String

The date and time, in ISO 8601 format, through which the billing cycle configuration is valid.

upcomingBillingCycleConfiguration: UpcomingBillingCycleConfiguration

The anticipated configuration values for the next upcoming billing cycle.

BillingCycleConnection

The connection type for a BillingCycle.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [BillingCycleEdge!]

A list of edges.

BillingCycleEdge

The edge type for a BillingCycle.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: BillingCycle

The BillingCycle.

BillingCycleOverride

An override of the default billing cycle type.

Output:OBJECT

Fields

billingCycleType: BillingCycleType

Specifies the billing cycle type to override the default behavior. If not provided, the system will use the default billing cycle associated with the product or account.

billingGracePeriod: UnsignedInt

Specifies the billing grace period in days to override the default behavior.

These are the valid value ranges: CHARGE products: 0 to 90 days

REVOLVING and PAY_IN_FULL products: Weekly cycle: 0 to 5 days Biweekly cycle: 0 to 10 days Monthly cycle: 0 to 25 days

Note: values are inclusive, and capped at the max. (eg, if 91 days is provided for a CHARGE product, it will be set to 90 days). If not provided, the system will use the default billing cycle associated with the product.

BusinessAccountHolderIdentityDocumentsRequestedEvent

Indicates that identity verification documents have been requested for a USBusinessAccountHolder.

Output:OBJECT

Fields

businessAccountHolder: USBusinessAccountHolder

The USBusinessAccountHolder for which documents have been requested.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

documentUploadSession: IdentityVerificationDocumentUploadSession

The IdentityVerificationDocumentUploadSession created for the requested documents.

reason: IdentityVerificationDocumentRequestReason

The reason identity verification documents are being requested.

BusinessAccountHolderIdentityUpdatedEvent

Indicates that the identifying information of a USBusinessAccountHolder has been updated.

Output:OBJECT

Fields

businessAccountHolder: USBusinessAccountHolder

The USBusinessAccountHolder which was updated.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

updateTypes: [BusinessAccountHolderIdentityUpdateType!]

The type of each update made, indicating which fields were modified on the USBusinessAccountHolder.

BusinessAuthorizedPersonIdentityDocumentsRequestedEvent

Indicates that identity verification documents have been requested for a USBusinessAuthorizedPerson.

Output:OBJECT

Fields

businessAuthorizedPerson: USBusinessAuthorizedPerson

The USBusinessAuthorizedPerson for which documents have been requested.

businessAccountHolder: USBusinessAccountHolder

The USBusinessAccountHolder to which the USBusinessAuthorizedPerson is associated.

createdAt: String

Fields

isPubliclyTradedOrGovernmentEntity: Boolean!

Whether the business is publicly traded or a government entity. If set to true, then ultimate beneficial owner information is not required.

hasOwnerWithMoreThan25PercentStake: Boolean!

Whether the business has an owner with more than 25% stake in the business.

owners: [OnboardingBusinessAuthorizedPerson!]

Ultimate beneficial owners for the business, owning 25% or more of the business.

The status of ownership information being collected

BusinessPlanCustomerSupportContactInformation

Details on the business' customer support contact information

Output:OBJECT

Fields

url: String

A support URL

email: String

A support email

phone: Phone

A support phone

address: Address

A support address

BusinessPlanIndicatorAttribute

An indicator-type (boolean) business plan attribute on the response.

Output:OBJECT

Fields

type: BusinessPlanIndicatorAttributeType

The type of indicator attribute.

value: Boolean

The boolean value for this indicator.

reportedAt: String

The date the indicator was reported.

Format: YYYY-MM-DD

BusinessPlanOperatingDetails

The business' reported operating details.

Output:OBJECT

Fields

annualVolumes: [BusinessPlanReportedAmount!]

Gross annual revenues per reported year.

largestTickets: [BusinessPlanReportedAmount!]

Largest anticipated sales per reported year.

averageTickets: [BusinessPlanReportedAmount!]

Average anticipated sales per reported year.

largestMonthlyVolumes: [BusinessPlanReportedAmount!]

Largest monthly volumes per reported year.

interactionMethods: [BusinessCustomerInteractionMethod!]

The different points of interaction the business has with their customers.

employeeCounts: [BusinessPlanReportedValue!]

Reported Employee Count

operatingModels: [BusinessPlanOperatingModel!]

Reported Business Operating Models

customerSupportContactInformation: BusinessPlanCustomerSupportContactInformation

Details on the business' customer support contact information

cardPresentSalesPercentage: [BusinessPlanReportedValue!]

Card present sales percentage

cardNotPresentSalesPercentage: [BusinessPlanReportedValue!]

Card not present sales percentage

businessSalesPercentage: [BusinessPlanReportedValue!]

Business to business sales percentage

consumerSalesPercentage: [BusinessPlanReportedValue!]

Business to consumer sales percentage

governmentSalesPercentage: [BusinessPlanReportedValue!]

Government sales percentage

indicatorAttributes: [BusinessPlanIndicatorAttribute!]

Indicator-type business plan attributes (e.g., fuel tax exempt).

BusinessPlanOperatingModel

Business Plan Operating Model.

Output:OBJECT

Fields

type: BusinessPlanOperatingModelType

The business plan operating model.

reportedAsOperatingModel: Boolean

Indicates whether the BusinessPlanOperatingModelType is a reported operating model.

operatingModelDetails: [BusinessPlanOperatingModelDetail!]

Details of the BusinessPlanOperatingModelType.

BusinessPlanOperatingModelForwardCommitment

For those that engage in forward commitments, identifies the timeframe for when contractually obligated sales will be completed

Output:OBJECT

Fields

minimumDays: UnsignedInt

Minimum possible days for the forward commitment

maximumDays: UnsignedInt

Maximum possible days for the forward commitment

reportedOn: Date

The date the forward commitment operating model was reported.

Format: YYYY-MM-DD

BusinessPlanOperatingModelGoodsAndService

Captures the types of goods and services provided by the business.

Output:OBJECT

Fields

goodsAndServicesProvided: [BusinessPlanOperatingGoodsAndServiceCategory!]

The list of products and/or services sold to your customers.

reportedOn: Date

The date the goods and services offered were reported.

Format: YYYY-MM-DD

BusinessPlanOperatingModelSeasonal

Captures when the business operates and whether they have seasonal peaks. Capture the open season or the peak season.

Output:OBJECT

Fields

seasonalRanges: [BusinessPlanOperatingModelSeasonalMonthlyRange!]

A collection of seasonal ranges describing the business operations.

peakMonths: [Month!]

Highest grossing month(s) for the business.

reportedOn: Date

The date the seasonal operating models were reported.

Format: YYYY-MM-DD

BusinessPlanOperatingModelSeasonalMonthlyRange

Represents a monthly start and ending range for seasonality.

Output:OBJECT

id: ID!

Global ID used to reference the business in operations.

accountHolderCurrent: AccountHolder

The account holder.

primaryAuthorizedPerson: BusinessAuthorizedPersonSnapshot

The details of the person authorized to act on behalf of business. Contains verification data at primaryAuthorizedPerson.currentVerification.

businessProfile: ProductApplicantBusinessProfileSnapshot

Information about the business. Contains verification data at businessProfile.currentVerification.

currentVerification: AccountHolderVerificationDeprecated

The current verification attempt, if any, of the business account holder. Deprecated. Check the currentVerification field under businessProfile instead. This field is provided for schema consistency with other snapshot types to prevent field erasure.

use `businessProfile.currentVerification` instead.

createdAt: String

The date and time, in ISO 8601 format, the business account holder was created.

updatedAt: String

The date and time, in ISO 8601 format, the business account holder was last updated.

BusinessUltimateBeneficialOwnerIdentityDocumentsRequestedEvent

Indicates that identity verification documents have been requested for a USBusinessUltimateBeneficialOwner.

Output:OBJECT

Fields

businessUltimateBeneficialOwner: USBusinessUltimateBeneficialOwner

The USBusinessUltimateBeneficialOwner for which documents have been requested.

businessAccountHolder: USBusinessAccountHolder

The USBusinessAccountHolder to which the USBusinessUltimateBeneficialOwner is associated.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

documentUploadSession: IdentityVerificationDocumentUploadSession

The IdentityVerificationDocumentUploadSession created for the requested documents.

reason: IdentityVerificationDocumentRequestReason

The reason identity verification documents are being requested.

BusinessUltimateBeneficialOwnerIdentityUpdatedEvent

Indicates that the identifying information of a USBusinessUltimateBeneficialOwner has been updated.

Output:OBJECT

Fields

businessUltimateBeneficialOwner: USBusinessUltimateBeneficialOwner

The USBusinessUltimateBeneficialOwner which was updated.

businessAccountHolder: USBusinessAccountHolder

The USBusinessAccountHolder for which a USBusinessUltimateBeneficialOwner was updated.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

updateTypes: [BusinessAssociatedPersonIdentityUpdateType!]

The type of each update made, indicating which fields were modified on the USBusinessUltimateBeneficialOwner.

CardAcceptanceMethodBreakdown

The percentage breakdown of how the business accepts card payments

Output:OBJECT

Fields

cardPresent: UnsignedInt!

The percentage of transactions that are card-present

moto: UnsignedInt!

The percentage of transactions in which card information is provided over the phone or through mail

eCommerce: UnsignedInt!

The percentage of transactions that are card-not-present

CardArtDocument

A secure upload link for a card art document upload session

Output:OBJECT

Interfaces

UploadLink

Fields

createdAt: String

The date and time, in ISO 8601 format, this document upload link was created.

documentType: CardArtDocumentType

The document type that was uploaded

documentUploadSession: CardProfileDocumentUploadSession

The session which associates all of the files uploaded using the secure upload link

id: ID!

Global ID used to reference the secure upload link

status: DocumentUploadLinkStatusCode

The status of the upload

updatedAt: String

The date and time, in ISO 8601 format, this document upload link was last updated.

uploadUrl: String

A url to be used to upload the contents of the document.

** Note: ** The maximum file size is 10 MB

downloadUrl: String

a url to be used to download the contents of the document.

CardAuthorizationAndCaptureStep

Deprecated: Reference CardAuthorizationStep and CardCaptureStep instead of CardAuthorizationAndCaptureStep.

Record of an acquiring PaymentTransaction authorization and capture step.

Output:OBJECT

Interfaces

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this object was created.

Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.

events: [PaymentTransactionEvent!]Deprecated

Events associated with this step.

Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.

transaction: PaymentTransactionDeprecated

The PaymentTransaction associated with this step.

Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.

CardAuthorizationStep

Record of an acquiring PaymentTransaction authorizing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CardAuthorizationStepSummary

Record of a payment transaction authorizing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

The PaymentTransactionSummary associated with this event.

CardAuthorizedStep

Record of an acquiring PaymentTransaction authorizing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Use `CardAuthorizationStep` instead.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Use `CardAuthorizationStep` instead.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this object was created.

Use `CardAuthorizationStep` instead.

events: [PaymentTransactionEvent!]Deprecated

Events associated with this step.

Use `CardAuthorizationStep` instead.

transaction: PaymentTransactionDeprecated

The PaymentTransaction associated with this step.

Use `CardAuthorizationStep` instead.

CardCapturedStep

Record of an acquiring PaymentTransaction capturing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Use `CardCaptureStep` instead.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Use `CardCaptureStep` instead.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this object was created.

Use `CardCaptureStep` instead.

events: [PaymentTransactionEvent!]Deprecated

Events associated with this step.

Use `CardCaptureStep` instead.

transaction: PaymentTransactionDeprecated

The PaymentTransaction associated with this step.

Use `CardCaptureStep` instead.

CardCapturePaymentOrderSummary

Record of an PaymentOrder capturing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

The PaymentTransactionSummary associated with this event.

order: PaymentOrder

The PaymentOrder associated with this PaymentTransaction.

CardCaptureStep

Record of an acquiring PaymentTransaction capturing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CardCaptureStepSummary

Record of a payment transaction capturing an amount with a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

The PaymentTransactionSummary associated with this event.

CardCreditedStep

Record of an acquiring PaymentTransaction refunding an amount to a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Use `CardCreditStep` instead.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Use `CardCreditStep` instead.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this object was created.

Use `CardCreditStep` instead.

events: [PaymentTransactionEvent!]Deprecated

Events associated with this step.

Use `CardCreditStep` instead.

transaction: PaymentTransactionDeprecated

The PaymentTransaction associated with this step.

Use `CardCreditStep` instead.

CardCreditStep

Record of an acquiring PaymentTransaction refunding an amount to a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CardCreditStepSummary

Record of a payment transaction refunding an amount to a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

transaction: PaymentCreditTransactionSummary

The PaymentTransactionSummary associated with this event.

CardDataInputCapabilitySpendRule

A Spend Control rule that allows or blocks certain CardDataInputCapability types during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CardDataInputCapabilitySpendRule in operations.

The name assigned to the rule.

allowed: [CardDataInputCapability!]

The CardDataInputCapability types that will be allowed during authorizations.

blocked: [CardDataInputCapability!]

The CardDataInputCapability types that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

CardDataInputCapabilitySpendRuleResult

The result of applying a CardDataInputCapabilitySpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [CardDataInputCapability!]

The tested CardDataInputCapability of the event.

spendRule: CardDataInputCapabilitySpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

CardDigitalWalletToken

A Card Digital Wallet Token which can be used for a card transactions.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Digital Wallet Token in operations.

status: CardDigitalWalletTokenState

The current status of the Digital Wallet Token.

createdAt: String

The date and time, in ISO 8601 format, the Digital Wallet Token was created.

updatedAt: String

The date and time, in ISO 8601 format, the Digital Wallet Token was last updated.

requesterName: String

The name of the requester the Digital Wallet Token was created for.

cardDigitalWalletTokenStateTransitions: CardDigitalWalletTokenStateTransitionConnection

Paginated list of card digital wallet token state transitions associated to a token.

Input Arguments

first: Int

Default Value: 10

after: String

Paginate card digital wallet token state transitions after the specified record.

paymentCard: PaymentCard

The PaymentCard that is associated to the CardDigitalWalletToken

tokenType: CardDigitalWalletTokenType

The Card Digital Wallet Token type.

sourceEntryMethod: CardDigitalWalletTokenSourceEntryMethod

The Card Digital Wallet Token source entry method.

verificationMethods: [CardDigitalWalletTokenVerificationMethod!]

The verification methods used to activate the Card Digital Wallet Token.

additionalWalletTokenDetails: CardDigitalWalletTokenAdditionalInformation

Additional Card Digital Wallet Token information.

requesterIdentifier: String

The identifier assigned to the token requester by the Network.

last4: String

The last four digits of the token primary account number (TPAN).

expirationDate: String

The exact date and time in UTC when the token expires.

CardDigitalWalletTokenActivatedEvent

The CardDigitalWalletTokenActivatedEvent is triggered when a CardDigitalWalletToken has been activated.

Output:OBJECT

Interfaces

CardDigitalWalletTokenEvent

Fields

id: ID!

The ID used to reference the CardDigitalWalletToken in operations.

paymentCardId: ID

Payment card ID for which token was issued.

tokenStatus: DigitalWalletTokenStatus

The current status of the CardDigitalWalletToken.

tokenPreviousStatus: DigitalWalletTokenStatus

The previous status of the CardDigitalWalletToken.

reason: DigitalWalletTokenStatusChangeReason

The reason for the status change.

CardDigitalWalletTokenAdditionalInformation

Additional Card Digital Wallet Token information.

Output:OBJECT

Fields

tokenUniqueReference: String

The Card Digital Wallet Token unique reference.

requesterIdentifier: String

The identifier assigned to the token requester by the Network.

numNetworkActiveTokens: Int

The number of active tokens of the current card.

numActivationAttempts: Int

The number of activation attempts of the Card Digital Wallet Token.

deviceInformation: CardDigitalWalletTokenDeviceInformation

Device information for the Card Digital Wallet Token.

walletProviderDeclineReasons: [String!]

The decision reasons provided by provider.

issuerDeclineReasons: [String!]

The decision reason provided by issuer.

CardDigitalWalletTokenConnection

The connection type for card digital wallet token.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [CardDigitalWalletTokenEdge!]

A list of edges.

CardDigitalWalletTokenDetails

The details of a CardDigitalWalletToken at the time of a transaction event.

Output:OBJECT

Fields

tokenUserApplicationType: TokenUserApplicationType

Indicates the type of application used for the token.

tokenServiceProviderIdentifier: String

Identifies the token service provider managing this token.

cardDigitalWalletTokenCurrent: CardDigitalWalletToken

The CardDigitalWalletToken.

CardDigitalWalletTokenDeviceInformation

The Card Digital Wallet Token device information.

Output:OBJECT

Fields

The device name.

serialNumber: String

The device serial number.

ip: IPAddress

The IP address where the Card Digital Wallet Token is activated.

location: Coordinates

The location where the Card Digital Wallet Token is activated.

formFactor: String

The form factor of the device to be provisioned.

osName: String

The device operating system name.

osVersion: String

The device operating system version.

paymentTypes: [DevicePaymentType!]

The payment types of the Card Digital Wallet Token.

cardStorageType: String

The architecture or technology used for token storage.

cardCaptureType: String

The technology used to capture the card details.

CardDigitalWalletTokenEdge

The edge type for card digital wallet token.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: CardDigitalWalletToken

The card digital wallet token.

CardDigitalWalletTokenStateTransition

State transitions for a card digital wallet token.

Output:OBJECT

Fields

state: CardDigitalWalletTokenState

A state of the card digital wallet token.

reason: CardDigitalWalletTokenStateReason

A reason for the state transition.

CardDigitalWalletTokenEvent

Fields

id: ID!

The ID used to reference the CardDigitalWalletToken in operations.

paymentCardId: ID

Payment card ID for which token was issued.

tokenStatus: DigitalWalletTokenStatus

The current status of the CardDigitalWalletToken.

tokenPreviousStatus: DigitalWalletTokenStatus

The previous status of the CardDigitalWalletToken.

reason: DigitalWalletTokenStatusChangeReason

The reason for the status change.

CardDigitalWalletTokenTerminatedEvent

The CardDigitalWalletTokenTerminatedEvent is triggered when a CardDigitalWalletToken has been terminated.

Output:OBJECT

Interfaces

CardDigitalWalletTokenEvent

Fields

id: ID!

The ID used to reference the CardDigitalWalletToken in operations.

paymentCardId: ID

Payment card ID for which token was issued.

tokenStatus: DigitalWalletTokenStatus

The current status of the CardDigitalWalletToken.

tokenPreviousStatus: DigitalWalletTokenStatus

The previous status of the CardDigitalWalletToken.

reason: DigitalWalletTokenStatusChangeReason

The reason for the status change.

CardDigitalWalletTokenVerificationMethod

The Card Digital Wallet Token verification method.

Output:OBJECT

Fields

type: String

The verification method of the Card Digital Wallet Token activation.

value: String

The value of the verification method. e.g. xxx@gmail.com

CardFundingFinancialAccountFeature

Whether or not the Financial Account supports Card Funding.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

creditLimit: Amount

The credit limit on the FleetCardAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

CardHolder

Used to represent cardHolder data.

Output:OBJECT

Fields

fullName: String

The full name as represented on the card.

email: String

The email address associated with the Card Holder.

billingAddress: Address

The billing address associated with the card.

CardIncrementalAuthorizationStep

Record of an acquiring PaymentTransaction authorized some incremental amount.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CardIncrementalAuthorizedStep

Record of an acquiring PaymentTransaction authorized some incremental amount.

Output:OBJECT

Interfaces

PaymentTransactionEvent

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Use `CardIncrementalAuthorizationStep` instead.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Fields

paymentTransaction: PaymentTransaction

PaymentTransactionEvent

Fields

paymentTransaction: PaymentTransaction

permittedProcessingNetwork: AcquirerNetwork

The permitted processing network where transactions can take place, e.g. Visa

permittedPaymentMethod: PaymentMethod

The permitted payment method, e.g. CARD

permittedTransactionTypes: [CardTransactionProcessingType!]

The permitted types of transactions, e.g., goods and services

acquiringProviderType: AcquiringProviderType

The acquiring provider or sponsor bank

merchantDescriptor: String

The merchant description that will be used for individual transactions

status: ProcessingCapabilityStatus

The status of this CardProcessingCapability.

CardProcessingProductFeature

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not this ProductFeature is enabled for the Product.

createdAt: String

The date and time, in ISO 8601 format, this ProductFeature was created.

updatedAt: String

The date and time, in ISO 8601 format, this ProductFeature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, this ProductFeature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, this ProductFeature was effective through.

supportedNetworks: [PaymentCardNetwork!]

The supported card networks enabled for this Product.

CardProduct

A shared configuration for a group of cards.

Output:OBJECT

Interfaces

Fields

paymentCardTransactionChargebacks: PaymentCardTransactionChargebackConnection

A paginated list of PaymentCardTransactionChargeback for this CardProduct. For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of PaymentCardTransactionChargeback to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: CardProductPaymentCardTransactionChargebacksFilterInput

Filter results to specific PaymentCardTransactionChargeback.

id: ID!

Global ID used to reference the Card Product in operations.

Human-friendly name of the Card Product.

usage: CardUsage

Whether the cards issued for this product are MULTI_USE or SINGLE_USE

vertical: CardProductVertical

The business use case for the Card Product.

commercial: Boolean

Indicates Card Product usage is for commercial purposes.

paymentCards: PaymentCardConnection

The Payment Cards issued to this Card Product.

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

Input Arguments

first: Int

The number of Payment Cards to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: CardProductPaymentCardsFilterInput

Filter results to specific Payment Cards.

transactionEvents: TransactionEventConnection

A paginated list of Transaction Events.

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

Input Arguments

first: Int

The number of Transaction Events to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: CardProductTransactionEventsFilterInput

Filter results to specific Transaction Card Events.

attachedSpendRules: SpendRuleConnection

The spend rules attached to this Card Product.

Input Arguments

first: Int

The number of Spend Rules to return.

Default Value: 20

after: String

The cursor to start the page.

attachedRewardRules: RewardRuleAttachmentConnection

A paginated list of Attached RewardEarnRules.

Input Arguments

first: Int

The number of RewardEarnRules to return.

Max: 20 Min: 1

Default Value: 20

after: String

The cursor to start the page.

attachedRewardRedemptionConfigurations: RewardRedemptionConfigurationAttachmentConnection

A paginated list of Attached RewardRedemptionConfigs.

Input Arguments

first: Int

The number of attached RewardRedemptionConfigurations to return.

Max: 20 Min: 1

Default Value: 20

after: String

The cursor to start the page.

cardProductApplications: AccountHolderCardProductApplicationConnectionDeprecated

The Applications for this Card Product.

Use searchCardProductApplications instead.

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

searchCardProductApplications: SearchCardProductApplicationConnection

Search Applications for this Card Product with a filter.

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

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: CardProductApplicationFilterInput

The filter to apply to the search.

financialAccounts: [FinancialAccount!]Deprecated

The financial account backing this CardProduct.

Use accounts instead.

accounts: FinancialAccountConnection

The financial accounts associated with this CardProduct.

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

Input Arguments

first: Int

after: String

filterBy: AccountHolderFinancialAccountsFilterInput

features: [CardProductFeature!]

The list of features for this CardProduct.

groupOrders: PhysicalCardGroupOrderConnection

The physical card group orders for this CardProduct.

Input Arguments

first: Int

The number of group orders to return.

Default Value: 20

after: String

The cursor to start the page.

attachedVelocityRules: VelocityRuleConnection

The velocity rules attached to this Card Product.

Input Arguments

first: Int

The number of Velocity Rules to return.

Default Value: 20

after: String

The cursor to start the page.

attachedPlatformSpendRules: SpendRuleConnection

The platform spend rules attached to this CardProduct. These are READ ONLY and cannot be modified.

Input Arguments

first: Int

The number of Platform Spend Rules to return.

Default Value: 20

after: String

The cursor to start the page.

first: Int

The number of fee configurations to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FeeScheduleFilterInput

Filter results to specific fee schedule.

attachedInterFinancialAccountTransferRules: InterFinancialAccountTransferRuleConnectionPayload

The inter financial account transfer rules attached to this Card Product.

Input Arguments

first: Int

The number of inter financial account transfer rules to return.

Default Value: 20

after: String

The cursor to start the page.

attachedVelocityInterFinancialAccountTransferRules: VelocityInterFinancialAccountTransferRuleConnectionPayload

The velocity inter financial account transfer rules belonging to this Card Product.

first: Int

The number of CreditPlans to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: CreditPlanFilterInput

Filter results to specific CreditPlans.

cardProfileSets: CardProfileSetConnectionPayload

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

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

Input Arguments

first: Int

The number of CardProfileSets to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FilteredCardProductCardProfileSetsInput

creditConfiguration: CreditCardProductConfiguration

The credit configuration for this CardProduct.

sourceTemplateId: String

The ID for the source template that created this CardProduct.

attachedRealtimeRiskRules: RealtimeRiskRuleConnectionPayload

The realtime risk rules attached to this Card Product.

Input Arguments

first: Int

The number of realtime risk rules to return.

Default Value: 20

after: String

The cursor to start the page.

profiles: [ProductProfile!]

ProductProfiles that are attached to this CardProduct.

CardProductApplicationBusinessMetric

Describes the metrics for applications.

Output:OBJECT

Fields

timeRange: BusinessMetricTimeRange

An ISO 8601 value (inclusive) for the beginning and end date.

createdApplications: CreatedOrApprovedApplicationBusinessMetricAttribute

The created applications.

approvedApplications: CreatedOrApprovedApplicationBusinessMetricAttribute

The approved applications.

deniedApplications: UnsignedInt

The denied applications.

inReviewApplications: UnsignedInt

The in review applications.

pendingApplications: UnsignedInt

The pending applications.

closedApplications: UnsignedInt

The closed applications.

CardProductApplicationBusinessMetricResult

Describes metric Result of card product application metric.

Output:OBJECT

Interfaces

BusinessMetricResult

Fields

timeRange: BusinessMetricTimeRange

An ISO 8601 value (inclusive) for the beginning and end date.

id: ID!

The ID of the CardProfileBin.

length: UnsignedInt

The bin length.

firstDigitsOfBin: String

The first digits of the bin based on the defined bin length.

network: PaymentCardNetwork

The configured card brand.

classification: PaymentCardBinClassification

The payment card bin classification.

fundingModel: PaymentCardBinFundingModel

The payment card bin funding model.

CardProfileDocumentUploadSession

A document upload session for a card profile

Output:OBJECT

Interfaces

Fields

documents: [CardArtDocument!]

A list of documents uploaded via a secure card art document upload link

id: ID!

Global ID used to reference the card art document upload session

The current state of the card art document upload session

updatedAt: String

The date and time, in ISO 8601 format, this document upload session was last updated.

createdAt: String

The date and time, in ISO 8601 format, this document upload session was created.

expiration: String

The date and time the card art document upload session will expire.

cardProduct: CardProduct!

Card Product of the card art document Upload Session.

allowedDocumentTypes: [CardArtDocumentType!]

List of allowed document types for the card art document upload session

CardProfileDuration

Input to pass time in milliseconds.

Output:OBJECT

Fields

timeInMilliseconds: UnsignedInt

Interval in milliseconds.

CardProfileSet

A selected set of Card Profiles for a given card product

Output:OBJECT

Interfaces

CardProfileSetInterface

Fields

id: ID!

ID of the card profile set.

status: CardProfileSetStatus

Status of the card profile set.

Name of the card profile set.

intent: CardProfileSetIntent

Intent of the card profile set.

network: CardProfileSetNetwork

Network of the card profile set.

binDetails: CardProfileBin

The bin details associated with the card profile set.

preferredConfiguration: Boolean

Preferred CardProfileSet configuration

cardProduct: CardProduct

Card Product of the card profile set.

physicalCardProfiles: [PhysicalCardProfile!]

Physical Card Profiles of the card profile set.

digitalCardProfiles: [DigitalCardProfile!]

Digital Card Profiles of the card profile set.

virtualCardProfiles: [VirtualCardProfile!]

Virtual Card Profiles of the card profile set.

createdAt: String

The date and time, in ISO 8601 format, this CardProfileSet was created.

id: ID!

ID of the CardProfileSetRelationship.

cardProfileSet: CardProfileSet

The parent CardProfileSet.

createdAt: String

The date and time, in ISO 8601 format, this CardProfileSetRelationship was created.

updatedAt: String

The date and time, in ISO 8601 format, this CardProfileSetRelationship was last updated.

CardProfileSetRestricted

A selected set of Card Profiles for a given card product

Output:OBJECT

Interfaces

CardProfileSetInterface

Fields

id: ID!

ID of the card profile set.

status: CardProfileSetStatus

Status of the card profile set.

Name of the card profile set.

intent: CardProfileSetIntent

Intent of the card profile set.

network: CardProfileSetNetwork

Network of the card profile set.

cardProductBinAssignmentId: ID

The bin assignment id associated with the card profile set.

preferredConfiguration: Boolean

Preferred CardProfileSet configuration

cardProduct: CardProduct!

Card Product of the card profile set.

physicalCardProfiles: [PhysicalCardProfile!]

Physical Card Profiles of the card profile set.

digitalCardProfiles: [DigitalCardProfile!]

Digital Card Profiles of the card profile set.

virtualCardProfiles: [VirtualCardProfile!]

Virtual Card Profiles of the card profile set.

createdAt: String

The date and time, in ISO 8601 format, this CardProfileSetRestricted was created.

updatedAt: String

The date and time, in ISO 8601 format, this CardProfileSetRestricted was last updated.

description: String

Description about the CardProfileSet.

CardProfileShipment

Output:OBJECT

Fields

courier: CardProfileShipmentCourier

Courier information.

senderDetails: PaymentCardSenderDetails

Sender details.

CardProfileShipmentCourier

The details of the shipping information.

Output:OBJECT

Fields

method: PaymentCardShippingMethod

Shipping method.

signatureRequiredOnDelivery: Boolean

Whether signature is required on delivery.

CardReversalStep

Record of an acquiring PaymentTransaction authorization being canceled.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CardReversalStepSummary

Record of a payment transaction authorization being canceled.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

The PaymentTransaction associated with this step.

CardReversedStep

Record of an acquiring PaymentTransaction authorization being canceled.

Output:OBJECT

Interfaces

Fields

amount: AmountDeprecated

The amount for this PaymentTransaction.

Use `CardReversalStep` instead.

status: PaymentTransactionLifecycleStepStatusDeprecated

The current status for this step.

Use `CardReversalStep` instead.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this object was created.

Use `CardReversalStep` instead.

events: [PaymentTransactionEvent!]Deprecated

Events associated with this step.

Use `CardReversalStep` instead.

transaction: PaymentTransactionDeprecated

The PaymentTransaction associated with this step.

Use `CardReversalStep` instead.

CardTransactionProcessingTypeConditionSpendRule

A rule that will allow or block CardTransactionProcessingType.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the rule in operations.

The name assigned to the rule.

allowed: [CardTransactionProcessingType!]

The list of CardTransactionProcessingType that will be allowed. Min: 1 Max: 5000

blocked: [CardTransactionProcessingType!]

The list of CardTransactionProcessingType that will be blocked. Min: 1 Max: 5000

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

CardTransactionProcessingTypeConditionSpendRuleResult

The result of applying a CardTransactionProcessingTypeConditionSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [CardTransactionProcessingType!]

The tested CardTransactionProcessingType of the event.

spendRule: CardTransactionProcessingTypeConditionSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

CardVerificationStep

Record of an acquiring PaymentTransaction verifying a PaymentMethod.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

Events associated with this step.

transaction: PaymentTransaction

The PaymentTransaction associated with this step.

CatalogItem

An defined item that can be added to an PaymentOrder.

Output:OBJECT

Fields

id: ID!

The ID of the CatalogItem.

The name of the CatalogItem.

description: String

The description of the CatalogItem.

amountPerItem: Amount

The amount for this CatalogItem per individual item.

paymentInstructions: [PaymentInstruction!]

Breakdown of the payment instructions for the CatalogItem by Amount.

externalIdentifier: String

An optional external reference ID for this PaymentOrderItem.

ChargebackExternalNetwork

The external network of the chargeback.

Output:OBJECT

Fields

networkType: ChargebackExternalNetworkType

The external network of the chargeback.

externalNetworkId: ID!

The external network id of the chargeback.

ChargeCardProductFeature

Whether or not the CardProduct supports charge.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

ChargedFeeTransfer

Charged fee transfer. Fees are charged to the account holder and transferred from

account holder financial account to income financial account.

Output:OBJECT

Fields

originatingAccount: FinancialAccount

The Financial account of account holder from where the fee is deducted.

receivingAccount: FinancialAccount

The income financial account of receiving fees.

cardProduct: CardProduct

The Card product associated with the financial activity from the account holder that triggered the fee charge.

feeActivityType: FeeTransferEventFeeActivityType

The activity for which the fee is charged.

feeAmount: Amount

The configured fee amount.

transferedFeeAmount: AmountDeprecated

The actual fee amount charged.

Use feeTransferAmount instead.

transferDate: String

The date and time, in ISO 8601 format, the fee was charged.

The Fee transfer event status.

feeChargeRule: FeeChargeRule

Fee charge rule that was applied to this fee transfer event.

feeChargeActvity: FeeChargeActivity

Details of the charge activity of account holder that is triggering fee transfer event.

feeTransferAmount: Amount

The actual fee amount charged.

CheckCapableAccountFeature

Whether or not the FinancialAccount is capable of sending checks.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

CheckPayment

An object representing a check.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

status: CheckPaymentStatus

The current status of the check.

failureReason: CheckPaymentFailureReason

The reason for the check failure, if applicable.

events: [CheckPaymentEvent!]

A list of events that the CheckPayment has gone through.

amount: Amount

The amount of the check.

recipient: CheckPaymentRecipient

The recipient of the check.

checkType: CheckPaymentType

The type of the check: digital or physical.

shippingTime: CheckPaymentShippingTime

The delivery type of the check.

createdAt: String

The date and time, in ISO 8602 format, this object was created.

updatedAt: String

The date and time, in ISO 8602 format, this object was updated.

financialAccount: FinancialAccount

The FinancialAccount that funded the check.

imageUri: String

The location of the check image.

checkNumber: String

The number of the check.

CheckPaymentDocumentUploadSession

A document upload session for CheckPayment.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the document upload session

The current state of the document upload session

createdAt: String

The date and time, in ISO 8601 format, this document upload session was created.

updatedAt: String

The date and time, in ISO 8601 format, this document upload session was last updated.

documents: [UploadLink!]

A list of documents uploaded via a secure document upload link

allowedDocumentTypes: [CheckPaymentDocumentType!]

List of allowed document types for the CheckPayment upload session

CheckPaymentEvent

An object representing a check event type change.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

type: CheckPaymentEventType

The event type of check at the time of the event.

failureReason: CheckPaymentFailureReason

The reason for the check failure, if applicable.

createdAt: String

The date and time, in ISO 8602 format, this event occurred.

checkPayment: CheckPayment

The checkPayment associated with this event.

CheckPaymentRecipient

An object representing a check recipient.

Output:OBJECT

Fields

The name of the recipient of the check.

cursor: String!

The cursor for this edge for use in pagination.

ClearedTransactionBusinessMetricAttribute

Describes attributes of a cleared transaction metric.

Output:OBJECT

Fields

The total number of cleared transactions.

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this ClearingEvent or correlate it with other events on this Transaction.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: IDDeprecated

ID of the transaction

Use transaction instead

transaction: Transaction

The Transaction for this event.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this ClearingEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this ClearingEvent and displayed in the transaction's (local) currency. Does not include fees.

originalAmount: Amount

The original Amount of the AuthorizationEvent related to this ClearingEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this ClearingEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this ClearingEvent.

cardProduct: CardProduct

The CardProduct associated to this ClearingEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the clear.

additionalTransactionData: [AdditionalTransactionData!]

Level 2 / Level 3 transaction data for this transaction

currentFinancialAccountAvailableToSpendAmount: Amount

The Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

disputes: [PaymentCardTransactionDispute!]

Disputes on this ClearingEvent.

partial: Boolean

Determines whether this is a partial or full clear for an authorization.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the ClearingEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

issuerStandInEnabled: Boolean

Indicates usage of card product's default settings to determine authorization decision when a CollaborativeAuthorizationEndpoint fails to respond.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

CollaborativeAuthorizationDetails

Details regarding your responses and settings for collaborative authorization on a transaction

Output:OBJECT

Fields

responseCode: CollaborativeAuthorizationResponseCode

Response code returned by you in collaborative authorization flow. This Response code is set to TIMEOUT if the platform does not receive a response within the allotted time. If an error occurred while receiving your response, the response code will be set to ERROR

authorizedAmount: Amount

The Amount you authorized for the transaction. Value will be ZERO if you responded with an invalid amount or did not provide an amount.

currentProductStandIn: CollaborativeAuthorizationStandIn

The state of the product's stand-in value at the time this event was processed, which determines whether transactions are approved or declined in the case of a timeout in the collaborative authorization flow.

CollaborativeAuthorizationEndpoint

A collaborative authorization endpoint.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CollaborativeAuthorizationEndpoint in operations.

The name of the CollaborativeAuthorizationEndpoint.

uri: String

The URI to send collaborative authorization requests.

createdAt: String

The date and time, in ISO 8601 format, the CollaborativeAuthorizationEndpoint was created.

updatedAt: String

The date and time, in ISO 8601 format, the CollaborativeAuthorizationEndpoint was most recently updated.

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

pastDueAmount: Amount

The past due balance on the Financial Account as of the close of the statement’s billing cycle.

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

accumulatedAccountInterestAndFees: AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated as it relates to a FinancialAccountStatement.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CommercialChargeCardFinancialAccountStatementEntry

Statement entry for Commercial Charge

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CommercialChargeCardFinancialAccountStatementSnapshot

Current account snapshot for a commercial charge card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

currentAmountDue: Amount

The ending balance from the latestClosedStatement, minus any payments that have been cleared and processed.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CommercialCreditPayInFullCardAccountFeature

Whether or not the Financial Account supports a Commercial Credit Pay In Full Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

creditLimit: Amount

The credit limit on the CommercialCreditPayInFullCardAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

CommercialRevolvingCardFinancialAccountStatement

Statement for commercial revolving card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodInterestCharges: Amount

The total from interest for the statement period.

periodInterestCredit: Amount

The total interest credit (for example due to waiving interest) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

pastDueAmount: Amount

The past due balance on the Financial Account as of the close of the statement’s billing cycle.

periodPurchaseCreditPlan: [FinancialAccountStatementPurchaseCreditPlan!]

Period's purchase details by Credit Plan for the statement

periodInstallmentActivity: [FinancialAccountStatementInstallmentCreditPlanActivity!]

InstallmentAgreement activity for this statement.

payOffWarning: FinancialAccountStatementPayOffWarning

Payoff warning for the statement when balance is greater than zero

periodMinimumPaymentDue: Amount

Period's minimum payment due to the statement

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

accumulatedAccountInterestAndFees: AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated as it relates to a FinancialAccountStatement.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CommercialRevolvingCardFinancialAccountStatementEntry

Statement entry for Commercial Revolving

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CommercialRevolvingCardFinancialAccountStatementSnapshot

Current account snapshot for a commercial revolving card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

currentAmountDue: Amount

The ending balance from the latestClosedStatement, minus any payments that have been cleared and processed.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConditionalRuleSetSpendRule

A rule that combines multiple other spend rule results together in an all or none approach. Must be used as a cumulativeRule for a VelocityRule with a PER_TRANSACTION window. The resulting VelocityRule will have a passing result if all spendRules on the VelocityRule pass or if all spendRules on the VelocityRule fail.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the rule in operations.

The name assigned to the rule.

allow: Boolean

The action to apply to the transaction event, if the rule passes

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

ConsentAgreement

Details on the acceptance of terms and conditions

Output:OBJECT

Fields

primaryAuthorizedPerson: ConsentingParty

This field represents the consenting party

consentTimestamp: String

The date and time, in ISO 8601 format, marking when the ConsentingParty accepted the agreement

For example, 2022-01-01T22:00:00.000Z.

consentIpAddress: IPAddress

The IPAddress of the ConsentingParty when they accepted the agreement.

ConsumerChargeCardFinancialAccountStatement

Statement for consumer charge card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

pastDueAmount: Amount

The past due balance on the Financial Account as of the close of the statement’s billing cycle.

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

accumulatedAccountInterestAndFees: AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated as it relates to a FinancialAccountStatement.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerChargeCardFinancialAccountStatementEntry

Statement entry for consumer charge card

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerChargeCardFinancialAccountStatementSnapshot

Current account snapshot for a consumer charge card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

currentAmountDue: Amount

The ending balance from the latestClosedStatement, minus any payments that have been cleared and processed.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerPrepaidCardFinancialAccountStatement

Statement for consumer prepaid card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerPrepaidCardFinancialAccountStatementEntry

Statement entry for consumer prepaid card

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerPrepaidCardFinancialAccountStatementSnapshot

Current account snapshot for a consumer prepaid card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerRevolvingCardFinancialAccountStatement

Statement for consumer revolving card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodInterestCharges: Amount

The total from interest for the statement period.

periodInterestCredit: Amount

The total interest credit (for example due to waiving interest) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

pastDueAmount: Amount

The past due balance on the Financial Account as of the close of the statement’s billing cycle.

periodPurchaseCreditPlan: [FinancialAccountStatementPurchaseCreditPlan!]

Period's purchase details by Credit Plan for the statement

periodInstallmentActivity: [FinancialAccountStatementInstallmentCreditPlanActivity!]

InstallmentAgreement activity for this statement.

payOffWarning: FinancialAccountStatementPayOffWarning

Payoff warning for the statement when balance is greater than zero

periodMinimumPaymentDue: Amount

Period's minimum payment due to the statement

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

accumulatedAccountInterestAndFees: AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated as it relates to a FinancialAccountStatement.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerRevolvingCardFinancialAccountStatementEntry

Statement entry for consumer revolving card

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

ConsumerRevolvingCardFinancialAccountStatementSnapshot

Current account snapshot for a consumer revolving card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

The fee charge condition count used with COUNT condition type.

maximumCount: Int

The fee charge condition maximum count used with COUNT condition type. Used with BETWEEN condition operator.

CountLimitCheckRule

A CheckRule that will put a check on hold if the number of checks is exceeded.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CountLimitCheckRule in operations.

The name assigned to the rule.

maximumCount: Int

The maximum number of checks to allow.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

revisions: CheckRuleConnection

The list of revisions for this check rule.

Input Arguments

first: Int

The number of revisions to return. Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the rule was last updated.

CountLimitInterFinancialAccountTransferRule

A InterFinancialAccountTransferRule that will put an inter financial account transfer on hold if the count is exceeded. This TransferRule must be used in a VelocityInterFinancialAccountTransferRule.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CountLimitInterFinancialAccountTransferRule in operations.

The name assigned to the rule.

maximumCount: Int

The maximum count of inter financial account transfers to allow.

interFinancialAccountTransferAccountType: InterFinancialAccountTransferAccountType

Indicates the account type to monitor.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

revisions: InterFinancialAccountTransferRuleConnection

The list of revisions for this transfer rule.

Input Arguments

first: Int

The number of revisions to return.

Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the transfer rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer rule was last updated.

CountLimitSpendRule

A Spend Control rule that limits the number of allowed transactions.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Count Limit Spend Rule in operations.

The name assigned to the rule.

maximumCount: Int

The maximum count of transactions to allow.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

CreateCardProductWithTemplate

The return type for createCardProductWithTemplate

Output:OBJECT

Fields

cardProduct: CardProduct!

The resulting CardProduct.

CreatedOrApprovedApplicationBusinessMetricAttribute

Describes attributes of an approved application metric.

Output:OBJECT

Fields

total: UnsignedInt

The total number of approved or created applications.

authorizedUsers: UnsignedInt

The total authorized user number.

accountHolders: UnsignedInt

The total account holder number.

CreateUnifiedFundsTransferQuoteResult

The result of createUnifiedFundsTransferQuote.

Output:OBJECT

Fields

quotes: [UnifiedFundsTransferQuote!]

The UnifiedFundsTransfers that can be offered to the end user for them to accept, and then initiate the transfer.

CreditAccountAgingCardProductConfiguration

The account aging configuration available on a CardProduct. For example, the number of days until a payment is due, and until an account is considered DELINQUENT, SUSPENDED, or CLOSED.

Output:OBJECT

Fields

delinquentInDays: UnsignedInt

The number of days between when a payment is due and when a FinancialAccount becomes delinquent if the payment is not made.

suspendedInDays: UnsignedInt

The number of days between when a payment is due and when a FinancialAccount becomes suspended if the payment is not made.

chargeOffInDays: UnsignedInt

The number of days between when a payment is due and when a FinancialAccount becomes closed if the payment is not made.

lateFeeGracePeriodInDays: UnsignedInt

The number of days between when a payment is assessed (cycle close date) and when it is due.

CreditBillingCycleCardProductConfiguration

The billing statement configuration available on a CardProduct.

Output:OBJECT

Fields

billingCyclePeriod: CreditStatementCyclePeriod

Whether statement cycles are WEEKLY or MONTHLY. Please note that WEEKLY cycles must have a FIXED grace period and MONTHLY cycles must have a FLOATING grace period.

billingCycleGracePeriodType: CreditStatementGracePeriodType

Whether the grace period is FLOATING or FIXED. Please note that WEEKLY cycles must have a FIXED grace period and MONTHLY cycles must have a FLOATING grace period.

billingCycleGracePeriodInDays: UnsignedInt

Number of days included in the grace period

billingCyclePaymentDueNotificationsDays: [UnsignedInt!]

Number of days before payment is due to send notification(s).

Examples: With Due Date of 1/15 and a Grace Period of 10 days, billingCyclePaymentDueNotificationDays of [5,3,1] would produce notifications on 1/10, 1/12, and 1/14."

CreditCardAccountFeature

Whether or not the Financial Account supports a Credit Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

creditLimit: Amount

The credit limit on the CreditCardAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

CreditCardInterestAccrual

Details about interest accrual.

Output:OBJECT

Fields

financialAccount: FinancialAccount

The FinancialAccount associated with this CreditCardInterestAccrual.

cardProduct: CardProduct

The CardProduct associated with this CreditCardInterestAccrual.

creditPlan: CreditPlan

The CreditPlan associated with this CreditCardInterestAccrual.

The FinancialAccountStatement associated with this CreditCardInterestAccrual.

transferAmount: Amount

The Amount of interest accrued for this CreditCardInterestAccrual.

apr: Float

The relevant annual percentage rate (APR) for the interest charged.

createdAt: String

The date and time, in ISO 8601 format, this CreditCardInterestAccrual took place.

CreditCardInterestReversal

Details about interest reversal.

Output:OBJECT

Fields

financialAccount: FinancialAccount

The FinancialAccount associated with this CreditCardInterestReversal.

cardProduct: CardProduct

The CardProduct associated with this CreditCardInterestReversal.

creditPlan: CreditPlan

The CreditPlan associated with this CreditCardInterestReversal.

The FinancialAccountStatement associated with this CreditCardInterestReversal.

transferAmount: Amount

The Amount of interest reversed for this CreditCardInterestReversal.

createdAt: String

The date and time, in ISO 8601 format, this CreditCardInterestReversal took place.

sourceInterestAccrual: CreditCardTransferEvent

The source CreditCardTransferEvent whose interest was waived.

CreditCardProductConfiguration

The credit configuration values available on a CardProduct. For example, account aging, minimum payment, and repayment configuration.

Output:OBJECT

Fields

accountAging: CreditAccountAgingCardProductConfiguration

The account aging configuration available on a CardProduct. For example, the number of days until a payment is due, and until an account is considered DELINQUENT, SUSPENDED, or CLOSED.

minimumPayment: CreditMinimumPaymentCardProductConfiguration

The minimum payment configuration available on a CardProduct. For example, whether the minimum payment includes the past due amount, interest, and fees. Used for Revolving Card Products only.

repayment: CreditRepaymentCardProductConfiguration

The repayment configuration available on a CardProduct. Used for Revolving Card Products only.

interest: CreditInterestApplicationCardProductConfiguration

The interest configuration available on a CardProduct. Used for Revolving Card Products only.

billingCycleConfiguration: CreditBillingCycleCardProductConfiguration

The billing statement configuration available on a CardProduct. Used for Revolving Card Products only.

CreditCardTransferEvent

A financial event that represents a credit card transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

balanceType: CreditBalanceTypeDeprecated

The type of balance this CreditPlan applies to. For example, PURCHASE, CASH_ADVANCE, INSTALLMENT, or BALANCE_TRANSFER.

please use balanceType on creditPlan in creditCardInterestTransferEvent field instead

interestDetails: InterestDetailsDeprecated

Details about the interest that will be charged, such as the annual percentage rate (APR).

please use apr in creditCardInterestTransferEvent field instead

accountingDirection: AccountingDirectionDeprecated

The direction funds are moving in the perspective of the customer.

when DEBIT, funds are moving out of the customer's account
when CREDIT, funds are moving into the customer's account

not in use

statement: FinancialAccountStatementDeprecated

The FinancialAccountStatement associated with this event.

please use statement in creditCardInterestTransferEvent field instead

creditPlan: CreditPlanDeprecated

The CreditPlan associated with this event.

please use creditPlan in creditCardInterestTransferEvent field instead

creditCardInterestTransferEvent: CreditCardInterestTransfer

The CreditCardInterestTransfer, such as a CreditCardInterestAccrual or CreditCardInterestReversal, represented by this CreditCardTransferEvent.

CreditFinancialAccountConfiguration

The credit configuration for this FinancialAccount.

Output:OBJECT

Fields

servicemembersCivilReliefAct: ServicemembersCivilReliefActConfiguration

The Servicemembers Civil Relief Act (SCRA) configuration for this FinancialAccount.

militaryLendingAct: MilitaryLendingActConfiguration

The Military Lending Act (MLA) configuration for this FinancialAccount.

interestRates: [CreditPlanFinancialAccountConfiguration!]Deprecated

A list of credit plan configurations for this FinancialAccount.

Please use `purchasePlans` on `FinancialAccount` instead.

CreditFunds

A credit transfer to a Highnote account.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the externally initiated ACH transfer.

companyName: String

The name of the company that initiated the ACH transfer.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID of the company that initiated the ACH transfer, ISO 8601 format.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

toFinancialAccount: FinancialAccount

The Highnote account receiving the credit.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

CreditFundsACHTransferEvent

A financial event that represents a CreditFunds transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The status of the externally initiated ACH transfer.

toFinancialAccount: FinancialAccount

The account receiving the funds.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

CreditInterestApplicationCardProductConfiguration

The interest calculation configuration available on a CardProduct.

Output:OBJECT

Fields

includesPurchase: Boolean

Whether or not to include purchase amount when calculating interest.

includesFees: Boolean

Whether or not to include fees when calculating interest.

CreditLedgerEntry

A ledger entry of type credit, it represents the portion of a financial event where a Ledger had money credited to it.

Output:OBJECT

Interfaces

LedgerEntry

Fields

id: ID!

The unique id of the CreditLedgerEntry.

financialAccount: FinancialAccount

A FinancialAccount backed by the Ledger that this ledger entry belongs to.

journalEntry: JournalEntry

A JournalEntry showing this CreditLedgerEntry and its offsetting DebitLedgerEntry.

ledger: Ledger

Ledger that CreditLedgerEntry belongs to.

amount: Amount

The Amount of the CreditLedgerEntry.

memo: String

The optional memo of the CreditLedgerEntry.

financialEvent: FinancialEvent

The event that triggered the ledger entry.

createdAt: String

The date and time, in ISO 8601 format, this ledger entry was created.

creditBalanceAtLedgerEntry: Amount

The credit balance that is the result of the ledger entry.

debitBalanceAtLedgerEntry: Amount

The debit balance that is the result of the ledger entry.

CreditLimitChangeRequest

A review of the credit limit on a FinancialAccount to either increase or decrease it.

Output:OBJECT

Interfaces

AccountReview

Fields

id: ID!

The Global ID of this CreditLimitChangeRequest

financialAccountId: ID!Deprecated

The Global ID of the FinancialAccount in review.

use financialAccount instead

financialAccount: FinancialAccount

The FinancialAccount in review.

status: CreditLimitChangeRequestStatus

The status of the CreditLimitChangeRequest.

statusHistory: [CreditLimitChangeRequestStatusHistory!]

The status history of the CreditLimitChangeRequest.

requestedChange: CreditLimitChangeRequestDetails

Details about the CreditLimitChangeRequest.

existingCreditLimit: Amount

The credit limit before the review.

updatedCreditLimit: Amount

The updated credit limit.

customerDetails: CreditLimitChangeRequestCustomerDetails

Details collected about the customer.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was updated.

closedAt: String

The date and time, in ISO 8601 format, this was closed.

CreditLimitChangeRequestCustomerDetails

Details collected about the customer.

Output:OBJECT

Fields

currentDebtObligations: [Amount!]

The current debt obligations amount used for this decision.

annualIncome: [Amount!]

The annual income amount used for this decision.

annualRevenue: [Amount!]

The annual revenue amount used for this decision. Only applicable for business accounts.

adverseActionReasons: [AdverseActionReason!]

The adverse action reason(s) why an increase request is denied or if a decrease request is approved.

externalFinancialAccountBalance: [Amount!]

The external bank balance used for this decision.

CreditLimitChangeRequestDetails

Details about the requested credit limit change.

Output:OBJECT

Fields

requestedChangeType: CreditLimitChangeRequestType

The type of CreditLimitChangeRequest, whether INCREASE or DECREASE.

requestedCreditLimit: Amount

The requested credit limit.

requestor: CreditLimitChangeRequestor

The type of requestor, whether CUSTOMER or SUBSCRIBER.

CreditLimitChangeRequestStatusChangedEvent

An event that occurs when a CreditLimitChangeRequest has a change in status.

Output:OBJECT

Fields

creditLimitChangeRequestId: ID

Unique identifier for the CreditLimitChangeRequest.

financialAccountId: ID

The identifier of the FinancialAccount associated with this request.

creditLimitChangeRequestType: CreditLimitChangeRequestType

The type of change request, whether INCREASE or DECREASE.

creditLimitChangeRequestStatus: CreditLimitChangeRequestStatus

The status of the change request.

creditLimitChangeRequestFailureReason: CreditLimitChangeRequestFailureReason

Details about a failure status.

createdAt: String

The date and time in ISO 8601 format this was created.

updatedAt: String

The date and time in ISO 8601 format this was updated.

CreditLimitChangeRequestStatusHistory

CreditLimitChangeRequest status history.

Output:OBJECT

Fields

previousStatus: CreditLimitChangeRequestStatus

The previous status.

newStatus: CreditLimitChangeRequestStatus

The new status.

createdAt: String

The date and time when the status changed, in ISO 8601 format.

CreditLimitPercentageSpendRule

A Spend Control rule that blocks transactions if the amount is above a configured percentage of the account's credit limit.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CreditLimitPercentageSpendRule in operations.

The name assigned to the rule.

maximumPercentageOfCreditLimit: UnsignedInt

The maximum percentage of the credit limit allowed for a transaction before transactions are declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

CreditLimitPercentageSpendRuleResult

The result of applying a CreditLimitPercentageSpendRule to an event.

Output:OBJECT

Interfaces

CreditPayInFullCardFinancialAccountStatement

Statement for credit pay in full card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

pastDueAmount: Amount

The past due balance on the Financial Account as of the close of the statement’s billing cycle.

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

accumulatedAccountInterestAndFees: AccumulatedAccountInterestAndFees

The interest and fees that an account has accumulated as it relates to a FinancialAccountStatement.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CreditPayInFullCardFinancialAccountStatementEntry

Statement entry for credit pay in full card

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CreditPayInFullCardFinancialAccountStatementSnapshot

Current account snapshot for a credit pay in full card

Output:OBJECT

Interfaces

FinancialAccountDelinquency

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

currentAmountDue: Amount

The ending balance from the latestClosedStatement, minus any payments that have been cleared and processed.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

CreditPayInFullFinancialAccountDelinquency

Delinquency for a FinancialAccount associated with a credit pay in full product.

Output:OBJECT

Interfaces

Fields

delinquencyStartedOn: String

The due date of the oldest contiguous delinquent Statement. Null if the FinancialAccount is not currently delinquent.

totalDaysDelinquent: UnsignedInt

Number of days since the due date of the oldest contiguous delinquent statement. 0 if the FinancialAccount is not currently delinquent.

totalAmount: Amount

The current amount deliquent, including any interest or fees, for this FinancialAccount.

numberOfCycles: UnsignedInt

Count of contiguous delinquent cycles for this FinancialAccount. 0 if the FinancialAccount is not currently delinquent.

currentDelinquentCycles: [CreditPayInFullFinancialAccountDelinquencyCycle]

A list of contiguous billing cycles where this FinancialAccount was delinquent.

CreditPayInFullFinancialAccountDelinquencyCycle

A billing cycle where a FinancialAccount associated with a credit pay in full product is delinquent at some point.

Output:OBJECT

Interfaces

FinancialAccountDelinquencyCycle

Fields

statementId: ID!

The unique identifier for the financial account statement for this billing cycle.

statement: CreditPayInFullCardFinancialAccountStatement

The financial account statement for this billing cycle. Includes information such as periodStart, periodEnd, and paymentDueOn.

daysDelinquent: UnsignedInt

Days elapsed between the due date of the oldest contiguous delinquent cycle and the periodEnd of this cycle.

amount: Amount

The amount delinquent, including any interest or fees, at the periodEnd of this cycle.

totalRepaymentsApplied: Amount

The total Amount of repayments applied to this billing cycle.

repayments: [CreditRepaymentStatementApplication!]

A list of repayments applied to this billing cycle. Please note that only the first 20 repayments for a cycle will be returned.

state: FinancialAccountDelinquencyState

The delinquency state of this FinancialAccount at the periodEnd of this cycle, such as CURRENT, DELINQUENT, or CLOSING.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was last updated.

CreditPaymentCardFinancialAccountFeature

Deprecated. Please use CreditCardAccountFeature instead.

Whether or not the Financial Account supports a Credit Payment Card.

Output:OBJECT

Interfaces

Fields

enabled: BooleanDeprecated

Whether or not the feature is enabled for the Financial Account.

CreditPaymentCardFinancialAccountFeature is deprecated. Please use CreditCardAccountFeature instead.

createdAt: StringDeprecated

The date and time, in ISO 8601 format, the feature was created.

CreditPaymentCardFinancialAccountFeature is deprecated. Please use CreditCardAccountFeature instead.

updatedAt: StringDeprecated

The date and time, in ISO 8601 format, the feature was last updated.

CreditPaymentCardFinancialAccountFeature is deprecated. Please use CreditCardAccountFeature instead.

effectiveFrom: StringDeprecated

The date and time, in ISO 8601 format, the feature was effective from.

CreditPaymentCardFinancialAccountFeature is deprecated. Please use CreditCardAccountFeature instead.

effectiveThrough: StringDeprecated

The date and time, in ISO 8601 format, the feature was effective through.

CreditPaymentCardFinancialAccountFeature is deprecated. Please use CreditCardAccountFeature instead.

CreditPlan

CreditPlans define the credit and interest terms of a credit CardProduct. For example, they include the interest rate (APR), the way interest will accrue and be assessed, and the effective dates of the plan.

Output:OBJECT

Interfaces

Fields

id: ID!

The globally unique identifier for this CreditPlan.

The name for this CreditPlan. Supports up to 255 alphanumeric characters. Does not need to be unique.

status: CreditPlanStatus

The status of this CreditPlan. For example, ACTIVE, INACTIVE, or DEPRECATED.

planType: CreditPlanType

The type of CreditPlan. For example, STANDARD or PROMOTIONAL.

balanceType: CreditBalanceType

The type of transaction this CreditPlan applies to. For example, PURCHASE, CASH_ADVANCE, INSTALLMENT, or BALANCE_TRANSFER.

riskBasedPricingPolicy: RiskBasedPricingPolicy

The risk based pricing policy for this CreditPlan.

percentageOfCreditLimit: UnsignedInt

The percentage of the FinancialAccount's credit limit that will be available for this CreditPlan.

interestPolicy: CreditPlanInterestPolicy

The interest policy for this CreditPlan.

installmentPolicy: CreditPlanInstallmentPolicy

The installment policy for this CreditPlan.

promotionalPolicy: CreditPlanPromotionalPolicy

For PROMOTIONAL plans, the promotional policy for this CreditPlan.

feeSchedule: FeeSchedule

The FeeSchedule attached to this CreditPlan.

effectiveFromDate: Date

The date this plan starts to be in effect for new FinancialAccounts, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15.

effectiveThroughDate: Date

The date this plan stops being in effect for new FinancialAccounts, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-02-15. If null, the plan is treated as indefinite, with no set ending.

balanceType: CreditBalanceType

The type of balance this configuration applies to. For example, PURCHASE, CASH_ADVANCE, INSTALLMENT, or BALANCE_TRANSFER.

interest: InterestDetails

Details about the interest that will be charged, such as the annual percentage rate (APR).

creditPlan: CreditPlan

The CreditPlan this configuration applies to.

CreditPlanInstallmentPolicy

The installment policy for this CreditPlan.

Output:OBJECT

Fields

numberOfPeriods: UnsignedInt

The number of periods for an InstallmentAgreement based on this CreditPlan.

principalAmountRange: AmountRange

The minimum and maximum cleared Amount a Transaction can have to be eligible to convert into installments.

CreditPlanInterestPolicy

The interest policy for this CreditPlan.

Output:OBJECT

Fields

rateType: InterestRateType

Whether the interest rate is fixed or variable.

index: InterestRateIndexConfiguration

For variable interest rates only. The current configuration of the index used to derive the variable APR.

accrualType: InterestAccrualType

Whether interest accrues using a SIMPLE or COMPOUND formula.

accrualMethod: InterestAccrualMethod

The date used to calculate interest accrual. For example, TRANSACTION_POST_DATE, FIRST_DAY_OF_BILLING_PERIOD, or PAYMENT_DUE_DATE.

assessmentSchedule: InterestAssessmentSchedule

Whether interest is assessed DAILY or on the STATEMENT cycle close date.

defaultApr: Float

The default interest rate (APR) for this CreditPlan, expressed as a Float with up to 3 digit precision after the decimal point.

scraApr: Float

The Servicemembers Civil Relief Act (SCRA) interest rate for this CreditPlan, expressed as a Float with up to 3 digit precision after the decimal point.

CreditPlanPromotionalPolicy

The promotional policy for this CreditPlan.

Output:OBJECT

Fields

duration: CreditPlanDuration

The number of units this CreditPlan will be in effect for a given FinancialAccount once it is enrolled in this CreditPlan.

CreditPlanTemplate

CreditPlanTemplates provide a base configuration for creating a CreditPlan. For example, they define the interest policy, the transaction and plan types, and the maximum credit limit allowed by the CreditPlan.

Output:OBJECT

Interfaces

Fields

id: ID!

The globally unique identifier for this CreditPlanTemplate.

The name for this CreditPlanTemplate. Supports up to 255 alphanumeric characters. Does not need to be unique.

status: CreditPlanTemplateStatus

The status of this CreditPlanTemplate. For example, ACTIVE, INACTIVE, or DEPRECATED.

planType: CreditPlanType

The type of CreditPlan this template supports. For example, STANDARD or PROMOTIONAL.

balanceType: CreditBalanceType

The type of transaction this CreditPlanTemplate applies to. For example, PURCHASE, CASH_ADVANCE, INSTALLMENT, or BALANCE_TRANSFER.

riskBasedPricingPolicy: RiskBasedPricingPolicy

The risk based pricing policy for this CreditPlanTemplate.

interestPolicy: CreditPlanTemplateInterestPolicy

The interest policy for this CreditPlanTemplate.

installmentPolicy: CreditPlanTemplateInstallmentPolicy

The installment policy for this CreditPlanTemplate.

promotionalPolicy: CreditPlanTemplatePromotionalPolicy

The promotional policy for this CreditPlanTemplate.

maximumCreditLimit: Amount

The maximum credit limit allowed by this plan, expressed as an Amount.

rateType: InterestRateType

Whether the interest rate is fixed or variable.

accrualType: InterestAccrualType

Whether interest accrues using a SIMPLE or COMPOUND formula.

accrualMethod: InterestAccrualMethod

The date used to calculate interest accrual. For example, TRANSACTION_POST_DATE, FIRST_DAY_OF_BILLING_PERIOD, or PAYMENT_DUE_DATE.

assessmentSchedule: InterestAssessmentSchedule

Whether interest is assessed DAILY or on the STATEMENT cycle close date.

aprRange: InterestRateRange

The range of potential interest rates (APRs) available through this CreditPlanTemplate.

variableAprIndex: InterestRateIndex

The index used for interest rate calculation. For example, PRIME or LIBOR.

scraApr: Float

The Servicemembers Civil Relief Act (SCRA) interest rate for this CreditPlanTemplate, expressed as a Float with up to 3 digit precision after the decimal point.

CreditPlanTemplatePromotionalPolicy

The promotional policy for this CreditPlanTemplate.

Output:OBJECT

Fields

durationUnits: CreditPlanDurationUnits

The units used to express the duration of a CreditPlan, for example BILLING_CYCLES. The specific duration value is defined when creating a PROMOTIONAL CreditPlan.

CreditPlanTerms

The terms in play for a CreditPlan, such as interest rate.

Output:OBJECT

Fields

creditPlan: CreditPlan

The CreditPlan for this configuration.

interest: InterestDetails

Details about the interest that will be charged, such as the annual percentage rate (APR).

CreditRepayment

A payment towards a balance owed for a credit product.

Output:OBJECT

Fields

amount: Amount

The total amount of the repayment.

repaymentMethod: CreditRepaymentMethod

The method used to repay the credit balance. For example, ACH.

repaymentType: CreditRepaymentType

Whether the repayment decreases (CREDIT) or increases (DEBIT) the owed balance.

memo: String

Used for manual credit repayments. This field represents notes about the adjustment. Can include UTF-8 or ASCII characters, with a maximum length of 1024 characters.

references: [String!]

Used for manual credit repayments. This is a list of references, such as support ticket identifiers or other external identifiers. Can include UTF-8 or ASCII characters, with a maximum length of 255 characters for each reference.

createdAt: String

The date and time this was created, in ISO 8601 format.

updatedAt: String

The date and time this was updated, in ISO 8601 format.

CreditRepaymentCardProductConfiguration

The repayment configuration available on a CardProduct.

Output:OBJECT

Fields

repaymentWaterfall: [RepaymentCategory!]

The order in which to apply a repayment across categories such as principal, interest, and fees.

CreditRepaymentStatementApplication

An application of a repayment to a statement.

Output:OBJECT

Fields

The statement this repayment is being applied to.

sourceRepayment: CreditRepayment

The CreditRepayment associated with this CreditRepaymentStatementApplication.

appliedAmount: Amount

The amount applied to this statement.

CreditReportFraudAlertVerificationResult

The AccountHolderCardProductApplication fields that were confirmed in response to a fraud alert on the applicant's credit report.

Output:OBJECT

Fields

accountHolderInitiatedApplication: Boolean!

Whether or not the AccountHolderinitiated this application.

Whether or not the AccountHolder name on the application matches the applicant.

dateOfBirth: Boolean!

Whether or not the AccountHolder date of birth on the application matches the applicant.

address: Boolean!

Whether or not the AccountHolder mailing address on the application matches the applicant.

CreditRiskAttributes

A type representing credit risk attributes.

Output:OBJECT

Fields

The current underwriting status.

reviewReasonDetails: CreditUnderwritingVerificationReviewReasonDetails

Details about an IN_REVIEW UnderwritingVerificationStatusCode. Only present if IN_REVIEW.

decision: UnderwriterDecision

The credit underwriting decision.

decisionDate: String

The date and time, in ISO 8601 format for a given application underwriting decision date.

decisionResults: [CreditDecisionResult!]

A list of results from the credit decision.

creditScoreDetails: CreditUnderwritingVerificationCreditScoreDetails

Details about the credit score associated with this decision.

CreditUnderwritingVerificationCreditScoreDetails

Details about the source, model, and retrieval context for a specific credit score used in underwriting.

Output:OBJECT

Fields

creditBureau: CreditBureau

Credit Bureau that sourced this credit score

customerIdentifier: String

The customer identifier that can be used to uniquely identify the Customer on subscriber side.

This can be either an external identifier defined on the subscriber side, or an AccountHolder ID to associate the customer with that AccountHolder.

wallet: PaymentMethodConnectionPayload

Payment methods associated to the Customer.

Input Arguments

first: Int

Default Value: 5

after: String

filterBy: FilteredPaymentMethodInput!

referenceNode: CustomerReferencePayload

The associated account holder if present in Highnote system.

CustomerAddress

Saved CustomerAddress details.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the CustomerAddress.

companyName: String

The company name associated to this address.

The name associated with the CustomerAddress.

address: Address

The saved Address.

createdAt: String

The date and time, in ISO 8601 format, the date this CustomerAddress was created.

id: ID!

The ID of the CustomerWebsiteContactMethod.

createdAt: String

The date and time, in ISO 8601 format, the date this CustomerWebsiteContactMethod was created.

updatedAt: String

The date and time, in ISO 8601 format, the date this CustomerWebsiteContactMethod was updated.

CustomFieldsResult

The result object returned when you update CustomFields.

Output:OBJECT

Fields

customFields: [CustomField!]

The CustomFields associated with the object.

CustomStringField

The string value data type for an element of CustomFields.

Output:OBJECT

Interfaces

CustomField

Fields

key: String!

The key of the custom field.

value: String!

The value of the custom field.

CVVSpendRule

A Spend Control rule that allows or blocks certain CVV response codes during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the CVV Spend Rule in operations.

The name assigned to the rule.

allowed: [CVVResponseCode!]

The CVVResponseCode values that will be allowed during authorizations.

blocked: [CVVResponseCode!]

The CVVResponseCode values that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

CVVSpendRuleResult

The result of applying a CVV spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [CVVResponseCode!]

The CVV response codes of the event.

spendRule: CVVSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

The ApplicableRuleUserType for which the rule will be evaluated.

DaysWithinAccountCreateDateSpendRule

A Spend Control rule that blocks transactions if the card's FinancialAccount was created more than a specified number of days ago.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the DaysWithinAccountCreateDateSpendRule in operations.

The name assigned to the rule.

maximumDaysAccountCreated: UnsignedInt

The maximum number of days since the creation of the FinancialAccount before transactions are declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

DaysWithinAccountCreateDateSpendRuleResult

The result of applying a DaysWithinAccountCreateDateSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

daysAccountCreated: UnsignedInt

The number of days since the FinancialAccount was created at the time of the event.

spendRule: DaysWithinAccountCreateDateSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

DaysWithinCardCreateDateSpendRule

A Spend Control rule that blocks transactions if the PaymentCard was created more than a specified number of days ago.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the DaysWithinCardCreateDateSpendRule in operations.

The name assigned to the rule.

maximumDaysCardCreated: UnsignedInt

The maximum number of days elapsed since the creation of the PaymentCard before transactions are declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

DaysWithinCardCreateDateSpendRuleResult

The result of applying a DaysWithinCardCreateDateSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

daysCardCreated: UnsignedInt

The number of days since the PaymentCard was created at the time of the event.

spendRule: DaysWithinCardCreateDateSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

DebitFunds

A debit transfer to a Highnote account.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the externally initiated ACH transfer.

companyName: String

The name of the company that initiated the ACH transfer.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID of the company that initiated the ACH transfer, ISO 8601 format.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fromFinancialAccount: FinancialAccount

The Highnote account receiving the debit.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

DebitFundsACHTransferEvent

A financial event that represents a DebitFunds transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The status of the externally initiated ACH transfer.

fromFinancialAccount: FinancialAccount

The account debiting the funds.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

DebitLedgerEntry

A ledger entry of type debit, it represents the portion of a financial event where a Ledger had money debited from it.

Output:OBJECT

Interfaces

LedgerEntry

Fields

id: ID!

The unique id of the DebitLedgerEntry.

financialAccount: FinancialAccount

A FinancialAccount backed by the Ledger that this ledger entry belongs to.

journalEntry: JournalEntry

A JournalEntry showing this DebitLedgerEntry and its offsetting CreditLedgerEntry.

ledger: Ledger

Ledger that DebitLedgerEntry belongs to.

amount: Amount

The Amount of the DebitLedgerEntry.

memo: String

The optional memo of the DebitLedgerEntry.

financialEvent: FinancialEvent

The event that triggered the ledger entry.

createdAt: String

The date and time, in ISO 8601 format, this ledger entry was created.

creditBalanceAtLedgerEntry: Amount

The credit balance that is the result of the ledger entry.

debitBalanceAtLedgerEntry: Amount

The debit balance that is the result of the ledger entry.

DebitManualAdjustmentDetail

This event encapsulates the impacted account and debit amount for a ManualAdjustmentEvent.

Output:OBJECT

Fields

financialAccount: FinancialAccount

The account that got impacted

amount: Amount

The Amount of the manual adjustment.

normalBalance: NormalBalance

The normal balance type of the Ledger.

ledgerName: LedgerName

The name of the Ledger.

DebitPaymentCardFinancialAccountFeature

Whether or not the Financial Account supports a Debit Payment Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

DebitTransaction

A Transaction which debits money from a PaymentCard.

Output:OBJECT

Interfaces

BusinessMetricSortAttribute

Fields

id: ID!

The ID of the transaction. This id can be used to later retrieve details of this Transaction.

transactionEvents: [TransactionEvent!]

The list of TransactionEvents related to this Transaction.

Input Arguments

eventTypes: [TransactionEventFilter!]

Scope results to specific types of TransactionEvents.

DeclinedTransactionBusinessMetricAttribute

Describes attributes of a declined transaction metric.

Output:OBJECT

Fields

The count field attributes of a transaction.

amount: Amount

The amount field attributes of a transaction.

responseCode: DeclinedTransactionResponseCodeBusinessMetric

List of response codes.

DeclinedTransactionResponseCodeBusinessMetric

Describes declined transaction reasons metric.

Output:OBJECT

Interfaces

Fields

sortedDirection: BusinessMetricAttributeSortedDirection

Sort by Ascending or Descending, Descending as default.

responseCodeAttributes: [DeclinedTransactionResponseCodeBusinessMetricAttribute!]

Declined response code attributes.

DeclinedTransactionResponseCodeBusinessMetricAttribute

Describes attributes of a declined transaction reason metric.

Output:OBJECT

Fields

The total number of declined transactions.

amount: Amount

The total amount of declined transactions.

responseCode: TransactionEventResponseCode

Declined response code.

DelinquencyStateTransition

The transition of a FinancialAccount to a certain FinancialAccountDelinquencyState, such as CURRENT, DELINQUENT, or CLOSING.

Output:OBJECT

Fields

newState: FinancialAccountDelinquencyState

The delinquency state this FinancialAccount is transitioning to, such as CURRENT, DELINQUENT, or CLOSING.

createdAt: String

The date and time, in ISO 8601 format, the FinancialAccount transitioned to this state.

DeliveryAttempt

An attempt to delivery a Notification Event to a target.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the delivery attempt in operations.

uri: String

The uri used for this attempt.

target: WebhookNotificationTarget

The target used for this attempt.

status: IntDeprecated

HTTP Status Code returned by the target.

Use response.httpStatusCode instead.

success: BooleanDeprecated

Whether or not the attempt was successful.

Use deliveryAttemptStatus instead.

response: DeliveryAttemptResponse

Details about the response from the target on this delivery attempt

deliveryAttemptStatus: DeliveryAttemptStatus

Whether the attempt was successful, failed or skipped

httpStatusCode: Int

The HTTP Status Code returned by the target.

DepositAmountLimitSpendRule

A rule that limits the dollar amount that can be deposited.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the rule in operations.

The name assigned to the rule.

maximumAmount: Amount

The maximum amount to allow for a single deposit.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

DepositAmountLimitSpendRuleResult

The result of applying a DepositAmountLimitSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [Amount!]

The tested amount of the event.

spendRule: DepositAmountLimitSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

DepositCountLimitSpendRule

A rule that limits the number of times that a cash deposit can be made.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the rule in operations.

The name assigned to the rule.

maximumCount: UnsignedInt

The maximum count of allowed deposits.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

DepositProcessingNetworkSpendRule

A rule that limits which processing networks can be used to make a deposit.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the spend rule in operations.

The name assigned to the rule.

allowed: [DepositProcessingNetwork!]

The DepositProcessingNetwork values that will be allowed during deposits.

blocked: [DepositProcessingNetwork!]

The DepositProcessingNetwork values that will result in declined deposits.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

DepositProcessingNetworkSpendRuleResult

The result of applying a DepositProcessingNetworkSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [DepositProcessingNetwork!]

The tested DepositProcessingNetwork of the event.

spendRule: DepositProcessingNetworkSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

DigitalArtColors

Digital card Art color customizations

Output:OBJECT

Fields

panColor: String!

PAN color in hex format: #a9b1c0

panColorRgb: String!

PAN color in RGB format: rgb(169, 177, 192)

backgroundColor: String!

Background color in hex format: #a9b1c0

backgroundColorRgb: String!

Background color in RGB format: rgb(169, 177, 192)

cardDescriptorColor: String!

Card descriptor color in hex format: #a9b1c0

cardDescriptorColorRgb: String!

Card descriptor color in RGB format: rgb(169, 177, 192)

DigitalCardArtDocument

Digital Card art properties for a card art document upload session

Output:OBJECT

Fields

cardArt: CardArtDocument!

The files for digital card art

digitalWalletProviders: [DigitalWalletProvider!]

Digital wallet provider

DigitalCardProfile

Digital Card Profile attributes

Output:OBJECT

Interfaces

CardProfile

Fields

id: ID!

ID of the digital card profile.

status: CardProfileStatus

Status of the digital card profile.

paymentNetworkStatus: CardProfilePaymentNetworkStatus

Payment Network Status of the digital card profile.

bankStatus: CardProfileBankStatus

Bank Status of the digital card profile.

cardHolderAgreementId: ID

Card Holder Agreement ID of the digital card profile.

cardProduct: CardProduct

Card Product of the digital card profile.

colors: DigitalArtColors

Digital Art colors in hex format.

cardArt: [DigitalCardArtDocument!]

Card art

createdAt: String

The date and time, in ISO 8601 format, this digital card profile was created.

updatedAt: String

The date and time, in ISO 8601 format, this digital card profile was last updated.

externalProfileId: String

The external id of the digital card profile used by the network for the card art configuration.

Name of the DigitalCardProfile.

description: String

Description about the DigitalCardProfile.

cardProfileSetRelationships: [CardProfileSetRelationship!]

The list of CardProfileSet related to this DigitalCardProfile.

sourceEntryMethods: [CardDigitalWalletTokenSourceEntryMethod!]

The list of allowed source entry methods for digital wallet tokens.

webPushAssetIdentifier: String

Web push provisioning asset Identifier.

webPushAssetType: WebPushAssetType

Web push provisioning asset type

tokenProvisioningConstraints: DigitalCardProfileTokenProvisioningConstraints

Card digital wallet token provisioning constraints.

DigitalCardProfileActiveTokenLimits

Active token quantity restrictions that limit how many digital wallet tokens can exist simultaneously. These controls help manage security exposure by preventing unlimited token proliferation across devices.

Output:OBJECT

Fields

maximumActiveTokens: UnsignedInt

The maximum number of active digital wallet tokens allowed simultaneously across all devices and digital wallets. When set, this number represents the hard limit - attempting to exceed it will result in provisioning failure. Common values range from 3-10 tokens depending on expected user behavior. Null indicates no active token limit is enforced.

DigitalCardProfileHistoricalTokenLimits

Historical usage tracking that monitors lifetime token creation patterns to detect suspicious behavior. These limits look at the total number of tokens ever created by a cardholder, regardless of current status.

Output:OBJECT

Fields

maximumHistoricalActiveTokens: UnsignedInt

Total number of digital wallet tokens the cardholder can create over their entire account lifetime. This cumulative count includes all tokens ever provisioned - active, deleted, expired, or suspended. Typical values range from 10-50 tokens depending on expected user behavior. When reached, provisioning is blocked until manual review. Null indicates no historical tracking limit.

previousDeclineRestrictedMerchantCategories: [MerchantCategory!]

List of merchant category codes (MCCs) where declined transactions prevent digital wallet provisioning. If the cardholder has any declined transactions with merchants in these categories, they cannot add their card to digital wallets until the restriction is lifted. Common restricted categories include gambling, adult entertainment, or high-risk merchants.

DigitalCardProfileTokenProvisioningAccountBalanceControl

Account balance requirements for digital wallet enrollment eligibility. These controls ensure cardholders have sufficient funds before allowing digital wallet provisioning.

Output:OBJECT

Fields

minimumAccountBalance: Amount

Minimum account balance required before cardholders can add their card to any digital wallet. This amount must be available in the account at the time of provisioning. Common values range from $0 (no restriction) to $25-100 for risk management. Null indicates no minimum balance requirement for digital wallet enrollment.

DigitalCardProfileTokenProvisioningConstraints

Active digital wallet provisioning configuration applied to this card profile. This type contains the current restrictions and limits that govern how cardholders can add and use this card in digital wallets. Use this to understand what restrictions and options are currently active for digital wallet provisioning.

Output:OBJECT

Fields

limits: DigitalCardProfileTokenProvisioningLimits

Current token quantity limits and lifecycle restrictions. When configured, these limits control how many digital wallet tokens a cardholder can have active simultaneously and throughout their account history. Null indicates no specific limits are set.

verificationRules: DigitalCardProfileTokenProvisioningVerificationRules

Active identity verification requirements for wallet provisioning. Defines which verification methods (SMS, email, customer service) are available to cardholders when adding their card to a digital wallet. Null indicates default verification methods apply.

active: DigitalCardProfileActiveTokenLimits

Maximum number of tokens that can be active simultaneously across all devices. When this limit is reached, users must remove their card from an existing device before adding it to a new one. Null indicates no active token limit is set.

historical: DigitalCardProfileHistoricalTokenLimits

Lifetime limits based on total tokens created by the cardholder over time. Tracks all tokens ever created (including deleted/expired ones) to detect suspicious activity patterns. Null indicates no historical tracking limits.

formattedName: String

A formatted name, composing the components of the name into a single field

givenName: String

The part of the name that identifies a person.

middleName: String

Additional part of name that identifies a person.

familyName: String

Part of a personal name that identifies a family, tribe, or community.

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

DirectDepositDetail

A financial instrument with an associated account and routing number.

The direct deposit detail that can be used to deposit funds.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the direct deposit detail in operations.

restrictedDetails: DirectDepositDetailRestrictedDetailsResult

The decrypted account number for this direct deposit detail.

createdAt: String

The date and time, in ISO 8601 format, the direct deposit detail was created.

updatedAt: String

The date and time, in ISO 8601 format, the direct deposit detail was last updated.

DirectDepositDetailRestrictedDetails

Direct deposit details for a financial account.

Output:OBJECT

Fields

number: String

The primary account number for the financial account.

routingNumber: String

The routing number for the financial account.

bank: BankDetails

The details about the backing bank.

type: BankAccountType

The details about the type of account.

DirectDepositFinancialAccountFeature

Whether or not the Financial Account supports a backing account and routing number.

The account and routing number can be used to deposit funds.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

DirectMerchantAcquiringCardProductFeature

Whether or not the CardProduct supports direct merchant acquiring.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

DisbursementTransferEvent

TransferEvent for disbursement.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the DisbursementTransferEvent in operations.

amount: Amount

The amount of the DisbursementTransferEvent.

createdAt: String

The date and time, in ISO 8601 format, the DisbursementTransferEvent was created.

updatedAt: String

The date and time, in ISO 8601 format, the DisbursementTransferEvent was last updated.

eventType: DisbursementTransferEventType

The type of the DisbursementTransferEvent.

status: DisbursementTransferEventStatus

The status of the DisbursementTransferEvent.

failureReason: DisbursementTransferEventFailureReason

The reason code on why this DisbursementTransferEvent failed.

toFinancialAccount: FinancialAccount

The receiving financial account of the DisbursementTransferEvent.

ledgers: [Ledger!]

The ledgers affected by the DisbursementTransferEvent.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

DisputeChargebackCardProductFeature

Whether or not the CardProduct supports Disputes and feature configurations for Dispute and Chargeback restrictions.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

chargebackMinimumThreshold: Amount

The minimum Amount for a Dispute to qualify for a Chargeback with the Network.

chargebackProvisionalCreditEnabled: Boolean

Whether or not a Provisional Credit will be granted when a Chargeback is filed to the Network.

disputeMaximumDaySinceTransaction: UnsignedInt

The maximum number of days from the original TransactionEvent date that a Transaction can be disputed.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

DisputeStep

Record of an acquiring PaymentTransaction dispute step.

Output:OBJECT

Interfaces

Fields

amount: Amount

The amount for this PaymentTransaction.

The current status for this step.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

id: ID!

The unique identifier for the document upload collection.

owner: DocumentCollectionOwnerEntity

The owner to which all documents in this collection are associated.

domain: DocumentUploadCategory

The domain associated with these documents

entries: [DocumentUploadCollectionEntry!]

The sets of documents associated with this collection.

DocumentUploadCollectionEntry

A set of documents collected in a single document upload session

Output:OBJECT

Fields

id: ID!

The unique identifier for the document upload collection entry.

documents: DocumentUploadCollection

The document upload collection this entry is a member of.

domain: DocumentUploadCategory

The domain associated with these documents

primaryEntity: DocumentCollectionPrimaryEntity

The primary entity associated with the DocumentUploadSession.

aggregateEntity: DocumentCollectionAggregateEntity

The aggregate entity to which all documents in this collection entry are associated.

files: [UploadLink!]

The files in this collection entry.

DocumentUploadLink

A secure upload link for a document upload session

Output:OBJECT

Interfaces

UploadLink

Fields

id: ID!

Global ID used to reference the secure upload link

documentUploadSession: DocumentUploadSession

The session which associates all of the files uploaded using the secure upload link

documentType: DocumentType

The document type that was uploaded

status: DocumentUploadLinkStatusCode

The status of the upload

documentCategoryType: DocumentCategoryType

The categorization of an uploaded document

uploadUrl: String

A url to be used to upload the contents of the document.

** Note: ** The maximum file size is 10 MB

documentUploadLinkDocumentDetails: DocumentUploadLinkDocumentDetailsResult

The document details.

createdAt: String

The date and time, in ISO 8601 format, this document upload link was created.

updatedAt: String

The date and time, in ISO 8601 format, this document upload link was last updated.

DocumentUploadLinkDocumentDetails

Upload link document details.

Output:OBJECT

Fields

downloadUrl: String

The url to download the document

DocumentUploadRequestEvent

A document upload session that has been requested.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the document upload session

expiresAt: String

The date and time, in ISO 8601 format, this ManuallyDocumentRequestUploadSession will expire.

documents: [DocumentRequest!]

A list of requested documents.

DocumentUploadRequirementConstraint

A requirement constraint for a document upload

Output:OBJECT

Fields

documentType: DocumentCategoryType

Allowed document type supported for a given upload requirement

numberOfDocuments: Int

The number of documents required for a category type

DocumentUploadSessionCompleteEvent

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the document upload session

documents: [DocumentUploadLink!]

All document upload links associated with the document upload session

EarlyDirectDepositCardProductFeature

Whether or not the CardProduct supports early direct deposit feature.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

EmbeddedDeviceInformation

Embedded Device information

Output:OBJECT

Fields

formFactor: FormFactorType

Type of form factor

image: String

URL to image of the device

Device name

serialNumber: String

Serial number

variant: String

Device variant

EmployerFinancialAccount

A employee financial account allows you to move money from Employer owned accounts to their customer accounts

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Employer Advance Account in operations.

The name of this account.

The owner of this Employer Financial Account

cardProduct: CardProduct

The Card Product associated to the Employer Financial Account.

application: AccountHolderCardProductApplication

The Card Product Application used to issue this Employer Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the Employer Financial Account was created.

updatedAt: String

The date and time, in ISO 8601 format, the Employer Financial Account was last updated.

The list of features for a Employer Financial Account.

companyIdentifier: String

The company Identifier.

EnhancedDataEvent

A event containing additional data related to a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this EnhancedDataEvent or correlate it with other events on this Transaction.

responseCode: TransactionEventResponseCode

The Highnote response code.

transaction: Transaction

The Transaction for this event.

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

networkResponseCode: StringDeprecated

Not used for this EnhancedDataEvent

Use responseCode instead

approvedAmount: Amount

Not used for this EnhancedDataEvent

requestedAmount: Amount

Not used for this EnhancedDataEvent

accountingDirection: AccountingDirection

Not used for this EnhancedDataEvent.

createdAt: String

The date and time, in ISO 8601 format, this EnhancedDataEvent was created.

paymentCard: PaymentCard

Not used for this EnhancedDataEvent

cardProduct: CardProduct

Not used for this EnhancedDataEvent

merchantDetails: MerchantDetails

Not used for this EnhancedDataEvent

additionalTransactionData: [AdditionalTransactionData!]

Level 2 / Level 3 transaction data for this transaction

currentFinancialAccountAvailableToSpendAmount: Amount

Not used for this EnhancedDataEvent

currentFinancialAccountMaximumBalanceAmount: Amount

Not used for this EnhancedDataEvent

transactionProcessingType: CardTransactionProcessingType

Not used for this EnhancedDataEvent

pointOfServiceDetails: PointOfServiceDetails

Not used for this EnhancedDataEvent

additionalNetworkData: AdditionalNetworkData

Not used for this EnhancedDataEvent

ExternalBankAccountAddedEvent

Event generated when an external bank account is linked to an account holder.

Output:OBJECT

Interfaces

ExternalBankAccountEvent

Fields

id: ID!

Id for the external account.

accountName: String

The name of this account.

accountHolderId: ID

The identifier of an Account holder

The provider that Highnote used to verify this bank account.

accountStatus: ExternalFinancialAccountStatus

ExternalFinancialBankAccount status.

externalBankAccountDetail: ExternalBankAccountDetail

The external bank account added to this external financial account.

createdAt: String

The date and time, in ISO 8601 format, the external bank account was created.

updatedAt: String

The date and time, in ISO 8601 format, the external bank account was last updated.

addedAt: String

The date and time, in ISO 8601 format, the external bank account was added.

ExternalBankAccountDetail

A financial instrument with an associated account and routing number.

The direct deposit detail that can be used to deposit funds.

If ExternalFinancialBankAccount is CLOSED then ExternalBankAccountDetail will not be returned except during close mutation.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the external bank account detail in operations.

last4: String

The last four digits of bank account number.

type: BankAccountType

The details about the type of bank account.

routingNumber: String

The routing number for the bank account.

createdAt: String

The date and time, in ISO 8601 format, the external bank account detail was created.

updatedAt: String

The date and time, in ISO 8601 format, the external bank account detail was last updated.

ExternalBankAccountRemovedEvent

Event generated when an external bank account was disconnected from an account holder.

Output:OBJECT

Interfaces

ExternalBankAccountEvent

Fields

id: ID!

Id for the external account.

accountName: String

The name of this account.

accountHolderId: ID

The identifier of an Account holder

The provider that Highnote used to verify this bank account.

accountStatus: ExternalFinancialAccountStatus

ExternalFinancialBankAccount status.

externalBankAccountDetail: ExternalBankAccountDetail

The external bank account removed from this external financial account.

createdAt: String

The date and time, in ISO 8601 format, the external bank account was created.

updatedAt: String

The date and time, in ISO 8601 format, the external bank account was last updated.

removedAt: String

The date and time, in ISO 8601 format, the external bank account was removed.

ExternalBusinessManagementCardProductFeature

Whether or not the CardProduct supports external business management

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

Fields

id: ID!

Global ID used to reference the External Financial Account in operations.

ledgers: [Ledger!]

The ledgers backing this financial account.

The owner of this financial account

The name of this account.

The provider that Highnote used to verify this bank account.

accountStatus: ExternalFinancialAccountStatus

ExternalFinancialBankAccount status.

The list of features for this financial account.

createdAt: String

The date and time, in ISO 8601 format, the Financial Account was created.

updatedAt: String

The date and time, in ISO 8601 format, the Financial Account was last updated.

externalBankAccountDetails: ExternalBankAccountDetail

The external bank account added to this external financial account.

integratorInitiatedAchTransfers: ACHTransactionConnectionDeprecated

A paginated list of Integrator Initiated ACH Transfers.

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

Deprecated

ACHTransactionConnection is deprecated in favor of IntegratorInitiatedACHTransferConnection and/or ExternallyInitiatedACHTransferConnection.

Input Arguments

first: Int

The number of Integrator Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: IntegratorInitiatedACHTransferFilterInput

Filter results to specific Integrator Initiated ACH Transfers.

externallyInitiatedAchTransfers: ACHTransactionConnectionDeprecated

A paginated list of Externally Initiated ACH Transfers.

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

Deprecated

ACHTransactionConnection is deprecated in favor of IntegratorInitiatedACHTransferConnection and/or ExternallyInitiatedACHTransferConnection.

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

integratorInitiatedACHTransfer: IntegratorInitiatedACHTransferConnection

A paginated list of Integrator Initiated ACH Transfers.

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

Deprecated, in favor of internalACHTransfers

Input Arguments

first: Int

The number of Integrator Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: IntegratorInitiatedACHTransferFilterInput

Filter results to specific Integrator Initiated ACH Transfers.

integratorACHTransfers: IntegratorInitiatedACHTransferConnection

A paginated list of Integrator Initiated ACH Transfers.

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

Input Arguments

first: Int

The number of Integrator Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: IntegratorInitiatedACHTransferFilterInput

Filter results to specific Integrator Initiated ACH Transfers.

externallyInitiatedACHTransfer: ExternallyInitiatedACHTransferConnection

A paginated list of Externally Initiated ACH Transfers.

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

Deprecated, in favor of externalACHTransfers

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

externalACHTransfers: ExternallyInitiatedACHTransferConnection

A paginated list of Externally Initiated ACH Transfers.

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

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

originatedAchTransfers: OriginatedAchTransferPayload

A paginated list of originated ACH transfers.

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

Input Arguments

first: Int

The number of originated ACH transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: OriginatedAchTransferFilterInput

Filter results to specific originated ACH transfers.

nonOriginatedAchTransfers: NonOriginatedAchTransferPayload

A paginated list of non-originated ACH transfers.

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

Input Arguments

first: Int

The number of non-originated ACH transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: NonOriginatedAchTransferFilterInput

Filter results to specific non-originated ACH transfers.

transactionEvents: TransactionEventConnection

A paginated list of TransactionEvents.

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

Input Arguments

first: Int

The number of TransactionEvents to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: TransactionEventsFilterInput

Filter results to specific TransactionEvents.

ExternallyInitiatedAchReleaseHoldTransfer

A movement of money to release hold on non originated ach credit

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount released from hold.

The current status of the transfer.

statusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

status: WireTransferStatusDetails

The status of the wire transfer.

toFinancialAccount: FinancialAccount

The destination financial account that will receive the funds.

ExternalMoneyMovementTransaction

A transaction for an external money movement.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer.

amount: Amount

The transfer amount.

createdAt: String

The date and time the transfer was created, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

updatedAt: String

The date and time the transfer was last updated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

type: ExternalMoneyMovementTransactionType

The type for this transfer.

status: ExternalMoneyMovementTransactionStatus

The status of the transfer.

statusReason: ExternalMoneyMovementTransactionStatusReasonCode

In the case of a failed status, returns the failed reason.

externalIdentifier: String

The external ID of the transaction.

financialAccount: FinancialAccount

The FinancialAccount where the funds for this transfer has initiated from

ExternalMoneyMovementTransactionEvent

A transaction event for an external money movement.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the ExternalMoneyMovementTransactionEvent in operations.

amount: Amount

The amount of the ExternalMoneyMovementTransactionEvent.

createdAt: String

The date and time the transfer was created, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

updatedAt: String

The date and time the transfer was last updated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

eventType: ExternalMoneyMovementTransactionEventType

The type of the ExternalMoneyMovementTransactionEvent.

status: ExternalMoneyMovementTransactionEventStatus

The status of the ExternalMoneyMovementTransactionEvent.

failureReason: ExternalMoneyMovementTransactionEventStatusFailureReason

The reason for the failure of the ExternalMoneyMovementTransactionEvent.

ledgers: [Ledger!]

The ledgers affected by the DisbursementTransferEvent.

ExternalPhysicalPaymentCardOrder

External Physical Payment Card Order

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the ExternalPhysicalPaymentCardOrder in operations.

card: PaymentCardDeprecated

Payment card.

`card` is no longer supported

paymentCard: PaymentCard

Payment card.

embeddedDevice: EmbeddedDeviceInformation

Embedded Device information.

status: PaymentCardOrderStatus

Current order status.

Fields

id: ID!

Global ID used to reference the FeeTransferEvent object.

originatingAccount: FinancialAccount

The financial account from where the fee was deducted.

receivingAccount: FinancialAccount

The Financial account that receives the fee.

feeActivityType: FeeTransferEventFeeActivityType

The activity for which the fee is charged.

The Fee status.

transferDate: String

The date and time, in ISO 8601 format, the fee was charged.

feeTransferAmount: Amount

The actual fee amount charged. This field is available when status is COMPLETE.

FeeChargeRule

A fee charge rule.

Output:OBJECT

Interfaces

Fields

id: ID!

ID used to reference the fee charge rule.

Fee charge rule name.

order: Int

Order at which this fee charge rule will be applied against other applicable fee charge rules.

value: FeeChargeValue

The value of fee charged when this charge rule is applied.

conditions: [FeeChargeRuleCondition!]

The list of conditions that determine if this fee charge rule should be applied. All conditions must be true for this charge rule to apply.

createdAt: String

The date and time, in ISO 8601 format, the fee charge rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the fee charge rule was last updated.

FeeChargeRuleAmountCondition

A fee charge condition that is based on amount in account holder activity.

Output:OBJECT

Fields

id: ID!

ID used to reference fee charge rule amount condition.

description: String

The description of fee charge rule amount condition.

condition: AmountFeeCondition

The logical condition with regard to amount in account holder activity.

aggregatedAt: FeeConditionAggregation

The amount of account holder activity is aggregated at.

aggregationDuration: FeeChargeConditionDuration

The duration for which amount is aggregated before it resets.

createdAt: String

The date and time, in ISO 8601 format, the fee charge rule amount condition was created.

updatedAt: String

The date and time, in ISO 8601 format, the fee charge rule amount condition was last updated.

FeeChargeRuleCountCondition

A fee charge condition that is based on count of account holder activity.

Output:OBJECT

Fields

id: ID!

ID used to reference the fee charge rule count condition.

description: String

The description of fee charge rule count condition.

condition: CountFeeCondition

The logical condition with regard to count of account holder activity.

aggregatedAt: FeeConditionAggregation

The count of account holder activity is aggregated at.

aggregationDuration: FeeChargeConditionDuration

The duration for which the count of account holder activity is aggregated before it resets.

createdAt: String

The date and time, in ISO 8601 format, the fee charge rule count condition was created.

updatedAt: String

The date and time, in ISO 8601 format, the fee charge rule count condition was last updated.

FeeConfiguration

A fee configuration. Fee configuration consists of account holder activity that is being charged and the rules that determines what fee charge is applicable.

Output:OBJECT

Fields

id: ID!

ID used to reference the fee configuration.

feeActivityType: FeeTransferEventFeeActivityType

The account holder activity for which fee is charged.

feeChargeRules: [FeeChargeRule!]

Set of rules that determine amount of fee to be charged.

createdAt: String

The date and time, in ISO 8601 format, the fee configuration was created.

updatedAt: String

The date and time, in ISO 8601 format, the fee configuration was last updated.

FeeReversalEvent

An event that occurs when a Fee is reversed.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the FeeTransferEvent object.

originatingAccount: FinancialAccount

The financial account from where the fee was deducted.

receivingAccount: FinancialAccount

The Financial account that receives the fee.

feeActivityType: FeeTransferEventFeeActivityType

The activity for which the fee is charged.

The Fee status.

transferDate: String

The date and time, in ISO 8601 format, the fee was reversed.

feeTransferAmount: Amount

The actual fee amount reversed. This field is available when status is COMPLETE.

sourceFeeTransferEvent: FeeTransferEvent

The original fee transfer event that was reversed.

FeeSchedule

Fee schedule. It has set of fee configurations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the fee schedule.

feeScheduleAssociatedTo: FeeScheduleAssociatedTo

The Fee schedule that is associated to a Card Product.

feeConfigurations: [FeeConfiguration!]

Set of fee configurations for this fee schedule.

activationDate: String

The date and time, in ISO 8601 format, the fee schedule was activated.

status: FeeScheduleStatus

Status of fee schedule.

A human-friendly description for the specific error.

errorPath: [String!]

The path to the input field which has an error, including indices.

FileUploadCompleteEvent

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the secure upload link

documentUploadSession: DocumentUploadSession

The session which associates all of the files uploaded using the secure upload link

documentType: DocumentType

The document type that was uploaded

status: DocumentUploadLinkStatusCode

The status of the upload

documentCategoryType: DocumentCategoryType

The categorization of an uploaded document

uploadUrl: String

A url to be used to upload the contents of the document.

** Note: ** The maximum file size is 10 MB

createdAt: String

The date and time, in ISO 8601 format, this document upload link was created.

updatedAt: String

The date and time, in ISO 8601 format, this document upload link was last updated.

FinancialAccount

A financial account allows you to move money into the Highnote platform and move funds to other accounts.

Output:OBJECT

Interfaces

Fields

paymentCardTransactionChargebacks: PaymentCardTransactionChargebackConnection

A paginated list of PaymentCardTransactionChargeback for this FinancialAccount. For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of PaymentCardTransactionChargeback to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountPaymentCardTransactionChargebacksFilterInput

Filter results to specific PaymentCardTransactionChargeback.

globalNotes: GlobalNoteConnectionPayload

All global notes pertaining to this FinancialAccount.

Input Arguments

first: Int

Default Value: 20

after: String

accountReviewHistory: AccountReviewConnectionPayload

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

Input Arguments

first: Int

The number of items to return.

Default Value: 20

after: String

The cursor to start the page.

id: ID!

Global ID used to reference the Financial Account in operations.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

ledgers: [Ledger!]

The ledgers backing this financial account.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The primary owner of this FinancialAccount.

accountHolder: FinancialAccountOwner

Will be the same as owner if the FinancialAccount is owned by the primary user, otherwise this will link to the authorized user.

The name of this account.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

application: AccountHolderCardProductApplicationDeprecated

The Card Product Application used to issue this Financial Account.

Use cardProductApplication instead.

cardProductApplication: CardProductApplication

The Card Product Application used to issue this Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the Financial Account was created.

updatedAt: String

The date and time, in ISO 8601 format, the Financial Account was last updated.

The list of features for a Financial Account.

directDepositDetails: DirectDepositDetail

The direct deposit details for this financial account.

activeBillingCycleConfiguration: BillingCycleConfiguration

The active billing cycle configuration for this financial account.

billingSummary: FinancialAccountBillingSummary

The current billing summary, including information on balances, minimum payment, and payment due date, for this FinancialAccount

statementSnapshot: FinancialAccountStatementSnapshot

Current account balance snapshot

statements: FinancialAccountStatementConnection

A paginated list of FinancialAccountStatements.

first: Int

The number of Integrator Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: IntegratorInitiatedACHTransferFilterInput

Filter results to specific Integrator Initiated ACH Transfers.

integratorACHTransfers: IntegratorInitiatedACHTransferConnection

A paginated list of Integrator Initiated ACH Transfers.

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

Input Arguments

first: Int

The number of Integrator Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: IntegratorInitiatedACHTransferFilterInput

Filter results to specific Integrator Initiated ACH Transfers.

externallyInitiatedAchTransfers: ACHTransactionConnectionDeprecated

A paginated list of Externally Initiated ACH Transfers.

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

Deprecated

ACHTransactionConnection is deprecated in favor of IntegratorInitiatedACHTransferConnection and/or ExternallyInitiatedACHTransferConnection.

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

externallyInitiatedACHTransfer: ExternallyInitiatedACHTransferConnectionDeprecated

A paginated list of Externally Initiated ACH Transfers.

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

Deprecated, in favor of externalACHTransfers

externallyInitiatedACHTransfer is deprecated in favor of externalACHTransfers.

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

externalACHTransfers: ExternallyInitiatedACHTransferConnection

A paginated list of Externally Initiated ACH Transfers.

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

Input Arguments

first: Int

The number of Externally Initiated ACH Transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: ExternallyInitiatedACHTransferFilterInput

Filter results to specific Externally Initiated ACH Transfers.

originatedAchTransfers: OriginatedAchTransferPayload

A paginated list of originated ACH transfers.

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

Input Arguments

first: Int

The number of originated ACH transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: OriginatedAchTransferFilterInput

Filter results to specific originated ACH transfers.

nonOriginatedAchTransfers: NonOriginatedAchTransferPayload

A paginated list of non-originated ACH transfers.

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

Input Arguments

first: Int

The number of non-originated ACH transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: NonOriginatedAchTransferFilterInput

Filter results to specific non-originated ACH transfers.

incomingScheduledTransfers: ScheduledTransferConnection

Incoming Scheduled Transfers for the financial account

Input Arguments

first: Int

The number of Incoming Scheduled Transfers to return.

Default Value: 20

after: String

The cursor to start the page

transactionEvents: TransactionEventConnection

A paginated list of TransactionEvents.

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

Input Arguments

first: Int

The number of TransactionEvents to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: TransactionEventsFilterInput

Filter results to specific Transaction Card Events.

interFinancialAccountTransfers: InterFinancialAccountTransferConnection

The InterFinancialAccountTransfers belonging to this FinancialAccount

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

Input Arguments

first: Int

The number of inter financial account transfers to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: InterFinancialAccountTransferFilterInput

Filter results to specific inter financial account transfers.

accountClosureBlockers: [AccountClosureBlocker]Deprecated

A list of states which could block account closure.

Legacy, unused field

accountClosureReasons: [FinancialAccountClosureReason!]

The reason(s) for closure of the FinancialAccount. Currently only available for revolving CardProducts.

accountStatus: FinancialAccountStatus

The FinancialAccountStatus.

accountAttributes: [FinancialAccountAttribute]

A List of FinancialAccountAttribute associated with this FinancialAccount.

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

financialAccountAttributesWithReason: [FinancialAccountAttributeWithReason!]

The attributes and reasons for the FinancialAccount.

paymentCards: PaymentCardConnection

The Payment Cards issued to this Financial Account.

Input Arguments

first: Int

The number of Payment Cards to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountPaymentCardsFilterInput

Filter results to specific Payment Cards.

velocityRuleBalances: [VelocityRuleBalance]Deprecated

The balances of the VelocityRules that pertain to this FinancialAccount

Use velocitySpendRuleBalances instead

velocitySpendRuleBalances: [VelocitySpendRuleBalance]

The balances of the VelocityRules that pertain to this FinancialAccount

partnerBankName: PartnerBankName

The name of our bank partner associated to this FinancialAccount

delinquency: FinancialAccountDelinquency

The delinquency details of this FinancialAccount

delinquencyState: CurrentFinancialAccountDelinquencyState

The current delinquency state of this FinancialAccount

billingCycleHistory: BillingCycleConnection

A paginated list of billing cycles for this FinancialAccount

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

Input Arguments

first: Int

The number of Billing Cycles to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: BillingCycleFilterInput

Filter results to specific Billing Cycles.

creditConfiguration: CreditFinancialAccountConfiguration

The credit configuration for this FinancialAccount.

purchasePlans: [FinancialAccountPurchaseCreditPlan!]

A list of CreditPlans with a CreditBalanceType of PURCHASE configured for this FinancialAccount.

installmentAgreements: InstallmentAgreementConnection

A paginated list of installment agreement for this FinancialAccount

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

Input Arguments

first: Int

The number of Installment Agreement to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: InstallmentAgreementFilterInput

Filter results to specific Installment Agreement Status.

feeTransferEvents: FeeTransferEventConnection

A paginated list of FeeTransferEvents.

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

Input Arguments

first: Int

The number of FeeTransferEvents to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FeeTransferEventFilterInput

Filter results to specific Transaction Card Events.

paymentCardTransactionDisputes: PaymentCardTransactionDisputeConnectionPayload

A paginated list of PaymentCardTransactionDispute for this FinancialAccount. For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of PaymentCardTransactionDispute to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountPaymentCardTransactionDisputesFilterInput

Filter results to specific PaymentCardTransactionDispute.

customFields: [CustomField!]

The customFields associated with this FinancialAccount.

userDefinedFields: UserDefinedFieldConnection

The UserDefinedFields associated with this FinancialAccount.

Input Arguments

first: Int

The number of UserDefinedFields to return

Default Value: 20

after: String

The cursor to start the page.

The filter used to search UserDefinedFields

revisionSnapshots: FinancialAccountSnapshotConnection

A paginated list of revisions made to this FinancialAccount.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

attachedSpendRules: SpendRuleConnection

The spend rules attached to this Financial Account.

Input Arguments

first: Int

The number of Spend Rules to return.

Default Value: 20

after: String

The cursor to start the page.

attachedVelocityRules: VelocityRuleConnection

The velocity rules attached to this Financial Account.

Input Arguments

first: Int

The number of Velocity Rules to return.

Default Value: 20

after: String

The cursor to start the page.

attachedRealtimeRiskRules: RealtimeRiskRuleConnectionPayload

The realtime risk rules attached to this Financial Account.

Input Arguments

first: Int

The number of realtime risk rules to return.

Default Value: 20

after: String

The cursor to start the page.

authorizedUserFinancialAccounts: FinancialAccountConnection

The FinancialAccounts for authorized user's managed by this FinancialAccount.

Input Arguments

after: String

Cursor for pagination

first: Int

Number of records to return

Default Value: 20

reviewWorkflowEvents: ReviewWorkflowEventConnectionPayload

The ReviewWorkflowEvents related to this FinancialAccount.

Input Arguments

after: String

Cursor for pagination

first: Int

Number of records to return

Default Value: 20

rewardPointsTransfers: RewardPointsTransferConnectionPayloadDeprecated

The reward points transfers associated to this FinancialAccount.

Please query the REWARDS_POINTS ledger on your FinancialAccount for ledger entries, which include RewardPointsTransfer financial events.

Input Arguments

first: Int

The number of transfers to return.

Default Value: 20

after: String

The cursor to start the page.

velocityInterFinancialAccountTransferRuleBalances: VelocityInterFinancialAccountTransferRuleBalanceConnectionPayload

The balances of VelocityInterFinancialAccountTransferRules that pertain to this FinancialAccount

Input Arguments

first: Int

The number of balances to return.

Default Value: 20

after: String

The cursor to start the page.

checkPayments: CheckPaymentsConnection

A paginated list of CheckPayments.

Input Arguments

first: Int

Default Value: 20

after: String

FinancialAccountActivity

Details of an activity, such as a transfer or payment card transaction, for a Financial Account.

Output:OBJECT

Fields

sign: FinancialAccountActivitySign

Whether the activity decreases or increases available cash or credit for the Financial Account.

isComplete: Boolean

If true, there are no more expected changes or updates to this activity.

createdAt: String

The date and time, in ISO 8601 format, this activity was created.

updatedAt: String

The date and time, in ISO 8601 format, this activity was updated.

pendingAmount: Amount

The amount pending for this activity. For PaymentCard transactions, this represents the remaining amount authorized.

ledgerName: LedgerName

The name of the Ledger.

normalBalance: NormalBalance

The expected normal balance of the Ledger.

In most cases the corresponding creditBalance and debitBalance field will have a non-zero value. If the corresponding creditBalance or debitBalance field has a zero value and the other creditBalance or debitBalance field has a value greater than zero, that greater than zero value represents a negative balance on the ledger.

creditBalance: Amount

The credit balance of the Ledger.

When the Ledger's normalBalance is CREDIT this field should change based on activity. Otherwise, the value will stay zero. If the balance is negative, this amount will be zero, and the DEBIT amount will be positive. Refer to normalBalance definition to see information about possible negative balances.

debitBalance: Amount

The debit balance of the Ledger.

When the Ledger's normalBalance is DEBIT this field should change based on activity. Otherwise, the value will stay zero. If the balance is negative, this amount will be zero, and the CREDIT amount will be positive. Refer to normalBalance definition to see information about possible negative balances.

asOf: String

The date and time, in ISO 8601 format, the debitBalance and creditBalance were last calculated.

FinancialAccountBalanceSearchResult

The FinancialAccount balance search result object.

Output:OBJECT

Fields

financialAccountOwner: FinancialAccountOwner

The owner of the FinancialAccount.

cardProduct: CardProduct

The CardProduct of the FinancialAccount.

financialAccountCreatedAt: String

The date and time, in ISO 8601 format, when the FinancialAccount was created.

financialAccount: FinancialAccount

The FinancialAccount pertaining to the FinancialAccount balance.

remainingLatestClosedStatementBalance: Amount

The latest closed statement balance less any payments applied to it.

minimumPaymentDue: Amount

The current minimum payment due, taking into account any payments made that applied to the latest closed statement balance.

paymentDueDate: StringDeprecated

The date payment is due for the latest closed statement, in ISO 8601 format.

please use `paymentDueOn` instead

paymentDueOn: String

The date and time payment is due for the latest closed statement, in ISO 8601 format.

asOf: String

The date and time this data was fetched, in ISO 8601 format.

FinancialAccountConnection

The connection type for FinancialAccount.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [FinancialAccountEdge!]

A list of edges.

totalRecords: UnsignedInt

The total number of records.

FinancialAccountCreditLimitUpdateFromProductFunding

Credit limit update of a Financial Account within the Highnote platform.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the credit limit update in operations.

amount: Amount

The amount of the credit limit.

status: FinancialAccountCreditLimitUpdateFromProductFundingStatus

The current status of the credit limit.

statusReason: FinancialAccountCreditLimitUpdateFromProductFundingStatusReasonCode

The reason for the current status.

createdAt: String

The date and time, in ISO 8601 format, the credit limit update was created.

updatedAt: String

The date and time, in ISO 8601 format, the credit limit update was last updated.

memo: String

A description of the credit limit update for later reference.

ledgers: [Ledger!]

The ledgers affected by the credit limit update.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

FinancialAccountEdge

The edge type for a FinancialAccount.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: FinancialAccount

The financial account.

FinancialAccountPseudoBalanceUpdate

The pseudo balance update applied to a financial account ID.

Output:OBJECT

Interfaces

Fields

id: ID!

ID for the pseudo balance update.

status: FinancialAccountPseudoBalanceUpdateStatus

The status of this pseudo balance update.

statusReason: FinancialAccountPseudoBalanceUpdateStatusReason

In the case of a failed status, returns the failed reason.

memo: String

The memo set when creating the pseudo balance update.

amount: Amount

The amount set for this pseudo balance.

createdAt: String

The date and time, in ISO 8601 format, at which this update was created.

updatedAt: String

The date and time, in ISO 8601 format, at which this update was modified.

FinancialAccountPurchaseCreditPlan

A CreditPlan for PURCHASE balances that is configured with an APR for this FinancialAccount.

Output:OBJECT

Fields

apr: Float

The annual percentage rate (APR) that will be charged for purchases under this CreditPlan for this FinancialAccount.

creditPlan: CreditPlan

The CreditPlan this configuration applies to.

FinancialAccountSnapshot

The initial details of the FinancialAccount before the revision was applied.

Output:OBJECT

Interfaces

FinancialAccountStatementBalanceType

Fields

id: ID!

Global ID used to reference the FinancialAccountSnapshot.

financialAccount: FinancialAccount

The FinancialAccount that this is a revision of.

financialAccountAttributes: [FinancialAccountAttribute!]

The attributes of the FinancialAccount.

accountStatus: FinancialAccountStatus

The status of the FinancialAccount.

cardProduct: CardProduct

The card product associated to the FinancialAccount.

externalId: String

The name of this account.

application: AccountHolderCardProductApplicationDeprecated

The Card Product Application used to issue this Employer Financial Account.

Use cardProductApplication instead.

cardProductApplication: CardProductApplication

The Card Product Application used to issue this Financial Account.

installmentAgreement: InstallmentAgreement

The InstallmentAgreement.

periodFeesAmount: Amount

The fees associated with this InstallmentAgreement for this statement period.

periodFeeCredit: Amount

The fee credit (for example due to waiving fees) associated with this InstallmentAgreement for this statement period.

periodPrincipal: Amount

The amount of principal paid down during this statement period for this InstallmentAgreement.

periodBalancePaid: Amount

The amount the total balance, including principal and fees, is reduced by during this statement period for this InstallmentAgreement.

FinancialAccountStatementPayOffPayment

The FinanceAccountStatementPayOffPayment is the amount paid by the consumer. This can be minimum or time based details.

Output:OBJECT

Fields

payOffType: PayOffType

Pay off Type to identity if pay off details are associated with Fixed minimum pay or Fixed three year pay.

paymentDetails: PayOffPaymentDetails

Payment details for the consumer for define category.

FinancialAccountStatementPayOffWarning

Warning for consumer to let them know about how much time it takes for them to pay statement balance and how additional payment they do with minimum or 36 months pay.

Output:OBJECT

Fields

paymentCycles: [FinancialAccountStatementPayOffPayment!]

Minimum amount paid by the consumer.

FinancialAccountStatementPurchaseCreditPlan

Financial Account Statement purchase credit Plan with details related to purchase interest charge and balance subject to interest.

Output:OBJECT

Interfaces

Fields

balanceType: BalanceType

Balance Type for the current statement

balanceSubjectToInterestAmount: Amount

Purchase balance for this CreditPlan, subject to the interest charge for specific credit plan'

interestChargedAmount: Amount

Period's purchase interest charge for this CreditPlan, subject to the interest charge for specific balance for specific credit plan type'

apr: Float

The interest rate (APR) for this CreditPlan for this statement, expressed as a Float with up to 3 digit precision after the decimal point. If this FinancialAccount qualifies for a Servicemembers Civil Relief Act (SCRA) interest rate during this statement period, it will be reflected in this value.

index: Float

For variable interest rates only. The current configuration of the index used to derive the variable APR.

margin: Float

For variable interest rates only. The current configuration of the margin used to derive the variable APR.

creditPlan: CreditPlan

The CreditPlan associated with this statement.

FinancialAccountStatementReadyEvent

The FinancialAccountStatementEvent notifies when a statement is ready.

Output:OBJECT

Interfaces

FinancialAccountStatementEvent

Fields

id: ID!

Id for statement which is ready.

financialAccountId: ID

Account Id associated with this statement.

FixedFeeChargeValue

Flat amount fee charge value.

Output:OBJECT

Fields

amount: Amount

The flat fee amount to be charged.

FleetCardAccountFeature

Whether or not the Financial Account supports a Fleet Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

creditLimit: Amount

The credit limit on the FleetCardAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

ForwardCommittmentBreakdown

The percentage breakdown of forward comittments

Output:OBJECT

Fields

percentageOfTransactionZeroToSevenDays: UnsignedInt!

The percentage of transactions that are shipped within 0-7 days of collecting payment

percentageOfTransactionEightToFourteenDays: UnsignedInt!

The percentage of transactions that are shipped within 8-14 days of collecting payment

percentageOfTransactionFIfteenToThirtyDays: UnsignedInt!

The percentage of transactions that are shipped within 15-30 days of collecting payment

percentageOfTransactionMoreThanThirtyDays: UnsignedInt!

The percentage of transactions that are shipped more than 30 days past payment collection

FundsDepositCanceledEvent

The FundsDepositCanceledEvent notifies when IntegratorInitiatedFundsDepositACHTransfers are canceled.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositCanceledEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

paymentRelatedInformation: String

This field contains payment-related information provided by the originator of the transaction. It can include free-form text, structured data, or codes. The field supports alphanumeric characters, including the following symbols: ! " & ' ( ) * + , - . / : ; ? = % ~ @ [ ] { } \ | < > # $.

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsDepositFailedEvent

The FundsDepositFailedEvent notifies when IntegratorInitiatedFundsDepositACHTransfers have failed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositFailedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

fundsDepositACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an Funds Deposit ACH Transfer failed.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsDepositInitiatedEvent

The FundsDepositInitiatedEvent notifies when IntegratorInitiatedFundsDepositACHTransfers are initiated.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositInitiatedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsDepositProcessedEvent

The FundsDepositProcessedEvent notifies when IntegratorInitiatedFundsDepositACHTransfers are processed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositProcessedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsDepositProcessingEvent

The FundsDepositProcessingEvent notifies when IntegratorInitiatedFundsDepositACHTransfers are processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositProcessingEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsDepositReturnedEvent

The FundsDepositReturnedEvent notifies when IntegratorInitiatedFundsDepositACHTransfers are returned.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsDepositReturnedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsDepositACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

fundsDepositACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an Funds Deposit ACH Transfer failed.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

FundsWithdrawalCanceledEvent

The FundsWithdrawalCanceledEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers are canceled.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalCanceledEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsWithdrawalFailedEvent

The FundsWithdrawalFailedEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers have failed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalFailedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

fundsWithdrawalACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an Funds Withdrawal ACH Transfer failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use fundsWithdrawalACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsWithdrawalInitiatedEvent

The FundsWithdrawalInitiatedEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers are initiated.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalInitiatedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsWithdrawalProcessedEvent

The FundsWithdrawalProcessedEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers are processed.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalProcessedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsWithdrawalProcessingEvent

The FundsWithdrawalProcessingEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers are processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalProcessingEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

FundsWithdrawalReturnedEvent

The FundsWithdrawalReturnedEvent notifies when IntegratorInitiatedFundsWithdrawalACHTransfers are returned.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transfer event. This id can be used to later retrieve details of this FundsWithdrawalReturnedEvent or correlate it with other events on this ElectronicFundsTransfer.

transactionId: ID

The ID of the IntegratorInitiatedFundsWithdrawalACHTransfer that triggered this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be a FinancialAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be an ExternalFinancialBankAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

fundsWithdrawalACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an Funds Withdrawal ACH Transfer failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use fundsWithdrawalACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

GenerateVerifiedExternalBankAccountExternalLinkToken

The details of the link token from the third-party provider.

Output:OBJECT

Fields

externalLinkToken: String

The link token generated by the third-party provider.

externalLinkHostedUrl: String

The hosted URL generated by the third-party provider.

expirationDate: String

The expiration date for the token in ISO 8601 format.

accountHolder: AccountHolder

The account holder for whom bank account is linked.

GlobalNote

A GlobalNote

Output:OBJECT

Fields

id: ID!

The ID used to reference the GlobalNote in operations.

createdBy: User

The user who added this GlobalNote.

message: String!

The message of the GlobalNote.

createdAt: String

The date and time, in ISO 8601 format, the GlobalNote was created.

Fields

id: ID!

Global ID used to reference the document upload session

The current state of the document upload session

createdAt: String

The date and time, in ISO 8601 format, this IdentityVerificationDocumentUploadSession was created.

updatedAt: String

The date and time, in ISO 8601 format, this IdentityVerificationDocumentUploadSession was last updated.

expiresAt: String

The date and time, in ISO 8601 format, this IdentityVerificationDocumentUploadSession will expire.

requestedDocuments: [DocumentType!]

A list of DocumentType requested in order to verify the identity of the entity.

documents: [UploadLink!]

A list of documents uploaded via a secure document upload link

IncomeAccountFinancialAccountFeature

Whether or not the Financial Account supports Product Income.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

InstallmentAgreement

An arrangement to convert a Transaction into installments.

Output:OBJECT

Interfaces

Fields

id: ID!

The unique identifier for this InstallmentAgreement.

status: InstallmentAgreementStatus

The status of this InstallmentAgreement.

statusHistory: [InstallmentAgreementStatusHistory!]

The status history of this InstallmentAgreement.

agreement: InstallmentOffer

The original offer information such as the relevant CreditPlan, and the total and per-installment amounts due.

transactionEvent: TransactionEvent

The TransactionEvent associated with this InstallmentAgreement.

snapshot: InstallmentAgreementSnapshot

The progress to date and remaining obligations for this InstallmentAgreement.

installmentAgreementPeriodStart: String

The date and time, in ISO 8601 format, the first statement where an installment is due starts.

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

InstallmentAgreementCompletedRollup

A summary of completed InstallmentAgreement activity.

Output:OBJECT

Fields

principalBalancePaid: Amount

The principal balance paid to date for this InstallmentAgreement.

principalBalanceRemaining: Amount

The remaining principal balance due for this InstallmentAgreement.

estimatedFeesRemaining: Amount

The remaining fees due for this InstallmentAgreement. This is a sum of per period fees for the remaining periods.

numberOfInstallmentsRemaining: UnsignedInt

The number of installments remaining for this InstallmentAgreement.

InstallmentAgreementSnapshot

The progress to date and remaining obligations for this InstallmentAgreement.

Output:OBJECT

Fields

asOf: String

The date and time, in ISO 8601 format, this was updated.

installmentPaymentsCompleted: InstallmentAgreementCompletedRollup

Details about past completed installments.

installmentPaymentsRemaining: InstallmentAgreementRemainingRollup

Details about remaining installments.

InstallmentAgreementStatusHistory

InstallmentAgreement status history.

Output:OBJECT

Fields

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

source: InstantNetworkTransferSource

The source of the funds to transfer.

destination: InstantNetworkTransferDestination

The destination of the funds to transfer.

status: InstantNetworkTransferStatus

The current status of the transfer.

events: [InstantNetworkTransferEvent!]

The events associated with this transfer.

transferDetail: InstantNetworkTransferDetail

The detail of the transfer including the fee and time estimate.

externalIdentifier: String

Externally provided ID (255 character limit) to associate this object with an external system.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

See this link for more

failureReason: InstantNetworkTransferFailureReason

When the InstantNetworkTransfer.status is FAILED, this will be populated with the reason for the failure.

InstantNetworkTransferDestination

The destination of the funds being transferred.

Output:OBJECT

Fields

node: InstantNetworkTransferDestinationNode

If the source is a Highnote Node, this will be the Node.

amount: Amount

The amount of funds to deposit at the destination.

InstantNetworkTransferDestinationPaymentInstrumentCapability

Indicates that this PaymentInstrument can be used as the destination ID for InstantNetworkTransfer.

Output:OBJECT

Fields

status: InstantNetworkTransferDestinationPaymentInstrumentCapabilityStatus

The current status for this capability. If it is ENABLED, the PaymentInstrument has this capability.

createdAt: String

The date and time, in ISO 8601 format, the capability was created.

updatedAt: String

The date and time, in ISO 8601 format, the capability was last updated.

InstantNetworkTransferDetail

Detail about the transfer.

Output:OBJECT

Fields

timeEstimate: String

A human-readable estimate of the time it will take for the transfer to complete.

feeTotal: Amount

The total fee for the transfer.

InstantNetworkTransferEvent

An event associated with a InstantNetworkTransfer.

Output:OBJECT

Interfaces

Fields

id: ID!

The global ID of the event.

type: InstantNetworkTransferEventType

The type of event that has happened on the InstantNetworkTransfer.

createdAt: String

The date and time, in ISO 8601 format, when this event occurred.

updatedAt: String

The date and time, in ISO 8601 format, when this event was updated.

status: InstantNetworkTransferStatus

The status of the transfer when the event happened.

failureReason: InstantNetworkTransferFailureReason

When the InstantNetworkTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

instantNetworkTransfer: InstantNetworkTransfer

The InstantNetworkTransfer associated with this event.

associatedPaymentTransaction: PaymentTransaction

The PaymentTransaction that InstantNetworkTransfer uses to move money.

InstantNetworkTransferSource

The source of the funds to transfer.

Output:OBJECT

Fields

node: InstantNetworkTransferSourceNode

If the source is a Highnote Node, this will be the Node.

amount: Amount

The amount of funds to source the transfer.

InstantNetworkTransferSourcePaymentInstrumentCapability

Indicates that this PaymentInstrument can be used as the source ID for InstantNetworkTransfer.

Output:OBJECT

Fields

status: InstantNetworkTransferSourcePaymentInstrumentCapabilityStatus

The current status for this capability. If it is ENABLED, the PaymentInstrument has this capability.

createdAt: String

The date and time, in ISO 8601 format, the capability was created.

updatedAt: String

The date and time, in ISO 8601 format, the capability was last updated.

InstantSettlementTransaction

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

carryoverAmount: AmountImpact

The AmountImpact that has been carried over from the last settlement transaction.

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

events: [InstantSettlementTransactionEvent!]

Events that have started due to this InstantSettlementTransaction.

feeAccount: FinancialAccount

The FinancialAccount used for fees.

merchantFundingAccount: FinancialAccount

The FinancialAccount used for merchant funding.

originatingAccount: FinancialAccount

The originating FinancialAccount.

pullPaymentSettlementAmount: AmountImpact

The AmountImpact for the pull payment settlement.

pullPaymentSettlementFeeAmount: AmountImpact

The AmountImpact for the pull payment settlement fees.

pushPaymentSettlementAmount: AmountImpact

The AmountImpact for the push payment settlement.

pushPaymentSettlementFeeAmount: AmountImpact

The AmountImpact for the push payment settlement fees.

receivingAccount: FinancialAccount

The receiving FinancialAccount.

settlementAmount: AmountImpact

The AmountImpact for settlement.

settlementAmountRoundingStrategy: RoundingStrategy

The RoundingStrategy for the settlementAmount.

status: InstantSettlementTransactionStatus

The status of the InstantSettlementTransaction.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

network: PaymentCardNetwork

The PaymentCardNetwork for which this settlement transaction occurred.

InstantSettlementTransactionEvent

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

eventType: InstantSettlementTransactionEventType

The type of event.

status: InstantSettlementTransactionStatus

The status of the event.

achTransfer: OriginatedAchTransfer

The AchTransfer that this event is related to.

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the integrator initiated ACH transfer.

fromFinancialAccount: AllFinancialAccount

The account sending the funds.

This will always be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

This will always be a type of ExternalFinancialAccount.

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

sameDay: Boolean

A flag that indicates that this transaction was Same-Day ACH.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

IntegratorInitiatedFundsDepositACHTransferEvent

A financial event that represents ACH funds deposit.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer event was created.

The status of the integrator initiated ACH transfer.

fromFinancialAccount: ExternalFinancialAccount

The account sending the funds.

toFinancialAccount: FinancialAccount

The account receiving the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

IntegratorInitiatedFundsWithdrawalACHTransfer

A withdrawal of funds from a FinancialAccount to an ExternalFinancialAccount.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the integrator initiated ACH transfer.

fromFinancialAccount: AllFinancialAccount

The account sending the funds.

This will always be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

This will always be a type of ExternalFinancialAccount.

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

sameDay: Boolean

A flag that indicates that this transaction was Same-Day ACH.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

IntegratorInitiatedFundsWithdrawalACHTransferEvent

A financial event that represents ACH funds withdrawal.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer event was created.

The status of the integrator initiated ACH transfer.

fromFinancialAccount: FinancialAccount

The account sending the funds.

toFinancialAccount: ExternalFinancialAccount

The account receiving the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

InterchangeFeePaymentTransactionFee

A fee associated with interchange a PaymentTransaction.

Output:OBJECT

Interfaces

Fields

feeAmount: Amount

The amount of the fee.

accountingDirection: AccountingDirection

The direction the fees are moving in the perspective of the subscriber.

when DEBIT, this fee is deducted from the total payable amount.
when CREDIT, this fee is credited to the total payable amount.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

The current status of the transfer.

statusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

purpose: TransferPurpose

The purpose for the transfer.

interFinancialAccountTransferRuleResults: [InterFinancialAccountTransferRuleResult!]

The outcomes of running rules on the transfer.

fromFinancialAccount: FinancialAccount

The source financial account of the transfer.

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent

The InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent is triggered when money movement from a Funding Financial Account to a Payment Financial Account has failed.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

internalTransferStatusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current internal transfer status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent

The InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent is triggered when money movement from a Funding Financial Account to a Payment Financial Account is pending.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent

The InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent is triggered when money movement from a Payment Financial Account to a Funding Financial Account has completed.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent

The InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent is triggered when money movement from a Payment Financial Account to a Funding Financial Account has failed.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

internalTransferStatusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current internal transfer status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent

The InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent is triggered when money movement from a Payment Financial Account to a Funding Financial Account is pending.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

internalTransferStatus: InterFinancialAccountTransferStatus

The current status of the internal transfer.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

IPAddress

IP address details.

Output:OBJECT

Fields

v4: String

The IPv4 address of the consenting party at the time they accepted the agreement.

v6: String

The IPv6 address. The IPv6 address provided should be the IP address of your customer and not your hosted server.

IssuePaymentCardForFinancialAccountResponse

Represents a payment card creation request.

Output:OBJECT

Fields

status: IssuePaymentCardForFinancialAccountResponseStatus

The status of the request to issue PaymentCards in bulk.

failureReason: String

If the request failed, the reason for the failure.

paymentCard: PaymentCard

The PaymentCard created as part of the request.

IssuePaymentCardOptionsDetail

Representation of IssuePaymentCardOptionsInput.

IssuePaymentCardOptionsDetail is used to safely return the values provided in IssuePaymentCardOptionsInput

Output:OBJECT

Fields

expirationDate: String

The exact date and time the payment card will expire. e.g. 2026-01-01T23:59:59Z

activateOnCreate: Boolean

Whether or not to activate the card when created. If not activated on creation, the card must be activated separately before use.

cardProfileSet: CardProfileSet

The card profile set

IssuerPreliminaryAuthorizationEvent

An IssuerPreliminaryAuthorizationEvent for a transaction. This event is created before subscriber's collaborative authorization endpoint is called. AuthorizationEvent is created after the subscribers response to collaborative request.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this IssuerPreliminaryAuthorizationEvent or correlate it with other events on this Transaction.

transaction: Transaction

The Transaction for this event.

responseCode: TransactionEventResponseCode

The Highnote response code.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: ID

The transaction ID from the card network (e.g. Mastercard).

approvedAmount: Amount

The Amount approved for this IssuerPreliminaryAuthorizationEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this IssuerPreliminaryAuthorizationEvent and displayed in the transaction's (local) currency. Does not include fees.

originalAmount: Amount

The original Amount of this IssuerPreliminaryAuthorizationEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this IssuerPreliminaryAuthorizationEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this IssuerPreliminaryAuthorizationEvent.

cardProduct: CardProduct

The CardProduct associated to this IssuerPreliminaryAuthorizationEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

authorizationExpiration: String

The date and time, in ISO 8601 format, the authorization will expire.

spendRuleResults: SpendRuleResultConnection

The triggered spend rules and the results for the authorization.

Input Arguments

first: Int

The number of results to return.

Default Value: 20

after: String

The cursor to start the page.

currentFinancialAccountAvailableToSpendAmount: Amount

The Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Service Input.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the IssuerPreliminaryAuthorizationEvent.

currencyConversionRate: Float

Conversion rate applied to the requestedAmount to get the requestedAmountInSettlementCurrency for this IssuerPreliminaryAuthorizationEvent.

Can be up to 7 decimal places, e.g. 1.2345678.

requestedAmountInSettlementCurrency: Amount

The Amount requested to be approved for this IssuerPreliminaryAuthorizationEvent converted to the settlement currency.

cashbackAmount: Amount

The Amount of cashback requested during the transaction.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetails

The details of the CardDigitalWalletToken at the time of this IssuerPreliminaryAuthorizationEvent event.

JournalEntry

A Journal Entry, showing the debit and credit ledger entries of a financial event. Every Journal Entry will have a LedgerEntry that is crediting a Ledger and a corresponding LedgerEntry that is debiting from a Ledger.

Output:OBJECT

Interfaces

Fields

id: ID!

The id of JournalEntry.

credits: [CreditLedgerEntry!]

Credit entries for this JournalEntry.

debits: [DebitLedgerEntry!]

Debit entries for this JournalEntry.

JustInTimeFundingFinancialAccountFeature

Whether or not the Financial Account supports Just-in-time Funding.

Output:OBJECT

Interfaces

Fields

enabled: BooleanDeprecated

Whether or not the feature is enabled for the Financial Account.

Access OnDemandFundingFinancialAccountFeature.enabled instead

createdAt: StringDeprecated

The date and time, in ISO 8601 format, the feature was created.

Access OnDemandFundingFinancialAccountFeature.createdAt instead

updatedAt: StringDeprecated

The date and time, in ISO 8601 format, the feature was last updated.

Access OnDemandFundingFinancialAccountFeature.updatedAt instead

effectiveFrom: StringDeprecated

The date and time, in ISO 8601 format, the feature was effective from.

Access OnDemandFundingFinancialAccountFeature.enabled instead

effectiveThrough: StringDeprecated

The date and time, in ISO 8601 format, the feature was effective through.

Access OnDemandFundingFinancialAccountFeature.enabled instead

Ledger

A ledger represents a record in an account used to collect related activity. For example, an Organization will have a CASH ledger which tracks every transaction related to CASH.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Ledger in operations.

The name of the Ledger.

description: String

A description of what activity the ledger is tracking.

normalBalance: NormalBalance

The expected normal balance of the Ledger.

creditBalance: Amount

The credit balance of the Ledger.

debitBalance: Amount

The debit balance of the Ledger.

asOf: String

The date and time, in ISO 8601 format, the debitBalance and creditBalance were last calculated.

financialAccount: FinancialAccount

The financial account the ledger is backing.

ledgerEntries: LedgerEntryConnection

The ledger entries that belong to this ledger

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

Input Arguments

first: Int

The number of LedgerEntry to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: LedgerEntriesFilterInput

Fields

id: ID!

Id for the workflow.

accountHolderId: ID

The identifier of an Account holder

The provider that Highnote used to verify this bank account.

reasons: [LinkVerifiedExternalBankAccountFailureReason!]

The reasons for the external bank account linking failure.

createdAt: String

The date and time, in ISO 8601 format, the external bank account was created.

updatedAt: String

The date and time, in ISO 8601 format, the external bank account was last updated.

LinkVerifiedExternalBankAccountFailureReason

A reason for the external bank account linking failure.

Output:OBJECT

Fields

code: String

A machine-readable code for the specific failure reason.

description: String

A human-readable description for the specific failure reason.

ManualAdjustmentEvent

A ManualAdjustmentEvent for an event that triggers the ledger

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the manual adjustment event. This id can be used to later retrieve details of this ManualAdjustmentEvent.

adjustmentActivityType: ManualAdjustmentActivityType

The type of manual adjustment event.

manualAdjustmentDetails: [ManualAdjustmentDetail!]

The event encapsulate impacted account and amount for a ManualAdjustment.

originalFinancialEvent: FinancialEventDeprecated

Related original finanical event

Use originalFinancialEventId instead

createdAt: String

The date and time, in ISO 8601 format, this ManualAdjustment was created.

updatedAt: String

The date and time, in ISO 8601 format, this ManualAdjustment was updated.

originalFinancialEventId: ID

The ID of a financial event. This id can be used to later retrieve details of this FinancialEvent or correlate it with other events on this ManualAdjustment.

ManualDocumentRequestUploadSession

A document upload session that has been requested.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the document upload session

The current state of the document upload session

createdAt: String

The date and time, in ISO 8601 format, this ManualDocumentRequestUploadSession was created.

updatedAt: String

The date and time, in ISO 8601 format, this ManualDocumentRequestUploadSession was last updated.

expiresAt: String

The date and time, in ISO 8601 format, this ManualDocumentRequestUploadSession will expire.

documentRequests: [DocumentRequest!]

A list of requested documents.

documents: [UploadLink!]

A list of documents uploaded via a secure document upload link

owner: DocumentCollectionOwnerEntity

The document owner this session has been created for

primaryEntity: DocumentCollectionPrimaryEntity

The primary entity associated with the DocumentUploadSession.

aggregateEntity: DocumentCollectionAggregateEntity

The aggregate entity to which all documents in this collection entry are associated.

ManualTransferAmount

A manually set amount to be transferred

Output:OBJECT

Fields

amount: Amount

The requested amount to be transferred

MastercardAdditionalFuelLocationDetails

Details about the fuel location used in a fleet transaction.

Output:OBJECT

Fields

openTwentyFourHours: Boolean

This fuel location is open 24 hours.

eighteenWheelerAccess: Boolean

This fuel location has access for 18 wheelers.

dieselSites: Boolean

This fuel location has diesel sites.

interstateAccess: Boolean

This fuel location has interstate highway access.

convenienceStore: Boolean

This fuel location has a convenience store.

restaurant: Boolean

This fuel location has a restaurant.

hotel: Boolean

This fuel location has a hotel.

showers: Boolean

This fuel location has showers.

repairBays: Boolean

This fuel location has repair bays.

vehicleWash: Boolean

This fuel location has a vehicle washing station.

aviationLocation: Boolean

This fuel location has an aviation location.

marinaLocation: Boolean

This fuel location has a marina location.

alternativeFuel: Boolean

This fuel location has alternative fuel pumps.

payAtPump: Boolean

This fuel location has pay-at-pump support.

MastercardData

Mastercard specific transaction data.

Output:OBJECT

Fields

banknetReferenceNumber: String

Mastercard’s alphanumeric Banknet reference number used to identify the transaction.

authorizationCode: String

An alphanumeric value generated by Highnote and shared with Mastercard when an authorization is approved.

acquiringInstitutionIdentificationCode: String

A number used by Mastercard to identify the acquiring institution.

systemTraceAuditNumber: String

A number assigned by the message initiator that uniquely identifies a transaction.

retrievalReferenceNumber: String

An value used to identify and track a transaction’s separate messages.

networkTransmissionDateAndTime: String

The date and time that the network transmitted the transaction. This value is expressed in Greenwich Mean Time (GMT) with format (MMDDhhmmss)

fraudScore: UnsignedInt

The fraud score for the transaction provided by Mastercard. Values are between 0-999.

aavResultCode: MastercardAavResultCode

Validation result for Mastercard's Accountholder Authentication Value.

threeDSecureCardholderAuthentication: MastercardThreeDSecureCardholderAuthentication

Information about the 3DSecure Cardholder Authentication.

ucafCollectionIndicator: MastercardUcafCollectionIndicator

Information about the collection capabilities of the Universal Cardholder Authentication Field.

paymentFacilitatorIdentifier: String

Payment facilitator identifier for the transaction.

MastercardFleetAuthorizationData

Details pertaining to a Mastercard Fleet transaction available at Authorization and Authorization Advice time

Output:OBJECT

Interfaces

Fields

id: ID!

Globally unique id of a MastercardFleetEnhancedData

driverIdentifier: String

An alphanumeric value representing a Driver ID provided by the cardholder

vehicleIdentifier: String

An alphanumeric value representing a Vehicle ID provided by the cardholder

spendControlOverrideFlag: Boolean

Indicates whether the POS supports overriding the fleet spend controls on the card

prompts: [MastercardFleetPrompt!]

A list of prompt codes and cardholder-entered values

fuelProducts: [MastercardFleetAuthorizationDataFuelProduct!]

A list of fuel products purchased

nonFuelProducts: [MastercardFleetAuthorizationDataNonFuelProduct!]

A list of non-fuel products purchased

MastercardFleetAuthorizationDataFuelProduct

Details of a Mastercard Fleet fuel product available at Authorization and Authorization Advice time

Output:OBJECT

Fields

code: MastercardFleetFuelProductCode

Indicates the type of fuel product purchased

unitPrice: UnsignedInt

The unit price of the fuel product as a whole number

unitPricePrecision: UnsignedInt

The precision of the UnitPrice value

unitOfMeasure: MastercardFleetUnitOfMeasure

The unit of measure for the product purchased

quantity: UnsignedInt

The quantity for the product purchased as a whole number

quantityPrecision: UnsignedInt

The precision of the Quantity value

saleAmount: Amount

Contains the sale amount of the product purchased

MastercardFleetAuthorizationDataNonFuelProduct

Details of a Mastercard Fleet non-fuel product available at Authorization and Authorization Advice time

Output:OBJECT

Fields

code: MastercardFleetNonFuelProductCode

Indicates the type of fuel product purchased

unitOfMeasure: String

The unit of measure for the product purchased

quantity: UnsignedInt

The quantity for the product purchased as a whole number

quantityPrecision: UnsignedInt

The precision of the Quantity value

extendedItemAmount: Amount

Contains the individual item amount that is normally calculated as price multiplied by quantity

MastercardFleetEnhancedData

Details of Mastercard Fleet enhanced transaction data. These are relevant additional transaction data items pertaining to a fleet transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

Globally unique id of a MastercardFleetEnhancedData.

fuelBrand: MastercardFleetFuelBrand

Oil Company Brand Name

purchaseTime: String

The local time the purchase was made. Should be in the format hhmm, with hours in the range 00–23 and minutes in the range 00–59

fuelServiceType: MastercardFleetFuelServiceType

Motor Fuel Service Type

fuelType: MastercardFleetProductCode

Motor Fuel Product Code

fuelUnitPrice: Amount

Motor Fuel Unit Price

fuelUnitPriceValue: UnsignedInt

The raw value received from the network for the motor fuel unit price

fuelUnitPriceValuePrecision: UnsignedInt

The decimal precision for the fuelUnitPriceValue

fuelUnitOfMeasure: MastercardFleetUnitOfMeasure

Motor Fuel Unit of Measure

fuelQuantity: Float

Motor Fuel Quantity

fuelSaleAmount: Amount

Motor Fuel Sale Amount

odometerReading: String

Odometer Reading. Only included if POS prompts for this value

vehicleNumber: String

Vehicle Identification Number. Only included if POS prompts for this value

driverIdentification: String

Driver Identification Number. Only included if POS prompts for this value

productType: MastercardFleetProductType

Product Type Code

fuelDiscountAmount: Amount

Fuel Discount Amount

taxAmount1: Amount

Tax Amount 1

taxAmount2: Amount

Tax Amount 2

fuelLocationDetails: MastercardAdditionalFuelLocationDetails

Details about the fuel location

lineItems: [MastercardFleetEnhancedDataLineItem!]

Line items on the invoice

MastercardFleetEnhancedDataLineItem

An single line item within a MastercardFleetEnhancedData

Output:OBJECT

Fields

productCode: MastercardFleetProductCode

The product code of the individual item purchased

description: String

Description of the individual item purchased

Maximum length: 255 characters

quantity: Float

Quantity of the item purchased

unitOfMeasure: String

The unit of measurement for the item purchased

unitPrice: Amount

The unit price of the item purchased

unitPriceValue: UnsignedInt

The raw value received from the network for the line item unit price

unitPriceValuePrecision: UnsignedInt

The decimal precision for the unitPriceValuePrecision

itemAmount: Amount

the individual item amount that is normally calculated as price multiplied by quantity

itemAmountValue: UnsignedInt

The raw value received from the network for the individual item amount

itemAmountValuePrecision: UnsignedInt

The decimal precision for the itemAmountValue

creditOrDebit: MastercardFleetCreditOrDebitIndicator

Indicates whether the item amount, net of discount, taxes, and price, is a debit or credit

MastercardFleetPrompt

Details of a Mastercard Fleet Prompt. Contains a prompt code and cardholder-entered value

Output:OBJECT

Fields

code: MastercardFleetPromptType

Indicates the type of prompted information

value: String

An alphanumeric value indicating the value entered by the cardholder

MastercardFraudScoreSpendRule

A Spend Control rule that blocks transactions if the Mastercard Fraud Score is above a configured threshold.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the MastercardFraudScoreSpendRule in operations.

The name assigned to the rule.

maximumMastercardFraudScore: UnsignedInt

The maximum Mastercard Fraud Score allowed for a transaction before transaction is declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MastercardFraudScoreSpendRuleResult

The result of applying a MastercardFraudScoreSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

mastercardFraudScore: UnsignedInt

The Mastercard Fraud Score for this transaction.

spendRule: MastercardFraudScoreSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MastercardInstallmentData

Mastercard-specific installment payment data.

Output:OBJECT

Fields

singleAuthorizationMultipleCaptures: Boolean

Indicates whether this is a single authorization with multiple captures.

MaximumAmountVarianceOnPseudoBalanceSpendRule

A Spend Control rule that allows for spending up to a specified Amount above the account's original balance'.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the MaximumAmountVarianceOnPseudoBalanceSpendRule in operations.

The name assigned to the rule.

amountVariance: Amount

The Amount over the account's original balance that is permitted for additional spending.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MaximumAmountVarianceOnPseudoBalanceSpendRuleResult

The result of applying a MaximumAmountVarianceOnPseudoBalanceSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [Amount!]

The tested Amount of the event.

spendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MaximumPercentVarianceOnPseudoBalanceSpendRule

A Spend Control rule that allows for spending up to a specified percentage over the account's original balance.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the MaximumPercentVarianceOnPseudoBalanceSpendRule in operations.

The name assigned to the rule.

percentVariance: Int

The percentage over the account's original balance that is permitted for additional spending.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MaximumPercentVarianceOnPseudoBalanceSpendRuleResult

The result of applying a MaximumPercentVarianceOnPseudoBalanceSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [Amount!]

The tested Amount of the event.

spendRule: MaximumPercentVarianceOnPseudoBalanceSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MerchantCategoryDetails

A representation of the merchant category that includes the category, the code and a display name.

Output:OBJECT

Fields

merchantCategory: MerchantCategory

The merchant category enum.

merchantCategoryCode: String

The merchant category enum number representation.

displayName: String

The display name of the merchant category.

MerchantCategoryDetailsContainer

A container for a list of merchant category details.

Output:OBJECT

Fields

merchantCategoryDetails: [MerchantCategoryDetails!]

A list of merchant category details.

MerchantCategorySpendRule

A Spend Control rule that allows or blocks certain merchant categories codes (MCC) during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Merchant Category Spend Rule in operations.

The name assigned to the rule.

allowed: [MerchantCategory!]

The merchant categories that will be allowed during authorizations.

blocked: [MerchantCategory!]

The merchant categories that will result in declined authorizations.

allowedMcc: [String!]

The merchant category codes that will be allowed during authorizations.

blockedMcc: [String!]

The merchant category codes that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MerchantCategorySpendRuleResult

The result of applying a merchant category spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [MerchantCategory!]

The merchant category of the event.

spendRule: MerchantCategorySpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MerchantCountrySpendRule

A Spend Control rule that allows or blocks certain merchant countries during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Merchant Category Spend Rule in operations.

The name assigned to the rule.

allowed: [ISO3166Alpha3Country!]

The merchant countries that will be allowed during authorizations.

blocked: [ISO3166Alpha3Country!]

The merchant countries that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MerchantCountrySpendRuleResult

The result of applying a merchant country spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [ISO3166Alpha3Country!]

The merchant country of the event.

spendRule: MerchantCountrySpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MerchantDetails

The details about the merchant who requested the authorization.

Output:OBJECT

Fields

merchantId: String

The merchant identifier.

category: MerchantCategory

The merchant category for the authorization.

categoryCode: String

The merchant category code for the authorization.

countryCodeAlpha3: ISO3166Alpha3Country

The merchant country code for the authorization.

description: String

The description. a.k.a. "Descriptor".

The merchant or institution name.

address: Address

The address of the merchant.

subMerchantIdentifier: String

Sub-merchant identifier for the transaction.

MerchantFeePaymentTransactionFee

A fee associated for the merchant to process the PaymentTransaction.

Output:OBJECT

Interfaces

Fields

feeAmount: Amount

The amount of the fee.

accountingDirection: AccountingDirection

The direction the fees are moving in the perspective of the subscriber.

when DEBIT, this fee is deducted from the total payable amount.
when CREDIT, this fee is credited to the total payable amount.

MerchantIdentifierSpendRule

A Spend Control rule that allows or blocks authorizations based on merchant identifier.

A merchant identifier is typically a numeric string representing the merchant in an acquirer's or network's system.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the spend rule in operations.

The name assigned to the rule.

allowed: [String!]

The merchant identifiers that will be allowed during authorizations.

blocked: [String!]

The merchant identifiers you want to block during authorizations.

Matching values will result in a declined authorization.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MerchantIdentifierSpendRuleResult

The result of applying a merchant identifier spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [String!]

The merchant identifiers of the event.

spendRule: MerchantIdentifierSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MerchantManagedInstallmentPayment

Information about a merchant-managed installment payment plan.

Output:OBJECT

Fields

totalAmount: Amount

The total amount across all payments in the plan.

numberOfInstallments: UnsignedInt

The total number of payments in the plan.

paymentAmount: Amount

The amount for each individual payment.

frequency: InstallmentFrequency

The frequency at which payments occur.

firstPaymentDate: String

The date of first installment payment, in ISO 8601 format (YYYY-MM-DD).

paymentNumber: UnsignedInt

The number of this installment payment.

fundedAmount: Amount

The total amount that has been funded so far in the plan.

firstInstallmentPaymentTransaction: PaymentTransaction

The PaymentTransaction from the first installment payment. Used to link all subsequent installment payments in the series.

networkData: InstallmentNetworkData

Network-specific installment payment data.

MerchantSettlementFinancialAccountFeature

Whether or not the FinancialAccount supports merchant settlement.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

MilitaryLendingActConfiguration

The Military Lending Act (MLA) configuration.

Output:OBJECT

Fields

effectiveFrom: Date

The date this MilitaryLendingActConfiguration starts to be in effect, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15.

effectiveThrough: Date

The date this MilitaryLendingActConfiguration stops being in effect, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15. Optional; if not present, this configuration is treated as indefinite, with no set end date.

updatedAt: String

The date and time when this was updated, in ISO 8601 format.

createdAt: String

The date and time, in ISO 8601 format, this was created.

MinimumAmountLimitSpendRule

A Spend Control rule that only allows transactions for a specified amount.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the MinimumAmountLimitSpendRule in operations.

The name assigned to the rule.

minimumAmount: Amount

The exact amount to allow for a single transaction.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

MinimumAmountLimitSpendRuleResult

The result of applying a MinimumAmountLimitSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [Amount!]

The tested Amount of the event.

spendRule: MinimumAmountLimitSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

MoneyMovementProductFeature

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not this ProductFeature is enabled for the Product.

createdAt: String

The date and time, in ISO 8601 format, this ProductFeature was created.

updatedAt: String

The date and time, in ISO 8601 format, this ProductFeature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, this ProductFeature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, this ProductFeature was effective through.

Name

Type representing common fields of a person's name.

Output:OBJECT

Fields

givenName: String

The part of the name that identifies a person.

middleName: String

Additional part of name that identifies a person.

familyName: String

Part of a personal name that identifies a family, tribe, or community.

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

NegativeBalanceReserveFinancialAccountFeature

The Negative Reserve is held to cover deficits in the product such as potential over limits, fraud, uncollectible negative balances, and losses due to disputes or network charges. Funds may not be transferred out of the Negative Reserve.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

NetworkFeePaymentTransactionFee

A fee associated with network processing the PaymentTransaction.

Output:OBJECT

Interfaces

Fields

feeAmount: Amount

The amount of the fee.

accountingDirection: AccountingDirection

The direction the fees are moving in the perspective of the subscriber.

when DEBIT, this fee is deducted from the total payable amount.
when CREDIT, this fee is credited to the total payable amount.

NonFailureACHTransferStatus

The status of the ACH transfer that has not failed.

This could be statuses which are still pending work or that have successfully completed.

Output:OBJECT

Fields

status: ACHTransferStatus

The status of the integrator initiated ACH transfer.

NonFailureExternallyInitiatedACHStatus

The status of the ACH transfer that has not failed.

This could be statuses which are still pending work or that have successfully completed.

Output:OBJECT

Fields

status: ExternallyInitiatedACHStatus

The status of the externally initiated ACH transfer.

The details of an AchTransfer initiated by an external financial institution. It can PULL funds from a Highnote FinancialAccount to an external financial institution or PUSH funds from an external financial institution to a Highnote FinancialAccount.

Output:OBJECT

Interfaces

AchTransfer

Fields

id: ID!

Global ID used to reference the NonOriginatedAchTransfer.

amount: Amount

The monetary amount to transfer.

createdAt: String

The date and time the transfer was received, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

updatedAt: String

The date and time the transfer details were last updated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The direction of the transfer, PUSH or PULL, from the perspective of the originating financial institution.

PUSH means pushing funds from an external financial account to a Highnote FinancialAccount and PULL means pulling funds from a Highnote FinancialAccount to an external financial account.

purpose: AchTransferPurpose

The purpose of the transfer, e.g. repayment.

The impact of the transfer on the Highnote FinancialAccount. Negative means a reduction of funds on the Highnote FinancialAccount. Positive means an increase of funds on the Highnote FinancialAccount.

financialAccount: FinancialAccount

The Highnote FinancialAccount funds being pulled from or pushed to.

cardProduct: CardProduct

The CardProduct associated with the Highnote FinancialAccount.

companyName: String

The name of the company that initiated the transfer.

companyIdentifier: String

The ID of the company that initiated the transfer.

companyEntryDescription: String

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

Maximum length: 10 characters.

individualName: String

Receiver’s individual name. This could be a person or a business.

Maximum length: 22 characters.

individualIdentificationNumber: String

Receiver’s identification number. This could be a person or a business.

Maximum length: 15 characters.

paymentRelatedInformation: String

Contains payment-related information provided by the originator of the transaction. It can include free-form text, structured data, or codes. The field supports alphanumeric characters, including the following symbols: ! " & ' ( ) * + , - . / : ; ? = % ~ @ [ ] { } \ | < > # $.

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters.

traceNumber: String

A unique 15 digit number assigned by the originator. It is used is used to identify the transfer in the ACH network.

status: NonOriginatedAchTransferStatus

The status of the transfer.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the transfer failed. This is only applicable when the transfer status is FAILED or RETURNED.

holdStatus: AchHoldStatus

The hold status of the transfer.

Funds from a NonOriginatedAchTransfer PUSH are not available to spend while the transfer is ON_HOLD.

This field is currently restricted to administrators.

holdType: AchHoldType

The hold type of the transfer.

This field is currently restricted to administrators.

settlementDate: String

The date in which the originating financial institution expects ACH settlement to occur, in ISO 8601 format, e.g. 2024-01-01.

processedAt: String

The date and time the transfer was processed (e.g. transitioned to PROCESSED) and reflected on the financial account, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

failedAt: String

The date and time the transfer was failed by Highnote before it was returned to the external financial institution, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

returnSentToBankAt: String

The date the transfer was returned by Highnote to the external financial institution, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

Output:OBJECT

Interfaces

Fields

id: ID!

Uniquely identifies the NonOriginatedAchTransferReturnedEvent.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the ACH transfer failed.

returnSentToBankAt: String

The date the transfer was returned by Highnote to the external financial institution, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

transfer: NonOriginatedAchTransfer!

Details about the NonOriginatedAchTransfer that was returned by Highnote.

NonOriginatedAchTransferSnapshot

A snapshot of a non-originated ACH transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this snapshot.

transfer: NonOriginatedAchTransfer

The non-originated ACH transfer that this is a revision of.

createdAt: String

The date and time this snapshot was created, in ISO 8601 format.

updatedAt: String

The date and time this snapshot was last updated, in ISO 8601 format.

version: Int

The version number of this snapshot.

amount: Amount

The monetary amount to transfer.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The direction of the transfer, PUSH or PULL, from the perspective of the originating financial institution.

PUSH means pushing funds from an external financial account to a Highnote FinancialAccount and PULL means pulling funds from a Highnote FinancialAccount to an external financial account.

purpose: AchTransferPurpose

The purpose of the transfer, e.g. repayment.

financialAccount: FinancialAccount

The Highnote FinancialAccount funds being pulled from or pushed to.

cardProduct: CardProduct

The CardProduct associated with the Highnote FinancialAccount.

companyName: String

The name of the company that initiated the transfer.

companyIdentifier: String

The ID of the company that initiated the transfer.

companyEntryDescription: String

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

Maximum length: 10 characters.

individualName: String

Receiver's individual name. This could be a person or a business.

Maximum length: 22 characters.

individualIdentificationNumber: String

Receiver's identification number. This could be a person or a business.

Maximum length: 15 characters.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters.

traceNumber: String

A unique 15 digit number assigned by the originator. It is used is used to identify the transfer in the ACH network.

status: NonOriginatedAchTransferStatus

The status of the transfer.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the transfer failed. This is only applicable when the transfer status is FAILED or RETURNED.

holdStatus: AchHoldStatus

The hold status of the transfer.

Funds from a NonOriginatedAchTransfer PUSH are not available to spend while the transfer is ON_HOLD.

This field is currently restricted to administrators.

holdType: AchHoldType

The hold type of the transfer.

This field is currently restricted to administrators.

settlementDate: String

The date in which the originating financial institution expects ACH settlement to occur, in ISO 8601 format, e.g. 2024-01-01.

processedAt: String

The date and time the transfer was processed (e.g. transitioned to PROCESSED) and reflected on the financial account, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

failedAt: String

The date and time the transfer was failed by Highnote before it was returned to the external financial institution, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

returnSentToBankAt: String

The date the transfer was returned by Highnote to the external financial institution, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

lastHoldStatusChangedAt: String

The date and time the hold status last changed, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

Funds from a NonOriginatedAchTransfer PUSH are not available to spend while the transfer is ON_HOLD.

This field is currently restricted to administrators.

NonOriginatedRtpTransfer

A non-originated RTP (Real-Time Payments) transfer via the TCH network.

A NonOriginatedRtpTransfer represents an RTP transfer received by the Highnote partner bank from an external bank account.

Output:OBJECT

Interfaces

RtpTransfer

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, when this object was received.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

The current status of the NonOriginatedRtpTransfer.

failureReason: RtpTransferFailureReason

When the NonOriginatedRtpTransfer has failed, this will be populated with the reason for the failure.

source: RtpTransferSource

The source of the funds being transferred.

destination: RtpTransferDestination

The destination of the funds being transferred.

events: [NonOriginatedRtpTransferEvent!]

The events associated with this NonOriginatedRtpTransfer.

bankTransferDetails: RtpTransferBankTransferDetails

Additional details for the bank transfer including payment related information.

NonOriginatedRtpTransferEvent

An event associated with a NonOriginatedRtpTransfer.

Output:OBJECT

Interfaces

Fields

id: ID!

The global ID of the event.

createdAt: String

The date and time, in ISO 8601 format, when this event occurred.

The status of the NonOriginatedRtpTransfer when the event occurred.

failureReason: RtpTransferFailureReason

When the NonOriginatedRtpTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

rtpTransfer: NonOriginatedRtpTransfer

The NonOriginatedRtpTransfer associated with this event.

NonVerifiedExternalUSFinancialBankAccount

A NonVerifiedExternalUSFinancialBankAccount

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the External Financial Account in operations.

The name of this account

accountStatus: ExternalFinancialAccountStatus

ExternalFinancialBankAccount status.

externalBankAccountDetails: NonVerifiedExternalUSFinancialBankAccountDetail

The external bank account added to this external financial account.

The owner of this financial account.

Features on the NonVerifiedExternalUSFinancialBankAccount

createdAt: String

The date and time, in ISO 8601 format, the account was created.

updatedAt: String

The date and time, in ISO 8601 format, the account was last updated.

NonVerifiedExternalUSFinancialBankAccountDetail

A financial instrument with an associated account and routing number.

The direct deposit detail that can be used to deposit funds.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the external bank account detail in operations.

last4: String

The last four digits of bank account number.

type: BankAccountType

The details about the type of bank account.

routingNumber: String

The routing number for the bank account.

restrictedDetails: NonVerifiedExternalUSFinancialBankAccountDetailRestrictedDetailsResult

The decrypted account number for this external bank account detail.

createdAt: String

The date and time, in ISO 8601 format, the external bank account detail was created.

updatedAt: String

The date and time, in ISO 8601 format, the external bank account detail was last updated.

NonVerifiedExternalUSFinancialBankAccountRestrictedDetails

Non Verified External US Financial Bank Account Details.

Output:OBJECT

Fields

number: String

The bank account number.

routingNumber: String

The routing number for the bank account.

NonVerifiedFinancialAccountFeature

Whether or not the Financial Account is a Non Verified account

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

NotificationEvent

The Notification Event that was triggered in the Highnote platform.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Event in operations.

createdAt: String

The date and time, in ISO 8601 format, the Notification Event was created.

expiresAt: String

The date and time, in ISO 8601 format, the Notification Event will expire.

The name of the Notification Event that was triggered.

node: NotificationEventNode

The Notification Event.

origination: Origination

Information about the origination of this event if it was relayed from another organization. Only present for relayed events.

deliveryAttempts: DeliveryAttemptConnection

The history of delivery attempts for this Notification Event.

Input Arguments

first: Int

The page size.

after: String

Cursor.

NotificationEventEdge

The edge type for Notification Events.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: NotificationEvent

The Notification Event.

NotificationEventsConnection

The connection type for Notification Events.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [NotificationEventEdge!]

A list of edges.

NotificationEventValidationTestEvent

The event sent when initiateEventValidationTest mutation is called.

Output:OBJECT

Fields

fixtureVersion: String

fixture version

nonZeroAmount: Amount

nonZeroAmount

zeroAmount: Amount

zeroAmount

nonEmptyListOfStrings: [String!]

nonEmptyListOfStrings

emptyListOfStrings: [String!]

emptyListOfStrings

nullableListOfStringsWithNull: [String]

nullableListOfStrings

nullMerchantDetails: MerchantDetails

nullMerchantDetails

merchantDetails: MerchantDetails

nullMerchantDetails

nonEmptyListOfAccountAttributes: [FinancialAccountAttribute]

nonEmptyListOfAccountAttributes

emptyListOfAccountAttributes: [FinancialAccountAttribute]

emptyListOfAccountAttributes

id: ID!

Global ID used to reference the status event in operations.

target: NotificationTarget

The notification target for this status entry.

createdAt: String

The date and time, in ISO 8601 format the status changed.

Fields

Name of person to contact

phoneNumber: Phone!

The phone number for the person to contact

emailAddress: String

The email address for the person to contact

title: String

The business title of the person to contact

The status of applicant contact information being collected

OnboardingBusinessAuthorizedPerson

The details of the person authorized to act on behalf of business.

Output:OBJECT

Fields

id: ID

The ID of the authorized person.

The authorized person's name.

percentageOwnership: UnsignedInt

Percentage ownership of authorized person.

businessTitle: OnboardingBusinessTitle

Authorized person's business title.

email: String

The email address of the authorized person.

phoneNumbers: [Phone!]

List of phone numbers associated to the authorized person.

homeAddress: Address

The default physical address of the authorized person.

dateOfBirth: String

The date of birth of the authorized person represented in YYYY-MM-DD format.

identificationDocument: OnboardingIdentificationDocument

Identification Document associated with the authorized person.

yearsAtCurrentAddress: UnsignedInt

Identification Document associated with the authorized person.

isPrimaryApplicant: Boolean

Indicates who is the primary applicant of the application

isUsPerson: Boolean

Is this person a US citizen or resident?

OnboardingBusinessDetails

Business information collected for an application

Output:OBJECT

Interfaces

Fields

legalBusinessName: String!

Business name

legalBusinessAddress: Address

The legal address of the business

mailingBusinessAddress: Address

The mailing address of the business (if different from legal address)

businessNameOnTaxReturns: String!

The name of the business as it appears on tax returns

businessAddressOnTaxReturns: Address!

Business address on tax returns

taxIdentifier: TaxIdentificationDocument

Business identifier used for business tax returns

acceptsTips: Boolean!

Does the business accept tips?

doingBusinessAsName: String!

Doing Business As name

emailAddressForTaxReturns: String!

Email address for tax returns

supportAddress: Address!

The physical address for customer support

supportPhone: Phone!

The phone nunmber for customer support

supportEmail: String!

Email address for customer support

customerSupportWebsite: String!

Customer support website URL.

The validation for the website URL uses the following regex pattern ^((((https?|ftps?|gopher|telnet|nntp)://)|(mailto:|news:))(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+)([).!';/?:,][[:blank:|:blank:]])?$

dbaAddress: Address

The address that customer's are familiar with'

isMailingAddressTheSameAsLegal: Boolean

Is the mailing address the same as the legal address

isDbaAddressTheSameAsLegal: Boolean

Is the DBA address the same as the legal address

isTaxAddressTheSameAsLegal: Boolean

Is the address for tax purposes the same as the legal address

The status of business details information being collected

OnboardingBusinessHistory

Business history related to incorporaton, history, and goods and services provided.

Output:OBJECT

Interfaces

Fields

businessStructure: BusinessStructure

The type of business

regionOfFormation: String!

A region for the address based on the codes for identifying the principle subdivisions, e.g. provinces and states, of countries IS0 3166 standard, including districts and outlying areas.

stockExchange: StockExchange

(If applicable) The stock exchange where the business is listed

previousBankruptcy: Boolean!

Whether the business has filed for bankruptcy in the past

yearsOfOperation: UnsignedInt

The number of years this business has been in operation

yearsOfOwnership: UnsignedInt

The number of years this business has been owned by its current owners

numberOfBusinessLocations: UnsignedInt

The number of physical locations for this business

usingFulfillmentPartners: Boolean!

Whether the business is using one or more fulfillment partners

fulfillmentPartnersNames: [String!]

(If applicable) The names of the fulfillment partners used by the business

forwardCommittment: Boolean!

Whether the business bills its customers prior to shipping goods

forwardCommittmentBreakdown: ForwardCommittmentBreakdown

Details regarding how long the business holds onto funds before shipping goods

businessPhoneNumber: Phone!

The phone number in a country specific format.

businessFaxNumber: Phone

The fax number in a country specific format.

cardAcceptanceBreakdown: CardAcceptanceMethodBreakdown

The percentage of transactions broken down by acceptance methods

advertisingMethods: [AdvertisingMethod!]

The advertising methods used by the business

businessDescription: String!

3-4 sentences about overall company answeering "Who is your target market?", "What type of products/services do you specialize in?", "What differentitates you from your competitors?"

creditCardsPreviouslyAccepted: Boolean!

Whether the business has previously accepted credit cards

previousCardProcessorName: String

The name of the previous card processor used by the business (if applicable)

employeeCount: UnsignedInt

The number of people employed by the business

physicalGoodsSold: Boolean!

Whether the business sells physical goods

dateOfFormation: Date

The date this business was formed

Format: YYYY-MM-DD

businessEntity: BusinessEntityType

The type of business entity

terminatedByPreviousPaymentProcessor: Boolean

Whether the business was terminated by a previous payment processor

paymentProcessorTerminationReason: String

(If applicable) details about the termination by a previous payment processor, including reasoning

The status of business history information being collected

stockTickerSymbol: String

(If applicable) ticker symbol from the stock exchange where this company is traded

OnboardingBusinessOrganizationInformation

Business information collected for a subscriber application

Output:OBJECT

Interfaces

Fields

id: ID!

The Global ID of the business organization info.

applicantContact: OnboardingApplicantContact

The person to contact about questions regarding this application

businessDetails: OnboardingBusinessDetails

The details of the business

businessType: OnboardingBusinessType

The type of business

businessHistory: OnboardingBusinessHistory

The history of the business

operatingDetails: OnboardingBusinessProcessingAttributes

The operating details of the business

ownershipInformation: BusinessOwnershipInformation

Ownership information for the business

controlProng: OnboardingControlProng

The beneficial owner who has significant responsibility to control, manage, or direct the business.

eSignature: OnboardingESignature

The details recorded at time of submission for business organization information

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

status: OnboardingBusinessOrganizationInformationStatus

Status of collection and processing of OnboardingBusinessOrganizationInformation

OnboardingBusinessProcessingAttributes

The business' reported operating details.

Output:OBJECT

Interfaces

Fields

annualVolume: [Amount!]

Gross annual revenues for each currency the business transacts with, per the most recent fiscal year

largestTicket: [Amount!]

Largest single order amount for each currency the business transacts with, per the most recent fiscal year

averageTicket: [Amount!]

Average single order amount for each currency the business transacts with, per the most recent fiscal year

largestMonthlyVolume: [Amount!]

Largest monthly volumes for each currency the business transacts with, per the most recent fiscal year

isSeasonalBusiness: Boolean!

Whether a business experiences seasonality in its operations.

seasonalVolumeBreakdown: SeasonalVolumeBreakdown

Breakdown of volumme by month

cardAcceptance: [OnboardingPaymentCardBrand!]

Card brands that are currently being accepted or would like to accept with their new program

nameOnBankAccount: String!

Name as it appears on bank account

accountNumberStored: Boolean

Whether an account number was previously stored for this object

routingNumber: String

Routing number of bank account 6-9 digits

fiscalYearEndDate: Date

The fiscal year end date for the financial numbers reported numbers reported here

Format: YYYY-MM-DD

The status of processing attributes information being collected

OnboardingBusinessType

Business information collected for an application

Output:OBJECT

Interfaces

Fields

businessWebsite: String!

Business website URL.

industry: BusinessPlanOperatingGoodsAndServiceCategory

The high-level categorization of the business

goodsAndServicesProvided: String!

Description of goods and services provided

productDescription: String!

Additional information about your specific use-case

billingDescriptor: String

The description that will appear on a consumer's bank statement and will help them identify the transaction.

The status of type of business information being collected

billingDescriptorSuggestions: [String!]

A set of suggestions for the billing descriptor

OnboardingControlProng

Under the control prong, the beneficial owner is a single individual who has significant responsibility to control, manage, or direct the business.

Output:OBJECT

Interfaces

Fields

isControlProngAnUltimateBeneficialOwner: Boolean!

Whether the Control Prong is one of the ultimate beneficial owners of the company

ultimateBeneficialOwnerID: ID

(if applicable) The ID of the ultimate beneficial owner who is the Control Prong

authorizedPerson: OnboardingBusinessAuthorizedPerson

If not an ultimate beneficial owner, the person who is the Control Prong

The status of the controlling individual information being collected

OnboardingESignature

eSignature and date

Output:OBJECT

Interfaces

Fields

eSignature: String

eSignature

confirmationOfESignature: Boolean

Confirmation of eSignature

submissionDate: Date

Submission date

acceptanceOfPrivacyPolicy: Boolean

Acceptance of Privacy Policy

acceptanceOfTermsAndConditions: Boolean

Acceptance of Terms & Conditions

acceptanceOfAcquirerTerms: Boolean

Acceptance of Acquirer Terms

acceptanceDateOfPrivacyPolicy: Date

Acceptance date of Privacy Policy

acceptanceDateOfTermsAndConditions: Date

Acceptance date of Terms and Conditions

acceptanceDateOfAcquirerTerms: Date

Acceptance date of Acquirer Terms

The status of eSignature information being collected

OnboardingIdentificationDocument

The identification documents attached to a Person.

Output:OBJECT

Fields

socialSecurityNumber: TaxIdentificationDocument

A person's social security number (USA only).

Must have 9 digits divided into 3 parts by hyphen. For example, 123-45-6789. The first part should have 3 digits and should not be 000, 666, or between 900 and 999. The second part should have 2 digits and it should be from 01 to 99. The third part should have 4 digits and it should be from 0001 to 9999.

The validation for the input uses the following regex pattern ^(?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4}$.

passport: PassportIdentificationDocument

A person's passport information

OnboardingPreliminaryBusinessInformation

The initial business information collected from a potential business customer

Output:OBJECT

Interfaces

Fields

id: ID!

The Global ID of the preliminary business info.

businessName: String!

The legal name of the business

regionOfFormation: String

A region for the address based on the codes for identifying the principle subdivisions, e.g. provinces and states, of countries IS0 3166 standard, including districts and outlying areas.

businessWebsite: String!

Business website URL.

goodsAndServicesProvided: BusinessPlanOperatingGoodsAndServiceCategory!

The permitted types of transactions, e.g goods and services. If empty, this will be populated from the contract's capabilities which match attributes of this MID.

productDescription: String

A brief description of the products or services it provides.

primaryContactEmail: String!

The primary contact email to use during the onboarding process

preApproved: Boolean

Whether subscriber has been pre-approved for acquiring

status: OnboardingPreApprovalStatus

Current status of the preliminary decision on the business onboarding application

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

averageMonthlyVolume: OnboardingAverageMonthlyVolumeRangeDeprecated

The average processing volume for the business

Use averageMonthlyPaymentVolume instead.

globalRegion: OnBoardingBusinessGlobalRegion

The global region the business operates in

customerLocation: OnboardingCustomerLocationDeprecated

The location of the business' customers

No longer supported.

solution: OnboardingBusinessPaymentSolutionDeprecated

The desired solution for the business

Use desiredSolutions instead.

consent: ConsentAgreement

Consent to store the preliminary business information

primaryContactName: String

The primary contact name to use during the onboarding process

averageMonthlyPaymentVolume: OnboardingAverageMonthlyPaymentVolumeRange

The average processing volume for the business

desiredSolutions: [OnboardingDesiredPaymentSolution!]

All applicable desired solutions for the business

OnDemandFundingCardProductFeature

Whether or not the CardProduct supports on demand funding.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

pseudoBalanceEnabled: Boolean

Whether or not pseudo balance is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

OnDemandFundingFinancialAccountFeature

Whether or not the Financial Account supports On-Demand Funding.

Output:OBJECT

Interfaces

Fields

sourceFinancialAccount: FinancialAccount

The source financial account that will act as the on-demand funding source for this financial account.

sourceFinancialAccountId: IDDeprecated

The source financial account that will act as the on-demand funding source for this financial account.

Use sourceFinancialAccount.id instead.

pseudoBalanceEnabled: Boolean

Whether or not pseudo balance should be enabled for this financial account.

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

OneTimeACHTransfer

A scheduled one time ACH transfer

Output:OBJECT

Interfaces

ScheduledTransfer

Fields

id: ID!

Global ID used to reference the one time ACH transfer

fromFinancialAccount: AllFinancialAccount

The financial account sending the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The financial account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

transferAmount: TransferAmountStrategy

The amount to be transferred.

status: ScheduledTransferStatusCode

The status of the scheduled transfer

transferDayCalculationType: TransferDateCode

The day the transfer is scheduled to be executed. Optional; only set if transfer day is calculated (for example, payment due date).

scheduledTransferDate: String

The date and time, in ISO 8601 format, the scheduled transfer is to be executed.

transferEvents: ScheduledTransferEventConnection

The transfers executed as a result of the recurring transfer

Input Arguments

first: Int

Default Value: 20

after: String

createdAt: String

The date and time, in ISO 8601 format, this OneTimeACHTransfer was created.

updatedAt: String

The date and time, in ISO 8601 format, this OneTimeACHTransfer was last updated.

Organization

Organization that controls a set of card programs.

Output:OBJECT

Interfaces

Fields

paymentCardTransactionDisputes: PaymentCardTransactionDisputeConnection

A paginated list of PaymentCardTransactionDispute for this Organization. For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of PaymentCardTransactionDispute to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: PaymentCardTransactionDisputesFilterInput

Filter results to specific PaymentCardTransactionDispute.

paymentCardTransactionChargebacks: PaymentCardTransactionChargebackConnection

A paginated list of PaymentCardTransactionChargeback for this Organization. For information on Highnote's Search API, see our Search guide.

Input Arguments

first: Int

The number of PaymentCardTransactionChargeback to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: PaymentCardTransactionChargebacksFilterInput

Filter results to specific PaymentCardTransactionChargeback.

id: ID!

ID of the Organization

profile: OrganizationProfile!

Details of the Organization

apiKeys: APIKeyConnection

All API Keys associated to this Organization.

Input Arguments

first: Int

after: String

financialAccounts: [FinancialAccount!]Deprecated

The financial accounts backing this Organization.

Use accounts instead.

users: UserConnection

All Users with access to the Organization.

Input Arguments

first: Int

Default Value: 20

after: String

accounts: FinancialAccountConnection

All financial accounts associated with this organization.

Input Arguments

first: Int

after: String

filterBy: AccountHolderFinancialAccountsFilterInput

businessDetail: BusinessDetail

Detailed information about the organization

searchTransactions: TransactionSearchResultPayload

Searches across all types of transaction, transaction events, and financial activities.

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: TransactionSearchFilterInput!

userDefinedFieldDefinitions: UserDefinedFieldDefinitionConnection

UserDefinedFieldDefinitions associated with this organization.

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: UserDefinedFieldDefinitionsFilterInput

reviewWorkflowEvents: ReviewWorkflowEventConnectionPayload

The ReviewWorkflowEvents related to this FinancialAccount.

Input Arguments

after: String

Cursor for pagination

first: Int

Number of records to return

Default Value: 20

filterBy: ReviewWorkflowEventFilterInput

The filter input for ReviewWorkflowEvents

userDefinedFields: UserDefinedFieldConnection

UserDefinedFields associated with this organization.

Input Arguments

first: Int

Default Value: 20

after: String

searchFinancialAccountBalances: FinancialAccountBalanceSearchResultPayload

FinancialAccount balances associated with this Organization.

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: FinancialAccountBalanceSearchFilterInput

onboardingPreliminaryBusinessInformation: OnboardingPreliminaryBusinessInformation

Onboarding information associated with this organization

onboardingBusinessOrganizationInformationByOrganization: OnboardingBusinessOrganizationInformation

Business information collected during onboarding

first: Int

The number of inter financial account transfer rules to return.

Default Value: 20

after: String

The cursor to start the page.

velocityInterFinancialAccountTransferRules: VelocityInterFinancialAccountTransferRuleConnectionPayload

The internal velocity transfer rules belonging to this Organization.

Input Arguments

first: Int

The number of velocity inter financial account transfer rules to return.

Default Value: 20

after: String

The cursor to start the page.

realtimeRiskRules: RealtimeRiskRuleConnectionPayload

The realtime risk rules belonging to this Organization.

Input Arguments

first: Int

The number of risk rules to return.

Default Value: 20

after: String

The cursor to start the page.

physicalPaymentCardOrders: PhysicalPaymentCardOrderConnection

A paginated list of Physical Payment Card Orders

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

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PhysicalPaymentCardOrderFilterInput

Filter results to specific Physical Payment Card Order.

physicalCardGroupOrders: PhysicalCardGroupOrderConnectionDeprecated

A paginated list of Physical Card Group Orders

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

Use physicalPaymentCardGroupOrders instead.

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PhysicalCardGroupOrderFilterInput

Filter results to specific physical payment card group order.

physicalPaymentCardGroupOrders: PhysicalCardGroupOrderConnection

A paginated list of Physical Card Group Orders

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

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: PhysicalPaymentCardGroupOrderFilterInput

Filter results to specific physical payment card group order.

webhookNotificationTargets: WebhookNotificationTargetConnection

A paginated list of Webhook Notification Target.

Input Arguments

first: Int

Default Value: 20

after: String

collaborativeAuthorizationEndpoints: CollaborativeAuthorizationEndpointConnection

A paginated list of CollaborativeAuthorizationEndpoints.

Input Arguments

first: Int

displayName: String

Display name of the Organization.

environment: IntegrationEnvironment

The environment for the organization.

region: ComputeRegion

Geographic region where organization data is persisted.

tenantId: ID

ID of the Tenant

featurePermissions: FeaturePermissionConnection

The feature permissions for this Organization

Input Arguments

first: Int

Default Value: 20

after: String

OriginatedAchTransfer

The details of an AchTransfer initiated by Highnote. It can PUSH funds from a Highnote FinancialAccount to an external financial institution or PULL funds from an external financial institution to a Highnote FinancialAccount.

Output:OBJECT

Interfaces

AchTransfer

Fields

id: ID!

Global ID used to reference the OriginatedAchTransfer.

amount: Amount

The monetary amount to transfer.

createdAt: String

The date and time the transfer was initiated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

updatedAt: String

The date and time the transfer details were last updated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The direction of the transfer, PUSH or PULL, from the perspective of the originating financial institution.

PUSH means pushing funds from a Highnote FinancialAccount to an external financial account and PULL means pulling funds from an external financial account to a Highnote FinancialAccount.

purpose: AchTransferPurpose

The purpose of the transfer, e.g. deposit.

fromFinancialAccount: AchFromFinancialAccount

The financial account sending funds. This can be a Highnote FinancialAccount or a verified external financial account (ExternalFinancialBankAccount).

toFinancialAccount: AchToFinancialAccount

The financial account receiving funds. This can be a Highnote FinancialAccount or a verified or non-verified external financial account (ExternalFinancialBankAccount or NonVerifiedExternalUSFinancialBankAccount).

cardProduct: CardProduct

The CardProduct associated with the Highnote FinancialAccount.

companyName: String

The name of the company that initiated the transfer.

companyIdentifier: String

The ID of the company that initiated the transfer.

companyEntryDescription: String

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

Maximum length: 10 characters.

individualName: String

Receiver’s individual name. This could be a person or a business.

Maximum length: 22 characters.

individualIdentificationNumber: String

Receiver’s identification number. This could be a person or a business.

Maximum length: 15 characters.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters.

sameDay: Boolean

A flag that indicates the desire to process this transaction using same-day ACH.

traceNumber: String

A unique 15 digit number assigned by the originator when the transfer is in the PROCESSING state. It is used is used to identify the transfer in the ACH network.

status: OriginatedAchTransferStatus

The status of the transfer.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the transfer failed. This is only applicable when the transfer status is FAILED or RETURNED.

holdStatus: AchHoldStatus

The hold status of the transfer.

Funds from an OriginatedAchTransfer PULL are not available to spend while the transfer is ON_HOLD. An OriginatedAchTransfer PUSH is not sent to the external financial institution while the transfer is ON_HOLD.

This field is currently restricted to administrators.

holdType: AchHoldType

The hold type of the transfer.

This field is currently restricted to administrators.

effectiveEntryDate: String

The date specified by Highnote in which ACH settlement is expected to occur at the external financial institution, in ISO 8601 date format, e.g. 2024-01-01.

When sameDay is true and the transfer is initiated within the Federal Reserve ACH processing schedule, the effective entry date is the same date as the date of createdAt on Eastern Time Zone, otherwise, it is equal to the next business day.

When sameDay is false, the effective entry date is equal to one business day from createdAt if the transfer is initiated within the Federal Reserve ACH processing schedule, otherwise, it is equal to two business days from createdAt.

sentToBankAt: String

The date and time the transfer was sent to the external financial institution for processing, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

expectedProcessedAt: String

The date and time the transfer is expected to process, e.g. transition to PROCESSED, and reflected on the financial account', in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

processedAt: String

The date and time the transfer was processed (e.g. transitioned to PROCESSED) and reflected on the financial account, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

returnProcessedAt: String

The date a return received from the external financial institution for this transfer was processed by Highnote, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

canceledAt: String

The date and time the transfer was canceled, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

failedAt: String

The date and time the transfer failed by Highnote, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

A failed transfer is not sent to the external financial institution.

lastHoldStatusChangedAt: String

The date and time the hold status last changed, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

This field is currently restricted to administrators.

OriginatedAchTransferCanceledEvent

An event that occurs when an OriginatedAchTransfer is canceled by Highnote.

Output:OBJECT

Interfaces

Fields

id: ID!

Uniquely identifies the OriginatedAchTransferCanceledEvent.

Output:OBJECT

Interfaces

Fields

id: ID!

Uniquely identifies the OriginatedAchTransferReturnedEvent.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the originated transfer was returned by the external financial institution.

returnProcessedAt: String

The date and time when a return received from the external financial institution for this transfer was processed by Highnote, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

transfer: OriginatedAchTransfer!

Details about the OriginatedAchTransfer that was returned by the external financial institution.

OriginatedAchTransferSnapshot

A snapshot of an originated ACH transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this snapshot.

transfer: OriginatedAchTransfer

The originated ACH transfer that this is a revision of.

createdAt: String

The date and time this snapshot was created, in ISO 8601 format.

updatedAt: String

The date and time this snapshot was last updated, in ISO 8601 format.

version: Int

The version number of this snapshot.

amount: Amount

The monetary amount to transfer.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The direction of the transfer, PUSH or PULL, from the perspective of the originating financial institution.

PUSH means pushing funds from a Highnote FinancialAccount to an external financial account and PULL means pulling funds from an external financial account to a Highnote FinancialAccount.

purpose: AchTransferPurpose

The purpose of the transfer, e.g. deposit.

fromFinancialAccount: AchFromFinancialAccount

The financial account sending funds. This can be a Highnote FinancialAccount or a verified external financial account (ExternalFinancialBankAccount).

toFinancialAccount: AchToFinancialAccount

cardProduct: CardProduct

The CardProduct associated with the Highnote FinancialAccount.

companyName: String

The name of the company that initiated the transfer.

companyIdentifier: String

The ID of the company that initiated the transfer.

companyEntryDescription: String

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

Maximum length: 10 characters.

individualName: String

Receiver's individual name. This could be a person or a business.

Maximum length: 22 characters.

individualIdentificationNumber: String

Receiver's identification number. This could be a person or a business.

Maximum length: 15 characters.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters.

sameDay: Boolean

A flag that indicates the desire to process this transaction using same-day ACH.

traceNumber: String

A unique 15 digit number assigned by the originator when the transfer is in the PROCESSING state. It is used is used to identify the transfer in the ACH network.

status: OriginatedAchTransferStatus

The status of the transfer.

statusFailureReason: AchTransferStatusFailureReason

Additional details about why the transfer failed. This is only applicable when the transfer status is FAILED or RETURNED.

holdStatus: AchHoldStatus

The hold status of the transfer.

This field is currently restricted to administrators.

holdType: AchHoldType

The hold type of the transfer.

This field is currently restricted to administrators.

effectiveEntryDate: String

The date specified by Highnote in which ACH settlement is expected to occur at the external financial institution, in ISO 8601 date format, e.g. 2024-01-01.

sentToBankAt: String

The date and time the transfer was sent to the external financial institution for processing, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

expectedProcessedAt: String

The date and time the transfer is expected to process, e.g. transition to PROCESSED, and reflected on the financial account', in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

processedAt: String

The date and time the transfer was processed (e.g. transitioned to PROCESSED) and reflected on the financial account, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

returnProcessedAt: String

The date a return received from the external financial institution for this transfer was processed by Highnote, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

canceledAt: String

The date and time the transfer was canceled, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

failedAt: String

The date and time the transfer failed by Highnote, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

A failed transfer is not sent to the external financial institution.

lastHoldStatusChangedAt: String

The date and time the hold status last changed, in ISO 8601 date and time format, e.g. 2024-01-01T00:00:00.000Z.

This field is currently restricted to administrators.

OriginatedRtpTransfer

An originated RTP (Real-Time Payments) transfer via the TCH network.

An OriginatedRtpTransfer represents an RTP transfer originated by the Highnote partner bank to an external bank account.

Output:OBJECT

Interfaces

RtpTransfer

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

The current status of the OriginatedRtpTransfer.

failureReason: RtpTransferFailureReason

When the OriginatedRtpTransfer has failed, this will be populated with the reason for the failure.

source: RtpTransferSource

The source of the funds being transferred.

destination: RtpTransferDestination

The destination of the funds being transferred.

events: [OriginatedRtpTransferEvent!]

The events associated with this OriginatedRtpTransfer.

bankTransferDetails: RtpTransferBankTransferDetails

Additional details for the bank transfer including payment related information.

OriginatedRtpTransferEvent

An event associated with an OriginatedRtpTransfer.

Output:OBJECT

Interfaces

Fields

id: ID!

The global ID of the event.

createdAt: String

The date and time, in ISO 8601 format, when this event occurred.

The status of the OriginatedRtpTransfer when the event occurred.

failureReason: RtpTransferFailureReason

When the OriginatedRtpTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

rtpTransfer: OriginatedRtpTransfer

The OriginatedRtpTransfer associated with this event.

Origination

Information about the origination of a relayed notification event. Provides context about which organization originally triggered the event and when it was relayed to the current organization.

Output:OBJECT

Fields

organization: Organization

The organization that originally triggered this notification event.

relayedAt: String

The date and time, in ISO 8601 format, when this event was relayed.

event: NotificationEvent

The original event that was relayed.

PageInfo

Information about the paginated result set.

Output:OBJECT

Fields

hasNextPage: Boolean!

Whether or not edges prior to before or after exist.

hasPreviousPage: Boolean!

Whether or not edges further from before or after exist.

startCursor: String!

When paginating backward, the cursor to use for your next request.

endCursor: String!

When paginating forward, the cursor to use for your next request.

PanEntryModeSpendRule

A Spend Control rule that allows or blocks certain PanEntryMode types during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PanEntryModeSpendRule in operations.

The name assigned to the rule.

allowed: [PanEntryMode!]

The PanEntryMode types that will be allowed during authorizations.

blocked: [PanEntryMode!]

The PanEntryMode types that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

PanEntryModeSpendRuleResult

The result of applying a PanEntryModeSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [PanEntryMode!]

The tested PanEntryMode of the event.

spendRule: PanEntryModeSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

PartialFundingCardProductFeature

Whether or not the CardProduct supports Partial funding configurations for unsecured credit product funding.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

receivablesPurchaseAgreementEnabled: Boolean

Whether or not Receivables Purchase Agreement functionality should be used.

creditProcessorOnlyEnabled: Boolean

Whether or not credit processor only functionality should be used.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PartialFundingFinancialAccountFeature

Whether or not the FinancialAccount supports partial funding.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

maximumAggregateCreditDistributionAmount: Amount

The maximum aggregate credit distribution limit amount on the PartialFundingFinancialAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PassportIdentificationDocument

A representation of a passport identification document.

Output:OBJECT

Fields

countryCodeAlpha3: String!

The three character country code of the issuing country.

issueDate: Date!

The passport issue date.

expirationDate: Date!

The passport expiration date.

identificationNumberPreviouslySaved: Boolean

Whether the passport identification number has been previously saved.

PaymentCard

A Payment Card which can be used for card transactions.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

last4: String

The last four digits of the primary account number (PAN).

expirationDate: String

The exact date and time in UTC when the payment card expires.

expirationMonth: String

The expiration month to display to the card holder. This value would be printed on the physical card.

expirationYear: String

The expiration year to display to the card holder. This value would be printed on the physical card.

network: PaymentCardNetwork

The card network that issued the Payment Card.

cardProduct: CardProduct

The Card Product associated to the Payment Card.

cardProductApplication: CardProductApplication

The CardProductApplication used to issue this Payment Card.

application: AccountHolderCardProductApplicationDeprecated

The Card Product Application used to issue this Payment Card.

Use `cardProductApplication` instead.

The current status of the Payment Card.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

originalPaymentCard: PaymentCard

The Payment card from which this card was reissued.

restrictedDetails: PaymentCardRestrictedDetailsResult

The decrypted values for this this card.

Note: This is only available to users/organizations who have provided an AOC (attestation of compliance).

atmLocations: AtmLocationsResult

Search ATM locations for the Payment Card.

Input Arguments

radius: ATMLocationRadiusInput

Search for ATM locations based on a radius.

Note: Use a radius when a coordinate location is available.

viewport: ATMLocationViewportInput

Search for ATM locations based on a viewport.

Note: Use a viewport when searching within a boxed area.

atmFilter: ATMLocationFilterInput

Filters ATM locations based on available features

limit: Int

The number of ATM locations to return.

Default limit is set to 50.

Max limit is 50.

Default Value: 50

transactionEvents: TransactionEventConnection

The Transaction Events that occurred on this Payment Card.

Input Arguments

first: Int

The number of Transaction Events to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: PaymentCardTransactionEventsFilterInput

Filter results to specific Transaction Events.

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

financialAccounts: [FinancialAccount!]

The financial accounts backing this Payment Card.

physicalPaymentCardOrders: [PhysicalPaymentCardOrder]

first: Int

The number of UserDefinedFields to return

Default Value: 20

after: String

The cursor to start the page.

The filter used to search UserDefinedFields

revisionSnapshots: PaymentCardSnapshotConnection

A paginated list of snapshotted revisions made to this PaymentCard.

Input Arguments

first: Int

The number of revision snapshots to return.

Default Value: 20

after: String

The cursor to start the page.

cardProfileSet: CardProfileSet

The CardProfileSet used to issue this PaymentCard.

pinDetails: PaymentCardPinDetails

PIN details for this PaymentCard.

suspensionFlags: [PaymentCardSuspensionFlag!]

The suspension flags on the PaymentCard.

cardLostDate: String

The UTC date on which the card was lost. e.g. 2026-01-01T23:59:59Z

attachedRealtimeRiskRules: RealtimeRiskRuleConnectionPayload

The realtime risk rules attached to this Payment Card.

Input Arguments

first: Int

The number of realtime risk rules to return.

Default Value: 20

after: String

The cursor to start the page.

externalPhysicalPaymentCardOrders: [ExternalPhysicalPaymentCardOrder!]

The external physical card orders for the Payment Card.

PaymentCardActivatedEvent

The PaymentCardActivatedEvent is triggered when a Payment Card has been activated.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

cardProductId: ID

The Card Product ID associated to the Payment Card.

expirationDate: String

The exact date and time the payment card expires.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

last4: String

The last four digits of the primary account number (PAN).

network: PaymentCardNetwork

The card network that issued the Payment Card.

The current status of the Payment Card.

previousStatus: PaymentCardStatus

The previous status of the Payment Card.

updatedAt: String

The date and time, in ISO 8601 format that the status of the Payment Card was updated.

paymentCardHolder: PaymentCardHolder

The authorized user of this PaymentCard.

PaymentCardAdjustmentEvent

PaymentCardAdjustmentEvent indicates an adjustment has been made to a Transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAdjustmentEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAdjustmentEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Not used for this PaymentCardAdjustmentEvent.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAdjustmentEvent was created.

cvvResponseCode: CVVResponseCode

Not used for this PaymentCardAdjustmentEvent.

merchantDetails: MerchantDetails

The details about the merchant who completed the transaction.

originalAmount: Amount

Not used for this PaymentCardAdjustmentEvent.

accountingDirection: AccountingDirection

Not used for this PaymentCardAdjustmentEvent.

pinResponseCode: PinResponseCode

Not used for this PaymentCardAdjustmentEvent.

postalCodeResponseCode: PostalCodeResponseCode

Not used for this PaymentCardAdjustmentEvent.

requestedAmount: Amount

Not used for this PaymentCardAdjustmentEvent.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

Not used for this PaymentCardAdjustmentEvent.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

PaymentCardAuthorizationAndClearApprovedEvent

PaymentCardAuthorizationAndClearApprovedEvent indicates that a PaymentCard Transaction Authorization and Clear has been approved.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationAndClearApprovedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAuthorizationAndClearApprovedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAuthorizationAndClearApprovedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization and clear.

originalAmount: Amount

The original Amount of this PaymentCardAuthorizationAndClearApprovedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be approved for this PaymentCardAuthorizationAndClearApprovedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

partial: Boolean

Determines whether this authorization and clear was approved for partial or full amount.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

PaymentCardAuthorizationAndClearDeclinedEvent

PaymentCardAuthorizationAndClearDeclinedEvent indicates that a PaymentCard Transaction Authorization and Clear has been declined.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationAndClearDeclinedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAuthorizationAndClearDeclinedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAuthorizationAndClearDeclinedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization and clear.

originalAmount: Amount

The original Amount of this PaymentCardAuthorizationAndClearDeclinedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be approved for this PaymentCardAuthorizationAndClearDeclinedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

Fees applied to the transaction, if any.

PaymentCardAuthorizationApprovedEvent

PaymentCardAuthorizationApprovedEvent indicates if a Payment Card Transaction Authorization has been approved.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationApprovedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAuthorizationApprovedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAuthorizationApprovedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardAuthorizationApprovedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be approved for this PaymentCardAuthorizationApprovedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

partial: Boolean

Determines whether this authorization was approved for partial or full amount.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

PaymentCardAuthorizationCreatedEvent

PaymentCardAuthorizationCreatedEvent indicates if a Payment Card Transaction Authorization has been created.

Output:OBJECT

Interfaces

Fields

id: ID!Deprecated

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationCreatedEvent or correlate it with other events on this Transaction.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

approvedAmount: AmountDeprecated

The Amount approved for this PaymentCardAuthorizationCreatedEvent and posted in the settlement currency. Does not include fees.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

avsResponseCode: AVSResponseCodeDeprecated

Code representing the result of AVS address verification.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

createdAt: StringDeprecated

The date and time, in ISO 8601 format, this PaymentCardAuthorizationCreatedEvent was created.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

cvvResponseCode: CVVResponseCodeDeprecated

Code representing the result of CVV (security code) verification.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

merchantDetails: MerchantDetailsDeprecated

The details about the merchant who requested the authorization.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

originalAmount: AmountDeprecated

The original Amount of this PaymentCardAuthorizationCreatedEvent.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

pinResponseCode: PinResponseCodeDeprecated

Code representing the result of PIN verification.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

postalCodeResponseCode: PostalCodeResponseCodeDeprecated

Code representing the result of AVS postal code verification.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

requestedAmount: AmountDeprecated

The Amount requested to be approved for this PaymentCardAuthorizationCreatedEvent and displayed in the transaction's (local) currency. Does not include fees.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

responseCode: TransactionEventResponseCodeDeprecated

The Highnote response code.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

transactionId: IDDeprecated

ID of the transaction

`PaymentCardAuthorizationCreatedEvent` is no longer supported

accountHolderId: IDDeprecated

ID of the account holder for the card account

`PaymentCardAuthorizationCreatedEvent` is no longer supported

financialAccountId: IDDeprecated

ID of the financial account.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

cardId: IDDeprecated

ID of the payment card.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

currentFinancialAccountAvailableToSpendAmount: AmountDeprecated

The Amount available to spend after this transaction event.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

currentFinancialAccountMaximumBalanceAmount: AmountDeprecated

Maximum balance allowed for the card account at the time of this transaction event

`PaymentCardAuthorizationCreatedEvent` is no longer supported

accountingDirection: AccountingDirectionDeprecated

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

`PaymentCardAuthorizationCreatedEvent` is no longer supported

transactionProcessingType: CardTransactionProcessingTypeDeprecated

Represents the customer transaction type being processed.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

pointOfServiceDetails: PointOfServiceDetailsDeprecated

The Point Of Service Details.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

additionalNetworkData: AdditionalNetworkDataDeprecated

Network specific transaction data.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

paymentCardSnapshot: PaymentCardSnapshotDeprecated

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

fees: [TransactionFee!]Deprecated

Fees applied to the transaction, if any.

`PaymentCardAuthorizationCreatedEvent` is no longer supported

PaymentCardAuthorizationDeclinedEvent

PaymentCardAuthorizationDeclinedEvent indicates if a Payment Card Transaction Authorization has been declined.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationDeclinedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAuthorizationDeclinedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAuthorizationDeclinedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardAuthorizationDeclinedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be approved for this PaymentCardAuthorizationDeclinedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

Fees applied to the transaction, if any.

PaymentCardAuthorizationReversedEvent

PaymentCardAuthorizationReversedEvent indicates that a PaymentCard Transaction Reversal has occurred.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardAuthorizationReversedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardAuthorizationReversedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardAuthorizationReversedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardAuthorizationReversedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be reversed for this PaymentCardAuthorizationReversedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

issuerExpiredAuthorization: Boolean

Determines whether this is an issuer initiated reversal for an expired authorization.

partial: Boolean

Determines whether this is a partial or full reversal for an authorization.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

PaymentCardBinRange

Payment Card Bin Range details.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the BinRange.

binLength: UnsignedInt

The bin length.

paymentCardBrand: PaymentCardBrand

The configured card brand.

firstDigitsOfBin: String

The first digits of the bin based on the defined bin length.

productName: String

The product name.

Examples: "Corporate T&E Prepaid", "Debit Mastercard BusinessCard Card", "Fleet with Purchasing"

reloadable: Boolean

The reload indicator for the bin.

binClassification: PaymentCardBinClassification

The payment card bin classification.

binFundingModel: PaymentCardBinFundingModel

The payment card bin funding model.

binProductCode: PaymentCardBinProductCode

The configured paymet card bin product code.

binSubProductCode: PaymentCardBinSubProductCode

The configured payment card bin sub product code.

activeAtNetwork: Boolean

The indicator whether the bin is active at network

liveAtNetworkFrom: String

The date and time, in ISO 8601 format, the date this PaymentCardBinRange was live at network.

activeAtPlatform: Boolean

The indicator whether the bin is active on the platform

liveAtPlatformFrom: String

The date and time, in ISO 8601 format, the date this PaymentCardBinRange was live at platform.

currencyCodes: [String!]

Three-character ISO 4217 currency code

Examples: "USD", "EUR", "GBP"

secondaryPointOfSaleNetworks: [SecondaryPointOfSaleNetwork!]

Allowed secondary point of sale networks

secondaryAtmNetworks: [SecondaryAtmNetwork!]

Allowed secondary atm networks.

secondarySurchargeFreeAtmNetworks: [SecondarySurchargeFreeAtmNetwork!]

Allowed Secondary surcharge free atm networks

emvType: PaymentCardEmvType

The configured payment card EMV type.

effectiveFrom: String

The date and time, in ISO 8601 format, the date (inclusive) this BinRange is effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the date (inclusive) this BinRange stops being in effect.

createdAt: String

The date and time, in ISO 8601 format, the date this BinRange was created.

updatedAt: String

The date and time, in ISO 8601 format, the date this BinRange was updated.

PaymentCardClearedEvent

PaymentCardClearedEvent indicates if a Payment Card Transaction has been cleared. This event will be conditionally fired after a PaymentCardAuthorizationApprovedEvent | PaymentCardAuthorizationDeclinedEvent. This event will not be triggered after a PaymentCardAuthorizationAndClearApprovedEvent | PaymentCardAuthorizationAndClearDeclinedEvent

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardClearedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardClearedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardClearedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardClearedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be approved for this PaymentCardClearedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

partial: Boolean

Determines whether this is a partial or full clear for an authorization.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

PaymentCardClosedEvent

The PaymentCardClosedEvent is triggered when a Payment Card has been closed.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

cardProductId: ID

The Card Product ID associated to the Payment Card.

expirationDate: String

The exact date and time the payment card expires.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

last4: String

The last four digits of the primary account number (PAN).

network: PaymentCardNetwork

The card network that issued the Payment Card.

The current status of the Payment Card.

previousStatus: PaymentCardStatus

The previous status of the Payment Card.

updatedAt: String

The date and time, in ISO 8601 format that the status of the Payment Card was updated.

paymentCardHolder: PaymentCardHolder

The authorized user of this PaymentCard.

PaymentCardConnection

The connection type for Payment Card.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [PaymentCardEdge!]

A list of edges.

PaymentCardDeliveryDetails

The details of the delivery.

Output:OBJECT

Fields

The name of a person to whom the shipment should be delivered.

companyName: String

The company to whom the shipment should be delivered.

address: Address

The address to where the shipment should be delivered.

validatedAddress: ValidatedAddress

The ID of validated address to where the shipment should be delivered.

PaymentCardDigitalWalletTokenApplePayDevicePushProvisioning

Return type to push provision a PaymentCard to an Apple Pay Enabled Device.

Output:OBJECT

Fields

paymentCard: PaymentCard

The PaymentCard requested to be push provisioned

encryptedPassData: String

A Base64-encoded cipher text containing the card data, nonce, and nonce signature generated by Highnote.

activationData: String

A Base64-encoded cryptographic OTP required to activate the Card by the Network. This data is not interpreted by Apple and the formats and contents are Network-specific. The Network and Highnote are responsible for validating the OTP and activating the Card.

ephemeralPublicKey: String

A Base64-encoded ephemeral public key. The ephemeralPublicKey can be used in PKEncryptionSchemeECC_V2.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardDigitalWalletTokenApplePayDevicePushProvisioning was created.

PaymentCardDigitalWalletTokenGooglePayPushProvisioning

Return type to push provision a PaymentCard to a Google Pay Enabled Device.

Output:OBJECT

Fields

paymentCard: PaymentCard

The PaymentCard requested to be push provisioned

opaquePaymentCard: String

The Opaque Payment Credential is an encrypted object that is created by Highnote and passed to Google Pay during push provisioning.

network: PaymentCardNetwork

The card networks that the Highnote platform uses to issue Payment Cards.

tokenServiceProvider: String

The Token Service Provider

displayName: String

A customer friendly name to appear on the Digital Wallet.

billingAddress: Address

The billing address information of the PaymentCard

cardholderName: DigitalWalletPushProvisioningCardholderName

A structured object representing the name of the Cardholder

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardDigitalWalletTokenGooglePayPushProvisioning was created.

PaymentCardDisputeCustomerContact

The customer contact information of the dispute.

Output:OBJECT

Fields

givenName: String

The given name of the customer.

familyName: String

The family name of the customer.

phone: Phone

The phone number of the customer.

email: String

The email of the customer.

PaymentCardEdge

The edge type for a PaymentCard.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: PaymentCard

The Payment Card.

PaymentCardEnhancedDataEvent

PaymentCardEnhancedDataEvent indicates if enhanced data for a Payment Card Transaction has been received. This event will be conditionally fired after a PaymentCardClearedEvent. This event will not be triggered after a PaymentCardAuthorizationAndClearApprovedEvent | PaymentCardAuthorizationAndClearDeclinedEvent

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardEnhancedDataEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount approved for this PaymentCardEnhancedDataEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Not used for this PaymentCardEnhancedDataEvent

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardEnhancedDataEvent was created.

cvvResponseCode: CVVResponseCode

Not used for this PaymentCardEnhancedDataEvent

merchantDetails: MerchantDetails

Not used for this PaymentCardEnhancedDataEvent

originalAmount: Amount

Not used for this PaymentCardEnhancedDataEvent

pinResponseCode: PinResponseCode

Not used for this PaymentCardEnhancedDataEvent

postalCodeResponseCode: PostalCodeResponseCode

Not used for this PaymentCardEnhancedDataEvent

requestedAmount: Amount

Not used for this PaymentCardEnhancedDataEvent

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction

accountHolderId: ID

ID of the account holder for the card account

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Not used for this PaymentCardEnhancedDataEvent

currentFinancialAccountMaximumBalanceAmount: Amount

Not used for this PaymentCardEnhancedDataEvent

accountingDirection: AccountingDirection

Not used for this PaymentCardEnhancedDataEvent

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type or the center function being processed.

pointOfServiceDetails: PointOfServiceDetails

Not used for this PaymentCardEnhancedDataEvent

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

Not used for this PaymentCardEnhancedDataEvent

PaymentCardGroupOrderStateDetail

The payment card brand.

last4: String

The last 4 digits of the payment card.

expiryYear: String

The year the payment card expires.

Formatted as YYYY.

expiryMonth: String

The month the payment card expires.

Formatted as MM.

cardHolder: CardHolder

The cardHolder data for the payment card.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

capabilities: [PaymentCardInstrumentCapability!]

A list of capabilities this PaymentCardInstrument supports.

PaymentCardIssuedEvent

The PaymentCardIssuedEvent is triggered when a Payment Card has been activated.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

cardProductId: ID

The Card Product ID associated to the Payment Card.

expirationDate: String

The exact date and time the payment card expires.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

last4: String

The last four digits of the primary account number (PAN).

network: PaymentCardNetwork

The card network that issued the Payment Card.

The current status of the Payment Card.

previousStatus: PaymentCardStatus

The previous status of the Payment Card.

updatedAt: String

The date and time, in ISO 8601 format that the status of the Payment Card was updated.

paymentCardHolder: PaymentCardHolder

The authorized user of this PaymentCard.

PaymentCardOrderStateDetail

Payment card order status detail.

Output:OBJECT

Fields

status: PaymentCardOrderStatus

Current order status.

PaymentCardOrderStateDetailHistory

Payment card order date detail history.

Output:OBJECT

Fields

previousStatus: PaymentCardOrderStatus

Previous order status.

newStatus: PaymentCardOrderStatus

New order status.

createdAt: String

The date and time, in ISO 8601 format the status changed.

PaymentCardPersonalization

Payment card personalization.

Output:OBJECT

Fields

textLines: PaymentCardPersonalizationTextLines!

Personalization text lines.

PaymentCardPersonalizationTextLines

Payment card personalization text lines.

Output:OBJECT

Fields

line1: String!

First line.

This value will always be capitalized.

Example: "JANE", "BOB"

line2: String

Second line.

This value will always be capitalized.

Example: "FOO"

line3: String

Third line.

This value will always be capitalized.

Example: "BAR"

PaymentCardPinDetails

PIN details for the PaymentCard.

Output:OBJECT

Fields

isSet: Boolean

Denotes whether the PaymentCard has a PIN set.

pinUpdateHistory: [PaymentCardPinUpdate!]

List of PIN updates.

PaymentCardPinUpdate

Update details for the PaymentCardPinDetails.

Output:OBJECT

Fields

updatedAt: String

The date and time, in ISO 8601 format, the PIN was updated.

PaymentCardRestrictedDetails

Raw payment card details.

Note: This is only available to users/organizations who have provided an AOC (attestation of compliance).

Output:OBJECT

Fields

number: String

The primary account number for the payment card.

cvv: String

The card verification code for the payment card.

See this link for more.

PaymentCardSenderDetails

The details of the sender.

Output:OBJECT

Fields

address: Address

Sender address. The address to where the shipment should be returned.

companyName: String

The company who is sending the shipment.

The name of a person to who is sending the shipment.

PaymentCardShipment

Output:OBJECT

Fields

courier: PaymentCardShipmentCourier

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

deliveryDetails: PaymentCardDeliveryDetails

Delivery details.

senderDetails: PaymentCardDeliveryDetails

Sender details.

PaymentCardShipmentCourier

The details of the shipment.

Output:OBJECT

Fields

method: PaymentCardShippingMethod

Shipping method.

signatureRequiredOnDelivery: Boolean

Whether signature is required on delivery.

tracking: PaymentCardShipmentTracking

Tracking information.

PaymentCardShipmentTracking

Output:OBJECT

Fields

trackingNumber: String

Shipment tracking number.

actualShipDateLocal: String

Actual ship date in YYYY-MM-DD format provided by the shipper.

PaymentCardSnapshot

A snapshot of the PaymentCard at the time of a transaction event.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PaymentCardSnapshot.

sourceCard: PaymentCard

Source card for the PaymentCard if replaced. When this happens, a new card ID is generated. The source card tells us that card A came from card B through this attribute.

expirationDate: String

The exact date and time in UTC when the PaymentCard expires.

expirationMonth: String

The expiration month to display to the card holder. This value would be printed on the physical card.

expirationYear: String

The expiration year to display to the card holder. This value would be printed on the physical card.

The status of the card when the snapshot was captured.

statusChangeReason: PaymentCardStatusChangeReason

The reason for the status change.

statusChangeMemo: String

Memo for the change.

usage: CardUsage

Whether the card is MULTI_USE or SINGLE_USE.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL.

updatedAt: String

The date and time, in ISO 8601 format, when this snapshot was updated. This is also the date that the PaymentCard was modified.

createdAt: String

The date and time, in ISO 8601 format, when this snapshot was created. This is also the date that the PaymentCard was created.

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

cardProductId: ID

The Card Product ID associated to the Payment Card.

expirationDate: String

The exact date and time the payment card expires.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

last4: String

The last four digits of the primary account number (PAN).

network: PaymentCardNetwork

The card network that issued the Payment Card.

Fields

id: ID!

The Global ID of the chargeback.

requestedAmount: Amount

The requested amount for the chargeback.

receivedAmount: Amount

The received amount for the chargeback.

status: PaymentCardChargebackStatus

The status of the chargeback.

creditStatus: PaymentCardChargebackCreditStatus

The credit status of the chargeback.

dispute: PaymentCardTransactionDispute

The payment card transaction dispute for the chargeback.

chargebackExternalNetwork: ChargebackExternalNetwork

The external network id of the chargeback.

networkReasonCode: PaymentCardChargebackNetworkReasonCode

The external network reason code of the chargeback.

fromDate: String

The date and time, in ISO 8601 format, from which this chargeback is submitted.

throughDate: String

The date and time, in ISO 8601 format, through which this chargeback is resolved.

creditIssueFromDate: String

The date and time, in ISO 8601 format, from which this chargeback credit is issued.

creditIssueThroughDate: String

The date and time, in ISO 8601 format, through which this chargeback credit is issued.

Fields

id: ID!

The Global ID of the dispute.

amount: Amount

The disputed amount.

status: PaymentCardDisputeStatus

The status of the dispute.

category: PaymentCardDisputeCategoryType

The category type of the dispute.

chargebacks: [PaymentCardTransactionChargeback!]

The chargebacks for the dispute.

transactionEvent: TransactionEvent

The payment card transaction event for the dispute.

customerInitiatedOn: String

The date, in YYYY-MM-DD format, from which this dispute is initiated by the customer.

customerClaimType: PaymentCardDisputeCustomerClaimType

The customer claim type of the dispute.

customerContact: PaymentCardDisputeCustomerContact

The customer contact information of the dispute.

subscriberNote: String

The subscriber note of the dispute.

provisionalCreditHistory: [PaymentCardTransactionDisputeProvisionalCredit!]

The payment card transaction provisional credit for the dispute.

disputeCreditHistory: [PaymentCardTransactionDisputeCredit!]

The payment card transaction credit status for the dispute.

liability: PaymentCardDisputeLiability

Whether the issuer is liable for the dispute.

fromDate: String

The date and time, in ISO 8601 format, from which this dispute is effective.

throughDate: String

The date and time, in ISO 8601 format, through which this dispute is effective.

createdAt: String

The date and time, in ISO 8601 format, this dispute was created.

updatedAt: String

The date and time, in ISO 8601 format, this dispute was most recently updated.

PaymentCardTransactionDisputeConnection

The connection type for a PaymentCardTransactionDispute.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [PaymentCardTransactionDisputeEdge!]

A list of edges.

PaymentCardTransactionDisputeCredit

The payment card transaction dispute credit.

Output:OBJECT

Fields

creditStatus: PaymentCardDisputeCreditStatus

The credit status of the dispute credit.

creditAmount: Amount

The amount for the dispute credit.

createdAt: String

The date and time, in ISO 8601 format, from which this dispute credit is created.

updatedAt: String

The date and time, in ISO 8601 format, from which this dispute credit is updated.

PaymentCardTransactionDisputeEdge

The edge type for the PaymentCardTransactionDispute.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: PaymentCardTransactionDispute

The payment card transaction dispute.

PaymentCardTransactionDisputeProvisionalCredit

The payment card transaction chargeback credit.

Output:OBJECT

Fields

creditStatus: PaymentCardProvisionalCreditStatus

The credit status of the dispute credit.

creditAmount: Amount

The amount for the chargeback credit.

createdAt: String

The date and time, in ISO 8601 format, from which this chargeback credit is created.

updatedAt: String

The date and time, in ISO 8601 format, from which this chargeback credit is updated.

PaymentCardUnsuspendedEvent

The PaymentCardUnsuspendedEvent is triggered when a Payment Card has been unsuspended.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Payment Card in operations.

bin: String

The Bank Identification Number of the Payment Card. Usually the first 6 digits of the primary account number (PAN).

cardProductId: ID

The Card Product ID associated to the Payment Card.

expirationDate: String

The exact date and time the payment card expires.

formFactor: CardFormFactor

Whether the card is PHYSICAL or VIRTUAL

last4: String

The last four digits of the primary account number (PAN).

network: PaymentCardNetwork

The card network that issued the Payment Card.

The current status of the Payment Card.

previousStatus: PaymentCardStatus

The previous status of the Payment Card.

updatedAt: String

The date and time, in ISO 8601 format that the status of the Payment Card was updated.

paymentCardHolder: PaymentCardHolder

The authorized user of this PaymentCard.

PaymentCardVerification

The result of a verification check ran against a payment card.

Output:OBJECT

Fields

responseCode: PaymentCardVerificationResponseCode

The result of the verification ran on the payment card.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

PaymentCardVerificationApprovedEvent

PaymentCardVerificationApprovedEvent indicates that a PaymentCard Transaction Verification has been approved.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardVerificationApprovedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount verified for this PaymentCardVerificationApprovedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardVerificationApprovedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardVerificationApprovedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be verified for this PaymentCardVerificationApprovedEvent and displayed in the transaction's (local) currency. Does not include fees.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

Fees applied to the transaction, if any.

PaymentCardVerificationDeclinedEvent

PaymentCardVerificationDeclinedEvent indicates that a PaymentCard Transaction Verification has been declined.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this PaymentCardVerificationDeclinedEvent or correlate it with other events on this Transaction.

approvedAmount: Amount

The Amount verified for this PaymentCardVerificationDeclinedEvent and posted in the settlement currency. Does not include fees.

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

createdAt: String

The date and time, in ISO 8601 format, this PaymentCardVerificationDeclinedEvent was created.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

merchantDetails: MerchantDetails

The details about the merchant who requested the authorization.

originalAmount: Amount

The original Amount of this PaymentCardVerificationDeclinedEvent.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

requestedAmount: Amount

The Amount requested to be verified for this PaymentCardVerificationDeclinedEvent.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: ID

ID of the transaction.

accountHolderId: ID

ID of the account holder for the card account.

financialAccountId: ID

ID of the financial account.

cardId: ID

ID of the payment card.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the PaymentCardTransactionEvent.

Fees applied to the transaction, if any.

PaymentCardVerificationResponseCode

Response codes for a payment card verification.

Output:OBJECT

Fields

processorResponseCode: PaymentTransactionResponseCodeProcessorResponseCode

The response code from the processor for this verification.

addressCode: PaymentTransactionAddressCodeResponseCode

The address code response code for this verification.

postalCode: PaymentTransactionPostalCodeResponseCode

The postal code response code for this verification.

securityCode: PaymentTransactionSecurityCodeResponseCode

The security code response code for this verification.

PaymentCreditTransaction

A payment transaction for a refund. This is a record of a payment being refunded.

Output:OBJECT

Interfaces

PaymentTransaction

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the customer.

For a PaymentCreditTransaction, this will always be CREDIT.

instrument: PaymentInstrument

The payment instrument used for the PaymentTransaction. Instrument data can be used to display information to the user without violating PCI compliance.

status: PaymentTransactionStatus

The status of this PaymentTransaction.

PaymentTransactionSummary

Events that have occurred on this PaymentTransaction.

steps: [PaymentTransactionLifecycleStep!]

Lifecycle steps that have occurred on this PaymentTransaction.

authorizedRemainingAmount: Amount

The total authorized amount remaining for this PaymentTransaction.

requestedAuthorizationAmount: Amount

The total authorization amount requested for this PaymentTransaction.

authorizedAmount: Amount

The total amount authorized for this PaymentTransaction.

capturedAmount: Amount

The total amount captured for this PaymentTransaction.

settledAmount: Amount

The total amount settled for this PaymentTransaction.

disbursedAmount: Amount

The total amount disbursed for this PaymentTransaction.

canceledAmount: Amount

The total authorized amount that has been canceled for this PaymentTransaction.

refundedAmount: Amount

The total amount refunded for this PaymentTransaction.

responseCode: PaymentTransactionResponseCode

The response codes for this PaymentTransaction.

originatedPaymentTransaction: PaymentDebitTransaction

The originating PaymentDebitTransaction that this refund was initiated from.

fees: [PaymentTransactionFee!]

The fee breakdown for this PaymentTransaction.

totalFeeAmount: Amount

The total amount of fees associated with this PaymentTransaction.

totalPayableAmount: Amount

The total payable amount for this PaymentTransaction.

refundReason: PaymentCreditTransactionRefundReason

The reason why the PaymentTransaction was refunded to the original payment method

refundNote: String

Include additional information regarding the refund for tracking and analysis

order: PaymentOrder

The originating PaymentOrder that this transaction was initiated from.

PaymentCreditTransactionSummary

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the customer.

when DEBIT, funds are moving out of the customer's account
when CREDIT, funds are moving into the customer's account

authorizedRemainingAmount: Amount

The total authorized amount remaining for this PaymentTransaction.

requestedAuthorizationAmount: Amount

The total authorization amount requested for this PaymentTransaction.

authorizedAmount: Amount

The total amount authorized for this PaymentTransaction.

capturedAmount: Amount

The total amount captured for this PaymentTransaction.

settledAmount: Amount

The total amount settled for this PaymentTransaction.

disbursedAmount: Amount

The total amount disbursed for this PaymentTransaction.

canceledAmount: Amount

The total authorized amount that has been canceled for this PaymentTransaction.

refundedAmount: Amount

The total amount refunded for this PaymentTransaction.

responseCode: PaymentTransactionResponseCode

The response codes for this PaymentTransaction.

originatedPaymentTransactionId: ID!

The ID for the originating PaymentDebitTransaction that this refund was initiated from.

instrument: PaymentInstrument

The payment instrument used for the PaymentTransaction. Instrument data can be used to display information to the user without violating PCI compliance.

refundReason: PaymentCreditTransactionRefundReason

The reason why the PaymentCreditTransaction was refunded to the original payment method

refundNote: String

Include additional information regarding the refund for tracking and analysis

PaymentDebitTransaction

A payment transaction for a purchase. This is a record of a payment being made.

Output:OBJECT

Interfaces

PaymentTransaction

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the customer.

For a PaymentDebitTransaction, this will always be DEBIT.

instrument: PaymentInstrument

The payment instrument used for the PaymentTransaction. Instrument data can be used to display information to the user without violating PCI compliance.

status: PaymentTransactionStatus

The status of this PaymentTransaction.

PaymentTransactionSummary

Events that have occurred on this PaymentTransaction.

steps: [PaymentTransactionLifecycleStep!]

Lifecycle steps that have occurred on this PaymentTransaction.

authorizedRemainingAmount: Amount

The total authorized amount remaining for this PaymentTransaction.

requestedAuthorizationAmount: Amount

The total authorization amount requested for this PaymentTransaction.

authorizedAmount: Amount

The total amount authorized for this PaymentTransaction.

settledAmount: Amount

The total amount settled for this PaymentTransaction.

capturedAmount: Amount

The total amount captured for this PaymentTransaction.

disbursedAmount: Amount

The total amount disbursed for this PaymentTransaction.

canceledAmount: Amount

The total authorized amount that has been canceled for this PaymentTransaction.

refundedAmount: Amount

The total amount refunded for this PaymentTransaction.

responseCode: PaymentTransactionResponseCode

The response codes for this PaymentTransaction.

refunds: [PaymentCreditTransaction!]

Any refunds that were initiated from this PaymentTransaction.

networkTransactionIdentifier: String

The Network Transaction ID for this PaymentTransaction.

fees: [PaymentTransactionFee!]

The fee breakdown for this PaymentTransaction.

totalFeeAmount: Amount

The total amount of fees associated with this PaymentTransaction.

totalPayableAmount: Amount

The total payable amount for this PaymentTransaction.

order: PaymentOrder

The originating PaymentOrder that this transaction was initiated from.

installmentPayment: MerchantManagedInstallmentPayment

Installment payment information for merchant-managed installment payments.

PaymentDebitTransactionSummary

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the customer.

when DEBIT, funds are moving out of the customer's account
when CREDIT, funds are moving into the customer's account

authorizedRemainingAmount: Amount

The total authorized amount remaining for this PaymentTransaction.

requestedAuthorizationAmount: Amount

The total authorization amount requested for this PaymentTransaction.

authorizedAmount: Amount

The total amount authorized for this PaymentTransaction.

capturedAmount: Amount

The total amount captured for this PaymentTransaction.

settledAmount: Amount

The total amount settled for this PaymentTransaction.

disbursedAmount: Amount

The total amount disbursed for this PaymentTransaction.

canceledAmount: Amount

The total authorized amount that has been canceled for this PaymentTransaction.

refundedAmount: Amount

The total amount refunded for this PaymentTransaction.

responseCode: PaymentTransactionResponseCode

The response codes for this PaymentTransaction.

networkTransactionIdentifier: String

The Network Transaction ID for this PaymentTransaction.

instrument: PaymentInstrument

The payment instrument used for the PaymentTransaction. Instrument data can be used to display information to the user without violating PCI compliance.

installmentPayment: MerchantManagedInstallmentPayment

Installment payment information for merchant-managed installment payments.

PaymentInstruction

The PaymentInstruction type defines where funds dirbused to, and the amount to disburse for an PaymentOrderItem.

Output:OBJECT

Fields

disburseTo: PaymentInstructionDisbursementTarget

The Highnote Node that funds will be disbursed to.

disbursementPercent: Int

The amount to disburse for this PaymentOrderItem in percentage, and the FinancialAccount to disburse to.

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

usage: PaymentMethodTokenUsage

How many times this PaymentMethodToken can be used.

instrument: PaymentInstrument

The payment instrument used for the PaymentMethodToken. Instrument data can be used to display information to the user without violating PCI compliance.

expiresAt: String

The date and time, in ISO 8601 format, the payment method token will expire.

token: ScopedPaymentMethodTokenPayload

A short lived scoped payment method token for the PaymentMethodToken.

Input Arguments

scope: TokenScope!

PaymentOrder

An PaymentOrder is used to represent a collection of items that a customer wants to purchase.

Output:OBJECT

Interfaces

PaymentTransactionEvent

Fields

id: ID!

Global ID used to reference this object.

transactions: [PaymentTransaction!]

PaymentTransactions associated with this PaymentOrder.

lineItems: [PaymentOrderLineItem!]

Line items associated with this PaymentOrder.

totalAmount: Amount

The total amount for this PaymentOrder. This is the amount that the customer will be charged.

PaymentOrderItemFromCatalogItem

A catalog item that is added to an PaymentOrder.

Output:OBJECT

Interfaces

PaymentOrderItem

Fields

The product name for this PaymentOrderItemFromCatalogItem.

description: String

The product description for this PaymentOrderItemFromCatalogItem.

amountPerItem: Amount

The amount for this PaymentOrderItemFromCatalogItem per individual item.

paymentInstructions: [PaymentInstruction!]

Breakdown of the payment instructions for the PaymentOrderItemFromCatalogItem by Amount.

catalogItem: CatalogItem

Reference to the original CatalogItem for this PaymentOrderItemFromCatalogItem.

externalIdentifier: String

An optional external reference ID for this PaymentOrderItem.

PaymentOrderItemFromCustomItem

A custom one time item that is added to an PaymentOrder. These are one-off items defined at the time the order is created. They cannot be queried outside of the PaymentOrder.

Output:OBJECT

Interfaces

PaymentOrderItem

Fields

The product name for this PaymentOrderItemFromCustomItem.

description: String

The product description for this PaymentOrderItemFromCustomItem.

amountPerItem: Amount

The amount for this PaymentOrderItemFromCustomItem per individual item.

paymentInstructions: [PaymentInstruction!]

Breakdown of the payment instructions for the PaymentOrderItemFromCustomItem by Amount.

externalIdentifier: String

An optional external reference ID for this PaymentOrderItem.

PaymentOrderLineItem

The PaymentOrderLineItem type defines an item and the quantity of that item for an PaymentOrder.

Output:OBJECT

Fields

item: PaymentOrderItem

Reference to the item for this PaymentOrderLineItem.

quantity: UnsignedInt

The quantity of the item for this PaymentOrderLineItem.

PaymentTransactionResponseCode

Response codes for a payment transaction.

Output:OBJECT

Fields

authorizationIdentifier: StringDeprecated

The authorization response code identifier provided by the processor for this PaymentTransaction on a successful authorization.

Use authorizationCode instead.

authorizationCode: String

The authorization code provided by the processor for this PaymentTransaction on a successful authorization.

processorResponseCode: PaymentTransactionResponseCodeProcessorResponseCode

The response code from the processor for this PaymentTransaction. This will include both approval and decline codes.

addressCode: PaymentTransactionAddressCodeResponseCode

The address code response code for this PaymentTransaction.

postalCode: PaymentTransactionPostalCodeResponseCode

The postal code response code for this PaymentTransaction.

securityCode: PaymentTransactionSecurityCodeResponseCode

The security code response code for this PaymentTransaction.

firstNameCode: PaymentTransactionAccountNameVerificationResponseCode

The first name match result for this PaymentTransaction.

middleNameCode: PaymentTransactionAccountNameVerificationResponseCode

The middle name match result for this PaymentTransaction.

estimatedPayOffDays: UnsignedIntDeprecated

Pay off can be completed in how many estimated days.

use estimatedPayOffPeriod instead

estimatedPayOffPeriod: String

Pay off can be completed in how many estimated years and / or months.

estimatedTotal: Amount

Pay off estimated total amount.

periodPayment: Amount

If you pay this amount each period, you will pay off your unpaid balance in estimatedPayOffPeriod.

PayoutTransferCompletedEvent

Represents a completed payout transfer event for an acquiring PaymentTransaction.

This event is created when the funds are transferred.

See transferedTo for more details in where it transferred to.

Output:OBJECT

Interfaces

Fields

paymentTransaction: PaymentTransaction

Reference to the parent PaymentTransaction that this event was created for.

amount: Amount

The amount associated with the PaymentTransactionEvent.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

transferredTo: TransferredEventNode

The node where the funds were transferred to.

PayrollACHTransferEvent

A financial event that represents a PayrollTransfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The status of the externally initiated ACH transfer.

toFinancialAccount: FinancialAccount

The account receiving the funds.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

PayrollAdvance

The Payroll Payment Advance within the Highnote platform.

Output:OBJECT

Interfaces

PaymentAdvance

Fields

id: ID!

Global ID used to reference the Payroll Payment Advance.

paymentAdvanceStatus: PaymentAdvanceStatus

The status of Payroll Payment Advance.

advanceAmount: Amount

The original amount of the Payroll Payment Advance.

amountBefore: Amount

The amount of the Payroll Payment Advance that has yet to be repaid.

amountApplied: Amount

The amount that should be deducted from the Payroll Payment Advance outstanding balance.

balanceAfter: Amount

The balance amount due after amountApplied has been applied and deducted from the Payroll Payment Advance outstanding balance.

repaymentAttemptCount: UnsignedInt!

Count of repayment attempts.

writeOffReason: PaymentAdvanceWriteOffReason

Will be set if the PaymentAdvanceStatus is of type WRITTEN_OFF, explains the reason for write off. Limit of 1024 characters.

writeOffAmount: Amount

Amount that will be written off from the Payroll Payment Advance outstanding balance.

PayrollAdvanceFinancialAccountFeature

Whether or not the Financial Account supports Payroll Advance.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PayrollAdvanceRepaymentCompletedEvent

The PayrollAdvanceRepaymentCompletedEvent is triggered when an amount pertaining to a PayrollAdvance is has been repaid.

Output:OBJECT

Interfaces

PayrollAdvanceEvent

Fields

id: ID!

Global ID used to reference the Financial Event Id in operations.

financialAccountId: ID

The ID of the financial account receiving funds.

employerFinancialAccountId: ID!

The ID of an employer financial account.

This must be a FinancialAccount ID.

payrollTransferId: ID

The ID of a payroll Transfer

payrollAdvance: PayrollAdvance

The PayrollAdvance related to this PayrollAdvanceWriteOffCompletedEvent

PayrollAdvanceRepaymentTransfer

A movement of money to repay payroll advance

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount repaid.

The current status of the transfer.

statusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

PayrollAdvanceWriteOffCompletedEvent

The PayrollAdvanceWriteOffCompletedEvent is triggered when an amount pertaining to a PayrollAdvance is has been written off.

Output:OBJECT

Interfaces

PayrollAdvanceEvent

Fields

id: ID!

Global ID used to reference the Financial Event Id in operations.

financialAccountId: ID

The ID of the financial account receiving funds.

employerFinancialAccountId: ID!

The ID of an employer financial account.

This must be a FinancialAccount ID.

payrollTransferId: ID

The ID of a payroll Transfer

payrollAdvance: PayrollAdvance

The PayrollAdvance related to this PayrollAdvanceWriteOffCompletedEvent

PayrollAdvanceWriteoffTransfer

A movement of money to write off payroll advance

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The written off amount.

The current status of the transfer.

statusReason: InterFinancialAccountTransferStatusReasonCode

The reason for the current status.

memo: String

A description of the transfer for reference.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

PayrollEmployerAdvanceFinancialAccountFeature

Whether or not the Financial Account supports Payroll Employer Advance.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PayrollTransfer

A transfer for the purposes of payroll.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the externally initiated ACH transfer.

toFinancialAccount: FinancialAccount

The Highnote account receiving the credit.

companyName: String

The name of the company that initiated the ACH transfer.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID of the company that initiated the ACH transfer, ISO 8601 format.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

PersonAccountHolderIdentityDocumentsRequestedEvent

Indicates that identity verification documents have been requested for a USPersonAccountHolder.

Output:OBJECT

Fields

personAccountHolder: USPersonAccountHolder

The USPersonAccountHolder for which documents have been requested.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

documentUploadSession: IdentityVerificationDocumentUploadSession

The IdentityVerificationDocumentUploadSession created for the requested documents.

reason: IdentityVerificationDocumentRequestReason

The reason identity verification documents are being requested.

PersonAccountHolderIdentityUpdatedEvent

Indicates that the identifying information of a USPersonAccountHolder has been updated.

Output:OBJECT

Fields

personAccountHolder: USPersonAccountHolder

The USPersonAccountHolder which was updated.

createdAt: String

The date and time, in ISO 8601 format, this event was created.

updateTypes: [PersonAccountHolderIdentityUpdateType!]

The type of each update made, indicating which fields were modified on the USPersonAccountHolder.

PersonCreditRiskAttributes

A type representing credit risk attributes for person underwriting.

Output:OBJECT

Fields

totalAnnualIncome: [Amount!]

Total annual income expressed as an Amount.

currentDebtObligations: [Amount!]

Current debt obligations expressed as an Amount.

employmentStatus: EmploymentStatus

Person's employment status.

monthlyHousingPayment: [Amount!]

The rent, mortgage, or other type of housing payment made on a monthly basis as an Amount.

Phone

Type representing parts of a phone number.

Output:OBJECT

Fields

countryCode: String

The assigned country code for the number.

number: String

The phone number in a country specific format.

label: PhoneLabel

A classification for the type of the device the phone number is attached or how the phone number is used (e.g. home or work)

PhysicalCardGroupOrder

A created PhysicalCardGroupOrder.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PhysicalCardGroupOrder in operations.

cardProductId: ID

Id of the product with which the group order will be associated.

cardCount: UnsignedInt

Number of cards in the group order

paymentCardShipment: PaymentCardShipment

Payment card shipment

orderState: PaymentCardGroupOrderStateDetail

Order state details.

stateHistory: [PaymentCardGroupOrderStateDetailHistory]

Fulfillment state detail history.

createdAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was created at.

updatedAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was last updated.

physicalPaymentCardOrders: PhysicalPaymentCardOrderConnection

The physical payment card orders for this PhysicalCardGroupOrder.

Input Arguments

first: Int

The number of physical payment card orders to return.

Default Value: 20

format: PhysicalCardPersonalizationFormat!

The format for the physical card profile look and feel.

line1: PhysicalCardPersonalizationLine!

The line 1 personalization for the physical card.

line2: PhysicalCardPersonalizationLine!

The line 2 personalization for the physical card.

physicalCardType: PhysicalCardType

The type of physical card

PhysicalCardPersonalizationLine

The personalization for a line.

Output:OBJECT

Fields

type: PhysicalCardPersonalizationLineType

The line type for the physical card line.

line: String

The line value for the physical card line.

PhysicalCardProfile

Physical Card Profile attributes

Output:OBJECT

Interfaces

CardProfile

Fields

id: ID!

ID of the physical card profile.

status: CardProfileStatus

Status of the physical card profile.

paymentNetworkStatus: CardProfilePaymentNetworkStatus

Payment Network Status of the physical card profile.

vendorStatus: CardProfileVendorStatus

Vendor Status of the physical card profile.

bankStatus: CardProfileBankStatus

Bank Status of the physical card profile.

vendorName: PhysicalCardVendorName

Vendor Name of the physical card profile.

vendorProgramExternalIdentifier: String

Vendor program external id for the physical card profile

carrier: String

Carrier for the physical card profile.

packaging: String

Packaging for the physical card profile.

fleetOptionConfigurationId: ID

The fleet option configuration ID

fleetOptionConfigurationVersion: Int

The fleet option configuration version

externalContactlessProfileIdentifier: String

External contactless profile id

chipProfileIdentifier: String

Chip profile id

physicalCardMaterial: PhysicalCardMaterial

Card Material of the physical card profile.

cardHolderAgreementId: ID

Card Holder Agreement ID of the physical card profile.

cardProduct: CardProduct

Card Product of the physical card profile.

cardPersonalization: PhysicalCardPersonalization

Card personalization.

defaultPaymentCardShipment: CardProfileShipment

Payment card shipment

cardArt: [CardArtDocument!]

Card art

createdAt: String

The date and time, in ISO 8601 format, this physical card profile was created.

updatedAt: String

The date and time, in ISO 8601 format, this physical card profile was last updated.

Name of the PhysicalCardProfile.

description: String

Description about the PhysicalCardProfile.

cardProfileSetRelationships: [CardProfileSetRelationship!]

The list of CardProfileSet related to this PhysicalCardProfile.

formFactor: FormFactorType

Form factor

includeBillingPostalCodeInOrderFile: Boolean

Whether the billing postal code should be included in the order file.

PhysicalPaymentCardGroupOrderShipFailedEvent

PhysicalPaymentCardGroupOrderShipFailedEvent indicates when a Physical Payment Card Group Order has failed to ship

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PhysicalPaymentCardGroupOrder in operations.

groupOrderState: PaymentCardGroupOrderStateDetail

Order state details.

cardProductId: ID

Card product ID.

cardCount: UnsignedInt

Number of cards in the group order

createdAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was created at.

updatedAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was last updated.

PhysicalPaymentCardGroupOrderShippedEvent

PhysicalPaymentCardGroupOrderShippedEvent indicates when a Physical Payment Card Group Order has shipped successfully

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PhysicalPaymentCardGroupOrder in operations.

groupOrderState: PaymentCardGroupOrderStateDetail

Order state details.

cardProductId: ID

Card product ID.

cardCount: UnsignedInt

Number of cards in the group order

createdAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was created at.

updatedAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was last updated.

PhysicalPaymentCardOrder

A created PhysicalPaymentCardOrder.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PaymentCardShipment in operations.

paymentCardShipment: PaymentCardShipment

Payment card shipment

orderState: PaymentCardOrderStateDetail

Order state details.

cardPersonalization: PaymentCardPersonalization

Card personalization.

stateHistory: [PaymentCardOrderStateDetailHistory]

Fulfillment state detail history.

paymentCard: PaymentCard

Payment card details.

groupOrder: PhysicalCardGroupOrder

Physical card group order details

Fields

id: ID!

Global ID used to reference the PaymentCardShipment in operations.

orderState: PaymentCardOrderStateDetail

Order state details.

paymentCardId: ID

Payment card ID.

createdAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was created at.

updatedAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was last updated.

PhysicalPaymentCardShippedEvent

PhysicalPaymentCardShippedEvent indicates when a Physical Payment Card has shipped successfully

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the PaymentCardShipment in operations.

orderState: PaymentCardOrderStateDetail

Order state details.

paymentCardId: ID

Payment card ID.

createdAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was created at.

updatedAt: String

The date and time, in ISO 8601 format, the PaymentCardShipment was last updated.

PointOfServiceCategorySpendRule

A Spend Control rule that allows or blocks certain point of service categories during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Merchant Category Spend Rule in operations.

The name assigned to the rule.

allowed: [PointOfServiceCategoryCondition!]

The point of services that will be allowed during authorizations.

blocked: [PointOfServiceCategoryCondition!]

The point of services that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

PointOfServiceCategorySpendRuleResult

The result of applying a point of service category spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [PointOfServiceCategory!]

The tested points of service of the event.

spendRule: PointOfServiceCategorySpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

PointOfServiceDetails

Details about the point of service for the transaction.

Output:OBJECT

Fields

category: PointOfServiceCategory

The point of service category.

panEntryMode: PanEntryMode

The PAN entry mode.

pinEntryMode: PinEntryMode

The PIN entry mode.

terminalAttendance: TerminalAttendance

The attendance at the terminal.

isCardHolderPresent: Boolean

Represents whether the cardholder is present or not.

isCardPresent: Boolean

Represents whether the card is present or not.

isRecurring: Boolean

Represents whether this transaction is recurring or not.

terminalSupportsPartialApproval: Boolean

Represents whether the terminal supports partial approval or not.

cardDataInputCapability: CardDataInputCapability

Tha capabilities of the terminal to read card data

PointRewardCardProductFeature

Whether or not the CardProduct supports rewards.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PointRewardFinancialAccountFeature

Whether or not the Financial Account supports Point Rewards.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PostalCodeVerificationSpendRule

A Spend Control rule that allows or blocks certain postal code response codes during authorizations.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Postal Code Verification Spend Rule in operations.

The name assigned to the rule.

allowed: [PostalCodeResponseCode!]

The postal code response codes that will be allowed during authorizations.

blocked: [PostalCodeResponseCode!]

The postal code response codes that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

PostalCodeVerificationSpendRuleResult

The result of applying a PostalCodeVerificationSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [PostalCodeResponseCode!]

The tested PostalCodeResponseCode of the event.

spendRule: PostalCodeVerificationSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

PrePaidPaymentCardFinancialAccountFeature

Whether or not the Financial Account supports a PrePaid Payment Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

PreprintedCardFinancialAccountFeature

Whether or not the FinancialAccount supports preprinted cards.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

Fields

id: ID!

The unique identifier of the PricingConfiguration.

pricingPlan: PricingPlan

The PricingPlan associated with this configuration.

payerEntityId: ID

The identifier of the payer entity associated with this configuration.

payeeEntityId: ID

The identifier of the payee entity associated with this configuration.

effectiveFrom: String

The timestamp, in ISO 8601 format, from which this configuration is effective.

effectiveThrough: String

The timestamp, in ISO 8601 format, through which this configuration is effective. If not set, the configuration has no expiration.

PricingPlan

The pricing plan available for an organization.

Output:OBJECT

Interfaces

Fields

id: ID!

The unique identifier of the PricingPlan.

The name of the pricing plan.

description: String

A description of the pricing plan.

rules: PricingRuleConnection

The list of PricingRule records that dictate how charges are calculated.

Input Arguments

first: Int

The number of rules to return.

Default Value: 20

after: String

The cursor to start the page.

status: PricingPlanStatus

The current lifecycle state of the plan. Rules are only modifiable when status is DRAFT.

updatedAt: String

The timestamp, in ISO 8601 format, when this plan was last updated.

createdAt: String

The timestamp, in ISO 8601 format, when this plan was created.

PricingRule

A pricing rule within a PricingPlan, referencing a template and containing trigger, frequency, and parameter values.

Output:OBJECT

Interfaces

Fields

id: ID!

The unique identifier of the PricingRule.

trigger: PricingRuleTrigger

The event that triggers this rule.

templateId: ID

The ID of the pricing rule template providing the logic for this rule.

frequency: PricingRuleFrequency

How often the rule is evaluated.

The name of the placeholder in the template script.

value: PricingRuleParameterValue

The value to substitute for the placeholder.

PricingRuleParameterValueSingle

A single value for a PricingRuleParameter.

Output:OBJECT

Fields

value: String

The value.

ProductApplication

An Application for an ApplicationProduct.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the application in operations.

applicationState: ProductApplicationState

The current state of the application.

product: ApplicationProduct

The Product to which the account holder is applying.

organization: Organization

The Organization associated with this ProductApplication.

affiliateOrganization: Organization

The affiliate Organization associated with this ProductApplication, such as an Independent Sales Org (ISO) or Independent Software Vendor (ISV).

contract: ApplicationContract

The contract for the ApplicationProduct used for this ProductApplication.

status: ProductApplicationStatusCode!

Status of application.

ProductApplicationWorkflow

Output:OBJECT

Fields

executionOrder: UnsignedInt

The order in which this workflow will be executed within the set of workflows associated with the application

status: ProductApplicationWorkflowStatus

The current status of this workflow

workflowType: ProductApplicationWorkflowType

The type of workflow

ProductFundingFinancialAccountFeature

Whether or not the Financial Account supports Product Funding.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

ProductProfile

Represents a profile for a Product which is a collection of ProductFeatures.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8602 format, this object was created.

updatedAt: String

The date and time, in ISO 8601 format, this object was updated.

The name for this ProductProfile.

effectiveFrom: String

The date and time, in ISO 8601 format, from which the ProductProfile is active.

effectiveThrough: String

The date and time, in ISO 8601 format, from which the ProductProfile becomes inactive.

features: [ProductFeature!]

The features that are available on this ProductProfile.

ProductReserveFinancialAccountFeature

The Product Reserve is held to cover deficits in the product such as card activity settlement. Funds may not be transferred out of the Product Reserve

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

ProductSecuredDepositFinancialAccountFeature

Whether or not the FinancialAccount supports product secured deposits.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

ProvisionAccountHolderActionDetail

Represents the details of an account holder provisioning action.

This type includes the various inputs required for different provisioning actions, such as creating an application, setting a credit limit, or issuing a payment card.

Output:OBJECT

Fields

createAccountHolderCardProductApplicationInput: ProvisionCreateAccountHolderCardProductApplicationActionDetail

Input details for creating an account holder application. This field contains the parameters needed to process the application.

issueFinancialAccountForApplicationInput: ProvisionIssueFinancialAccountForApplicationActionDetail

Input details for creating a financial account. This field includes the parameters necessary to establish a new financial account for the account holder.

initiateFinancialAccountCreditLimitUpdateFromProductFundingInput: ProvisionInitiateFinancialAccountCreditLimitUpdateFromProductFundingActionDetail

Input details for setting a credit limit on a financial account. This field specifies the parameters required to update the credit limit for the financial account.

issuePaymentCardForFinancialAccountInput: ProvisionIssuePaymentCardForFinancialAccountActionDetail

Input details for issuing a payment card for a financial account. This field contains the parameters needed to issue a new payment card associated with the specified financial account.

linkVerifiedExternalBankAccountInput: ProvisionLinkVerifiedExternalBankAccountActionDetail

Input details for linking external bank account.

ProvisionCreateAccountHolderCardProductApplicationActionDetail

Details for an account holder's application process.

Output:OBJECT

Fields

cardHolderAgreementConsent: ConsentAgreement

Details on the acceptance of the terms and conditions of the card holder agreement. This field captures the applicant's consent to the agreement.

accountHolderCreditReportPullConsent: ConsentAgreement

Details on the account holder's consent to pull their credit report as part of the card product application. This field captures the applicant's consent for this specific action.

applicationConfiguration: ApplicationConfiguration

Optional application-level configuration provided by the applicant at the start of the application, such as billing cycle preferences.

ProvisionInitiateFinancialAccountCreditLimitUpdateFromProductFundingActionDetail

Input for setting the credit limit of a financial account.

This input type includes details for specifying the credit limit amount and an optional description.

Output:OBJECT

Fields

amount: Amount

The amount of credit limit to be set for the payment card. This field specifies the new credit limit amount.

memo: String

An optional description or memo for the credit limit update. This field provides context or notes about the credit limit change for future reference.

ProvisionIssueFinancialAccountForApplicationActionDetail

Request contents for ProvisionIssueFinancialAccountForApplicationAction

Output:OBJECT

Fields

The name of the financial account. This field is required and should provide a meaningful name for the account.

ProvisionIssuePaymentCardForFinancialAccountActionDetail

Input for provisioning an issued payment card for a financial account.

A list of edges.

RealtimeRiskRuleEdge

The edge type for a RealtimeRiskRule.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: RealtimeRiskRule

The Realtime Risk Rule.

RecurringACHTransfer

A scheduled recurring ACH transfer

Output:OBJECT

Interfaces

ScheduledTransfer

Fields

id: ID!

Global ID used to reference the recurring transfer

fromFinancialAccount: AllFinancialAccount

The account sending the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

transferAmount: TransferAmountStrategy

The amount to be transferred.

frequency: RecurringAchTransferFrequencyCode

The frequency of the scheduled payment

balanceAmountType: TransferBalanceAmountCode

The type of balance payment to be scheduled

status: ScheduledTransferStatusCode

The status of the scheduled transfer

transferDayCalculationType: TransferDateCode

The day the transfer is scheduled to be executed. Optional; only set if transfer day is calculated (for example, payment due date).

nextScheduledTransferDate: String

The date and time, in ISO 8601 format, the next scheduled transfer is to be executed.

transferEvents: ScheduledTransferEventConnection

The transfers executed as a result of the recurring transfer

Input Arguments

first: Int

Default Value: 20

after: String

createdAt: String

The date and time, in ISO 8601 format, this RecurringACHTransfer was created.

updatedAt: String

The date and time, in ISO 8601 format, this RecurringACHTransfer was last updated.

RepaymentFailedEvent

The RepaymentFailedEvent notifies when ACH Repayments have failed to process.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this RepaymentFailedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

repaymentACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an ACH Repayments failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use repaymentACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

RepaymentFinancialAccountFeature

Whether or not the FinancialAccount supports repayment account feature.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

RepaymentProcessedEvent

The RepaymentProcessedEvent notifies when ACH Repayments are finished processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this RepaymentProcessedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

RepaymentProcessingEvent

The RepaymentProcessingEvent notifies when ACH Repayments are processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this RepaymentProcessingEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

RepaymentReturnedEvent

The RepaymentReturnedEvent notifies when ACH Repayments are returned.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this RepaymentReturnedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

repaymentACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why an ACH Repayments was returned.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use repaymentACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

Report

Describes the current status of a report and where it can be downloaded from.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the Report in operations.

status: ReportStatus

The current status of an Report.

reportType: ReportType

Describes which type of report was generated.

statusReason: String

Describes why the report is in a failed state, if applicable.

download: ReportDownload

Used to download the contents of the report, if available.

start: String

reportType: ReportType

The report type that the usage metrics applies to.

limit: UnsignedInt

The limit of the number of reports that can be generated within a 24 hour period. The 24 hour period is defined as midnight to midnight, Eastern Time.

limitRemaining: UnsignedInt

The number of reports remaining for the report type in the given period.

periodEnd: String

The date and time, in ISO 8601 format, for the end of the current period.

RequestedIdentityAppliedUpdate

Changes applied to a requested identity update.

Output:OBJECT

Fields

appliedChanges: [RequestedIdentityUpdateType!]

The change types for the applied update.

requestedChange: RequestedIdentityUpdateParty

The supplied information to update on the RequestedIdentityUpdateParty.

createdAt: String

The date and time, in ISO 8601 format, the requested update was created.

updatedAt: String

The date and time, in ISO 8601 format, the requested update was last updated.

RequestedIdentityUpdate

A request to update an identity.

Output:OBJECT

Interfaces

Fields

id: ID!

The Global ID for the requested Identity Update

status: RequestedIdentityUpdateStatus

The status of the identity update request

referredBy: RequestedIdentityUpdateSource

The referring system that originated this RequestedIdentityUpdate.

requestedFor: RequestedIdentityUpdateParty

The identity which has a requested update.

changesRequested: [RequestedIdentityUpdateType!]

The changes requested on the identity.

createdAt: String

The date and time, in ISO 8601 format, when the identity update request was created.

updatedAt: String

The date and time, in ISO 8601 format, when the identity update request was last updated.

appliedUpdates: [RequestedIdentityAppliedUpdate!]

Changes applied to the identity as part of this RequestedIdentityUpdate.

ResetBalanceFinancialAccountFeature

Whether or not the FinancialAccount is enabled for reset balance.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the FinancialAccount.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

cadence: PseudoBalanceCadence

The PseudoBalance cadence, how often to reset the PseudoBalance.

resetTime: String

An ISO 8601 formatted timestamp that determines when and how often the balance resets. The date and time components are used differently based on the selected cadence. See PseudoBalanceCadence for more details.

resetAvailableBalance: Boolean

Whether to reset the available balance when the pseudo balance resets according to the cadence.

RestrictedAccountHolderSpendRule

A Spend Control rule that blocks certain account holders during authorization.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the RestrictedAccountHolderSpendRule in operations.

The name assigned to the rule.

allowed: [ID!]

The account holders that are allowed during authorization. This is not used.

blocked: [ID!]

The account holders that are blocked during authorization.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

RestrictedAccountHolderSpendRuleResult

The result of applying a RestrictedAccountHolderSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [ID!]

The account holder of the event.

spendRule: RestrictedAccountHolderSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

RestrictedCardHolderSpendRule

A Spend Control rule that blocks certain card holders during authorization.

Output:OBJECT

Interfaces

Fields

blocked: [ID!]

The card holders that are blocked during authorization.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

id: ID!

Global ID used to reference the RestrictedCardholderSpendRule in operations.

The name assigned to the rule.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

after: String

The cursor to start the page.

first: Int

The number of revisions to return.

Default Value: 20

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

The ApplicableRuleUserType for which the rule will be evaluated.

RestrictedCardHolderSpendRuleResult

The result of applying a RestrictedCardHolderSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [ID!]

The card holder of the event.

spendRule: RestrictedCardHolderSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

ReversalEvent

An ReversalEvent for a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this Reversal or correlate it with other events on this Transaction.

responseCode: TransactionEventResponseCode

The Highnote response code.

transactionId: IDDeprecated

ID of the transaction

Use transaction instead

transaction: Transaction

The Transaction for this event.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this ReversalEvent and posted in the settlement currency. Does not include fees.

originalAmount: Amount

The original Amount of the AuthorizationEvent related to this ReversalEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this ReversalEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this ReversalEvent.

cardProduct: CardProduct

The CardProduct associated to this ReversalEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the reversal.

currentFinancialAccountAvailableToSpendAmount: Amount

The Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

issuerExpiredAuthorization: Boolean

Determines whether this is an issuer initiated reversal for an expired authorization.

partial: Boolean

Determines whether this is a partial or full reversal for an authorization.

paymentCardSnapshot: PaymentCardSnapshot

A snapshot of the PaymentCard at the time of the ReversalEvent.

additionalTransactionData: [AdditionalTransactionData!]

Additional transaction data for this transaction

advice: Boolean

Determines whether this event is an advice.

adviceDetail: AdviceDetail

Details if event is an advice.

Fees applied to the transaction, if any.

requestedAmount: Amount

The Amount requested to be approved for this ReversalEvent and displayed in the transaction's (local) currency. Does not include fees.

currencyConversionRate: Float

Conversion rate applied to the requestedAmount to get the requestedAmountInSettlementCurrency for this ReversalEvent.

Can be up to 7 decimal places, e.g. 1.2345678.

requestedAmountInSettlementCurrency: Amount

The Amount requested to be approved for this ReversalEvent converted to the settlement currency.

cashbackAmount: Amount

The Amount of cashback requested.

ReversedFeeTransfer

Reversed fee transfer. Reversing the charged fee transfer.

Output:OBJECT

Fields

originatingAccount: FinancialAccount

The Financial account from where the fee is reversed. This field is available when status is COMPLETE.

receivingAccount: FinancialAccount

The Financial account that receives the reversed fee. This field is available when status is COMPLETE.

transferedFeeAmount: AmountDeprecated

The actual fee amount reversed. This field is available when status is COMPLETE.

Use feeTransferAmount instead.

transferDate: String

The date and time, in ISO 8601 format, the fee was reversed.

The fee transfer event status.

memo: String

Memo

sourceFeeTransferEvent: FeeTransferEvent

The original fee transfer event that was reversed.

feeTransferAmount: Amount

The actual fee amount charged.

ReviewWorkflowEvent

An event representing the review process of a transfer. Use the reviewState field to determine the current state of the review.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the ReviewWorkflowEvent.

reviewState: ReviewWorkflowEventStatus

The status of the transfer workflow.

createdAt: String

The date and time the review was initiated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

updatedAt: String

The date and time the review was last updated, in ISO 8601 format, e.g. 2024-01-01T00:00:00.000Z.

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

RewardDefaultEarnRule

RewardEarnRule that will hold default reward configuration for transfers that have not accrued points from other RewardEarnRuless.

Output:OBJECT

Interfaces

RewardEarnRule

Fields

id: ID!

Global ID used to reference the reward earn rule.

type: EarnRuleType

The EarnRuleType. For example, PER_TRANSACTION_SPEND_AMOUNT.

Name of this RewardDefaultEarnRule.

rewardPointEarning: RewardEarnRate

Earning Rate. This rate describes the amount of points earn related to the amount of money spent. (i.e., a rate of 1.5 means earning 15 points on a $10 transaction)

attachments: RewardRuleAttachmentConnection

Objects that a rule is attached to.

Input Arguments

first: Int

The number of object attachments to return.

Default Value: 20

after: String

The cursor to start the page.

RewardEarnRule

Fields

id: ID!

Global ID used to reference the reward earn rule.

type: EarnRuleType

The EarnRuleType. For example, PER_TRANSACTION_SPEND_AMOUNT.

Name of RewardMerchantCategoryEarnRule

rewardPointEarning: RewardEarnRate

Earning Rate. This rate describes the amount of points earn related to the amount of money spent. (i.e. rate of 1.5 means earning 15 points on a $10 transaction)

attachments: RewardRuleAttachmentConnection

Objects that a rule is attached to.

Input Arguments

first: Int

The number of object attachments to return.

Default Value: 20

after: String

The cursor to start the page.

allowedList: [MerchantCategory!]

Collection of MerchantCategory that a transaction's MCC must exist within in order for this rule to earn reward points. This field must have at least one MerchantCategory.

allowedListCodes: [String!]

Collection of MerchantCategory codes that a transaction's MCC must exist within in order for this rule to earn reward points. This field must have at least one MerchantCategory code.

createdAt: String

The date and time, in ISO 8601 format, when the earn rule was created.

updatedAt: String

The date and time, in ISO 8601 format, when the earn rule was updated.

RewardPointsTransfer

A transfer for the purposes of reward points

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

rewardPointsAmount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

status: RewardPointsTransferStatusDetails

The status of the reward points transfer.

activity: RewardPointsActivityType

Reward activity like AWARD, REDEEM, REFUND, DEDUCT

source: RewardPointsTransferSource

Source for reward points transfer like CARD_TRANSACTION, API

memo: String

Description for the transfer ** Note: ** The maximum size is 1024 characters

externalTransactionIdentifier: String

An optional tracker for external transaction identifier. Max character length is 255.

rewardPointsValue: Amount

Reward points monetary value

Fields

status: RewardPointsTransferStatus

The status of the reward points transfer.

RewardRedemptionConfiguration

RewardRedemptionConfiguration holds configuration for how rewards points could be redeemed.

Output:OBJECT

Interfaces

RewardRedemptionConfigurationAttachment

Fields

id: ID!

Global ID used to reference the RewardRedemptionConfiguration.

type: RedemptionConfigurationType

The RedemptionConfigurationType. For example, STATEMENT_CREDIT.

Name of RewardRedemptionConfiguration

rewardPointRedemption: RewardRedemptionRate

Redemption Rate. This rate describes the value of money that can be redeemed for earned points. See RewardRedemptionRate.

attachments: RewardRedemptionConfigurationAttachmentConnection

Objects that a RewardRedemptionConfiguration is attached to.

Input Arguments

first: Int

The number of object attachments to return.

Default Value: 20

after: String

The cursor to start the page.

Fields

id: ID!

Global ID used to reference the RewardRedemptionConfigurationAttachment.

redemptionConfiguration: RewardRedemptionConfiguration

RewardRedemptionConfiguration that is attached.

cardProduct: CardProduct

CardProduct that the RewardRedemptionConfiguration is attached to.

RewardRuleAttachment

Fields

id: ID!

Global ID used to reference the RewardRuleAttachment.

rewardEarnRule: RewardEarnRule

RewardEarnRule that is attached.

cardProduct: CardProduct

CardProduct that the RewardEarnRule is attached to.

effectiveFrom: String

The date and time in ISO 8601 format, representing when the attachment should start taking effect.

effectiveThrough: String

The date and time in ISO 8601 format, representing when the attachment should stop taking effect.

RiskAmountAmplitude

Represents the amplitude or variability in monetary risk metrics.

Output:OBJECT

Fields

amount: Amount

Monetary amount reflecting the variability.

RiskApplicationSDK

The risk application sdk feature permission

Output:OBJECT

Interfaces

FeaturePermission

FeaturePermissionRevision

Fields

id: ID!

ID of the FeaturePermission

createdBy: String

The entity that created the feature permission

updatedBy: String

The entity that updated the feature permission

createDate: String

When the entity was created

updateDate: String

When the entity was updated

enabled: Boolean

Indicates if the permission is enabled

revisions: FeaturePermissionRevisionConnection

The list of revisions for this feature permission.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

RiskApplicationSDKRevision

A revision of the risk application sdk feature permission

Output:OBJECT

Interfaces

Fields

id: ID!

ID of the FeaturePermissionRevision

featurePermissionId: ID!

ID of the FeaturePermission that this entity is a revision of

createdBy: String

The entity that created the feature permission

updatedBy: String

The entity that updated the feature permission

createDate: String

When the entity was created

updateDate: String

When the entity was updated

Numerical count reflecting the variability.

RiskGeolocationDataPoint

Defines a data point for geolocation scatter plots, including coordinates, label, and associated amplitude.

Output:OBJECT

Fields

latitude: String

Latitude coordinate of the data point.

longitude: String

Longitude coordinate of the data point.

label: String

Text for the data point.

moneyAmplitude: RiskAmountAmplitude

Amplitude (intensity) associated with the data point representing the total sum of money spent at this coordinate.

countAmplitude: RiskCountAmplitude

Amplitude (intensity) associated with the data point representing the total times money has been spent at this coordinate.

RiskGeolocationDensity

Structure for holding geolocation density data points, used in visualizing the distribution of locations.

Output:OBJECT

Fields

organization: Organization

Organization associated with the data.

accountHolder: AccountHolder

Account holder related to the data.

geolocationDataPoints: [RiskGeolocationDataPoint!]

List of geolocation data points.

RiskGeolocationPath

Represents a geolocation path, comprising a sequence of data points to illustrate movement or trajectories.

coordinate: RiskMoneyCoordinate

Coordinates of the scatter data point.

RiskPositionalCoordinate

Defines a data point's coordinates for a scatter plot, including position and potential anomalies indicated by error.

Output:OBJECT

Fields

x: String

X-axis value of the data point.

y: Float

Y-axis value of the data point.

Numerical count reflecting the variability.

RiskScatterDataPoints

The RiskScatterDataPoints type defines the structure of the response when querying for scatter data points. This type encapsulates various attributes necessary for plotting data points on a scatter plot, including information about each data point and any metadata that may be relevant to the visualization

Output:OBJECT

Fields

organization: Organization

The organization field returns an Organization object, representing an entity that is involved in the data.

accountHolder: AccountHolder

The accountHolder field returns an AccountHolder object, representing an entity that is involved in the data.

periodicityType: RiskPeriodicityType

Specifies the frequency or regularity at which certain data or events are recorded or aggregated.

Fields

id: ID!

Global ID used to reference the RuleCollection.

version: String

The rule collection version.

The name assigned to the RuleCollection.

spendRules: [SpendRule!]

The list of SpendRule objects in this RuleCollection.

interFinancialAccountTransferRules: [InterFinancialAccountTransferRule!]

The list of InterFinancialAccountTransferRule objects in this RuleCollection

velocityInterFinancialAccountTransferRules: [VelocityInterFinancialAccountTransferRule!]

The list of VelocityInterFinancialAccountTransferRule objects in this RuleCollection

velocitySpendRules: [VelocityRule!]

The list of VelocityRule objects in this RuleCollection. VelocityRules are also known as VelocitySpendRules Note: Up to 5 allowed

createdAt: String

The date and time, in ISO 8601 format, the rule collection was created.

updatedAt: String

The date and time, in ISO 8601 format, the rule collection was last updated.

RuleCollectionRevision

A RuleCollectionRevision is a specific version of a RuleCollection.

Output:OBJECT

Interfaces

AccountHolderIdentityRiskScore

Fields

id: ID!

Global ID used to reference the RuleCollectionRevision.

publicRuleCollectionId: ID!

Global ID used to reference the RuleCollection that this revision is of.

version: String

The rule collection version.

The name assigned to the RuleCollectionRevision.

spendRules: [SpendRule!]

The list of SpendRule objects in this RuleCollectionRevision.

interFinancialAccountTransferRules: [InterFinancialAccountTransferRule!]

The list of InterFinancialAccountTransferRule objects in this RuleCollectionRevision

velocityInterFinancialAccountTransferRules: [VelocityInterFinancialAccountTransferRule!]

The list of VelocityInterFinancialAccountTransferRule objects in this RuleCollectionRevision

velocitySpendRules: [VelocityRule!]

The list of VelocityRule objects in this RuleCollectionRevision. VelocityRules are also known as VelocitySpendRules Note: Up to 5 allowed

createdAt: String

The date and time, in ISO 8601 format, the rule collection revision was created.

updatedAt: String

The date and time, in ISO 8601 format, the rule collection revision was last updated.

SankeyDataLink

Defines a single link in a Sankey diagram, including source and target nodes, and the value representing the flow between them.

Output:OBJECT

Fields

source: String

Source node of the link.

target: String

Target node of the link.

label: String

Label for the link.

moneyValue: RiskSankeyAmountValue

Value representing the money flow between nodes.

countValue: RiskSankeyCountValue

Value representing the number of transactions between nodes.

SankeyDataPoints

Structure for Sankey diagram data points, including nodes and links that illustrate the flow of money or other metrics.

Output:OBJECT

Fields

organization: Organization

Organization associated with the data.

accountHolder: AccountHolder

Account holder related to the data.

sankeyDataLinks: [SankeyDataLink!]

List of links representing the flow in the Sankey diagram.

SardineIdentityRiskScore

Values associated with the sardine assessing risk

Output:OBJECT

Interfaces

Fields

riskLevel: IdentityRiskLevel

The severity of the risk

sessionKey: String

The session key associated with this event.

determinedAt: String

The date and time, in ISO 8601 format, when the risk decision was made

ScheduledTransferAchEvent

A scheduled transfer event that executed on the ACH rails.

Output:OBJECT

Interfaces

ScheduledTransferEvent

Fields

id: ID!

The Global ID used to reference the ScheduledTransferAchEvent

fromFinancialAccount: AllFinancialAccount

The financial account sending the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The financial account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialAccount and the other will be a FinancialAccount.

transferAmount: Amount

The amount requested to be transferred.

transfers: [ElectronicFundsTransfer]

The transfers executed as part of the scheduled payment transfer event.

status: ScheduledTransferEventStatusCode

The status of the scheduled transfer event.

paymentInitiatedAt: String

The date and time, in ISO 8601 format, this scheduled transfer event was initiated.

paymentPostedAt: String

The date and time, in ISO 8601 format, this scheduled transfer event was posted to the account.

criticality: SchemaChangeCriticality

The criticality of the SchemaChange.

message: String

Description of schema change, e.g. `Field 'bar' was added to object type 'Foo'.

path: String

The schema path of the change e.g. Foo.bar.

changeType: String

The type of the schema change, e.g. FIELD_ADDED.

SchemaChangeCriticality

The criticality of the SchemaChange

Output:OBJECT

Fields

level: SchemaChangeCriticalityLevel

This code represents the level of criticality of the SchemaChange.

SchemaChangelog

The schema changes for a specific deploy timestamp.

Output:OBJECT

Fields

id: ID!

Globally unique identifier for a SchemaChangelog

token: String

Global ID used to reference this object.

scope: AddressTokenScope

Scope of the token

expiresAt: String

The date and time, in ISO 8601 format, the short lived payment method token will expire.

ScopedPaymentMethodToken

A short lived token representing the payment method limited to a scope of usage.

Output:OBJECT

Fields

token: String

Global ID used to reference this object.

scope: TokenScope

Scope of the token

expiresAt: String

The date and time, in ISO 8601 format, the short lived payment method token will expire.

ScriptRealtimeRiskRule

A realtime script-based risk rule. These rules execute in realtime during the authorization of a card transaction.

Output:OBJECT

Interfaces

RealtimeRiskRule

Fields

id: ID!

Global ID used to reference in operations.

The name assigned to the rule.

script: String

The MVEL script expression to evaluate.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the realtime risk rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the realtime risk rule was last updated.

revisions: RealtimeRiskRuleConnectionPayload

The list of revisions for this realtime risk rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

createdBy: UserPayload

The User who created the entity.

updatedBy: UserPayload

The User who last updated the entity.

SearchCardProductApplicationConnection

The connection type for CardProductApplication search.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [SearchCardProductApplicationEdge!]

A list of edges.

SeasonalVolumeBreakdown

Breakdown of seasonal volumme by month

Output:OBJECT

Fields

january: [Amount!]

January volume for each currency the business transacts with

february: [Amount!]

February volume for each currency the business transacts with

march: [Amount!]

March volume for each currency the business transacts with

april: [Amount!]

April volume for each currency the business transacts with

may: [Amount!]

May volume for each currency the business transacts with

june: [Amount!]

June volume for each currency the business transacts with

july: [Amount!]

July volume for each currency the business transacts with

august: [Amount!]

August volume for each currency the business transacts with

september: [Amount!]

September volume for each currency the business transacts with

october: [Amount!]

October volume for each currency the business transacts with

november: [Amount!]

November volume for each currency the business transacts with

december: [Amount!]

December volume for each currency the business transacts with

SecureCardBalanceRepaymentACHTransfer

A transfer that refills the balance on a secure card.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the integrator initiated ACH transfer.

fromFinancialAccount: AllFinancialAccount

The account sending the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialBankAccount and the other will be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialBankAccount and the other will be a FinancialAccount.

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

SecureCardBalanceRepaymentACHTransferEvent

A financial event that represents card balance repayment ACH transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer event was created.

The status of the integrator initiated ACH transfer.

fromFinancialAccount: ExternalFinancialBankAccount

The account sending the funds.

toFinancialAccount: FinancialAccount

The account receiving the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

SecuredCreditPaymentCardFinancialAccountFeature

Whether or not the Financial Account supports a Secured Credit Deposit funded Credit Payment Card.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

creditLimit: Amount

The credit limit on the SecuredCreditPaymentCardFinancialAccountFeature

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

SecuredDepositCardProductFeature

Whether or not the CardProduct supports secured deposits.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the CardProduct.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

SecuredDepositCommercialCreditCardFinancialAccountStatement

Statement for secured deposit commercial credit card accounts

Output:OBJECT

Interfaces

Fields

id: ID!

The unique id of the FinancialAccountStatement.

periodStart: String

The date, in ISO 8601 format, the statement period starts.

periodEnd: String

The date, in ISO 8601 format, the statement period ends.

openedAt: String

The timestamp, in ISO 8601 format, the statement was opened.

closedAt: String

The timestamp, in ISO 8601 format, the statement was closed.

startingPrimaryCreditBalance: Amount

The credit balance at the start of the period for the primary ledger.

startingPrimaryDebitBalance: Amount

The debit balance at the start of the period for the primary ledger.

endingPrimaryCreditBalance: Amount

The credit balance at the end of the period for the primary ledger.

endingPrimaryDebitBalance: Amount

The debit balance at the end of the period for the primary ledger.

primaryLedger: Ledger

The ledger associated with the primary balance

startingSecondaryCreditBalance: Amount

The credit balance at the start of the period for the secondary ledger.

startingSecondaryDebitBalance: Amount

The debit balance at the start of the period for the secondary ledger.

endingSecondaryCreditBalance: Amount

The credit balance at the end of the period for the secondary ledger.

endingSecondaryDebitBalance: Amount

The debit balance at the end of the period for the secondary ledger.

secondaryLedger: Ledger

The ledger associated with the primary balance

startingTertiaryCreditBalance: Amount

The credit balance at the start of the period for the tertiary ledger.

startingTertiaryDebitBalance: Amount

The debit balance at the start of the period for the tertiary ledger.

endingTertiaryCreditBalance: Amount

The credit balance at the end of the period for the tertiary ledger.

endingTertiaryDebitBalance: Amount

The debit balance at the end of the period for the tertiary ledger.

tertiaryLedger: Ledger

The ledger associated with the tertiary balance

periodPurchasesAmount: Amount

The total from purchases for the statement period.

periodFeesAmount: Amount

The total from fees for the statement period.

periodFeeCredit: Amount

The total fee credit (for example due to waiving fees) for the statement period.

periodRefundsAndPaymentsAmount: Amount

The total refunds and payments for the statement period.

endingCreditLimit: Amount

The credit limit at the end of the period.

paymentDueOn: String

The date, in ISO 8601 format, payment is due on end of day.

statementEntries: FinancialAccountStatementEntryConnection

statement entries.

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

Input Arguments

first: Int

The number of Financial Account Activities to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: FinancialAccountStatementEntriesFilterInput

Filter results to specific Financial Account Activities.

repaymentHistory: [CreditRepaymentStatementApplication!]

History of repayments per statement

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

SecuredDepositCommercialCreditCardFinancialAccountStatementEntry

Statement entry for secured commercial credit card

Output:OBJECT

Interfaces

Fields

creditAmount: Amount

Credit amount of the transaction.

debitAmount: Amount

Debit amount of the transaction.

primaryCreditBalance: Amount

Credit balance of the account.

primaryDebitBalance: Amount

Debit balance of the account.

postDate: String

The date, in ISO 8601 format, the transaction was posted. (Different word for 'posted'?)

ledgerEntry: LedgerEntry

Ledger Entry for the entry

createdAt: String

The date and time, in ISO 8601 format, this was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

SecuredDepositCommercialCreditCardFinancialAccountStatementSnapshot

Current account snapshot for a secured deposit commercial credit card

Output:OBJECT

Interfaces

Fields

asOf: String

The date and time, in ISO 8601 format, the snapshot was calculated. Note that this will be the date/time of the last impactful event.

currentOpenStatement: FinancialAccountStatement

The current open statement

latestClosedStatement: FinancialAccountStatement

The most recently closed statement

currentAmountDue: Amount

The ending balance from the latestClosedStatement, minus any payments that have been cleared and processed.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

SecuredDepositFinancialAccountFeature

Whether or not the FinancialAccount supports secured deposits.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

SecureDeposit

Externally Initiated Secure Deposit transfer

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialBankAccount and the other will be a FinancialAccount.

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The status of the integrator initiated ACH transfer.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

SecureDepositACHTransfer

Originated SecureDeposit transfer

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

The status of the integrator initiated ACH transfer.

fromFinancialAccount: AllFinancialAccount

The account sending the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialBankAccount and the other will be a FinancialAccount.

toFinancialAccount: AllFinancialAccount

The account receiving the funds.

Exactly one of fromFinancialAccount and toFinancialAccount will be an ExternalFinancialBankAccount and the other will be a FinancialAccount.

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

descriptor: ACHDescriptor

Descriptive fields about the transfer which may show up on bank reports.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

cardProduct: CardProduct

The Card Product associated to the Financial Account.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

traceNumber: String

A unique 15 digit number assigned by the originator to identify the transfer.

SecureDepositACHTransferEvent

A financial event that represents secure deposit transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer event was created.

The status of the integrator initiated ACH transfer.

fromFinancialAccount: ExternalFinancialBankAccount

The account sending the funds.

toFinancialAccount: FinancialAccount

The account receiving the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

SecureDepositCanceledEvent

The SecureDepositCanceledEvent notifies when ACH Secure Deposits are canceled.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositCanceledEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

SecureDepositFailedEvent

The SecureDepositFailedEvent notifies when ACH Secure Deposits have failed to process.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositFailedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

secureDepositACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why a secure deposit ACH transfer failed.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use secureDepositACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

SecureDepositInitiatedEvent

The SecureDepositInitiatedEvent notifies when ACH Secure Deposits are initiated.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositInitiatedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

SecureDepositProcessedEvent

The SecureDepositProcessedEvent notifies when ACH Secure Deposits are finished processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositProcessedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

SecureDepositProcessingEvent

The SecureDepositProcessingEvent notifies when ACH Secure Deposits are processing.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositProcessingEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

transfer status only needed for failed or returned events

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

SecureDepositReturnedEvent

The SecureDepositReturnedEvent notifies when ACH Secure Deposits are returned.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event. This id can be used to later retrieve details of this SecureDepositReturnedEvent or correlate it with other events on this Transaction.

transactionId: ID

The ID of the Electronic Funds Transfer that trigger this event.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

fromFinancialAccountId: ID

The ID of the account sending the funds. Will always be an ExternalFinancialBankAccount.

toFinancialAccountId: ID

The ID of the account receiving the funds. Will always be a FinancialAccount

companyName: String

The name of the company that initiated the ACH transfer.

This will always be Highnote.

companyIdentifier: String

The ID for Highnote.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

fundsAvailableDate: String

The date and time, in ISO 8601 format, the transfer will be transitioned to PROCESSED and the funds are available.

secureDepositACHReasonCode: IntegratorInitiatedACHStatusReasonCode

Additional details about why a secure deposit ACH transfer was returned.

transferStatus: ACHTransferStatusDetailsDeprecated

The status of the ACH transfer.

use secureDepositACHReasonCode instead

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

returnDate: String

The date this transaction was returned, in ISO 8601 format.

SecureDepositTransferEvent

A financial event that represents a non-originated secure deposit transfer.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer event was created.

The status of the integrator initiated ACH transfer.

toFinancialAccount: FinancialAccount

The account receiving the funds.

companyName: String

The name of the company that initiated the ACH transfer.

companyIdentifier: String

`Identification Code Designator (ICD)`	`ANSI Identification Number`	Example
`IRS Employer Identification Number (EIN)`	1	1234567890 for an Originator with 234567890 EIN
`Data Universal Numbering Systems (DUNS)`	3	30008016958 for an Originator with 0008016958 DUNS
`User Assigned Number`	9	9111111111 for an Originator with 111111111 under assigned Identification Number

companyEntryDescription: String

Company entered value for the type of ACH.

settlementDate: String

The settlement date as specified by the company that initiated the ACH transfer, ISO 8601 format.

The ElectronicFundsTransfer that triggered this event.

returnDate: String

The date this transaction was returned, in ISO 8601 format.

ServicemembersCivilReliefActConfiguration

The Servicemembers Civil Relief Act (SCRA) configuration.

Output:OBJECT

Fields

status: ServicemembersCivilReliefActStatus

The status of this configuration. For example, PENDING, APPROVED, or REJECTED.

effectiveFrom: Date

The start date for this configuration, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15.

effectiveThrough: Date

The end date for this configuration, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15. Optional; if not present, this configuration is treated as indefinite, with no set end date.

activeDutyFrom: Date

The start date of active duty, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15.

activeDutyThrough: Date

The end date of active duty, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15. Optional; if not present, active duty is treated as indefinite, with no set ending. Cannot be in the past. Must be after activeDutyFromDate.

updatedAt: String

The date and time when this was updated, in ISO 8601 format.

createdAt: String

The date and time, in ISO 8601 format, this was created.

SigningKey

A key used to sign the notification payload.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the SigningKey in operations.

secret: String

The shared secret to use to verify a notification payload.

createdAt: String

The date and time, in ISO 8601 format, this was created.

expiresAt: String

Expiration date and time, in ISO 8601 format, for this key. If this is set, it means that the rotateNotificationTargetSigningKey mutation was called for this key's target.

SpendRuleConnection

The connection type for Spend Rule.

Output:OBJECT

Fields

pageInfo: PageInfo!

Information about the current page.

edges: [SpendRuleEdge!]

A list of edges.

SpendRuleContainer

A container that holds a SpendRule.

cursor: String!

The cursor for this edge for use in pagination.

node: SpendRuleResult

The SpendRuleResult.

StreetAddressSpendRule

A Spend Control rule that allows or blocks certain AVS response codes during authorizations.

Note A StreetAddressSpendRule only applies to street numbers. To control postal codes, use PostalCodeSpendRule.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the spend rule in operations.

The name assigned to the rule.

allowed: [AVSResponseCode!]

The AVSResponseCode values that will be allowed during authorizations.

blocked: [AVSResponseCode!]

The AVSResponseCode values that will result in declined authorizations.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

StreetAddressSpendRuleResult

The result of applying a street address spend rule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

valuesTested: [AVSResponseCode!]

The AVS response codes of the event.

spendRule: StreetAddressSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

SuspenseFinancialAccountFeature

Whether or not the FinancialAccount is enabled as a suspense account.

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the FinancialAccount.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

TaxIdentificationDocument

A type representing the parts of a tax identification number (e.g. SSN, TIN, EIN).

Output:OBJECT

Fields

numberHash: String

A cryptographically hashed representation of the number.

countryCodeAlpha3: String

The three character country code of the issuing country.

taxIdentificationNumberType: TaxIdentificationNumberType

The type of tax identification number.

taxIdentificationNumberStored: Boolean

Whether a tax identification number has been previously stored

TransactionBusinessMetricAttribute

Describes attributes of a transaction metric.

Output:OBJECT

requestedFeeAmount: Amount

The requested fee amount. Note that requestedFeeAmount and approvedFeeAmount may be different currencies.

approvedFeeAmount: Amount

The approved fee amount. Note that requestedFeeAmount and approvedFeeAmount may be different currencies.

transactionFeeType: TransactionFeeType

The type of fee charged.

TransactionSearchResult

Represents a normalized object that has common fields shared across all Transaction and TransactionEvent types

Output:OBJECT

Fields

source: TransactionSearchSource

The unique identifier for the search result object. This value corresponds to a Node that can be queried for more information.

amount: Amount

The amount of the transaction.

status: TransactionSearchStatus

The status of the TransactionSearchResult.

Interfaces

Fields

id: ID!

Global ID used to reference the Transfer in operations.

amount: Amount

The amount of the Transfer.

status: TransferStatus

The current status of the Transfer.

statusReason: TransferStatusReasonCode

The reason for the current status.

createdAt: String

The date and time, in ISO 8601 format, the Transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the Transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers

TransferAmountCalculation

The strategy used to calculate the amount to be transferred

Output:OBJECT

Fields

calculatedType: CalculatedTransferAmountType

The type used to calculate the total amount to be transferred

TransferPurposeInterFinancialAccountTransferRule

A InterFinancialAccountTransferRule that will block an inter financial account transfer if the transfer purpose is not allowed or blocked.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the TransferPurposeInterFinancialAccountTransferRule in operations.

The name assigned to the rule.

allowed: [TransferPurpose!]

The transfer purposes that will be allowed.

blocked: [TransferPurpose!]

The transfer purposes that will be blocked.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

revisions: InterFinancialAccountTransferRuleConnection

The list of revisions for this transfer rule.

Input Arguments

first: Int

The number of revisions to return.

Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the transfer rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer rule was last updated.

TransferPurposeInterFinancialAccountTransferRuleResult

Result of TransferPurposeInterFinancialAccountTransferRule

Output:OBJECT

Interfaces

Fields

status: InterFinancialAccountTransferRuleResultStatus

A status representing the result of the rule’s evaluation.

message: String

A message describing the result.

interFinancialAccountTransferRule: TransferPurposeInterFinancialAccountTransferRule

Transfer purpose inter financial account transfer rule

UnderwriterAdverseDecision

A type representing an adverse underwriting decision.

Output:OBJECT

Fields

adverseActionReasons: [AdverseActionReason]

A list of reasons why the underwriting decision was adverse.

UnderwriterPositiveDecision

A type representing a positive underwriting decision.

Output:OBJECT

Fields

creditLine: Amount!

The approved credit line, based on pre-defined rules.

creditPlanTerms: [CreditPlanTerms!]

Terms such as interest rates for each CreditPlan associated with this application.

UndeterminedFeePaymentTransactionFee

This fee is undetermined. Contact Highnote to get more details about this fee.

Output:OBJECT

Interfaces

Fields

feeAmount: Amount

The amount of the fee.

accountingDirection: AccountingDirection

The direction the fees are moving in the perspective of the subscriber.

when DEBIT, this fee is deducted from the total payable amount.
when CREDIT, this fee is credited to the total payable amount.

UnifiedFundsTransfer

UnifiedFundsTransfer is a common type object used to transfer money between multiple objects.

Once the transfer has started, use UnifiedFundsTransfer.transfer to view the actual transfer between the source and destination objects.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference this object.

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

source: UnifiedFundsTransferSource

The source of the funds to transfer.

destination: UnifiedFundsTransferDestination

The destination of the funds to transfer.

status: UnifiedFundsTransferStatus

The current status of the transfer.

failureReason: UnifiedFundsTransferFailureReason

When the UnifiedFundsTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

steps: [UnifiedFundsTransferStep!]

The steps associated with this transfer.

externalIdentifier: String

Externally provided ID (255 character limit) to associate this object with an external system.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

id: ID

The global ID of the step.

status: UnifiedFundsTransferStatus

The status of the transfer at the time of this step.

failureReason: UnifiedFundsTransferFailureReason

When the UnifiedFundsTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

createdAt: String

The date and time, in ISO 8601 format, when this step occurred.

UnifiedFundsTransferInstantNetworkTransferStep

A step associated with a UnifiedFundsTransfer when a transfer has initiated.

Output:OBJECT

Fields

id: ID

The global ID of the step.

status: UnifiedFundsTransferStatus

The status of the transfer at the time of this step.

failureReason: UnifiedFundsTransferFailureReason

When the UnifiedFundsTransfer.status is FAILED during this event, this will be populated with the reason for the failure.

createdAt: String

The date and time, in ISO 8601 format, when this step occurred.

transfer: UnifiedFundsTransferStepTransfer

The transfer associated with this step.

UnifiedFundsTransferQuote

A quote generated by createUnifiedFundsTransferQuote. This is the first step towards transferring funds. Show this quote to your customer for them to accept.

Once the quote is accepted, call initiateUnifiedFundsTransfer with the UnifiedFundsTransferQuote.id to initiate the transfer.

Output:OBJECT

Fields

id: ID!

Identifier used to reference the quote. Will need to be passed into initiateUnifiedFundsTransfer to start a transfer

createdAt: String

The date and time, in ISO 8601 format, when this object was created.

updatedAt: String

The date and time, in ISO 8601 format, when this object was last updated.

expiresAt: String

The date and time, in ISO 8601 format, when this transfer will expire.

memo: String

The reason for the transfer.

source: UnifiedFundsTransferSource

The source of the funds to transfer.

destination: UnifiedFundsTransferDestination

The destination of the funds to transfer.

minimumInclusive: UnsignedInt

The minimum value (inclusive).

minimumExclusive: UnsignedInt

The minimum value (exclusive).

maximumInclusive: UnsignedInt

The maximum value (inclusive).

maximumExclusive: UnsignedInt

The maximum value (exclusive).

UpcomingBillingCycleConfiguration

The anticipated configuration values for the next upcoming billing cycle.

Output:OBJECT

Fields

paymentDueDayOfMonth: Int

Payment due day of the month.

Min: 1 Max: 21

billingCycleStartDayOfMonth: Int

Billing cycle start day of the month. The billing cycle starts the day the Financial Account is created.

The billingCycleStartDayOfMonth range is between 1 and 31.

billingCycleEndDayOfMonth: Int

Billing cycle end day of the month.

Min: 4 Max: 24

UpcomingStatementDueDateEvent

Event generated when a FinancialAccountStatement has an upcoming due date.

Output:OBJECT

Fields

financialAccount: FinancialAccount

The FinancialAccount with an upcoming due date.

paymentDueDayOfMonth: UnsignedInt

The day of the month when payment is due. Will be an integer between 1 and 28.

upcomingStatementDueDate: String

The date and time, in ISO 8601 format, of the upcoming due date.

numberOfDaysUntilDueDate: UnsignedInt

The number of days remaining until the upcoming due date, as of this event creation.

createdAt: String

The date and time, in ISO 8601 format, this was created.

UploadRequirement

Details of the requirements for the upload.

Output:OBJECT

Fields

constraints: [UploadRequirementConstraint]

A list of a constraints for an upload

USAccountHolderApplicationDocumentUploadSession

A document upload session for a US Account Holder Application

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the document upload session

The current state of the document upload session

primaryDocumentTypes: [DocumentType!]

A list of primary document types that are compliant for upload. A primary document is a verifiable document used to provide evidence of identity containing personally identifiable information.

secondaryDocumentTypes: [DocumentType!]

A list of secondary document types that are compliant for upload. A secondary document is additional substantiating evidence to verify the identity of the entity.

supportingDocumentTypes: [DocumentType!]

A list of supporting document types that are compliant for upload. A supporting document contains information to correlate the identity of the entity.

uploadRequirements: [UploadRequirement!]

A list of upload requirements, dependent upon the type of document upload

documents: [UploadLink!]

A list of documents uploaded via a secure document upload link

documentContext: DocumentUploadSessionContext

A context to represent rules and configurations for the USAccountHolderApplicationDocumentUploadSession

recommendedDocumentTypes: [DocumentType!]

A recommended list of documents to collect during this USAccountHolderApplicationDocumentUploadSession.

createdAt: String

The date and time, in ISO 8601 format, this document upload session was created.

updatedAt: String

The date and time, in ISO 8601 format, this document upload session was last updated.

USBankAccount

A US bank account used for RTP transfers.

Output:OBJECT

Fields

last4: String

The last four digits of the bank account number.

routingNumber: String

The bank routing number (ABA).

accountType: USBankAccountType

The type of bank account.

The account holder's name.

USBusinessAccountHolder

A USBusinessAccountHolder.

Output:OBJECT

Interfaces

BusinessAccountHolder

Fields

id: ID!

Global ID used to reference the business in operations.

primaryAuthorizedPerson: USBusinessAuthorizedPerson

The details of the person authorized to act on behalf of business.

businessProfile: USBusinessProfile

Information about the business.

externalId: String

An ID associated with the account holder provided by an external party. Highnote does not validate the ID.

createdAt: String

The date and time, in ISO 8601 format, the business account holder was created.

updatedAt: String

The date and time, in ISO 8601 format, the business account holder was last updated.

cardProductApplications: AccountHolderCardProductApplicationConnection

The Applications for this Account Holder.

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

paymentCards: PaymentCardConnection

The Payment Cards issued for this Account Holder.

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

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: AccountHolderPaymentCardsFilterInput

Filter results to specific Payment Cards.

externalFinancialAccounts: ExternalFinancialAccountConnection

The external financial account for this Account Holder.

Input Arguments

first: Int

Default Value: 20

after: String

externalFinancialAccountId: ID

Filter results to a specific External Financial Account.

financialAccounts: FinancialAccountConnection

The financial accounts associated with the account holder.

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

Input Arguments

first: Int

The number of financial accounts to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: AccountHolderFinancialAccountsFilterInput

Filter results to specific financial accounts.

authorizedAccountHolderRelationships: AuthorizedAccountHolderRelationshipConnection

Returns the list of authorized account holder relationships associated with the USBusinessAccountHolder.

Only active relationships are returned. A relationship is considered active if it has not been explicitly revoked, expired, or marked inactive in the system.

Use this field to access currently valid relationships from this USBusinessAccountHolder

Input Arguments

first: Int

Default Value: 20

after: String

globalNotes: GlobalNoteConnectionPayload

All global notes for this USBusinessAccountHolder.

Input Arguments

first: Int

Default Value: 20

after: String

BusinessAccountHolder

Fields

accountHolderCurrent: USBusinessAccountHolder

The account holder.

businessProfile: USBusinessProfileSnapshot

Business.

primaryAuthorizedPerson: USBusinessAuthorizedPersonSnapshot

Authorized person

currentVerification: AccountHolderVerificationDeprecated

The current verification attempt, if any, of the account holder. Deprecated. Check the currentVerification field under USBusinessProfileSnapshot instead.

use `businessProfile.currentVerification` instead.

USBusinessAccountHolderToken

A reference to a tokenized USBusinessAccountHolder.

Output:OBJECT

Fields

token: String!

The reference to the tokenized UsBusinessAccountHolder.

The tokenized USBusinessAccountHolder data to be used as input to subsequent mutations (e.g. createUSBusinessAccountHolderFromToken).

Expires after 1 hour.

USBusinessAuthorizedPerson

The details of the person authorized to act on behalf of business.

Output:OBJECT

Interfaces

AuthorizedPerson

Fields

id: ID!

Global ID used to reference the authorized person.

The authorized person's name.

percentageOwnership: Int

Percentage ownership of authorized person.

authorizingPersonTitle: BusinessTitle

Authorized person's business title.

email: String

The email address of the authorized person.

phoneNumbers: [Phone!]

List of phone numbers associated with the authorized person.

homeAddress: Address

The default physical address of the authorized person.

dateOfBirth: String

The date of birth of the authorized person represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the authorized person.

isGuarantor: Boolean

Indicates whether or not the authorized person is a guarantor.

createdAt: String

The date and time, in ISO 8601 format, the authorized person was created.

updatedAt: String

The date and time, in ISO 8601 format, the authorized person was last updated.

USBusinessAuthorizedPersonSnapshot

The details of the person authorized to act on behalf of business.

Output:OBJECT

Interfaces

AuthorizedPerson

Fields

The authorized person's name.

percentageOwnership: Int

Percentage ownership of authorized person.

authorizingPersonTitle: BusinessTitle

Authorized person's business title.

email: String

The email address of the authorized person.

phoneNumbers: [Phone!]

List of phone numbers associated with the authorized person.

homeAddress: Address

The default physical address of the authorized person.

dateOfBirth: String

The date of birth of the authorized person represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the authorized person.

verificationState: AccountHolderVerificationStatusCodeDeprecated

Verification status of authorized person.

Use currentVerification instead.

currentVerification: AccountHolderVerification

The current verification attempt, if any, of the authorized person.

createdAt: String

The date and time, in ISO 8601 format, the authorized person was created.

updatedAt: String

The date and time, in ISO 8601 format, the authorized person was last updated.

USBusinessIdentificationDocument

The US business identification document attached to a Business.

Output:OBJECT

Fields

employerIdentificationNumber: TaxIdentificationDocument

Employer Identification Number (USA only).

USBusinessProfile

Information about the US business.

Output:OBJECT

Interfaces

BusinessProfile

Fields

id: ID!

Global ID used to reference the business.

Name of the business.

businessDescription: String

A short description of what the business does, its purpose, and the products or services it provides.

businessType: BusinessStructure

Type of business.

creditRiskAttributes: CreditRiskAttributesDeprecated

The business' credit risk attributes such as annual revenue, used for underwriting decisions.

Use businessCreditRiskAttributes instead.

businessCreditRiskAttributes: BusinessCreditRiskAttributes

The business' credit risk attributes such as annual revenue, used for underwriting decisions.

website: String

Business website.

billingAddress: Address

The default physical address of the business.

legalAddress: Address

The address supplied for the business' registration.

phoneNumbers: [Phone!]

List of phone numbers associated with the business.

identificationDocument: USBusinessIdentificationDocument

Identification document associated with the business.

ultimateBeneficialOwners: [USBusinessUltimateBeneficialOwner]

Ultimate beneficial owners of the business.

authorizedUsers: AuthorizedUserConnectionDeprecated

Authorized users of the business.

Use UsBusinessAccountHolder.authorizedAccountHolderRelationships instead.

Input Arguments

first: Int

Default Value: 20

after: String

operatingDetails: BusinessPlanOperatingDetails

Operating Details

createdAt: String

The date and time, in ISO 8601 format, the business was created.

updatedAt: String

The date and time, in ISO 8601 format, the business was last updated.

industryType: BusinessPlanOperatingGoodsAndServiceCategory

The industry type for the business

incorporationDate: Date

The date this business was incorporated

Format: YYYY-MM-DD

regionOfFormation: String

A region for the address based on the codes for identifying the principle subdivisions, e.g. provinces and states, of countries IS0 3166 standard, including districts and outlying areas.

externalId: String

An ID representing this business organization in an external system.

USBusinessProfileSnapshot

Information about the US business.

Output:OBJECT

Interfaces

BusinessProfile

Fields

Name of the business.

businessDescription: String

A short description of what the business does, its purpose, and the products or services it provides.

businessType: BusinessStructure

Type of business.

creditRiskAttributes: CreditRiskAttributesDeprecated

The business' credit risk attributes, such as annual revenue. Used for underwriting decisions.

Use businessCreditRiskAttributes instead.

operatingDetails: BusinessPlanOperatingDetails

Operating Details

businessCreditRiskAttributes: BusinessCreditRiskAttributes

The business' credit risk attributes, such as annual revenue. Used for underwriting decisions.

currentCreditUnderwritingVerification: CreditUnderwritingVerification

The business' current credit underwriting status and details.

website: String

Business website.

billingAddress: Address

The default physical addresses of the business.

legalAddress: Address

The address supplied for the business' registration.

phoneNumbers: [Phone!]

List of phone numbers associated with the business.

identificationDocument: USBusinessIdentificationDocument

Identification document associated with the business.

verificationState: AccountHolderVerificationStatusCodeDeprecated

Verification status of business.

Use currentVerification instead.

currentVerification: AccountHolderVerification

The current verification attempt, if any, on the business profile.

ultimateBeneficialOwners: [USBusinessUltimateBeneficialOwnerSnapshot]

Ultimate beneficial owners of the business.

createdAt: String

The date and time, in ISO 8601 format, the business was created.

updatedAt: String

The date and time, in ISO 8601 format, the business was last updated.

USBusinessUltimateBeneficialOwner

Ultimate beneficial owner for the business owning 25% or more of the business.

Output:OBJECT

Fields

id: ID!

Global ID used to reference the ultimate beneficial owner.

The ultimate beneficial owner's full name.

percentageOwnership: Int

Percentage ownership of ultimate beneficial owner.

homeAddress: Address

The default physical address of the ultimate beneficial owner.

dateOfBirth: String

The date of birth of the ultimate beneficial owner represented in YYYY-MM-DD format.

email: String

The email address of the ultimate beneficial owner.

phoneNumbers: [Phone!]

List of phone numbers associated with the ultimate beneficial owner.

identificationDocument: USIdentificationDocument

Identification Document associated with the ultimate beneficial owner.

isGuarantor: Boolean

Indicates whether or not the ultimate beneficial owner is a guarantor.

isPrimaryAuthorizedPerson: Boolean

Indicates whether or not the ultimate beneficial owner is the primary authorized person.

createdAt: String

The date and time, in ISO 8601 format, the ultimate beneficial owner was created.

updatedAt: String

The date and time, in ISO 8601 format, the ultimate beneficial owner was last updated.

USBusinessUltimateBeneficialOwnerSnapshot

A snapshot of the Ultimate beneficial owner for the business.

Output:OBJECT

Fields

ultimateBeneficialOwnerId: ID!

Global ID used to reference the ultimate beneficial owner.

The ultimate beneficial owner's full name.

percentageOwnership: Int

Percentage ownership of ultimate beneficial owner.

homeAddress: Address

The default physical address of the ultimate beneficial owner.

dateOfBirth: String

The date of birth of the ultimate beneficial owner represented in YYYY-MM-DD format.

email: String

The email address of the ultimate beneficial owner.

phoneNumbers: [Phone!]

List of phone numbers associated with the ultimate beneficial owner.

identificationDocument: USIdentificationDocument

Identification Document associated with the ultimate beneficial owner.

verificationState: AccountHolderVerificationStatusCodeDeprecated

Verification status of ultimate beneficial owner.

Use currentVerification instead.

currentVerification: AccountHolderVerification

The current verification attempt, if any, of the ultimate beneficial owner.

createdAt: String

The date and time, in ISO 8601 format, the ultimate beneficial owner was created.

updatedAt: String

The date and time, in ISO 8601 format, the ultimate beneficial owner was last updated.

User

A human User of the Highnote Platform.

Output:OBJECT

Interfaces

Fields

id: ID!

The Global ID of the User.

email: String

The email address of the User.

clientCredentials: [UserClientCredential!]

A list of credentials for the User that can be used to make client-side requests.

id: ID!

Unique identifier for this field instance.

value: Boolean

The actual value stored in this field instance.

version: Int

Version number of the UserDefinedField.

The field definition that this instance is based on.

UserDefinedFieldRevision

The Node entity that this field is attached to.

deleted: Boolean

Whether this field instance has been deleted.

createdBy: User

The User profile for the user who created the UserDefinedField

updatedBy: User

The User profile for the user who updated the UserDefinedField

createdAt: String

ISO 8601 timestamp when this field instance was created.

updatedAt: String

ISO 8601 timestamp when this field instance was last updated.

revisions: UserDefinedFieldRevisionPayload

Historical revisions of this field, ordered by creation time (newest first).

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

UserDefinedBooleanFieldRevision

A historical snapshot of a UserDefinedBooleanField at a specific point in time.

Output:OBJECT

Interfaces

Fields

userDefinedField: UserDefinedField

The ID of the UserDefinedField this revision belongs to.

version: Int

Version number of this revision (matches the version field on UserDefinedField at capture time).

value: Boolean

The boolean value of the UserDefinedBooleanField for this version.

The field definition snapshot at the time of this revision.

The Node entity that this field was attached to at the time of this revision.

deleted: Boolean

Whether the field was marked as deleted in this revision.

createdBy: User

The User who created this revision (who made the change).

createdAt: String

ISO 8601 timestamp when this revision was created.

UserDefinedFieldConnection

The connection type for UserDefinedField

Output:OBJECT

Fields

edges: [UserDefinedFieldEdge!]

A list of edges.

pageInfo: PageInfo!

Information about the current page.

UserDefinedFieldDefinition

Configuration template for creating UserDefinedField instances.

Output:OBJECT

Interfaces

Fields

id: ID!

Unique identifier for this field definition.

Human-readable name for this field definition.

description: String

Optional description explaining the purpose of this field definition.

dataType: UserDefinedFieldDefinitionDataType

The data type that values of this field must conform to.

relationships: [UserDefinedFieldDefinitionRelationshipType!]

The relationships between the UserDefinedField and the applicable entity types.

version: Int

The version of the UserDefinedFieldDefinition.

deleted: Boolean

Whether this field definition has been deleted.

createdBy: User

The User profile for the user who created the UserDefinedFieldDefinition

updatedBy: User

The User profile for the user who updated the UserDefinedFieldDefinition

createdAt: String

ISO 8601 timestamp when this definition was created.

updatedAt: String

ISO 8601 timestamp when this definition was last updated.

revisions: UserDefinedFieldDefinitionRevisionPayload

Historical revisions of this definition, ordered by creation time (newest first).

Input Arguments

first: Int

userDefinedFieldDefinition: UserDefinedFieldDefinition

The UserDefinedFieldDefinition this revision belongs to.

version: Int

Version number of this revision (matches the version field on UserDefinedFieldDefinition at capture time).

Human-readable name for this field definition at the time of this revision.

description: String

Description explaining the purpose of this field definition at the time of this revision.

dataType: UserDefinedFieldDefinitionDataType

The data type that values of this field must conform to at the time of this revision.

relationships: [UserDefinedFieldDefinitionRelationshipType!]

The relationships between the UserDefinedField and the applicable entity types at the time of this revision.

deleted: Boolean

Whether this field definition was marked as deleted in this revision.

cursor: String!

The cursor for this edge for use in pagination.

node: UserDefinedFieldRevision

The UserDefinedFieldRevision.

UserDefinedIntegerField

Output:OBJECT

Interfaces

UserDefinedField

Fields

id: ID!

Unique identifier for this field instance.

value: Int

The actual value stored in this field instance.

version: Int

Version number of the UserDefinedField.

The field definition that this instance is based on.

UserDefinedFieldRevision

The Node entity that this field is attached to.

deleted: Boolean

Whether this field instance has been deleted.

createdBy: User

The User profile for the user who created the UserDefinedField

updatedBy: User

The User profile for the user who updated the UserDefinedField

createdAt: String

ISO 8601 timestamp when this field instance was created.

updatedAt: String

ISO 8601 timestamp when this field instance was last updated.

revisions: UserDefinedFieldRevisionPayload

Historical revisions of this field, ordered by creation time (newest first).

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

UserDefinedIntegerFieldRevision

A historical snapshot of a UserDefinedIntegerField at a specific point in time.

Output:OBJECT

Interfaces

Fields

userDefinedField: UserDefinedField

The ID of the UserDefinedField this revision belongs to.

version: Int

Version number of this revision (matches the version field on UserDefinedField at capture time).

value: Int

The integer value of the UserDefinedIntegerField for this version.

The field definition snapshot at the time of this revision.

The Node entity that this field was attached to at the time of this revision.

deleted: Boolean

Whether the field was marked as deleted in this revision.

createdBy: User

The User who created this revision (who made the change).

createdAt: String

ISO 8601 timestamp when this revision was created.

UserDefinedStringField

Output:OBJECT

Interfaces

UserDefinedField

Fields

id: ID!

Unique identifier for this field instance.

value: String

The actual value stored in this field instance.

version: Int

Version number of the UserDefinedField.

The field definition that this instance is based on.

UserDefinedFieldRevision

The Node entity that this field is attached to.

deleted: Boolean

Whether this field instance has been deleted.

createdBy: User

The User profile for the user who created the UserDefinedField

updatedBy: User

The User profile for the user who updated the UserDefinedField

createdAt: String

ISO 8601 timestamp when this field instance was created.

updatedAt: String

ISO 8601 timestamp when this field instance was last updated.

revisions: UserDefinedFieldRevisionPayload

Historical revisions of this field, ordered by creation time (newest first).

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

UserDefinedStringFieldRevision

A historical snapshot of a UserDefinedStringField at a specific point in time.

Output:OBJECT

Interfaces

Fields

userDefinedField: UserDefinedField

The ID of the UserDefinedField this revision belongs to.

version: Int

Version number of this revision (matches the version field on UserDefinedField at capture time).

value: String

The string value of the UserDefinedStringField for this version.

The field definition snapshot at the time of this revision.

The Node entity that this field was attached to at the time of this revision.

deleted: Boolean

Whether the field was marked as deleted in this revision.

createdBy: User

The User who created this revision (who made the change).

createdAt: String

ISO 8601 timestamp when this revision was created.

UserEdge

The edge type for a User.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: User

The User.

UserError

Result type when user errors are present on the request.

Output:OBJECT

Fields

errors: [FieldUserError!]

The user errors present on the request.

USIdentificationDocument

The US identification documents attached to a Person.

Output:OBJECT

Fields

socialSecurityNumber: TaxIdentificationDocument

A person's social security number (USA only).

The validation for the input uses the following regex pattern ^(?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4}$.

USPersonAccountHolder

A USPersonAccountHolder.

Output:OBJECT

Interfaces

PersonAccountHolder

Fields

id: ID!

Global ID used to reference the account holder in operations.

The account holder's name, represented as different parts.

email: String

The email address of the account holder.

phoneNumbers: [Phone!]

List of phone numbers associated with the account holder.

billingAddress: Address

The default billing addresses of the account holder

dateOfBirth: String

The date of birth of the account holder represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the account holder.

externalId: String

An ID associated with the account holder provided by an external party. Highnote does not validate the ID.

createdAt: String

The date and time, in ISO 8601 format, the account holder was created.

updatedAt: String

The date and time, in ISO 8601 format, the account holder was last updated.

personCreditRiskAttributes: PersonCreditRiskAttributes

The credit risk attributes for the USPersonAccountHolder.

cardProductApplications: AccountHolderCardProductApplicationConnectionDeprecated

The Applications for this Account Holder.

Use applications instead.

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

applications: CardProductApplicationConnection

The Applications for this Account Holder.

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

paymentCards: PaymentCardConnection

The Payment Cards issued for this Account Holder.

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

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: AccountHolderPaymentCardsFilterInput

Filter results to specific Payment Cards.

externalFinancialAccounts: ExternalFinancialAccountConnection

The external financial account for this Account Holder.

first: Int

Default Value: 20

after: String

globalNotes: GlobalNoteConnectionPayload

All global notes for this USPersonAccountHolder.

Input Arguments

first: Int

Default Value: 20

after: String

PersonAccountHolder

Fields

accountHolderCurrent: USPersonAccountHolder

The account holder.

The account holder's name, represented as different parts.

billingAddress: Address

The default billing addresses of the account holder

email: String

The email address of the account holder.

phoneNumbers: [Phone!]

List of phone numbers associated with the account holder.

dateOfBirth: String

The date of birth of the account holder represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the account holder.

currentVerification: AccountHolderVerification

The current verification attempt, if any, of the account holder.

currentCreditUnderwritingVerification: CreditUnderwritingVerification

The USPersonAccountHolder's current credit underwriting status and details.

personCreditRiskAttributes: PersonCreditRiskAttributes

The USPersonAccountHolder's credit risk attributes, such as annual income. Used for underwriting decisions.

USPersonAccountHolderToken

A reference to a tokenized USPersonAccountHolder.

Output:OBJECT

Fields

token: String!

The reference to the tokenized USPersonAccountHolder.

The tokenized USPersonAccountHolder data to be used as input to subsequent mutations (e.g. createUSPersonAccountHolderFromToken).

Expires after 1 hour.

USPersonAuthorizedUser

A USPersonAuthorizedUser.

Output:OBJECT

Interfaces

PersonAuthorizedUser

Fields

id: ID!

ID used to reference the authorized user in operations.

The authorized user's name, represented as different parts.

email: String

The email address of the authorized user.

phoneNumbers: [Phone!]

List of phone numbers associated with the authorized user.

billingAddress: Address

The default billing addresses of the authorized user.

dateOfBirth: String

The date of birth of the authorized user represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the authorized user.

externalId: String

An ID associated with the authorized user provided by an external party. Highnote does not validate the ID.

createdAt: String

The date and time, in ISO 8601 format, the authorized user was created.

updatedAt: String

The date and time, in ISO 8601 format, the authorized user was last updated.

cardProductApplications: AuthorizedUserCardProductApplicationConnection

The Applications for this authorized user.

Input Arguments

first: Int

The number of Applications to return.

Default Value: 20

after: String

The cursor to start the page.

paymentCards: PaymentCardConnection

The Payment Cards issued for this authorized user.

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

Input Arguments

first: Int

Default Value: 20

after: String

filterBy: AuthorizedUserPaymentCardsFilterInput

Filter results to specific Payment Cards.

associatedAccountHolders: AccountHolderConnection

The account holders associated with the authorized user.

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

Input Arguments

first: Int

The number of financial accounts to return.

Default Value: 20

after: String

The cursor to start the page.

filterBy: AccountHolderFinancialAccountsFilterInput

Filter results to specific financial accounts.

riskScores: AccountHolderRiskScore

A list of risk scores associated with the account holder.

USPersonAuthorizedUserSnapshot

The details of the AuthorizedUser at the time of application.

Output:OBJECT

Interfaces

PersonAuthorizedUser

Fields

authorizedUserCurrent: USPersonAuthorizedUser

The authorized user.

The authorized user's name, represented as different parts.

billingAddress: Address

The default billing addresses of the authorized user

email: String

The email address of the account holder.

phoneNumbers: [Phone!]

List of phone numbers associated with the authorized user.

dateOfBirth: String

The date of birth of the authorized user represented in YYYY-MM-DD format.

identificationDocument: USIdentificationDocument

Identification Document associated with the authorized user.

USPersonAuthorizedUserToken

A reference to a tokenized USPersonAuthorizedUser.

Output:OBJECT

Fields

token: String!

The reference to the tokenized USPersonAuthorizedUser.

The tokenized USPersonAuthorizedUser data to be used as input to subsequent mutations (e.g. createUSPersonAuthorizedUserFromToken).

Expires after 1 hour.

ValidatedAddress

The ValidatedAddress.

Output:OBJECT

Interfaces

ValidAddress

Fields

id: ID!

Global ID used to reference this object.

provided: Address

The address as provided to validateAddress.

standardized: Address

The standardized version of the provided address.

labels: [ValidatedAddressLabel!]

Additional information about the address.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

ValidatedAddressToken

The ValidatedAddressToken.

Output:OBJECT

Interfaces

ValidAddress

Fields

id: ID!

Global ID used to reference this object.

provided: Address

The address as provided to validateAddress.

standardized: Address

The standardized version of the provided address.

labels: [ValidatedAddressLabel!]

Additional information about the address.

createdAt: String

The date and time, in ISO 8601 format, this object was created.

expiresAt: String

The date and time, in ISO 8601 format, this object will expire.

deliveryStatus: AddressDeliveryStatus

The delivery status of the validated address, as determined by the USPS Delivery Point Validation (DPV).

deliveryStatusMessage: String

A human-readable message providing additional context about the delivery status.

VariableFeeChargeValue

Percentage based fee charge value.

Output:OBJECT

Fields

basisPoints: UnsignedInt

Basis points representation of the fee percentage to be charged. eg: 125 basis points = 1.25%

VelocityInterFinancialAccountTransferRule

A VelocityInterFinancialAccountTransferRule is window constrained inter financial account transfer control that is composed of at most 3 ConditionalInterFinancialAccountTransferRules and 1 cumulative CumulativeInterFinancialAccountTransferRule (e.g. AmountLimitInterFinancialAccountTransferRule)

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the VelocityInterFinancialAccountTransferRule in operations.

The name assigned to the rule.

velocityRuleWindow: VelocityRuleWindow

The evaluation window of a VelocityInterFinancialAccountTransferRule

cumulativeInterFinancialAccountTransferRule: CumulativeInterFinancialAccountTransferRule

The cumulative rule attached to the VelocityInterFinancialAccountTransferRule

conditionalInterFinancialAccountTransferRules: [ConditionalInterFinancialAccountTransferRule]

The conditional rules attached to the VelocityInterFinancialAccountTransferRule

version: String

The current version of the rule. Specific versions can be attached and detached from CardProducts.

Input Arguments

filterBy: String

createdAt: String

The date and time, in ISO 8601 format, the VelocityTransferRule was created.

updatedAt: String

The date and time, in ISO 8601 format, the VelocityTransferRule was last updated.

VelocityInterFinancialAccountTransferRuleAmountBalance

The amount balance details of an amount VelocityInterFinancialAccountTransferRule.

Output:OBJECT

Fields

currentBalance: Amount

The current balance for the VelocityInterFinancialAccountTransferRule

remainingBalance: Amount

The remaining balance for the VelocityInterFinancialAccountTransferRule

computedCurrentBalance: Amount

The computed current balance for the VelocityInterFinancialAccountTransferRule

computedRemainingBalance: Amount

The computed remaining balance for the VelocityInterFinancialAccountTransferRule

currentCount: UnsignedInt

The current count for the VelocityInterFinancialAccountTransferRule

remainingCount: UnsignedInt

The remaining count for the VelocityInterFinancialAccountTransferRule

computedCurrentCount: UnsignedInt

The computed current count for the VelocityInterFinancialAccountTransferRule

computedRemainingCount: UnsignedInt

The computed remaining count for the VelocityInterFinancialAccountTransferRule

asOfDate: String

The date and time, in ISO 8601 format, the balance was last updated.

velocityInterFinancialAccountTransferRule: VelocityInterFinancialAccountTransferRule

Indicates the VelocityInterFinancialAccountTransferRule the balance is associated to.

VelocityInterFinancialAccountTransferRuleEdge

The edge type for a VelocityInterFinancialAccountTransferRule.

Output:OBJECT

Fields

cursor: String!

The cursor for this edge for use in pagination.

node: VelocityInterFinancialAccountTransferRule

The VelocityInterFinancialAccountTransferRule.

VelocityInterFinancialAccountTransferRuleResult

The result of applying a VelocityInterFinancialAccountTransferRule to an event.

Output:OBJECT

Interfaces

Fields

status: InterFinancialAccountTransferRuleResultStatus

A status representing the result of the rule’s evaluation.

message: String

A message describing the result.

velocityInterFinancialAccountTransferRule: VelocityInterFinancialAccountTransferRule

The VelocityInterFinancialAccountTransferRule attached at the time of the event.

feedbackCode: FeedbackCode

This field will be populated if an override is attempted. It will indicate if the override was allowed or denied.

VelocityRule

A VelocityRule is window constrained authorization control that is composed of at most 3 SpendRules and 1 cumulative SpendRule (e.g. AmountLimitSpendRule)

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the VelocityRule in operations.

The name assigned to the rule.

velocityRuleWindow: VelocityRuleWindow

The evaluation window of a VelocityRule

cumulativeRule: SpendRule

The cumulative rule attached to the VelocityRule

spendRules: [SpendRule]

The SpendRules attached to the VelocityRule

version: String

The current version of the rule. Specific versions can be attached and detached from CardProducts and PaymentCards.

Input Arguments

filterBy: String

createdAt: String

The date and time, in ISO 8601 format, the VelocityRule was created.

updatedAt: String

The date and time, in ISO 8601 format, the VelocityRule was last updated.

revisions: VelocityRuleConnection

The list of revisions for this VelocityRule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

velocityConstraintLevelOverride: VelocityConstraintLevel

Optional VelocityConstraintLevel at which the cumulative spend rule will be evaluated.

Defaults to CARD when VelocityRule is directly attached to a card All other times defaults to ACCOUNT

The ApplicableRuleUserType for which the rule will be evaluated.

VelocityRuleAssociation

A VelocityRule that is or was attached.

Output:OBJECT

Fields

velocityRule: VelocityRule

The VelocityRule

The name assigned to the rule.

associatedTo: VelocityRuleAssociatedType

The associated entity the VelocityRule is attached to

version: String

The current version of the rule. Specific versions can be attached and detached.

createdAt: String

The date and time, in ISO 8601 format, the VelocityRule was created.

updatedAt: String

The date and time, in ISO 8601 format, the VelocityRule was last updated.

VelocityRuleBalance

DEPRECATED: The balance details of a VelocityRule

Output:OBJECT

Fields

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

velocityRule: VelocityRule

The VelocityRule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

VelocitySpendRuleAmountBalance

The amount balance details of a VelocityRule

Output:OBJECT

Fields

currentBalance: Amount

The current amount balance for the VelocityRule

remainingBalance: Amount

The remaining amount balance for the VelocityRule

computedCurrentBalance: Amount

The computed current amount balance for the VelocityRule

computedRemainingBalance: Amount

The computed remaining amount balance for the VelocityRule

asOfDate: String

The date and time, in ISO 8601 format, the balance was last updated.

velocityRule: VelocityRule

Indicates the VelocityRule the balance is associated to.

attachedLevel: AttachedLevel

The attached level. (Platform, Product, Card)

VelocitySpendRuleCountBalance

The count balance details of a VelocityRule

Output:OBJECT

Fields

currentCountBalance: Int

The current count balance for the VelocityRule

remainingCountBalance: Int

The remaining count balance for the VelocityRule

computedCurrentCountBalance: Int

The computed current count balance for the VelocityRule

computedRemainingCountBalance: Int

The computed remaining count balance for the VelocityRule

asOfDate: String

The date and time, in ISO 8601 format, the balance was last updated.

velocityRule: VelocityRule

Indicates the VelocityRule the balance is associated to.

attachedLevel: AttachedLevel

The attached level. (Platform, Product, Card)

VendorProvidedBankFinancialAccountFeature

Whether or not the Financial Account is a Non Verified account

Output:OBJECT

Interfaces

Fields

enabled: Boolean

Whether or not the feature is enabled for the Financial Account.

createdAt: String

The date and time, in ISO 8601 format, the feature was created.

updatedAt: String

The date and time, in ISO 8601 format, the feature was last updated.

effectiveFrom: String

The date and time, in ISO 8601 format, the feature was effective from.

effectiveThrough: String

The date and time, in ISO 8601 format, the feature was effective through.

VendorRelationship

Represents a relationship between an originating organization and a vendor organization. Defines which notification events should be relayed from the originator to the vendor.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the VendorRelationship.

originatingOrganization: Organization

The organization that originally triggers notification events.

vendorOrganization: Organization

The organization that receives relayed notification events.

vendorName: String

The name of the vendor organization.

notificationEventTypes: [NotificationEventName!]

The notification event types that will be relayed to the vendor.

active: Boolean

Whether this vendor relationship is active.

createdAt: String

The date and time, in ISO 8601 format, when this relationship was created.

updatedAt: String

The date and time, in ISO 8601 format, when this relationship was last updated.

VerificationEvent

A Verification Event for a transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of the transaction event.

responseCode: TransactionEventResponseCode

The Highnote response code.

transaction: Transaction

The Transaction for this event.

networkResponseCode: StringDeprecated

The response code from the card network (e.g. Mastercard).

Use responseCode instead

avsResponseCode: AVSResponseCode

Code representing the result of AVS address verification.

pinResponseCode: PinResponseCode

Code representing the result of PIN verification.

postalCodeResponseCode: PostalCodeResponseCode

Code representing the result of AVS postal code verification.

cvvResponseCode: CVVResponseCode

Code representing the result of CVV (security code) verification.

networkTransactionId: IDDeprecated

The transaction ID from the card network (e.g. Mastercard).

No longer supported

approvedAmount: Amount

The Amount approved for this VerificationEvent and posted in the settlement currency. Does not include fees.

requestedAmount: Amount

The Amount requested to be approved for this VerificationEvent.

originalAmount: Amount

The original Amount of the VerificationEvent.

accountingDirection: AccountingDirection

The direction funds are moving in the perspective of the cardholder.

when DEBIT, funds are moving out of the cardholder's account
when CREDIT, funds are moving into the cardholder's account

createdAt: String

The date and time, in ISO 8601 format, this VerificationEvent was created.

paymentCard: PaymentCard

The PaymentCard associated to this VerificationEvent.

cardProduct: CardProduct

The CardProduct associated to this VerificationEvent.

merchantDetails: MerchantDetails

The details about the merchant who requested the verification.

spendRuleResults: SpendRuleResultConnection

The triggered spend rules and the results for the verification.

Input Arguments

first: Int

The number of results to return.

Default Value: 20

after: String

The cursor to start the page.

currentFinancialAccountAvailableToSpendAmount: Amount

Amount available to spend after this transaction event.

currentFinancialAccountMaximumBalanceAmount: Amount

Maximum balance allowed for the card account at the time of this transaction event.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetails

The Point Of Service Details.

additionalNetworkData: AdditionalNetworkData

Network specific transaction data.

CardProfile

Fields

id: ID!

ID of the virtual card profile.

status: CardProfileStatus

Status of the virtual card profile.

paymentNetworkStatus: CardProfilePaymentNetworkStatus

Payment Network Status of the virtual card profile.

bankStatus: CardProfileBankStatus

Bank Status of the virtual card profile.

cardHolderAgreementId: ID

Card Holder Agreement ID of the virtual card profile.

cardProduct: CardProduct

Card Product of the virtual card profile.

personalization: VirtualCardPersonalizationType

Personalization type for the virtual card profile

serviceCode: ServiceCode

Specify intended POS behavior for card

cardArt: [CardArtDocument!]

Card art

createdAt: String

The date and time, in ISO 8601 format, this virtual card profile was created.

updatedAt: String

The date and time, in ISO 8601 format, this virtual card profile was last updated.

Name of the VirtualCardProfile.

description: String

Description about the VirtualCardProfile.

cardProfileSetRelationships: [CardProfileSetRelationship!]

The list of CardProfileSet related to this VirtualCardProfile.

browserText: VirtualCardBrowserText

The browser text displayed to cardholder during 3DS verification for online transactions

appText: VirtualCardAppText

The native app text displayed to cardholder during 3DS verification for mobile transactions

VisaData

Visa specific transaction data.

Output:OBJECT

Fields

transactionIdentifier: String

The transaction identifier sent by Visa.

authorizationCode: String

An alphanumeric value generated by Highnote and shared with Visa when an authorization is approved.

acquiringInstitutionIdentificationCode: String

A number used by Visa to identify the acquiring institution.

systemTraceAuditNumber: String

A number assigned by the message initiator that uniquely identifies a transaction.

retrievalReferenceNumber: String

An value used to identify and track a transaction’s separate messages.

networkTransmissionDateAndTime: String

The date and time that the network transmitted the transaction. This value is expressed in Greenwich Mean Time (GMT) with format (MMDDhhmmss)

riskScore: UnsignedInt

The risk score for the transaction provided by Visa. Values are between 0-99.

motoAndElectronicCommerceIndicator: VisaMotoAndElectronicCommerceIndicator

Classification information for Mail Order/Telephone Order (MOTO) and Electronic Commerce transactions.

cavvResultCode: VisaCavvResultCode

Information about the Cardholder Authentication Verification Value (CAVV) for this transaction.

threeDSecureIndicator: VisaThreeDSecureIndicator

Information about the verification method used in this transaction.

paymentFacilitatorIdentifier: String

Payment facilitator identifier for the transaction.

VisaFleetAuthorizationData

Details pertaining to a Visa Fleet transaction available at Authorization and Authorization Advice time

Output:OBJECT

Interfaces

Fields

id: ID!

Globally unique id of a VisaFleetAuthorizationData

purchaseType: VisaFuelPurchaseType

Indicates whether fuel or non-fuel items are included in the transaction

serviceType: VisaFuelServiceType

Indicates whether the transaction occurred at a self-service or a full-service station

purchaseIdentifierFormat: VisaFleetPurchaseIdentifierFormat

Indicates whether purchaseIdentifier is an Order Number or a Invoice Number provided by the cardholder

purchaseIdentifier: String

An alphanumeric value representing either an Order Number or an Invoice Number provided by the cardholder

fleetIdentifier: String

An alphanumeric value representing either a Vehicle, Driver, or Generic ID provided by the cardholder

odometer: String

The odometer value provided by the cardholder

employeeNumber: String

An alphanumeric value representing the employee’s ID number

trailerNumber: String

An alphanumeric value representing the trailer’s ID number

customPrompt1: String

An alphanumeric value representing the answer to a custom prompt

customPrompt2: String

An alphanumeric value representing the answer to a custom prompt

purchaseRestrictonsFlag: Boolean

Indicates whether the POS supports host-based restriction processing

nonFuelProductCodes: [VisaNonFuelProductCode!]

A list of non-fuel product codes for the products purchased

VisaFleetL2FuelLineItem

Visa Fleet Level 2 fuel line item data. These are relevant data items describing fuel products purchased in a fleet transaction. Also used to provide EV charging information

Output:OBJECT

Fields

productCode: VisaFuelType

Describes one of the fuels purchased in this transaction

unitPrice: UnsignedInt

Cost of fuel per unit of measure

unitPriceMinorUnit: UnsignedInt

The number of places the decimal point shall be moved to the left, starting from the right-most numeric digit of unit price

unitOfMeasure: VisaFuelUnitOfMeasure

Unit of measure used to measure this fuel item

quantity: UnsignedInt

Quantity of fuel purchased

quantityMinorUnit: UnsignedInt

The number of places the decimal point shall be moved to the left, starting from the right-most numeric digit of quantity

totalTimePluggedIn: String

Total amount of time the vehicle was plugged in, in the format HHMMSS

totalTimeCharging: String

Total amount of time taken to charge the vehicle, in the format HHMMSS

chargingStartTime: String

Start time of the charge expressed in local time of the card acceptor location, in the format HHMMSS

chargingFinishTime: String

Finish time of the charge expressed in local time of the card acceptor location, in the format HHMMSS

totalAmount: Amount

Total amount for this fuel code line item, including tax

fuelIndicator: Boolean

Indicates whether the line item represents a fuel product or service or not

serviceType: VisaFuelServiceType

The type of service provided at the card acceptor location

productCategoryOrDescription: String

The product category or detail description

discountRatePercentage: UnsignedInt

The discount rate in basis points. Two decimal places are implied

discountPerUnit: Amount

The discount amount per unit

discountPerTransaction: Amount

The discount amount per transaction

totalDiscountAmount: Amount

The total discount amount for this line item

netAmount: Amount

The net line item amount less than tax exempted or discounts

notTaxableIndicator: Boolean

An indicator to show whether the item is taxable or not

localTaxIncludedIndicator: Boolean

An indicator to show whether the local tax is included in the unit cost or not

localTaxAmount: Amount

The Amount of local tax

localTaxRate: UnsignedInt

The VAT/Local tax rate in basis points for fuel purchased. Two decimal places are implied

nationalTaxIncludedIndicator: Boolean

An indicator to show whether national tax is included in the unit cost or not

nationalTaxAmount: Amount

The Amount of national tax

nationalTaxRate: UnsignedInt

The national tax rate in basis points for fuel purchased. Two decimal places are implied

otherTaxIncludedIndicator: Boolean

Indicates whether other tax is included in the unit cost or not

otherTaxAmount: Amount

The Amount of other tax

otherTaxRate: UnsignedInt

The other tax rate in basis points for fuel purchased. Two decimal places are implied

VisaFleetL2TransactionData

An Visa Fleet L2 additional transaction data

Output:OBJECT

Interfaces

Fields

id: ID!

Globally unique id of a VisaFleetL2TransactionData.

visaFuelPurchaseType: VisaFuelPurchaseType

Describes the type of items included in the transaction. (Gas, non-fuel, fuel, and non-fuel)

visaFuelServiceType: VisaFuelServiceType

Indicates whether the transaction occurred at a self-service or a full-service station

visaFuelType: VisaFuelType

The variety of fuel purchased during the transaction

visaFuelQuantity: UnsignedInt

The amount of fuel purchased during the transaction.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelUnitOfMeasure: VisaFuelUnitOfMeasure

The dimension utilized in conjunction with quantity

visaFuelUnitCost: UnsignedInt

The price per unit of measure for the fuel.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelNetAmount: UnsignedInt

The fuel amount less any exempted taxes or discounts. The value will equal visaFuelQuantity * visaFuelUnitCost exclusive of taxes.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelGrossAmount: UnsignedInt

The total amount for only the fuel purchased in the transaction. The value will equal visaFuelQuantity * visaFuelUnitCost inclusive of taxes.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaNonFuelNetAmount: UnsignedInt

The non-fuel amount less any exempted taxes or discounts. The value will equal the sum of the line item(s) exclusive of taxes.

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaNonFuelGrossAmount: UnsignedInt

The total amount for only the non-fuel products purchased in the transaction. The value will equal the sum of the line item(s) inclusive of taxes.

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaTaxRate: UnsignedInt

The VAT or tax rate applied for the transaction

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaExpandedFuelType: VisaFuelType

An additional identifier to further differentiate the fuel product

visaAdditionalDataIndicator: Boolean

Indicates whether the Merchant will send more additional (Level 3) information in the future

visaFleetIdentifier: String

An alphanumeric value representing either a Vehicle, Driver, or Generic ID

visaOdometerReading: UnsignedInt

A numeric value indicating the vehicle’s odometer reading at the time of the transaction.

Up to 7 digits.

visaPurchaseIdentifierFormat: VisaFleetPurchaseIdentifierFormat

Indicates whether Purchase Identifier is an order or invoice number

visaPurchaseIdentifier: String

An alphanumeric value representing an order or invoice number

visaFleetEmployeeNumber: String

An alphanumeric value representing the employee’s ID number

visaFleetTrailerNumber: String

An alphanumeric value representing the trailer’s ID number

visaFleetCustomPrompt1: String

An alphanumeric value representing the answer to a custom prompt

visaFleetCustomPrompt2: String

An alphanumeric value representing the answer to a custom prompt

visaNonFuelProductCodes: [VisaNonFuelProductCode!]

A list of up to eight visaNonFuelProductCode values for products in the transaction

visaChargingPowerCapacity: UnsignedInt

Charging station power output capacity represented in kW

visaChargingReasonCode: UnsignedIntDeprecated

Specific charging reason code for this transaction

Use visaEvChargingReasonCode instead

visaEvChargingReasonCode: VisaEvChargingReasonCode

Specific charging reason code for this transaction

visaEstimatedKmMilesAdded: UnsignedInt

Estimate of the total distance added in km/miles, based on the kWh added and the type of vehicle engine charged

visaCarbonFootprintAvoided: UnsignedInt

Carbon footprint avoidance (how much was saved from this charge) measurement for the purchase on the transaction – measured in grams of carbon dioxide equivalent (CO2e)

visaEstimatedKmMilesAvailable: UnsignedInt

Estimated range in Km/Miles the car will have, after completion of the charge, once it leaves the electric vehicle charging station

visaMaxPowerDispensed: UnsignedInt

Maximum power dispensed during the specific charge session from that charging station. This could be different to the power output capacity of the station based on power management by the site operator

visaConnectorType: StringDeprecated

Visa-defined code for a specific connector type to identify the connection for the charge session

Use visaEvConnectorType instead

visaEvConnectorType: VisaEvConnectorType

Visa-defined code for a specific connector type to identify the connection for the charge session

visaFleetFuelLineItems: [VisaFleetL2FuelLineItem!]

A list of fuel products purchased if this transaction contained multiple fuel types

visaNationalTaxRate: UnsignedInt

The national tax rate in basis points for fuel purchased. Two decimal places are implied

visaOtherTaxRate: UnsignedInt

Other tax rate in basis points for fuel purchased. Two decimal places are implied

visaDiscountMethod: VisaFleetDiscountMethod

Discount method applied to the transaction

visaDiscountAgent: VisaFleetDiscountAgent

Identifies the entity that calculated the discount

visaDiscountPlanIdentifier: String

Identifies the discount plan applied to the transaction

visaClientIdentifier: String

Identifies the fleet client

VisaFleetL3EnhancedData

Visa Fleet Level 3 enhanced transaction Data. These are relevant additional transaction data items pertaining to a fleet transaction.

Output:OBJECT

Interfaces

Fields

id: ID!

The ID of this VisaFleetL3EnhancedData. This id cannot be used to later retrieve details of this EnhancedDataEvent. Please use the id of the EnhancedDataEvent.

discount: VisaFleetL3EnhancedDataDiscount

Discount data for this transaction.

duty: VisaFleetL3EnhancedDataDuty

Duty data for this transaction.

invoice: VisaFleetL3EnhancedDataInvoice

Invoice data for this transaction.

shipping: VisaFleetL3EnhancedDataShipping

Shipping data for this transaction.

tax: VisaFleetL3EnhancedDataTax

Tax data for this transaction.

VisaFleetL3EnhancedDataDiscount

Discount data for this transaction.

Output:OBJECT

Fields

amount: Amount

Total amount of discount at invoice level according to the treatment and the tax.treatment.

This figure excludes any discount amounts defined at line item level.

The last two digits are implied decimal places.

signage: VisaAmountSignage

This field specifies if the invoice-level Discount Amount is a credit or debit value.

treatment: VisaDiscountTreatment

Identifies how to treat the discount if one was applied at the invoice level

VisaFleetL3EnhancedDataDuty

Duty data for this transaction.

Output:OBJECT

Fields

amount: Amount

The price of duty. The last two digits are implied decimal places.

signage: VisaAmountSignage

This field specifies if the Duty Amount is a credit or debit value.

VisaFleetL3EnhancedDataInvoice

Invoice data for this transaction.

Output:OBJECT

Fields

referenceNumber: String

The VAT invoice reference number

destinationPostalCode: String

Postal code of the destination. The field may contain spaces.

shipFromPostalCode: String

Postal code of the location being shipped from. The field may contain spaces.

destinationCountryCode: String

Country code of the destination. The field may contain spaces.

authorizationCode: String

The Authorization Code of the transaction.

orderDate: String

Date the order was taken. The entry should be in the format YYYY-MM-DD.

lineItems: [VisaFleetL3EnhancedDataLineItem!]

List of VisaFleetL3EnhancedDataLineItem objects

VisaFleetL3EnhancedDataLineItem

An single line item within a VisaFleetL3EnhancedData

Output:OBJECT

Fields

commodityCode: VisaItemCommodityCode

The value holds either a fuelType or a nonFuelProductCode value.

descriptor: String

Freeform text description of item or service

productCode: String

Typically, an SKU or identifier from the Merchant

quantity: UnsignedInt

The number of items.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

unitOfMeasure: String

A readable unit of measure

unitCost: Amount

Unit cost for this item or service in accordance with the taxTreatment.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

taxAmount: Amount

Amount of sales tax for this item or service in accordance with the taxTreatment.

The last two digits are implied decimal places.

taxRate: UnsignedInt

Rate of sales tax charged on the item or service (in accordance with the taxTreatment).

The last two digits are implied decimal places.

discountPerItem: Amount

Amount of discount if provided for this line item according to the discountTreatment.

The last two digits are implied decimal places.

lineItemDiscountTreatment: VisaDiscountTreatment

Identifies how to treat the discount if one was applied at the line item level

lineItemTotal: Amount

Formula: (quantity * unitCost) - discountPerItem

The last two digits are implied decimal places.

lineItemDetailIndicator: VisaLineItemDetailIndicator

Defines the type of line item

VisaFleetL3EnhancedDataShipping

Shipping data for this transaction.

Output:OBJECT

Fields

amount: Amount

The price of freight/shipping. The last two digits are implied decimal places.

signage: VisaAmountSignage

This field specifies if the Shipping Amount is a credit or debit value.

taxAmount: Amount

Amount of Sales Tax charged on the shipping amount (in accordance with the tax.treatment).

The last two digits are implied decimal places.

taxAmountSignage: VisaAmountSignage

This field specifies if the Duty Amount is a credit or debit value.

taxRate: UnsignedInt

Rate of sales tax charged on the shipping amount (in accordance with the tax.treatment).

The last two digits are implied decimal places.

VisaFleetL3EnhancedDataTax

Tax data for this transaction.

Output:OBJECT

Fields

treatment: VisaTaxTreatment

Describes how the tax is calculated on the invoice.

VisaRiskScoreSpendRule

A Spend Control rule that blocks transactions if the Visa Risk Score is above a configured threshold.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the VisaRiskScoreSpendRule in operations.

The name assigned to the rule.

maximumVisaRiskScore: UnsignedInt

The maximum Visa Risk Score allowed for a transaction before transaction is declined.

version: String

The current version of the rule. Specific versions can be attached and detached from card products and payment cards.

createdAt: String

The date and time, in ISO 8601 format, the spend rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the spend rule was last updated.

revisions: SpendRuleConnection

The list of revisions for this spend rule.

Input Arguments

first: Int

The number of revisions to return.

Default Value: 20

after: String

The cursor to start the page.

The ApplicableRuleUserType for which the rule will be evaluated.

VisaRiskScoreSpendRuleResult

The result of applying a VisaRiskScoreSpendRule to an event.

Output:OBJECT

Interfaces

Fields

recommendation: SpendRuleRecommendation

The recommendation to ALLOW or BLOCK an event based on the result of the rule.

message: String

A message describing the result.

visaRiskScore: UnsignedInt

The Visa Risk Score for this transaction.

spendRule: VisaRiskScoreSpendRule

The spend rule attached at the time of the event.

attachedLevel: AttachedLevel

The attached level.

WatchlistInterFinancialAccountTransferRule

A inter account transfer rule that is connected to the watchlist.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the WatchlistInterFinancialAccountTransferRule in operations.

The name assigned to the rule.

version: String

The current version of the rule.

revisions: InterFinancialAccountTransferRuleConnection

The list of revisions for this transfer rule.

Input Arguments

first: Int

The number of revisions to return.

Default first is set to 20.

Default Value: 20

after: String

The cursor to start the page.

createdAt: String

The date and time, in ISO 8601 format, the transfer rule was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer rule was last updated.

WatchlistInterFinancialAccountTransferRuleResult

The result of applying a WatchlistInterFinancialAccountTransferRule to an event.

Output:OBJECT

Interfaces

Fields

status: InterFinancialAccountTransferRuleResultStatus

A status representing the result of the rule’s evaluation.

message: String

A message describing the result.

interFinancialAccountTransferRule: WatchlistInterFinancialAccountTransferRule

The WatchlistInterFinancialAccountTransferRule attached at the time of the event.

feedbackCode: FeedbackCode

This field will be populated if an override is attempted. It will indicate if the override was allowed or denied.

WebhookNotificationTarget

A webhook notification target.

Output:OBJECT

Interfaces

Fields

id: ID!

Global ID used to reference the WebhookNotificationTarget in operations.

The name of the WebhookNotificationTarget.

uri: String

The URI to send notifications.

email: String

The email address to which target deactivation emails are sent. This data is only stored in the live environment. Deactivation emails are not sent in the test environment.

subscriptions: [NotificationEventName!]

The event names this target is subscribed to.

createdAt: String

The date and time, in ISO 8601 format, the WebhookNotificationTarget was created.

updatedAt: String

The date and time, in ISO 8601 format, this was most recently updated.

deactivatedAt: String

The date and time, in ISO 8601 format, this was most recently deactivated.

signingKeys: [SigningKey!]

The signing keys used for this target.

status: NotificationTargetStatus!

The status of the target.

deliveryAttempts: DeliveryAttemptConnection

The history of delivery attempts for this notification target.

Input Arguments

first: Int

The page size.

after: String

Cursor.

statusHistory: NotificationTargetStatusHistoryConnection

The history of status changes for this notification target.

Input Arguments

first: Int

The page size.

after: String

Cursor.

webhookNotificationTargetEvents: WebhookNotificationTargetEventConnection

The events that should have been delivered to this target.

Input Arguments

first: Int

The page size.

Default Value: 20

hasSuccessfulDelivery: Boolean

Indicates whether the event was delivered to the target. If false, the latest delivery attempt was unsuccessful OR skipped because the target was deactivated.

event: NotificationEvent

The notification event that should have been delivered to the target.

deliveryAttempts: DeliveryAttemptConnection

Fields

id: ID!

Global ID used to reference the transfer in operations.

amount: Amount

The amount of the transfer.

createdAt: String

The date and time, in ISO 8601 format, the transfer was created.

updatedAt: String

The date and time, in ISO 8601 format, the transfer was last updated.

ledgers: [Ledger!]

The ledgers affected by the transfer.

Input Arguments

ledgerNames: [LedgerName!]

Scope the results to specific ledgers.

type: WireTransferType

The type that this WireTransfer is.

status: WireTransferStatus

The current status of this WireTransfer.

statusReason: WireTransferStatusReasonCode

The reason for the current status.

financialAccount: FinancialAccount

The FinancialAccount effected for this WireTransfer.

memo: String

A memo for the WireTransfer.

userDefinedFields: UserDefinedFieldConnection

The UserDefinedFields associated with this WireTransfer.

Input Arguments

first: Int

The number of UserDefinedFields to return

Default Value: 20

after: String

The cursor to start the page.

The filter used to search UserDefinedFields

WireTransferReview

The details of an WireTransferReview initiated by Highnote.

Output:OBJECT

Interfaces