Interface
An Interface is an abstract type that specifies a set of required fields. A type may implement the interface by including these fields.
AccountHolderIdentityRiskScore
Interface representing the common fields related to an account holder's identity risk score
Output:INTERFACE
Fields
determinedAt: String
The date and time, in ISO 8601 format, when the risk decision was made
riskLevel: IdentityRiskLevel
The severity of the risk
Possible Types
SardineIdentityRiskScore: SardineIdentityRiskScore
Fields
id: ID!
The Global ID of this AccountReview.
financialAccountId: ID!
The Global ID of the FinancialAccount in review.
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.
Possible Types
CreditLimitChangeRequest: CreditLimitChangeRequest
AccountStatusEvent
Output:INTERFACE
Interfaces
Fields
id: ID!
The ID of the FinancialAccount that has changed status.
accountName: String
The name of this FinancialAccount.
externalId: String
Externally provided ID (255 character limit) that can be used to refer to the issued payment card's' financial account. This ID is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).
createdAt: String
The date and time, in ISO 8601 format, this event was created.
Possible Types
AccountStatusActiveEvent: AccountStatusActiveEvent
AccountStatusSuspendedEvent: AccountStatusSuspendedEvent
AccountStatusUnderReviewEvent: AccountStatusUnderReviewEvent
AccountStatusPendingClosureEvent: AccountStatusPendingClosureEvent
AccountStatusClosedEvent: AccountStatusClosedEvent
AchExternallyInitatedEvent
Output:INTERFACE
Fields
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
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.
transferStatus: ACHTransferStatusDetailsDeprecated
The status of the ACH transfer.
transfer status only needed for failed or returned events
Possible Types
AchExternallyInitatedDepositReceivedEvent: AchExternallyInitatedDepositReceivedEvent
AchExternallyInitatedDepositProcessedEvent: AchExternallyInitatedDepositProcessedEvent
AchExternallyInitatedDepositFailedEvent: AchExternallyInitatedDepositFailedEvent
AchExternallyInitiatedWithdrawalReceivedEvent: AchExternallyInitiatedWithdrawalReceivedEvent
AchExternallyInitiatedWithdrawalProcessedEvent: AchExternallyInitiatedWithdrawalProcessedEvent
AchExternallyInitiatedWithdrawalFailedEvent: AchExternallyInitiatedWithdrawalFailedEvent
AchHoldEvent
Output:INTERFACE
Fields
id: ID!
The global ID to reference this event.
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.
Possible Types
AchHoldAddedEvent: AchHoldAddedEvent
AchHoldRemovedEvent: AchHoldRemovedEvent
AchTransfer
The base details of an OriginatedAchTransfer or NonOriginatedAchTransfer.
An OriginatedAchTransfer is 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.
A NonOriginatedAchTransfer is 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:INTERFACE
Fields
id: ID!
Global ID used to reference the AchTransfer.
amount: Amount
The monetary amount to transfer.
createdAt: String
The date and time the transfer was initiated (OriginatedAchTransfer) or received (NonOriginatedAchTransfer),
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
type: AchTransferType
The direction of the transfer, PUSH or PULL, from the perspective of the originating financial institution.
For an OriginatedAchTransfer, 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.
For a NonOriginatedAchTransfer, 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. deposit.
sign: AchTransferSign
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.
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 when the transfer is in the PROCESSING state.
It is used is used to identify the transfer in the ACH network.
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 or a NonOriginatedAchTransfer PUSH 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.
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.
Funds from an OriginatedAchTransfer PULL or a NonOriginatedAchTransfer PUSH 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.
Possible Types
OriginatedAchTransfer: OriginatedAchTransfer
NonOriginatedAchTransfer: NonOriginatedAchTransfer
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
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.
returnDate: String
The date this transaction was returned, in ISO 8601 format.
Possible Types
CreditFundsACHTransferEvent: CreditFundsACHTransferEvent
DebitFundsACHTransferEvent: DebitFundsACHTransferEvent
PayrollACHTransferEvent: PayrollACHTransferEvent
SecureDepositACHTransferEvent: SecureDepositACHTransferEvent
SecureDepositTransferEvent: SecureDepositTransferEvent
SecureCardBalanceRepaymentACHTransferEvent: SecureCardBalanceRepaymentACHTransferEvent
IntegratorInitiatedFundsWithdrawalACHTransferEvent: IntegratorInitiatedFundsWithdrawalACHTransferEvent
IntegratorInitiatedFundsDepositACHTransferEvent: IntegratorInitiatedFundsDepositACHTransferEvent
AdditionalTransactionData
Output:INTERFACE
Interfaces
Fields
id: ID!
Globally unique id of a AdditionalTransactionData.
Possible Types
VisaFleetL2TransactionData: VisaFleetL2TransactionData
VisaFleetL3EnhancedData: VisaFleetL3EnhancedData
MastercardFleetEnhancedData: MastercardFleetEnhancedData
MastercardFleetAuthorizationData: MastercardFleetAuthorizationData
VisaFleetAuthorizationData: VisaFleetAuthorizationData
Fields
Possible Types
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
USBusinessAuthorizedPersonSnapshot: USBusinessAuthorizedPersonSnapshot
BusinessAccountHolder
The base fields for all BusinessAccountHolders (regardless of region or snapshot).
Output:INTERFACE
Fields
primaryAuthorizedPerson: AuthorizedPerson
The details of the person authorized to act on behalf of business.
businessProfile: BusinessProfile
Information about the business.
Possible Types
USBusinessAccountHolder: USBusinessAccountHolder
USBusinessAccountHolderSnapshot: USBusinessAccountHolderSnapshot
Fields
timeRange: BusinessMetricTimeRange
An ISO 8601 value (inclusive) for the beginning and end date.
asOf: String
Data freshness timestamp of metrics.
Possible Types
CardProductApplicationBusinessMetricResult: CardProductApplicationBusinessMetricResult
PaymentCardTransactionBusinessMetricResult: PaymentCardTransactionBusinessMetricResult
Fields
sortedDirection: BusinessMetricAttributeSortedDirection
Sort by Ascending or Descending, Descending as default.
Possible Types
DeclinedTransactionResponseCodeBusinessMetric: DeclinedTransactionResponseCodeBusinessMetric
ClearedTransactionBusinessMetricTopMerchantCategory: ClearedTransactionBusinessMetricTopMerchantCategory
ClearedTransactionBusinessMetricTopMerchantName: ClearedTransactionBusinessMetricTopMerchantName
Fields
name: BusinessName
The business' legal name.
billingAddress: Address
The primary address of the business.
operatingDetails: BusinessPlanOperatingDetails
Operating Details
Possible Types
USBusinessProfile: USBusinessProfile
USBusinessProfileSnapshot: USBusinessProfileSnapshot
CardDigitalWalletTokenEvent
Output:INTERFACE
Interfaces
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.
Possible Types
CardDigitalWalletTokenActivatedEvent: CardDigitalWalletTokenActivatedEvent
CardDigitalWalletTokenSuspendedEvent: CardDigitalWalletTokenSuspendedEvent
CardDigitalWalletTokenTerminatedEvent: CardDigitalWalletTokenTerminatedEvent
CardProductFeature
Output:INTERFACE
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.
Possible Types
CollaborativeAuthorizationCardProductFeature: CollaborativeAuthorizationCardProductFeature
CollaborativeApplicationUnderwritingCardProductFeature: CollaborativeApplicationUnderwritingCardProductFeature
DisputeChargebackCardProductFeature: DisputeChargebackCardProductFeature
OnDemandFundingCardProductFeature: OnDemandFundingCardProductFeature
PartialFundingCardProductFeature: PartialFundingCardProductFeature
EarlyDirectDepositCardProductFeature: EarlyDirectDepositCardProductFeature
AuthorizedUserCardProductFeature: AuthorizedUserCardProductFeature
RevolvingCardProductFeature: RevolvingCardProductFeature
ChargeCardProductFeature: ChargeCardProductFeature
PointRewardCardProductFeature: PointRewardCardProductFeature
SecuredDepositCardProductFeature: SecuredDepositCardProductFeature
DirectMerchantAcquiringCardProductFeature: DirectMerchantAcquiringCardProductFeature
ExternalBusinessManagementCardProductFeature: ExternalBusinessManagementCardProductFeature
Fields
id: ID!
ID of the card profile.
status: CardProfileStatus
Status of the card profile.
cardHolderAgreementId: ID
Card Holder Agreement ID of the card profile.
cardProduct: CardProduct
Card Product of the card profile.
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: String
Name of the CardProfile.
description: String
Description about the CardProfile.
cardProfileSetRelationships: [CardProfileSetRelationship!]
The list of CardProfileSet related to this CardProfile.
Possible Types
PhysicalCardProfile: PhysicalCardProfile
VirtualCardProfile: VirtualCardProfile
DigitalCardProfile: DigitalCardProfile
Fields
id: ID!
ID of the card profile set.
status: CardProfileSetStatus
Status of the card profile set.
name: String
Name of the card profile set.
intent: CardProfileSetIntent
Intent of the card profile set.
network: CardProfileSetNetwork
Network of 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.
updatedAt: String
The date and time, in ISO 8601 format, this CardProfileSet was last updated.
description: String
A description about the card profile set.
Possible Types
CardProfileSet: CardProfileSet
CardProfileSetRestricted: CardProfileSetRestricted
Fields
key: String!
The key of the custom field.
Possible Types
CustomStringField: CustomStringField
DocumentUploadSession
Output:INTERFACE
Fields
id: ID!
Global ID used to reference the document upload session
status: DocumentUploadSessionStatusCode
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
Possible Types
IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession
USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession
ManualDocumentRequestUploadSession: ManualDocumentRequestUploadSession
CardProfileDocumentUploadSession: CardProfileDocumentUploadSession
CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession
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
Possible Types
PayrollTransfer: PayrollTransfer
CreditFunds: CreditFunds
DebitFunds: DebitFunds
SecureDepositACHTransfer: SecureDepositACHTransfer
SecureDeposit: SecureDeposit
IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer
IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer
SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer
ExternallyInitiatedWireTransfer: ExternallyInitiatedWireTransfer
OriginatedAchTransfer: OriginatedAchTransfer
NonOriginatedAchTransfer: NonOriginatedAchTransfer
ExternalMoneyMovementTransaction: ExternalMoneyMovementTransaction
Interfaces
Fields
id: ID!
Id for the external account.
accountName: String
The name of this account.
accountHolderId: ID
The identifier of an Account holder
provider: BankVerificationProvider
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.
Possible Types
ExternalBankAccountAddedEvent: ExternalBankAccountAddedEvent
ExternalBankAccountRemovedEvent: ExternalBankAccountRemovedEvent
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: ExternallyInitiatedACHStatusDetails
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.
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.
Possible Types
PayrollTransfer: PayrollTransfer
CreditFunds: CreditFunds
DebitFunds: DebitFunds
SecureDeposit: SecureDeposit
Interfaces
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.
Possible Types
RiskApplicationSDK: RiskApplicationSDK
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
enabled: Boolean
Indicates if the permission is enabled
Possible Types
RiskApplicationSDKRevision: RiskApplicationSDKRevision
FinancialAccountDelinquency
Interface for a delinquency for a FinancialAccount associated with a credit product.
Output:INTERFACE
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: [FinancialAccountDelinquencyCycle]
A list of contiguous billing cycles where this FinancialAccount was delinquent.
Possible Types
CreditPayInFullFinancialAccountDelinquency: CreditPayInFullFinancialAccountDelinquency
FinancialAccountDelinquencyCycle
A billing cycle where a FinancialAccount is delinquent at some point.
Output:INTERFACE
Fields
statementId: ID!
The unique identifier for the FinancialAccount statement for this billing cycle.
statement: FinancialAccountStatement
The FinancialAccount 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. Can be DELINQUENT or CURRENT.
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.
Possible Types
CreditPayInFullFinancialAccountDelinquencyCycle: CreditPayInFullFinancialAccountDelinquencyCycle
FinancialAccountFeature
Output:INTERFACE
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.
Possible Types
DirectDepositFinancialAccountFeature: DirectDepositFinancialAccountFeature
PrePaidPaymentCardFinancialAccountFeature: PrePaidPaymentCardFinancialAccountFeature
DebitPaymentCardFinancialAccountFeature: DebitPaymentCardFinancialAccountFeature
CreditPaymentCardFinancialAccountFeature: CreditPaymentCardFinancialAccountFeature
PayrollAdvanceFinancialAccountFeature: PayrollAdvanceFinancialAccountFeature
PayrollEmployerAdvanceFinancialAccountFeature: PayrollEmployerAdvanceFinancialAccountFeature
NegativeBalanceReserveFinancialAccountFeature: NegativeBalanceReserveFinancialAccountFeature
ProductReserveFinancialAccountFeature: ProductReserveFinancialAccountFeature
ProductFundingFinancialAccountFeature: ProductFundingFinancialAccountFeature
IncomeAccountFinancialAccountFeature: IncomeAccountFinancialAccountFeature
JustInTimeFundingFinancialAccountFeature: JustInTimeFundingFinancialAccountFeature
OnDemandFundingFinancialAccountFeature: OnDemandFundingFinancialAccountFeature
SecuredCreditPaymentCardFinancialAccountFeature: SecuredCreditPaymentCardFinancialAccountFeature
FleetCardAccountFeature: FleetCardAccountFeature
CommercialCreditPayInFullCardAccountFeature: CommercialCreditPayInFullCardAccountFeature
CreditCardAccountFeature: CreditCardAccountFeature
CardFundingFinancialAccountFeature: CardFundingFinancialAccountFeature
PointRewardFinancialAccountFeature: PointRewardFinancialAccountFeature
NonVerifiedFinancialAccountFeature: NonVerifiedFinancialAccountFeature
AchCapableFinancialAccountFeature: AchCapableFinancialAccountFeature
VendorProvidedBankFinancialAccountFeature: VendorProvidedBankFinancialAccountFeature
PartialFundingFinancialAccountFeature: PartialFundingFinancialAccountFeature
RepaymentFinancialAccountFeature: RepaymentFinancialAccountFeature
PreprintedCardFinancialAccountFeature: PreprintedCardFinancialAccountFeature
SecuredDepositFinancialAccountFeature: SecuredDepositFinancialAccountFeature
ProductSecuredDepositFinancialAccountFeature: ProductSecuredDepositFinancialAccountFeature
MerchantSettlementFinancialAccountFeature: MerchantSettlementFinancialAccountFeature
CheckCapableAccountFeature: CheckCapableAccountFeature
AuthorizedUserAccountFeature: AuthorizedUserAccountFeature
ResetBalanceFinancialAccountFeature: ResetBalanceFinancialAccountFeature
SuspenseFinancialAccountFeature: SuspenseFinancialAccountFeature
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 secondary 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
statementEntries: FinancialAccountStatementEntryConnection
statement entries.
For information on Highnote's Search API, see our Search guide.
Input Arguments
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.
Possible Types
SecuredDepositCommercialCreditCardFinancialAccountStatement: SecuredDepositCommercialCreditCardFinancialAccountStatement
CreditPayInFullCardFinancialAccountStatement: CreditPayInFullCardFinancialAccountStatement
ConsumerChargeCardFinancialAccountStatement: ConsumerChargeCardFinancialAccountStatement
ConsumerPrepaidCardFinancialAccountStatement: ConsumerPrepaidCardFinancialAccountStatement
ConsumerRevolvingCardFinancialAccountStatement: ConsumerRevolvingCardFinancialAccountStatement
CommercialChargeCardFinancialAccountStatement: CommercialChargeCardFinancialAccountStatement
CommercialRevolvingCardFinancialAccountStatement: CommercialRevolvingCardFinancialAccountStatement
FinancialAccountStatementBalanceType
Output:INTERFACE
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'
creditPlan: CreditPlan
The CreditPlan associated with this statement.
Possible Types
FinancialAccountStatementPurchaseCreditPlan: FinancialAccountStatementPurchaseCreditPlan
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.
Possible Types
SecuredDepositCommercialCreditCardFinancialAccountStatementEntry: SecuredDepositCommercialCreditCardFinancialAccountStatementEntry
CreditPayInFullCardFinancialAccountStatementEntry: CreditPayInFullCardFinancialAccountStatementEntry
ConsumerChargeCardFinancialAccountStatementEntry: ConsumerChargeCardFinancialAccountStatementEntry
ConsumerPrepaidCardFinancialAccountStatementEntry: ConsumerPrepaidCardFinancialAccountStatementEntry
ConsumerRevolvingCardFinancialAccountStatementEntry: ConsumerRevolvingCardFinancialAccountStatementEntry
CommercialChargeCardFinancialAccountStatementEntry: CommercialChargeCardFinancialAccountStatementEntry
CommercialRevolvingCardFinancialAccountStatementEntry: CommercialRevolvingCardFinancialAccountStatementEntry
FinancialAccountStatementEvent
Output:INTERFACE
Fields
Possible Types
FinancialAccountStatementReadyEvent: FinancialAccountStatementReadyEvent
FinancialAccountStatementSnapshot
Interface for a FinancialAccountStatementSnapshot.
Output:INTERFACE
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.
Possible Types
SecuredDepositCommercialCreditCardFinancialAccountStatementSnapshot: SecuredDepositCommercialCreditCardFinancialAccountStatementSnapshot
CreditPayInFullCardFinancialAccountStatementSnapshot: CreditPayInFullCardFinancialAccountStatementSnapshot
ConsumerChargeCardFinancialAccountStatementSnapshot: ConsumerChargeCardFinancialAccountStatementSnapshot
ConsumerPrepaidCardFinancialAccountStatementSnapshot: ConsumerPrepaidCardFinancialAccountStatementSnapshot
ConsumerRevolvingCardFinancialAccountStatementSnapshot: ConsumerRevolvingCardFinancialAccountStatementSnapshot
CommercialChargeCardFinancialAccountStatementSnapshot: CommercialChargeCardFinancialAccountStatementSnapshot
CommercialRevolvingCardFinancialAccountStatementSnapshot: CommercialRevolvingCardFinancialAccountStatementSnapshot
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: IntegratorInitiatedACHStatusDetails
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
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.)
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.
Possible Types
SecureDepositACHTransfer: SecureDepositACHTransfer
IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer
IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer
SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer
InterFinancialAccountTransferRule
A rule applicable to Inter Financial Account Transfers.
Output:INTERFACE
Fields
id: ID!
Global ID used to reference the transfer rule in operations.
name: String
The name assigned to the rule.
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.
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.
Possible Types
AmountLimitInterFinancialAccountTransferRule: AmountLimitInterFinancialAccountTransferRule
CountLimitInterFinancialAccountTransferRule: CountLimitInterFinancialAccountTransferRule
TransferPurposeInterFinancialAccountTransferRule: TransferPurposeInterFinancialAccountTransferRule
WatchlistInterFinancialAccountTransferRule: WatchlistInterFinancialAccountTransferRule
InterFinancialAccountTransferRuleResult
The result of a InterFinancialAccountTransferRule execution in the risk layer.
Output:INTERFACE
Fields
status: InterFinancialAccountTransferRuleResultStatus
A status representing the result of the rule’s evaluation.
message: String
A message describing the result.
Possible Types
AmountLimitInterFinancialAccountTransferRuleResult: AmountLimitInterFinancialAccountTransferRuleResult
TransferPurposeInterFinancialAccountTransferRuleResult: TransferPurposeInterFinancialAccountTransferRuleResult
VelocityInterFinancialAccountTransferRuleResult: VelocityInterFinancialAccountTransferRuleResult
WatchlistInterFinancialAccountTransferRuleResult: WatchlistInterFinancialAccountTransferRuleResult
InternalTransferEvent
Output:INTERFACE
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.
Possible Types
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent
LedgerEntry
Output:INTERFACE
Fields
id: ID!
The unique id of the LedgerEntry.
financialAccount: FinancialAccount
A FinancialAccount backed by the Ledger that this ledger entry belongs to.
journalEntry: JournalEntry
A JournalEntry showing this ledger entry and its offsetting entry.
ledger: Ledger
Ledger that LedgerEntry belongs to.
amount: Amount
The Amount of the LedgerEntry.
memo: String
The optional memo of the LedgerEntry.
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.
Possible Types
CreditLedgerEntry: CreditLedgerEntry
DebitLedgerEntry: DebitLedgerEntry
Node
Output:INTERFACE
Fields
id: ID!
Globally unique ID to fetch a Node.
Possible Types
USPersonAccountHolder: USPersonAccountHolder
USPersonAuthorizedUser: USPersonAuthorizedUser
USBusinessAccountHolder: USBusinessAccountHolder
AccountHolderApplicationDocument: AccountHolderApplicationDocument
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
AccountHolderCardProductApplicationOffer: AccountHolderCardProductApplicationOffer
ProductApplication: ProductApplication
ApplicationContract: ApplicationContract
RequestedIdentityUpdate: RequestedIdentityUpdate
OnboardingBusinessOrganizationInformation: OnboardingBusinessOrganizationInformation
OnboardingPreliminaryBusinessInformation: OnboardingPreliminaryBusinessInformation
PaymentCardTransactionDispute: PaymentCardTransactionDispute
PaymentCardTransactionChargeback: PaymentCardTransactionChargeback
Organization: Organization
CardProduct: CardProduct
FinancialAccount: FinancialAccount
CreditLimitChangeRequest: CreditLimitChangeRequest
AdminAgentOrganization: AdminAgentOrganization
User: User
APIKey: APIKey
RiskApplicationSDK: RiskApplicationSDK
RiskApplicationSDKRevision: RiskApplicationSDKRevision
PaymentCard: PaymentCard
PaymentCardSnapshot: PaymentCardSnapshot
CardDigitalWalletToken: CardDigitalWalletToken
FinancialAccountSnapshot: FinancialAccountSnapshot
EmployerFinancialAccount: EmployerFinancialAccount
ExternalFinancialBankAccount: ExternalFinancialBankAccount
DirectDepositDetail: DirectDepositDetail
ExternalBankAccountDetail: ExternalBankAccountDetail
PaymentCardIssuedEvent: PaymentCardIssuedEvent
PaymentCardActivatedEvent: PaymentCardActivatedEvent
PaymentCardSuspendedEvent: PaymentCardSuspendedEvent
PaymentCardUnsuspendedEvent: PaymentCardUnsuspendedEvent
PaymentCardClosedEvent: PaymentCardClosedEvent
NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount
NonVerifiedExternalUSFinancialBankAccountDetail: NonVerifiedExternalUSFinancialBankAccountDetail
AccountStatusActiveEvent: AccountStatusActiveEvent
AccountStatusSuspendedEvent: AccountStatusSuspendedEvent
AccountStatusUnderReviewEvent: AccountStatusUnderReviewEvent
AccountStatusPendingClosureEvent: AccountStatusPendingClosureEvent
AccountStatusClosedEvent: AccountStatusClosedEvent
ExternalBankAccountAddedEvent: ExternalBankAccountAddedEvent
ExternalBankAccountRemovedEvent: ExternalBankAccountRemovedEvent
FinancialAccountPseudoBalanceUpdate: FinancialAccountPseudoBalanceUpdate
LinkVerifiedExternalBankAccountFailedEvent: LinkVerifiedExternalBankAccountFailedEvent
AccountRelationship: AccountRelationship
CreditTransaction: CreditTransaction
DebitTransaction: DebitTransaction
ReversalEvent: ReversalEvent
ClearingEvent: ClearingEvent
EnhancedDataEvent: EnhancedDataEvent
AuthorizationEvent: AuthorizationEvent
VisaFleetL2TransactionData: VisaFleetL2TransactionData
ManualAdjustmentEvent: ManualAdjustmentEvent
IssuerPreliminaryAuthorizationEvent: IssuerPreliminaryAuthorizationEvent
PaymentCardAuthorizationApprovedEvent: PaymentCardAuthorizationApprovedEvent
PaymentCardAuthorizationCreatedEvent: PaymentCardAuthorizationCreatedEvent
PaymentCardAuthorizationDeclinedEvent: PaymentCardAuthorizationDeclinedEvent
PaymentCardAuthorizationReversedEvent: PaymentCardAuthorizationReversedEvent
PaymentCardClearedEvent: PaymentCardClearedEvent
PaymentCardEnhancedDataEvent: PaymentCardEnhancedDataEvent
PaymentCardAuthorizationAndClearApprovedEvent: PaymentCardAuthorizationAndClearApprovedEvent
PaymentCardAuthorizationAndClearDeclinedEvent: PaymentCardAuthorizationAndClearDeclinedEvent
PaymentCardVerificationApprovedEvent: PaymentCardVerificationApprovedEvent
PaymentCardVerificationDeclinedEvent: PaymentCardVerificationDeclinedEvent
PaymentCardAdjustmentEvent: PaymentCardAdjustmentEvent
AuthorizationAndClearEvent: AuthorizationAndClearEvent
VerificationEvent: VerificationEvent
BalanceInquiryEvent: BalanceInquiryEvent
AdjustmentEvent: AdjustmentEvent
Ledger: Ledger
CreditLedgerEntry: CreditLedgerEntry
DebitLedgerEntry: DebitLedgerEntry
JournalEntry: JournalEntry
VisaFleetL3EnhancedData: VisaFleetL3EnhancedData
MastercardFleetEnhancedData: MastercardFleetEnhancedData
MastercardFleetAuthorizationData: MastercardFleetAuthorizationData
VisaFleetAuthorizationData: VisaFleetAuthorizationData
Transfer: Transfer
WireTransfer: WireTransfer
PhysicalPaymentCardOrder: PhysicalPaymentCardOrder
PhysicalPaymentCardShippedEvent: PhysicalPaymentCardShippedEvent
PhysicalPaymentCardShipFailedEvent: PhysicalPaymentCardShipFailedEvent
PhysicalPaymentCardGroupOrderShippedEvent: PhysicalPaymentCardGroupOrderShippedEvent
PhysicalPaymentCardGroupOrderShipFailedEvent: PhysicalPaymentCardGroupOrderShipFailedEvent
PhysicalCardGroupOrder: PhysicalCardGroupOrder
ExternalPhysicalPaymentCardOrder: ExternalPhysicalPaymentCardOrder
PaymentCardBinRange: PaymentCardBinRange
CustomerAddress: CustomerAddress
CustomerName: CustomerName
CustomerPhone: CustomerPhone
CustomerEmailContactMethod: CustomerEmailContactMethod
CustomerWebsiteContactMethod: CustomerWebsiteContactMethod
VendorRelationship: VendorRelationship
WebhookNotificationTarget: WebhookNotificationTarget
NotificationEvent: NotificationEvent
DeliveryAttempt: DeliveryAttempt
SigningKey: SigningKey
CheckPaymentEvent: CheckPaymentEvent
CheckPayment: CheckPayment
FeeChargeEvent: FeeChargeEvent
FeeReversalEvent: FeeReversalEvent
DocumentUploadSessionCompleteEvent: DocumentUploadSessionCompleteEvent
FileUploadCompleteEvent: FileUploadCompleteEvent
CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint
InterFinancialAccountTransfer: InterFinancialAccountTransfer
FinancialAccountCreditLimitUpdateFromProductFunding: FinancialAccountCreditLimitUpdateFromProductFunding
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent
InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent
InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent
PayrollAdvanceRepaymentCompletedEvent: PayrollAdvanceRepaymentCompletedEvent
PayrollAdvanceWriteOffCompletedEvent: PayrollAdvanceWriteOffCompletedEvent
PayrollAdvance: PayrollAdvance
PayrollAdvanceWriteoffTransfer: PayrollAdvanceWriteoffTransfer
PayrollAdvanceRepaymentTransfer: PayrollAdvanceRepaymentTransfer
ExternallyInitiatedAchReleaseHoldTransfer: ExternallyInitiatedAchReleaseHoldTransfer
DisbursementTransferEvent: DisbursementTransferEvent
SecureDepositInitiatedEvent: SecureDepositInitiatedEvent
SecureDepositProcessingEvent: SecureDepositProcessingEvent
SecureDepositProcessedEvent: SecureDepositProcessedEvent
SecureDepositFailedEvent: SecureDepositFailedEvent
SecureDepositReturnedEvent: SecureDepositReturnedEvent
SecureDepositCanceledEvent: SecureDepositCanceledEvent
RepaymentProcessingEvent: RepaymentProcessingEvent
RepaymentProcessedEvent: RepaymentProcessedEvent
RepaymentFailedEvent: RepaymentFailedEvent
RepaymentReturnedEvent: RepaymentReturnedEvent
FundsWithdrawalInitiatedEvent: FundsWithdrawalInitiatedEvent
FundsWithdrawalProcessingEvent: FundsWithdrawalProcessingEvent
FundsWithdrawalProcessedEvent: FundsWithdrawalProcessedEvent
FundsWithdrawalFailedEvent: FundsWithdrawalFailedEvent
FundsWithdrawalReturnedEvent: FundsWithdrawalReturnedEvent
FundsWithdrawalCanceledEvent: FundsWithdrawalCanceledEvent
FundsDepositInitiatedEvent: FundsDepositInitiatedEvent
FundsDepositProcessingEvent: FundsDepositProcessingEvent
FundsDepositProcessedEvent: FundsDepositProcessedEvent
FundsDepositFailedEvent: FundsDepositFailedEvent
FundsDepositReturnedEvent: FundsDepositReturnedEvent
FundsDepositCanceledEvent: FundsDepositCanceledEvent
AchExternallyInitatedDepositReceivedEvent: AchExternallyInitatedDepositReceivedEvent
AchExternallyInitatedDepositProcessedEvent: AchExternallyInitatedDepositProcessedEvent
AchExternallyInitatedDepositFailedEvent: AchExternallyInitatedDepositFailedEvent
AchExternallyInitiatedWithdrawalReceivedEvent: AchExternallyInitiatedWithdrawalReceivedEvent
AchExternallyInitiatedWithdrawalProcessedEvent: AchExternallyInitiatedWithdrawalProcessedEvent
AchExternallyInitiatedWithdrawalFailedEvent: AchExternallyInitiatedWithdrawalFailedEvent
PayrollTransfer: PayrollTransfer
CreditFunds: CreditFunds
DebitFunds: DebitFunds
SecureDepositACHTransfer: SecureDepositACHTransfer
SecureDeposit: SecureDeposit
IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer
IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer
SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer
ExternallyInitiatedWireTransfer: ExternallyInitiatedWireTransfer
OneTimeACHTransfer: OneTimeACHTransfer
RecurringACHTransfer: RecurringACHTransfer
ScheduledTransferAchEvent: ScheduledTransferAchEvent
CreditFundsACHTransferEvent: CreditFundsACHTransferEvent
DebitFundsACHTransferEvent: DebitFundsACHTransferEvent
PayrollACHTransferEvent: PayrollACHTransferEvent
SecureDepositACHTransferEvent: SecureDepositACHTransferEvent
SecureDepositTransferEvent: SecureDepositTransferEvent
SecureCardBalanceRepaymentACHTransferEvent: SecureCardBalanceRepaymentACHTransferEvent
IntegratorInitiatedFundsWithdrawalACHTransferEvent: IntegratorInitiatedFundsWithdrawalACHTransferEvent
IntegratorInitiatedFundsDepositACHTransferEvent: IntegratorInitiatedFundsDepositACHTransferEvent
AchHoldAddedEvent: AchHoldAddedEvent
AchHoldRemovedEvent: AchHoldRemovedEvent
OriginatedAchTransfer: OriginatedAchTransfer
NonOriginatedAchTransfer: NonOriginatedAchTransfer
OriginatedAchTransferInitiatedEvent: OriginatedAchTransferInitiatedEvent
OriginatedAchTransferPendingEvent: OriginatedAchTransferPendingEvent
OriginatedAchTransferProcessingEvent: OriginatedAchTransferProcessingEvent
OriginatedAchTransferProcessedEvent: OriginatedAchTransferProcessedEvent
OriginatedAchTransferCanceledEvent: OriginatedAchTransferCanceledEvent
OriginatedAchTransferFailedEvent: OriginatedAchTransferFailedEvent
OriginatedAchTransferReturnedEvent: OriginatedAchTransferReturnedEvent
NonOriginatedAchTransferReceivedEvent: NonOriginatedAchTransferReceivedEvent
NonOriginatedAchTransferProcessedEvent: NonOriginatedAchTransferProcessedEvent
NonOriginatedAchTransferFailedEvent: NonOriginatedAchTransferFailedEvent
NonOriginatedAchTransferReturnedEvent: NonOriginatedAchTransferReturnedEvent
AchTransferHoldAddedEvent: AchTransferHoldAddedEvent
AchTransferHoldRemovedEvent: AchTransferHoldRemovedEvent
ReviewWorkflowEvent: ReviewWorkflowEvent
WireTransferReview: WireTransferReview
NonOriginatedAchTransferSnapshot: NonOriginatedAchTransferSnapshot
OriginatedAchTransferSnapshot: OriginatedAchTransferSnapshot
DocumentUploadLink: DocumentUploadLink
IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession
USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession
ManualDocumentRequestUploadSession: ManualDocumentRequestUploadSession
DocumentUploadRequestEvent: DocumentUploadRequestEvent
RewardPointsTransfer: RewardPointsTransfer
RewardDefaultEarnRule: RewardDefaultEarnRule
RewardMerchantCategoryEarnRule: RewardMerchantCategoryEarnRule
RewardRedemptionConfiguration: RewardRedemptionConfiguration
SecuredDepositCommercialCreditCardFinancialAccountStatement: SecuredDepositCommercialCreditCardFinancialAccountStatement
CreditPayInFullCardFinancialAccountStatement: CreditPayInFullCardFinancialAccountStatement
ConsumerChargeCardFinancialAccountStatement: ConsumerChargeCardFinancialAccountStatement
ConsumerPrepaidCardFinancialAccountStatement: ConsumerPrepaidCardFinancialAccountStatement
ConsumerRevolvingCardFinancialAccountStatement: ConsumerRevolvingCardFinancialAccountStatement
CommercialChargeCardFinancialAccountStatement: CommercialChargeCardFinancialAccountStatement
CommercialRevolvingCardFinancialAccountStatement: CommercialRevolvingCardFinancialAccountStatement
FinancialAccountStatementReadyEvent: FinancialAccountStatementReadyEvent
CardDigitalWalletTokenActivatedEvent: CardDigitalWalletTokenActivatedEvent
CardDigitalWalletTokenSuspendedEvent: CardDigitalWalletTokenSuspendedEvent
CardDigitalWalletTokenTerminatedEvent: CardDigitalWalletTokenTerminatedEvent
MerchantCategorySpendRule: MerchantCategorySpendRule
CVVSpendRule: CVVSpendRule
StreetAddressSpendRule: StreetAddressSpendRule
MerchantIdentifierSpendRule: MerchantIdentifierSpendRule
MerchantCountrySpendRule: MerchantCountrySpendRule
AmountLimitSpendRule: AmountLimitSpendRule
CountLimitSpendRule: CountLimitSpendRule
PointOfServiceCategorySpendRule: PointOfServiceCategorySpendRule
PostalCodeVerificationSpendRule: PostalCodeVerificationSpendRule
DepositAmountLimitSpendRule: DepositAmountLimitSpendRule
DepositProcessingNetworkSpendRule: DepositProcessingNetworkSpendRule
DepositCountLimitSpendRule: DepositCountLimitSpendRule
ConditionalRuleSetSpendRule: ConditionalRuleSetSpendRule
CardTransactionProcessingTypeConditionSpendRule: CardTransactionProcessingTypeConditionSpendRule
RestrictedAccountHolderSpendRule: RestrictedAccountHolderSpendRule
RestrictedCardHolderSpendRule: RestrictedCardHolderSpendRule
PanEntryModeSpendRule: PanEntryModeSpendRule
CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule
MinimumAmountLimitSpendRule: MinimumAmountLimitSpendRule
MaximumPercentVarianceOnPseudoBalanceSpendRule: MaximumPercentVarianceOnPseudoBalanceSpendRule
MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule
DaysWithinCardCreateDateSpendRule: DaysWithinCardCreateDateSpendRule
DaysWithinAccountCreateDateSpendRule: DaysWithinAccountCreateDateSpendRule
VisaRiskScoreSpendRule: VisaRiskScoreSpendRule
MastercardFraudScoreSpendRule: MastercardFraudScoreSpendRule
AccountTransactionCountSpendRule: AccountTransactionCountSpendRule
CreditLimitPercentageSpendRule: CreditLimitPercentageSpendRule
AccountSpendRule: AccountSpendRule
VelocityRule: VelocityRule
ScriptRealtimeRiskRule: ScriptRealtimeRiskRule
AmountLimitCheckRule: AmountLimitCheckRule
CountLimitCheckRule: CountLimitCheckRule
RuleCollection: RuleCollection
RuleCollectionRevision: RuleCollectionRevision
CreditPlan: CreditPlan
CreditPlanTemplate: CreditPlanTemplate
CreditCardTransferEvent: CreditCardTransferEvent
InstallmentAgreement: InstallmentAgreement
FeeTransferEvent: FeeTransferEvent
FeeSchedule: FeeSchedule
FeeChargeRule: FeeChargeRule
AmountLimitInterFinancialAccountTransferRule: AmountLimitInterFinancialAccountTransferRule
CountLimitInterFinancialAccountTransferRule: CountLimitInterFinancialAccountTransferRule
VelocityInterFinancialAccountTransferRule: VelocityInterFinancialAccountTransferRule
TransferPurposeInterFinancialAccountTransferRule: TransferPurposeInterFinancialAccountTransferRule
WatchlistInterFinancialAccountTransferRule: WatchlistInterFinancialAccountTransferRule
Report: Report
CardProfileDocumentUploadSession: CardProfileDocumentUploadSession
PhysicalCardProfile: PhysicalCardProfile
VirtualCardProfile: VirtualCardProfile
DigitalCardProfile: DigitalCardProfile
CardArtDocument: CardArtDocument
CardProfileSet: CardProfileSet
CardProfileSetRestricted: CardProfileSetRestricted
PaymentDebitTransaction: PaymentDebitTransaction
PaymentCreditTransaction: PaymentCreditTransaction
PricingPlan: PricingPlan
PricingConfiguration: PricingConfiguration
PricingRule: PricingRule
PaymentMethodToken: PaymentMethodToken
ValidatedAddress: ValidatedAddress
AccountHolderProvisioning: AccountHolderProvisioning
AccountHolderProvisioningWorkflowAction: AccountHolderProvisioningWorkflowAction
PaymentOrder: PaymentOrder
CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession
ExternalMoneyMovementTransaction: ExternalMoneyMovementTransaction
ExternalMoneyMovementTransactionEvent: ExternalMoneyMovementTransactionEvent
UnifiedFundsTransfer: UnifiedFundsTransfer
OriginatedRtpTransfer: OriginatedRtpTransfer
NonOriginatedRtpTransfer: NonOriginatedRtpTransfer
OriginatedRtpTransferEvent: OriginatedRtpTransferEvent
NonOriginatedRtpTransferEvent: NonOriginatedRtpTransferEvent
InstantNetworkTransfer: InstantNetworkTransfer
InstantNetworkTransferEvent: InstantNetworkTransferEvent
UserDefinedFieldDefinition: UserDefinedFieldDefinition
UserDefinedStringField: UserDefinedStringField
UserDefinedBooleanField: UserDefinedBooleanField
UserDefinedIntegerField: UserDefinedIntegerField
ProductProfile: ProductProfile
InstantSettlementTransaction: InstantSettlementTransaction
InstantSettlementTransactionEvent: InstantSettlementTransactionEvent
OnboardingApplicationStep
Output:INTERFACE
Fields
stepStatus: OnboardingApplicationStepStatus
The status of the individual step of the application
Possible Types
OnboardingBusinessType: OnboardingBusinessType
OnboardingApplicantContact: OnboardingApplicantContact
BusinessOwnershipInformation: BusinessOwnershipInformation
OnboardingBusinessProcessingAttributes: OnboardingBusinessProcessingAttributes
OnboardingBusinessDetails: OnboardingBusinessDetails
OnboardingBusinessHistory: OnboardingBusinessHistory
OnboardingControlProng: OnboardingControlProng
OnboardingESignature: OnboardingESignature
PaymentAdvance
Output:INTERFACE
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.
Possible Types
PayrollAdvance: PayrollAdvance
PaymentCardEvent
Output:INTERFACE
Fields
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.
last4: String
The last four digits of the primary account number (PAN).
network: PaymentCardNetwork
The card network that issued the Payment Card.
status: PaymentCardStatus
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.
Possible Types
PaymentCardIssuedEvent: PaymentCardIssuedEvent
PaymentCardActivatedEvent: PaymentCardActivatedEvent
PaymentCardSuspendedEvent: PaymentCardSuspendedEvent
PaymentCardUnsuspendedEvent: PaymentCardUnsuspendedEvent
PaymentCardClosedEvent: PaymentCardClosedEvent
PaymentCardTransactionEvent
Output:INTERFACE
Fields
approvedAmount: Amount
The Amount approved for this PaymentCardTransactionEvent 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 AuthorizationEvent 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 PaymentCardTransactionEvent.
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 PaymentCardTransactionEvent 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.
fees: [TransactionFee!]
Fees applied to the transaction, if any.
Possible Types
PaymentCardAuthorizationApprovedEvent: PaymentCardAuthorizationApprovedEvent
PaymentCardAuthorizationCreatedEvent: PaymentCardAuthorizationCreatedEvent
PaymentCardAuthorizationDeclinedEvent: PaymentCardAuthorizationDeclinedEvent
PaymentCardAuthorizationReversedEvent: PaymentCardAuthorizationReversedEvent
PaymentCardClearedEvent: PaymentCardClearedEvent
PaymentCardEnhancedDataEvent: PaymentCardEnhancedDataEvent
PaymentCardAuthorizationAndClearApprovedEvent: PaymentCardAuthorizationAndClearApprovedEvent
PaymentCardAuthorizationAndClearDeclinedEvent: PaymentCardAuthorizationAndClearDeclinedEvent
PaymentCardVerificationApprovedEvent: PaymentCardVerificationApprovedEvent
PaymentCardVerificationDeclinedEvent: PaymentCardVerificationDeclinedEvent
PaymentCardAdjustmentEvent: PaymentCardAdjustmentEvent
PaymentOrderItem
Output:INTERFACE
Fields
name: String
The product name for this PaymentOrderItem.
description: String
The product description for this PaymentOrderItem.
amountPerItem: Amount
The amount for this PaymentOrderItem per individual item.
paymentInstructions: [PaymentInstruction!]
Breakdown of the payment instructions for the PaymentOrderItem by Amount.
externalIdentifier: String
An optional external reference ID for this PaymentOrderItem.
Possible Types
PaymentOrderItemFromCustomItem: PaymentOrderItemFromCustomItem
PaymentOrderItemFromCatalogItem: PaymentOrderItemFromCatalogItem
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.
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
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.
events: [PaymentTransactionEvent!]
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.
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.
Possible Types
PaymentDebitTransaction: PaymentDebitTransaction
PaymentCreditTransaction: PaymentCreditTransaction
PaymentTransactionEvent
Represents a synchronous payment event for an acquiring PaymentTransaction.
Output:INTERFACE
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.
Possible Types
CardPaymentAuthorizingEvent: CardPaymentAuthorizingEvent
CardPaymentAuthorizedEvent: CardPaymentAuthorizedEvent
CardPaymentIncrementalAuthorizedEvent: CardPaymentIncrementalAuthorizedEvent
CardPaymentReversedEvent: CardPaymentReversedEvent
CardPaymentPartialReversedEvent: CardPaymentPartialReversedEvent
CardPaymentCapturingEvent: CardPaymentCapturingEvent
CardPaymentCapturedEvent: CardPaymentCapturedEvent
CardPaymentCaptureProcessingEvent: CardPaymentCaptureProcessingEvent
CardPaymentSettledEvent: CardPaymentSettledEvent
CardPaymentClearedEvent: CardPaymentClearedEvent
CardPaymentClearingFailedEvent: CardPaymentClearingFailedEvent
CardPaymentDisbursedEvent: CardPaymentDisbursedEvent
CardPaymentAuthorizationDeclinedEvent: CardPaymentAuthorizationDeclinedEvent
CardPaymentIncrementalAuthorizationDeclinedEvent: CardPaymentIncrementalAuthorizationDeclinedEvent
CardPaymentReversalDeclinedEvent: CardPaymentReversalDeclinedEvent
CardPaymentCaptureDeclinedEvent: CardPaymentCaptureDeclinedEvent
CardPaymentPayoutEvent: CardPaymentPayoutEvent
PayoutTransferCompletedEvent: PayoutTransferCompletedEvent
CardPaymentVerificationPendingEvent: CardPaymentVerificationPendingEvent
CardPaymentVerifiedEvent: CardPaymentVerifiedEvent
CardPaymentVerificationDeclinedEvent: CardPaymentVerificationDeclinedEvent
CardPaymentFirstChargebackEvent: CardPaymentFirstChargebackEvent
CardPaymentRepresentmentEvent: CardPaymentRepresentmentEvent
CardPaymentPreArbitrationEvent: CardPaymentPreArbitrationEvent
CardPaymentArbitrationEvent: CardPaymentArbitrationEvent
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.
Possible Types
InterchangeFeePaymentTransactionFee: InterchangeFeePaymentTransactionFee
NetworkFeePaymentTransactionFee: NetworkFeePaymentTransactionFee
MerchantFeePaymentTransactionFee: MerchantFeePaymentTransactionFee
UndeterminedFeePaymentTransactionFee: UndeterminedFeePaymentTransactionFee
PaymentTransactionLifecycleStep
A payment transaction event. This is a record of a payment transaction moving money.
Output:INTERFACE
Fields
amount: Amount
The amount for this PaymentTransaction.
status: PaymentTransactionLifecycleStepStatus
The current status for this step.
createdAt: String
The date and time, in ISO 8601 format, this object was created.
events: [PaymentTransactionEvent!]
Events associated with this step.
transaction: PaymentTransaction
The PaymentTransaction associated with this step.
Possible Types
CardAuthorizedStep: CardAuthorizedStep
CardAuthorizationStep: CardAuthorizationStep
CardIncrementalAuthorizedStep: CardIncrementalAuthorizedStep
CardIncrementalAuthorizationStep: CardIncrementalAuthorizationStep
CardReversedStep: CardReversedStep
CardReversalStep: CardReversalStep
CardAuthorizationAndCaptureStep: CardAuthorizationAndCaptureStep
CardCreditedStep: CardCreditedStep
CardCreditStep: CardCreditStep
CardCapturedStep: CardCapturedStep
CardCaptureStep: CardCaptureStep
CardVerificationStep: CardVerificationStep
DisputeStep: DisputeStep
PaymentTransactionLifecycleStepSummary
A payment transaction lifecycle step summary. This is a summary record of a payment transaction moving money returned from a mutation.
Output:INTERFACE
Fields
amount: Amount
The amount for this PaymentTransaction.
createdAt: String
The date and time, in ISO 8601 format, this object was created.
transaction: PaymentTransactionSummary
The PaymentTransaction associated with this step.
Possible Types
CardAuthorizationStepSummary: CardAuthorizationStepSummary
CardCaptureStepSummary: CardCaptureStepSummary
CardCapturePaymentOrderSummary: CardCapturePaymentOrderSummary
CardReversalStepSummary: CardReversalStepSummary
CardCreditStepSummary: CardCreditStepSummary
PaymentTransactionSummary
Output:INTERFACE
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.
instrument: PaymentInstrument
The payment instrument used for the PaymentTransaction. Instrument data can be used to display information to the user without violating PCI compliance.
Possible Types
PaymentDebitTransactionSummary: PaymentDebitTransactionSummary
PaymentCreditTransactionSummary: PaymentCreditTransactionSummary
PayrollAdvanceEvent
Output:INTERFACE
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 PayrollAdvanceEvent
Possible Types
PayrollAdvanceRepaymentCompletedEvent: PayrollAdvanceRepaymentCompletedEvent
PayrollAdvanceWriteOffCompletedEvent: PayrollAdvanceWriteOffCompletedEvent
PersonAccountHolder
The base fields for all PersonAccountHolders (regardless of region or snapshot)
Output:INTERFACE
Fields
Possible Types
USPersonAccountHolder: USPersonAccountHolder
USPersonAccountHolderSnapshot: USPersonAccountHolderSnapshot
PersonAuthorizedUser
The base fields for all PersonAuthorizedUser (regardless of region or snapshot)
Output:INTERFACE
Fields
Possible Types
USPersonAuthorizedUser: USPersonAuthorizedUser
USPersonAuthorizedUserSnapshot: USPersonAuthorizedUserSnapshot
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.
Possible Types
CollaborativeAuthorizationCardProductFeature: CollaborativeAuthorizationCardProductFeature
CollaborativeApplicationUnderwritingCardProductFeature: CollaborativeApplicationUnderwritingCardProductFeature
DisputeChargebackCardProductFeature: DisputeChargebackCardProductFeature
OnDemandFundingCardProductFeature: OnDemandFundingCardProductFeature
PartialFundingCardProductFeature: PartialFundingCardProductFeature
EarlyDirectDepositCardProductFeature: EarlyDirectDepositCardProductFeature
AuthorizedUserCardProductFeature: AuthorizedUserCardProductFeature
RevolvingCardProductFeature: RevolvingCardProductFeature
ChargeCardProductFeature: ChargeCardProductFeature
PointRewardCardProductFeature: PointRewardCardProductFeature
SecuredDepositCardProductFeature: SecuredDepositCardProductFeature
DirectMerchantAcquiringCardProductFeature: DirectMerchantAcquiringCardProductFeature
ExternalBusinessManagementCardProductFeature: ExternalBusinessManagementCardProductFeature
CardProcessingProductFeature: CardProcessingProductFeature
MoneyMovementProductFeature: MoneyMovementProductFeature
RealtimeRiskRule
The interface for a realtime risk rule. These rules execute in realtime during the authorization of a card transaction.
Output:INTERFACE
Interfaces
Fields
id: ID!
Global ID used to reference the Realtime Risk Rule in operations.
name: String
The name assigned to the rule.
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.
createdBy: UserPayload
The User who created the entity.
updatedBy: UserPayload
The User who last updated the entity.
Possible Types
ScriptRealtimeRiskRule: ScriptRealtimeRiskRule
RewardEarnRule
Rule that holds configuration for how transactions should earn reward points.
Output:INTERFACE
Interfaces
Fields
id: ID!
Global ID used to reference the reward earn rule.
name: String
Name of RewardEarnRule
attachments: RewardRuleAttachmentConnection
Objects that a rule is attached to.
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.
Possible Types
RewardDefaultEarnRule: RewardDefaultEarnRule
RewardMerchantCategoryEarnRule: RewardMerchantCategoryEarnRule
RewardRedemptionConfigurationAttachment
Attachment object that a RewardRedemptionConfiguration is attached to.
Output:INTERFACE
Fields
id: ID!
Global ID used to reference the RewardRedemptionConfigurationAttachment.
redemptionConfiguration: RewardRedemptionConfiguration
RewardRedemptionConfiguration that is attached.
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.
Possible Types
RewardRedemptionConfigurationProductAttachment: RewardRedemptionConfigurationProductAttachment
Fields
id: ID!
Global ID used to reference the RewardRuleAttachment.
rewardEarnRule: RewardEarnRule
RewardEarnRule that is attached.
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.
Possible Types
RewardRuleProductAttachment: RewardRuleProductAttachment
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.
status: RtpTransferStatus
The current status of the RtpTransfer.
failureReason: RtpTransferFailureReason
When the RtpTransfer 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.
bankTransferDetails: RtpTransferBankTransferDetails
Additional details for the bank transfer including payment related information.
Possible Types
OriginatedRtpTransfer: OriginatedRtpTransfer
NonOriginatedRtpTransfer: NonOriginatedRtpTransfer
ScheduledTransfer
Output:INTERFACE
Fields
id: ID!
Global ID used to reference the scheduled 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.
Possible Types
OneTimeACHTransfer: OneTimeACHTransfer
RecurringACHTransfer: RecurringACHTransfer
SpendRule
Output:INTERFACE
Interfaces
Fields
id: ID!
Global ID used to reference the Spend Rule in operations.
name: String
The name assigned to the rule.
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.
userType: ApplicableRuleUserType
The ApplicableRuleUserType for which the rule will be evaluated.
Possible Types
MerchantCategorySpendRule: MerchantCategorySpendRule
CVVSpendRule: CVVSpendRule
StreetAddressSpendRule: StreetAddressSpendRule
MerchantIdentifierSpendRule: MerchantIdentifierSpendRule
MerchantCountrySpendRule: MerchantCountrySpendRule
AmountLimitSpendRule: AmountLimitSpendRule
CountLimitSpendRule: CountLimitSpendRule
PointOfServiceCategorySpendRule: PointOfServiceCategorySpendRule
PostalCodeVerificationSpendRule: PostalCodeVerificationSpendRule
DepositAmountLimitSpendRule: DepositAmountLimitSpendRule
DepositProcessingNetworkSpendRule: DepositProcessingNetworkSpendRule
DepositCountLimitSpendRule: DepositCountLimitSpendRule
ConditionalRuleSetSpendRule: ConditionalRuleSetSpendRule
CardTransactionProcessingTypeConditionSpendRule: CardTransactionProcessingTypeConditionSpendRule
RestrictedAccountHolderSpendRule: RestrictedAccountHolderSpendRule
RestrictedCardHolderSpendRule: RestrictedCardHolderSpendRule
PanEntryModeSpendRule: PanEntryModeSpendRule
CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule
MinimumAmountLimitSpendRule: MinimumAmountLimitSpendRule
MaximumPercentVarianceOnPseudoBalanceSpendRule: MaximumPercentVarianceOnPseudoBalanceSpendRule
MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule
DaysWithinCardCreateDateSpendRule: DaysWithinCardCreateDateSpendRule
DaysWithinAccountCreateDateSpendRule: DaysWithinAccountCreateDateSpendRule
VisaRiskScoreSpendRule: VisaRiskScoreSpendRule
MastercardFraudScoreSpendRule: MastercardFraudScoreSpendRule
AccountTransactionCountSpendRule: AccountTransactionCountSpendRule
CreditLimitPercentageSpendRule: CreditLimitPercentageSpendRule
AccountSpendRule: AccountSpendRule
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.
attachedLevel: AttachedLevel
The attached level. (Platform, Product, Card)
Possible Types
MerchantCategorySpendRuleResult: MerchantCategorySpendRuleResult
MerchantCountrySpendRuleResult: MerchantCountrySpendRuleResult
MerchantIdentifierSpendRuleResult: MerchantIdentifierSpendRuleResult
CVVSpendRuleResult: CVVSpendRuleResult
StreetAddressSpendRuleResult: StreetAddressSpendRuleResult
AmountLimitSpendRuleResult: AmountLimitSpendRuleResult
PointOfServiceCategorySpendRuleResult: PointOfServiceCategorySpendRuleResult
DepositAmountLimitSpendRuleResult: DepositAmountLimitSpendRuleResult
DepositProcessingNetworkSpendRuleResult: DepositProcessingNetworkSpendRuleResult
PostalCodeVerificationSpendRuleResult: PostalCodeVerificationSpendRuleResult
CardTransactionProcessingTypeConditionSpendRuleResult: CardTransactionProcessingTypeConditionSpendRuleResult
RestrictedAccountHolderSpendRuleResult: RestrictedAccountHolderSpendRuleResult
RestrictedCardHolderSpendRuleResult: RestrictedCardHolderSpendRuleResult
PanEntryModeSpendRuleResult: PanEntryModeSpendRuleResult
CardDataInputCapabilitySpendRuleResult: CardDataInputCapabilitySpendRuleResult
MinimumAmountLimitSpendRuleResult: MinimumAmountLimitSpendRuleResult
MaximumPercentVarianceOnPseudoBalanceSpendRuleResult: MaximumPercentVarianceOnPseudoBalanceSpendRuleResult
MaximumAmountVarianceOnPseudoBalanceSpendRuleResult: MaximumAmountVarianceOnPseudoBalanceSpendRuleResult
DaysWithinCardCreateDateSpendRuleResult: DaysWithinCardCreateDateSpendRuleResult
DaysWithinAccountCreateDateSpendRuleResult: DaysWithinAccountCreateDateSpendRuleResult
VisaRiskScoreSpendRuleResult: VisaRiskScoreSpendRuleResult
MastercardFraudScoreSpendRuleResult: MastercardFraudScoreSpendRuleResult
AccountTransactionCountSpendRuleResult: AccountTransactionCountSpendRuleResult
CreditLimitPercentageSpendRuleResult: CreditLimitPercentageSpendRuleResult
AccountSpendRuleResult: AccountSpendRuleResult
VelocityRuleResult: VelocityRuleResult
TransactionEvent
Output:INTERFACE
Interfaces
Fields
id: ID!
Globally unique id of the `TransactionEvent.
transaction: Transaction
The associated Transaction.
approvedAmount: Amount
The Amount approved for this TransactionEvent 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
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
paymentCard: PaymentCard
The PaymentCard associated to the TransactionEvent.
cardProduct: CardProduct
The CardProduct associated to the TransactionEvent.
createdAt: String
The date and time, in ISO 8601 format, this ReversalEvent was created.
responseCode: TransactionEventResponseCode
The Highnote response code.
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.
Possible Types
ReversalEvent: ReversalEvent
ClearingEvent: ClearingEvent
EnhancedDataEvent: EnhancedDataEvent
AuthorizationEvent: AuthorizationEvent
IssuerPreliminaryAuthorizationEvent: IssuerPreliminaryAuthorizationEvent
AuthorizationAndClearEvent: AuthorizationAndClearEvent
VerificationEvent: VerificationEvent
BalanceInquiryEvent: BalanceInquiryEvent
AdjustmentEvent: AdjustmentEvent
Fields
id: ID!
Global ID used to reference the secure upload link
status: DocumentUploadLinkStatusCode
The status of the upload
uploadUrl: String
A url to be used to upload the contents of the document.
createdAt: String
The date and time, in ISO 8601 format, this upload link was created.
updatedAt: String
The date and time, in ISO 8601 format, this upload link was last updated.
Possible Types
DocumentUploadLink: DocumentUploadLink
CardArtDocument: CardArtDocument
UserDefinedField
A custom field instance with a value, associated with a specific Node.
Output:INTERFACE
Interfaces
Fields
id: ID!
Unique identifier for this field instance.
version: Int
Version number of the UserDefinedField.
definition: UserDefinedFieldDefinition
The field definition that this instance is based on.
node: UserDefinedFieldNode
The Node entity that this field is attached to.
createdBy: User
The User profile for the user who created the UserDefinedField
updatedBy: User
The User profile for the user who updated the UserDefinedField
revisions: UserDefinedFieldRevisionPayload
Historical revisions of this field, ordered by creation time (newest first).
Possible Types
UserDefinedStringField: UserDefinedStringField
UserDefinedBooleanField: UserDefinedBooleanField
UserDefinedIntegerField: UserDefinedIntegerField
UserDefinedFieldRevision
A historical snapshot of a UserDefinedField at a specific point in time.
Output:INTERFACE
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).
definition: UserDefinedFieldDefinition
The field definition snapshot at the time of this revision.
node: UserDefinedFieldNode
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.
Possible Types
UserDefinedStringFieldRevision: UserDefinedStringFieldRevision
UserDefinedBooleanFieldRevision: UserDefinedBooleanFieldRevision
UserDefinedIntegerFieldRevision: UserDefinedIntegerFieldRevision
ValidAddress
Output:INTERFACE
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.
Possible Types
ValidatedAddressToken: ValidatedAddressToken
ValidatedAddress: ValidatedAddress