API Changelog
Keep track of updates and changes to the Highnote API.
2025-05-28
ExternalPhysicalPaymentCardOrder
paymentCard was added to object type ExternalPhysicalPaymentCardOrderExternalPhysicalPaymentCardOrder.card is deprecatedDeprecated
ExternalPhysicalPaymentCardOrder.card has deprecation reason `card` is no longer supportedCOMPLETED was added to enum PaymentCardOrderStatussocialSecurityNumber of type HashedFilterInput was added to input object type PersonAccountHolderFilterInput2025-05-27
expiresAt was added to object type ValidatedAddressToken2025-05-22
UnifiedFundsTransferStepTransfer was addedUnifiedFundsTransferStepType was addedUnifiedFundsTransferStep was addedUnifiedFundsTransferTransferStep was addedUnifiedFundsTransferTransfer was removedUnifiedFundsTransferEvent was removedmemo was added to object type ReversedFeeTransferUnifiedFundsTransfer
steps was added to object type UnifiedFundsTransferevents was removed from object type UnifiedFundsTransfertransfer was removed from object type UnifiedFundsTransferQUOTE_ACCEPTED was removed from enum UnifiedFundsTransferStatusInstantNetworkTransferEventType
QUOTE_CREATED was removed from enum InstantNetworkTransferEventTypeQUOTE_ACCEPTED was removed from enum InstantNetworkTransferEventType2025-05-21
CreateReusablePaymentMethodTokenPayload was addedCreateReusablePaymentMethodTokenInput was addedCustomerPayload was addedPaymentMethodType was addedPaymentMethodTypeInput was addedFilteredPaymentMethodInput was addedCustomerReferencePayload was addedPaymentMethodConnectionPayload was addedPaymentMethodVariant was addedPaymentMethodEdge was addedPaymentMethodConnection was addedCustomer was addedScopedPaymentMethodTokenPayload was addedScopedPaymentMethodToken was addedTokenScope was addedcustomer was added to object type QuerycreateReusablePaymentMethodToken was added to object type Mutationtoken was added to object type PaymentMethodToken2025-05-19
expiresAt was added to object type PaymentMethodToken2025-05-16
CardProductApplicationConnection was addedCardProductApplicationEdge was addedUSPersonAccountHolder
applications was added to object type USPersonAccountHolderUSPersonAccountHolder.cardProductApplications is deprecatedDeprecated
USPersonAccountHolder.cardProductApplications has deprecation reason Use applications instead.FinancialAccount
cardProductApplication was added to object type FinancialAccountFinancialAccount.application is deprecatedDeprecated
FinancialAccount.application has deprecation reason Use cardProductApplication instead.FinancialAccountSnapshot
cardProductApplication was added to object type FinancialAccountSnapshotFinancialAccountSnapshot.application is deprecatedDeprecated
FinancialAccountSnapshot.application has deprecation reason Use cardProductApplication instead.2025-05-15
TRANSFER_AMOUNT_IS_NEGATIVE was added to enum AchTransferStatusFailureReason2025-05-14
memo was added to object type UnifiedFundsTransferQUOTE_CREATED was removed from enum UnifiedFundsTransferStatus2025-05-13
UnifiedFundsTransferDetails was addedUnifiedFundsTransfer was addedUnifiedFundsTransferTransfer was addedUnifiedFundsTransferSource was addedUnifiedFundsTransferSourceNode was addedUnifiedFundsTransferDestination was addedUnifiedFundsTransferDestinationNode was addedUnifiedFundsTransferStatus was addedUnifiedFundsTransferEvent was addedInstantNetworkTransfer was addedInstantNetworkTransferDetails was addedInstantNetworkTransferSource was addedInstantNetworkTransferSourceNode was addedInstantNetworkTransferDestination was addedInstantNetworkTransferDestinationNode was addedInstantNetworkTransferStatus was addedInstantNetworkTransferEventType was addedInstantNetworkTransferEvent was addedInstantNetworkTransferFailureReason was added2025-05-09
authorizedUserFinancialAccounts was added to object type FinancialAccount2025-05-07
AchTransfer
holdStatus was added to interface AchTransferholdType was added to interface AchTransferlastHoldStatusChangedAt was added to interface AchTransferOriginatedAchTransfer
holdStatus was added to object type OriginatedAchTransferholdType was added to object type OriginatedAchTransferlastHoldStatusChangedAt was added to object type OriginatedAchTransferNonOriginatedAchTransfer
holdStatus was added to object type NonOriginatedAchTransferholdType was added to object type NonOriginatedAchTransferlastHoldStatusChangedAt was added to object type NonOriginatedAchTransfer2025-05-07
authorizedUserFinancialAccounts was added to object type USPersonAccountHolder2025-05-06
RECEIVABLE_PURCHASE_INTEREST was added to enum ManualAdjustmentActivityTypeInterFinancialAccountTransferActivityType
RECEIVABLE_PURCHASE_INTEREST was added to enum InterFinancialAccountTransferActivityTypeRECEIVABLE_PURCHASE_INTEREST_REVERSAL was added to enum InterFinancialAccountTransferActivityTypeISSUER_BALANCE_MIGRATION was added to enum InterFinancialAccountTransferActivityTypeISSUER_BALANCE_MIGRATION was added to enum TransferPurpose2025-05-01
CreateVisaRiskScoreSpendRulePayload was addedUpdateVisaRiskScoreSpendRulePayload was addedCreateMastercardFraudScoreSpendRulePayload was addedUpdateMastercardFraudScoreSpendRulePayload was addedCreateVisaRiskScoreSpendRuleInput was addedUpdateVisaRiskScoreSpendRuleInput was addedVisaRiskScoreSpendRule was addedVisaRiskScoreSpendRuleResult was addedCreateMastercardFraudScoreSpendRuleInput was addedUpdateMastercardFraudScoreSpendRuleInput was addedMastercardFraudScoreSpendRule was addedMastercardFraudScoreSpendRuleResult was addedSignedInt was removedSignedAmount was removedMutation
createVisaRiskScoreSpendRule was added to object type MutationupdateVisaRiskScoreSpendRule was added to object type MutationcreateMastercardFraudScoreSpendRule was added to object type MutationupdateMastercardFraudScoreSpendRule was added to object type MutationriskScore was added to object type VisaDatafraudScore was added to object type MastercardDatasignedBalance was removed from object type LedgersignedBalance was removed from object type FinancialAccountBalanceLedgerDetail2025-04-30
AuthorizedUserAccountFeature was addedCreateExternalPhysicalPaymentCardOrderInput was addedEmbeddedDeviceInformationInput was addedExternalPhysicalPaymentCardOrderPayload was addedcreateExternalPhysicalPaymentCardOrder was added to object type MutationaccountHolder was added to object type FinancialAccountexternalPhysicalPaymentCardOrders was added to object type PaymentCardAUTHORIZED_USER was added to enum FinancialAccountFeatureTypeExternalPhysicalPaymentCardOrder
status was added to object type ExternalPhysicalPaymentCardOrdercreatedAt was added to object type ExternalPhysicalPaymentCardOrderupdatedAt was added to object type ExternalPhysicalPaymentCardOrder2025-04-29
SignedInt was addedSignedAmount was addedSignedMoneyFilterInput was addedSignedMoneyFilterInputRange was addedFinancialAccountBalanceSearchResultConnection was addedFinancialAccountBalanceSearchResultPayload was addedFinancialAccountBalanceSearchResultEdge was addedFinancialAccountBalanceSearchField was addedFinancialAccountBalanceSearchResult was addedFinancialAccountBalanceLedgerDetail was addedFinancialAccountBalanceSearchFilterInput was addedFinancialAccountBalanceSearchFilter was addedsearchFinancialAccountBalances was added to object type OrganizationsignedBalance was added to object type Ledger2025-04-24
MERCHANT_PUSH_PAYMENT_FUNDING was added to enum AchTransferPurpose2025-04-23
CreateDaysWithinCardCreateDateSpendRulePayload was addedUpdateDaysWithinCardCreateDateSpendRulePayload was addedCreateDaysWithinAccountCreateDateSpendRulePayload was addedUpdateDaysWithinAccountCreateDateSpendRulePayload was addedCreateDaysWithinCardCreateDateSpendRuleInput was addedUpdateDaysWithinCardCreateDateSpendRuleInput was addedCreateDaysWithinAccountCreateDateSpendRuleInput was addedUpdateDaysWithinAccountCreateDateSpendRuleInput was addedDaysWithinCardCreateDateSpendRule was addedDaysWithinCardCreateDateSpendRuleResult was addedDaysWithinAccountCreateDateSpendRule was addedDaysWithinAccountCreateDateSpendRuleResult was addedMutation
createDaysWithinCardCreateDateSpendRule was added to object type MutationupdateDaysWithinCardCreateDateSpendRule was added to object type MutationcreateDaysWithinAccountCreateDateSpendRule was added to object type MutationupdateDaysWithinAccountCreateDateSpendRule was added to object type Mutation2025-04-18
CreditDecisionResult
DOB_MISMATCH was added to enum CreditDecisionResultNAME_MISMATCH was added to enum CreditDecisionResultSSN_MISMATCH was added to enum CreditDecisionResultADDRESS_MISMATCH was added to enum CreditDecisionResult2025-04-16
UpcomingBillingCycleConfiguration was addedEmbeddedDeviceInformation was addedExternalPhysicalPaymentCardOrder was addedFormFactorType was addedupcomingBillingCycleConfiguration was added to object type BillingCycleConfigurationformFactor was added to object type PhysicalCardProfileDIGISEQ was added to enum PhysicalCardVendorName2025-04-14
OnDemandFundingFinancialAccountFeature
sourceFinancialAccount was added to object type OnDemandFundingFinancialAccountFeatureOnDemandFundingFinancialAccountFeature.sourceFinancialAccountId is deprecatedDeprecated
OnDemandFundingFinancialAccountFeature.sourceFinancialAccountId has deprecation reason Use sourceFinancialAccount.id instead.2025-04-14
SimulateCheckPaymentEventChangePayload was addedSimulateCheckPaymentEventInput was addedSimulateCheckPaymentStatusChangePayload was removedSimulateCheckPaymentStatusInput was removedMutation
simulateCheckPaymentEvent was added to object type MutationsimulateCheckPaymentStatus was removed from object type MutationUSPersonAccountHolderSnapshot was added to Union type AuthorizedUserSnapshot2025-04-11
CLOSED was added to enum FinancialAccountDelinquencyState2025-04-07
SimulateCheckPaymentStatusChangePayload was addedSimulateCheckPaymentStatusInput was addedMutation
simulateCheckPaymentStatus was added to object type MutationMutation.issuePaymentCardForApplication is no longer deprecatedDeprecated
Mutation.issuePaymentCardForApplication2025-04-04
externalLinkHostedUrl was added to object type GenerateVerifiedExternalBankAccountExternalLinkTokenCREDIT_LOAN_TAPE was added to enum ReportTypeCREDIT_LOAN_TAPE was added to enum OrganizationReportType2025-04-03
WEB_HOSTED was added to enum VerifiedExternalBankAccountLinkExperienceFlow2025-04-02
CardProductVertical.SECURED_COMMERCIAL_CREDIT was deprecated with reason The SECURED_COMMERCIAL_CREDIT CardProductVertical is deprecated. Please use COMMERCIAL_CREDIT instead. Please reach out to Highnote support with any questions.Deprecated
CreditPlanType
PROMOTIONAL was added to enum CreditPlanTypeCreditPlanType.PROMO was deprecated with reason Please use PROMOTIONALDeprecated
2025-04-01
VelocityRuleWindow
COOLDOWN_MINUTE was added to enum VelocityRuleWindowCOOLDOWN_HOUR was added to enum VelocityRuleWindow2025-03-25
billingDescriptorSuggestions was added to object type OnboardingBusinessTypeRIYADH_AIR was added to enum MerchantCategoryVERITEX_BANK was added to enum PartnerBankName2025-03-24
NotificationEventName
CHECK_PAYMENT_EVENT_PRINTED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_PAID was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_PROCESSING_BY_HIGHNOTE was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_ON_RISK_HOLD was added to enum NotificationEventNameCheckPaymentEventType
PRINTED was added to enum CheckPaymentEventTypePAID was added to enum CheckPaymentEventTypePROCESSING_BY_HIGHNOTE was added to enum CheckPaymentEventType2025-03-20
VerifiedExternalBankAccountLinkExperience was addedVerifiedExternalBankAccountLinkExperienceFlow was addedlinkExperience of type VerifiedExternalBankAccountLinkExperience was added to input object type GenerateVerifiedExternalBankAccountLinkTokenInput2025-03-19
PaymentCardTransactionDisputesFilterInput
disputeHasChargeback of type BooleanFilterInput was added to input object type PaymentCardTransactionDisputesFilterInputchargebackId of type IDFilterInput was added to input object type PaymentCardTransactionDisputesFilterInputchargebackStatus of type PaymentCardChargebackStatusFilterInput was added to input object type PaymentCardTransactionDisputesFilterInputchargebackCreatedAt of type TimestampFilterInput was added to input object type PaymentCardTransactionDisputesFilterInputexternalNetworkId of type StringFilterInput was added to input object type PaymentCardTransactionDisputesFilterInput2025-03-17
RISK was added to enum CheckPaymentFailureReasonON_RISK_HOLD was added to enum CheckPaymentEventType2025-03-12
RuleCollectionRevision was added2025-03-11
USBusinessProfileInput.businessType changed type from BusinessStructure to BusinessStructure!2025-03-10
CheckCapableAccountFeature was added2025-03-07
FinancialAccountPurchaseCreditPlan was addedCreditDecisionResult
AGE_OF_OLDEST_TRADELINE was added to enum CreditDecisionResultCURRENT_DELINQUENT_CREDIT_OBLIGATIONS was added to enum CreditDecisionResultCURRENT_DELINQUENT_CREDIT_OBLIGATIONS_30 was added to enum CreditDecisionResultCURRENT_DELINQUENT_CREDIT_OBLIGATIONS_90 was added to enum CreditDecisionResultDECEASED was added to enum CreditDecisionResultFORECLOSURE was added to enum CreditDecisionResultHIGH_CREDIT_CARD_UTILIZATION was added to enum CreditDecisionResultHIGH_DEBT_TO_INCOME was added to enum CreditDecisionResultHIGH_REVOLVING_CREDIT_CARD_UTILIZATION was added to enum CreditDecisionResultNO_CREDIT_HISTORY was added to enum CreditDecisionResultNUMBER_OF_OPEN_ACCOUNTS was added to enum CreditDecisionResultPAST_CHARGE_OFFS was added to enum CreditDecisionResultPAST_DELINQUENT_CREDIT_OBLIGATIONS was added to enum CreditDecisionResultDECEASED was added to enum AdverseActionCodepurchasePlans was added to object type FinancialAccountCreditFinancialAccountConfiguration
CreditFinancialAccountConfiguration.interestRates is deprecatedDeprecated
CreditFinancialAccountConfiguration.interestRates has deprecation reason Please use `purchasePlans` on `FinancialAccount` instead.CardAuthorizationAndCaptureStep
CardAuthorizationAndCaptureStep.amount is deprecatedDeprecated
CardAuthorizationAndCaptureStep.amount has deprecation reason Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.CardAuthorizationAndCaptureStep.status is deprecatedDeprecated
CardAuthorizationAndCaptureStep.status has deprecation reason Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.CardAuthorizationAndCaptureStep.createdAt is deprecatedDeprecated
CardAuthorizationAndCaptureStep.createdAt has deprecation reason Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.CardAuthorizationAndCaptureStep.events is deprecatedDeprecated
CardAuthorizationAndCaptureStep.events has deprecation reason Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.CardAuthorizationAndCaptureStep.transaction is deprecatedDeprecated
CardAuthorizationAndCaptureStep.transaction has deprecation reason Highnote will return `CardAuthorizationStep` and `CardCaptureStep` instead of `CardAuthorizationAndCaptureStep`.2025-03-06
billingCyclePaymentDueNotificationsDays was added to object type CreditBillingCycleCardProductConfiguration2025-03-05
IssuePaymentCardForApplicationWithOnDemandFundingSourceInput was addedIssuePaymentCardForApplicationWithOnDemandFundingSourcePayload was addedissuePaymentCardForApplicationWithOnDemandFundingSource was added to object type Mutation2025-03-04
FinancialAccountStatementInstallmentCreditPlanActivity was addedInstallmentEligibilityForTransactionEventsInput was addedInstallmentEligibilityForTransactionEventsPayload was addedInstallmentEligibilityForTransactionEvents was addedInstallmentEligibilityForTransactionEvent was addedCreditInstallmentEligibilityStatusForTransactionEvent was addedinstallmentEligibilityForTransactionEvents was added to object type QueryperiodInstallmentActivity was added to object type ConsumerRevolvingCardFinancialAccountStatementperiodInstallmentActivity was added to object type CommercialRevolvingCardFinancialAccountStatement2025-03-03
AmountRange was addedUnsignedIntegerRange was addedInstallmentOffersForTransactionEventInput was addedInstallmentOffersForTransactionEventPayload was addedActivateInstallmentAgreementForTransactionEventInput was addedActivateInstallmentAgreementForTransactionEventPayload was addedAttachFeeToCreditPlanInput was addedAttachFeeToCreditPlanPayload was addedCreateCardProductInstallmentCreditPlanInput was addedCreditPlanFeeInput was addedCreateCardProductInstallmentCreditPlanPayload was addedCreditPlanInstallmentPolicy was addedCreditPlanTemplateInstallmentPolicy was addedInstallmentAgreementConnection was addedInstallmentAgreementEdge was addedInstallmentAgreementFilterInput was addedInstallmentOffersForTransactionEvent was addedinstallmentOffersForTransactionEvent was added to object type QueryMutation
createCardProductInstallmentCreditPlan was added to object type MutationactivateInstallmentAgreementForTransactionEvent was added to object type MutationattachFeeToCreditPlan was added to object type MutationCardProduct
CardProduct.cardProductApplications is deprecatedDeprecated
CardProduct.cardProductApplications has deprecation reason Use searchCardProductApplications instead.installmentAgreements was added to object type FinancialAccountCreditPlan
installmentPolicy was added to object type CreditPlanfeeSchedule was added to object type CreditPlaninstallmentPolicy was added to object type CreditPlanTemplateInterestDetails
index was added to object type InterestDetailsmargin was added to object type InterestDetailsInstallmentOfferDetails
principalDuePerPeriod was added to object type InstallmentOfferDetailstotalAmountDuePerPeriod was removed from object type InstallmentOfferDetails2025-02-28
FinancialAccountStatementPurchaseCreditPlan
index was added to object type FinancialAccountStatementPurchaseCreditPlanmargin was added to object type FinancialAccountStatementPurchaseCreditPlan2025-02-27
financialAccount was added to object type CheckPayment2025-02-26
PinResponseCode was addedpinResponseCode was added to object type AuthorizationEventpinResponseCode was added to object type IssuerPreliminaryAuthorizationEventpinResponseCode was added to interface PaymentCardTransactionEventpinResponseCode was added to object type PaymentCardAuthorizationApprovedEventpinResponseCode was added to object type PaymentCardAuthorizationCreatedEventpinResponseCode was added to object type PaymentCardAuthorizationDeclinedEventpinResponseCode was added to object type PaymentCardAuthorizationReversedEventpinResponseCode was added to object type PaymentCardClearedEventpinResponseCode was added to object type PaymentCardEnhancedDataEventpinResponseCode was added to object type PaymentCardAuthorizationAndClearApprovedEventpinResponseCode was added to object type PaymentCardAuthorizationAndClearDeclinedEventpinResponseCode was added to object type PaymentCardVerificationApprovedEventpinResponseCode was added to object type PaymentCardVerificationDeclinedEventpinResponseCode was added to object type AuthorizationAndClearEventpinResponseCode was added to object type VerificationEventpinResponseCode was added to object type BalanceInquiryEventpin of type String was added to input object type VerificationOverridesInput2025-02-24
UpcomingStatementDueDateEvent was addedstockTickerSymbol was added to object type OnboardingBusinessHistoryLedgerName
CHECK_PAYABLE was added to enum LedgerNameCHECK_SETTLEMENT_DEPOSIT was added to enum LedgerNameCHECK_PROCESSING was added to enum LedgerNameCheckPaymentEvent was added to Union type FinancialEventUpcomingStatementDueDateEvent was added to Union type NotificationEventNodeUPCOMING_STATEMENT_DUE_DATE was added to enum NotificationEventName2025-02-21
FinancialEventType was addedLedgerReportParametersInput was addedCheckRule was removedFieldUserError
FieldUserError.path is deprecatedDeprecated
FieldUserError.path has deprecation reason `path` does not provide index information for list input errors. Use `errorPath` instead.AmountLimitCheckRule object type no longer implements CheckRule interfaceCountLimitCheckRule object type no longer implements CheckRule interfacenode was removed from object type CheckRuleEdgeledgerReportParameters of type LedgerReportParametersInput was added to input object type ReportParametersInput2025-02-20
globalNotes was added to object type AccountHolderCardProductApplication2025-02-19
memo of type String was added to input object type ConfirmVerificationOfCreditProductApplicationForFraudAlertInputAccountHolderCardProductApplication was added to Union type GlobalNotePrimaryEntityACCOUNT_HOLDER_CARD_PRODUCT_APPLICATION was added to enum GlobalNotePrimaryEntityType2025-02-18
CheckPaymentEvent was added to Union type NotificationEventNodeNotificationEventName
CHECK_PAYMENT_EVENT_FUNDING_PENDING was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_FUNDING_STARTED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_FUNDING_COMPLETED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_FUNDING_DISBURSED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_PENDING_SHIPMENT was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_SHIPPED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_COMPLETED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_VOIDED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_FAILED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_REVERSAL_INITIATED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_REVERSAL_COMPLETED was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_PENDING_PROCESSING_BY_HIGHNOTE was added to enum NotificationEventNameCHECK_PAYMENT_EVENT_PROCESSED_BY_HIGHNOTE was added to enum NotificationEventNameCheckPaymentFailureReason
FINANCIAL_ACCOUNT_NOT_ENABLED_FOR_CHECK_PAYMENTS was added to enum CheckPaymentFailureReasonINTERNAL_ERROR was added to enum CheckPaymentFailureReason2025-02-13
RestrictedCardHolderSpendRule was addedRestrictedCardHolderSpendRuleResult was addedAPI Changelog displays the 50 most recent updates.