Mutation

Accept an extended AccountHolderCardProductApplicationOffer.

Output:AccountHolderCardProductApplicationOffersPayload

Activate a CreditPlan for a CardProduct.

Output:ActivateCardProductCreditPlanPayload

Activate a CollaborativeAuthorizationEndpoint.

Output:ActivateCollaborativeAuthorizationEndpointPayload

Activate an InstallmentAgreement for a Transaction by providing a TransactionEvent.

Output:ActivateInstallmentAgreementForTransactionEventPayload

Reactivates a previously deactivated notification target.

Output:ActivateNotificationTargetPayload

Activate a Payment Card.

Output:ActivatePaymentCardPayload

Add a CollaborativeAuthorizationEndpoint for use in real-time transaction authorization.

You are able to create up to 5 CollaborativeAuthorizationEndpoints, but only one may be active at a time.

By default, the created endpoint is not active. You must call the activateCollaborativeAuthorizationEndpoint mutation.

Output:AddCollaborativeAuthorizationEndpointPayload

Add a bank account for account holder using external token.

Use Mutation.addExternalBankAccountVerifiedThroughPlaid instead.

Output:AddExternalBankAccountFromTokenPayload

Add a bank account for account holder using external token. (Finicity specific)

Output:AddExternalBankAccountFromTokenPayload

Add a bank account for account holder using external token. (Plaid specific)

Output:AddExternalBankAccountFromTokenPayload

Add a bank account for account holder using external tokens. (Third Party with Plaid specific) This is only usable for specific products within the CONSUMER_CREDIT vertical.

Output:AddExternalBankAccountFromTokenPayload

Transfer funds from a funding account of the Organization to a payment card.

Transfer is deprecated in favor of initiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccount

Output:AddFundsToPaymentCardPayload

Add a non-verified US bank account for an account holder. Can only be used to initiateFundsWithdrawalACHTransfer

Output:AddNonVerifiedExternalUSFinancialBankAccountPayload

Request encrypted and activation data required to push provision a PaymentCard directly from your mobile application to an Apple Pay enabled device.

Output:AddPaymentCardDigitalWalletTokenApplePayDevicePushProvisioningPayload

Request encrypted and activation data required to push provision a PaymentCard directly from your mobile application to a Google Pay enabled device.

Output:AddPaymentCardDigitalWalletTokenGooglePayPushProvisioningPayload

Adds subscriptions to a notification target.

Output:AddSubscriptionsToNotificationTargetPayload

Adds a new https target for webhook notifications.

Output:AddWebhookNotificationTargetPayload

Once a decision has been reached to approve a credit limit decrease, use this mutation to update the CreditLimitChangeRequest and provide the adverse action reason (if applicable) and other details.

Output:CreditLimitChangeRequestPayload

Once a decision has been reached to approve a credit limit increase, use this decision to update the CreditLimitChangeRequest and provide the updated credit limit and other details.

Output:CreditLimitChangeRequestPayload

Approve a credit-based AccountHolderCardProductApplication.

Output:ApproveCreditProductApplicationUnderwritingPayload

Assigns a PaymentCard to a FinancialAccount.

This is used in addition to the issuePreprintedPaymentCardFinancialAccountForApplication mutation.

Output:AssignPaymentCardToFinancialAccountPayload

Attach a VelocityRule to a CardProduct

Output:AttachCardProductVelocityRulePayload

Attach a fee to a CreditPlan.

Output:AttachFeeToCreditPlanPayload

Attach a VelocityRule to a PaymentCard

Output:AttachPaymentCardVelocityRulePayload

Attach a reward earn rule to a product.

Output:AttachRewardEarnRuleToProductPayload

Attach Reward RewardRedemptionConfiguration to a CardProduct.

Output:AttachRewardRedemptionConfigurationToProductPayload

Attaches a spend rule to the given Card Product. The spend rule will be evaluated for every authorization on a payment card issued under the card product.

Output:AttachSpendRuleToCardProductPayload

Attaches a spend rule to the given FinancialAccount. The spend control rule will be evaluated for every authorization.

Output:AttachSpendRuleToFinancialAccountPayload

Attaches a spend control rule to the given Payment Card. The spend control rule will be evaluated for every authorization.

Output:AttachSpendRuleToPaymentCardPayload

Attach a VelocityRule to a FinancialAccount

Output:AttachVelocityRuleToFinancialAccountPayload

Authorizes a PaymentCard for later capture.

Output:AuthorizePaymentCardPayload

Authorizes a PaymentMethodToken for later capture.

Output:AuthorizePaymentMethodTokenPayload

Cancels remaining held authorized amount.

Output:CancelPaymentTransactionPayload

Cancels a group order, and all the fulfillments in it.

Output:PhysicalCardGroupOrderPayload

Cancel an order for a physical payment card. This can only be called while the order is in the NEW state.

Output:CancelPhysicalPaymentCardPayload

Cancels the RequestedIdentityUpdate. The individual or business has acknowledged the accuracy and correctness of the provided information.

Requested updates will not be applied.

Output:CancelRequestedIdentityUpdatePayload

Cancel a scheduled transfer between financial accounts.

Output:CancelScheduledTransferPayload

Captures a previously authorized payment.

Output:CapturePaymentTransactionPayload

One step authorization and capture of a payment card.

Output:ChargePaymentCardPayload

One step authorization and capture of a PaymentMethodToken.

Output:ChargePaymentMethodTokenPayload

One step authorization and capture of an Order.

Output:ChargePaymentOrderPayload

One step authorization and capture of an PaymentOrder.

Output:ChargePaymentOrderPayload

Close previously added external bank account.

Output:CloseExternalFinancialBankAccountPayload

Close a Payment Card and decline all future authorizations.

Output:ClosePaymentCardPayload

Completes a group order, marking it as ready to ship.

Output:PhysicalCardGroupOrderPayload

Confirm credit freeze is lifted for an AccountHolderCardProductApplication.

If a credit freeze was present during initial underwriting, confirm the freeze is no longer present and then use this mutation to restart underwriting.

Will return an error if the AccountHolderCardProductApplication is in a terminal state such as APPROVED, DENIED, or CLOSED.

Output:ConfirmCreditReportUnfrozenPayload

Confirm that the specified ACH deposit is a payroll deposit.

Output:ConfirmPayrollDepositPayload

Confirms the RequestedIdentityUpdate. The individual or business has acknowledged the accuracy and correctness of the supplied information.

Output:ConfirmRequestedIdentityUpdatePayload

Confirm a credit-based AccountHolderCardProductApplication is verified in response to a fraud alert on the applicant's credit report.

If an applicant's credit report contains a fraud alert, verify the applicant did intend to initiate this application, and that their name, date of birth, and address are correct on the application. Then, call this mutation.

Will return an error if the AccountHolderCardProductApplication is in a terminal state such as APPROVED, DENIED, or CLOSED.

Output:ConfirmVerificationOfCreditProductApplicationForFraudAlertPayload

Create a new card product application for an AccountHolder.

Output:CreateAccountHolderCardProductApplicationPayload

Creates a new spend rule that limits the amount of authorizations.

Output:CreateAmountLimitSpendRulePayload

Create a new card product application for an AuthorizedUser.

Output:CreateAuthorizedUserCardProductApplicationPayload

Creates a CardDataInputCapabilitySpendRule that allows or blocks a CardDataInputCapability.

Output:CreateCardDataInputCapabilitySpendRulePayload

Creates a new Card Product.

Output:CreateCardProductPayload

Create a CreditPlan for a CardProduct based on a CreditPlanTemplate. For plans with a CreditBalanceType of INSTALLMENT, please use createCardProductInstallmentCreditPlan.

Output:CreateCardProductCreditPlanPayload

Create a CreditPlan with a CreditBalanceType of INSTALLMENT for a CardProduct based on a CreditPlanTemplate.

Output:CreateCardProductInstallmentCreditPlanPayload

Creates a card product from a template.

Note: This feature is only available in the TEST environment.

Output:CreateCardProductWithTemplatePayload

Creates a CardTransactionProcessingTypeConditionSpendRule that allows or blocks a CardTransactionProcessingType.

Output:CreateCardTransactionProcessingTypeConditionSpendRulePayload

Create a CreditCardProductConfiguration for a charge CardProduct, specifying details about the number of days until an account ages into states like DELINQUENT, SUSPENDED, and CLOSING, what is included in the minimum payment, and how repayments are applied.

Output:CreateCreditCardProductConfigurationPayload

Creates a document upload session for check documents.

Output:CreateCheckPaymentDocumentUploadSessionPayload

Creates a ConditionalRuleSetSpendRule that combines the results of multiple spend rules.

Output:CreateConditionalRuleSetSpendRulePayload

Creates a new spend rule that limits the number of allowed transactions.

Output:CreateCountLimitSpendRulePayload

Create a CreditLimitChangeRequest, to track status and ultimately decision it.

Output:CreditLimitChangeRequestPayload

Creates a new spend rule that specifies if the result of a CVV check should be approved or declined.

Output:CreateCVVSpendRulePayload

Creates a DepositAmountLimitSpendRule that limits the amount of authorizations.

Output:CreateDepositAmountLimitSpendRulePayload

Creates a new DepositCountLimitSpendRule that limits the number of authorizations.

Output:CreateDepositCountLimitSpendRulePayload

Creates a new DepositProcessingNetworkSpendRule which allows or blocks an ATM processing network.

Output:CreateDepositProcessingNetworkSpendRulePayload

Create a link to upload a document to Highnote.

Output:CreateDocumentUploadLinkPayload

Creates a new GlobalNote for an entity.

Output:GlobalNotePayload

Creates a MaximumAmountVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified Amount above the account's original balance'.

Output:CreateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload

Creates a MaximumPercentVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified percentage over the account's original balance.

Output:CreateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload

Creates a new spend rule that specifies the merchant categories that are either allowed or blocked during authorizations.

Output:CreateMerchantCategorySpendRulePayload

Creates a new spend rule that specifies the merchant countries that are either allowed or blocked during authorizations.

Output:CreateMerchantCountrySpendRulePayload

Creates a new spend rule that specifies which merchant identifiers (MIDs) are either allowed or blocked.

Output:CreateMerchantIdentifierSpendRulePayload

Create a new USBusinessAccountHolder with minimal information.

Note: The following mutation may not be sufficient for your CardProduct.

Output:CreateMinimalUSBusinessAccountHolderPayload

Creates a MinimumAmountLimitSpendRule that only allows transactions for a specified amount.

Output:CreateMinimumAmountLimitSpendRulePayload

Create a one time ACH transfer between financial accounts.

Output:CreateOneTimeACHTransferPayload

Creates a PanEntryModeSpendRule that allows or blocks a PanEntryMode.

Output:CreatePanEntryModeSpendRulePayload

Creates a new PaymentOrder.

Output:CreatePaymentOrderPayload

Creates a new group order that can be used to ship multiple physical cards to the same location.

Output:PhysicalCardGroupOrderPayload

Creates a new group order that can be used to ship multiple physical cards to the same validated address.

Use `createPhysicalCardGroupOrderWithValidatedAddressToken` instead.

Output:PhysicalCardGroupOrderPayload

Creates a new group order that can be used to ship multiple physical cards to the same validated address.

Output:PhysicalCardGroupOrderPayload

Creates a new spend rule that specifies which Point of Service (POS) categories are either allowed or blocked.

Output:CreatePointOfServiceCategorySpendRulePayload

Creates a new spend rule that specifies which address verification postal codes are either allowed or blocked.

Output:CreatePostalCodeVerificationSpendRulePayload

Create a recurring ACH transfer between financial accounts.

Output:CreateRecurringACHTransferPayload

Create a CreditCardProductConfiguration for a revolving CardProduct, specifying details about the number of days until an account ages into states like DELINQUENT, SUSPENDED, and CLOSING, what is included in the minimum payment, and how repayments are applied.

Output:CreateCreditCardProductConfigurationPayload

Creates a new RewardDefaultEarnRule.

Output:CreateRewardDefaultEarnRulePayload

Creates a new RewardMerchantCategoryEarnRule.

Output:CreateRewardMerchantCategoryEarnRulePayload

Manually Deduct reward points from reward point balance.

Output:RewardPointsTransferPayload

Creates a new RewardRedemptionConfiguration.

Output:CreateRewardRedemptionConfigurationPayload

Creates a new Secret API Key.

Output:CreateSecretAPIKeyPayload

Creates a new spend rule that specifies if the result of a street address verification should be approved or declined.

Note Street address verifications only verify a street number. Use createPostalCodeVerificationSpendRule to change how postal codes are verified.

Output:CreateStreetAddressSpendRulePayload

Create a new USBusinessAccountHolder.

Output:CreateUSBusinessAccountHolderPayload

Create a new USBusinessAccountHolder from tokenized data.

Output:CreateUSBusinessAccountHolderFromTokenPayload

Create a new USPersonAccountHolder.

Output:CreateUSPersonAccountHolderPayload

Create a new USPersonAccountHolder from tokenized data.

Output:CreateUSPersonAccountHolderFromTokenPayload

Create a new USPersonAuthorizedUser.

Output:CreateUSPersonAuthorizedUserPayload

Create a new USPersonAuthorizedUser from tokenized data.

Output:CreateUSPersonAuthorizedUserFromTokenPayload

Create a VelocityRule

Output:CreateVelocityRulePayload

Deactivate a CollaborativeAuthorizationEndpoint.

Output:DeactivateCollaborativeAuthorizationEndpointPayload

Deactivates a notification target.

Output:DeactivateNotificationTargetPayload

Deletes all CustomFields for an object.

Output:CustomFieldsPayload

Deletes an existing spend rule.

Output:DeleteSpendRulePayload

Deletes an existing velocity rule.

Output:DeleteVelocityRulePayload

Once a decision has been reached to deny a credit limit decrease, use this mutation to update the CreditLimitChangeRequest and provide any customer information collected.

Output:CreditLimitChangeRequestPayload

Once a decision has been reached to deny a credit limit increase, use this mutation to update the CreditLimitChangeRequest and provide the adverse action reason (if applicable) and other details.

Output:CreditLimitChangeRequestPayload

Deny a credit-based AccountHolderCardProductApplication.

Output:DenyCreditProductApplicationUnderwritingPayload

Detach a VelocityRule from a CardProduct

Output:DetachCardProductVelocityRulePayload

Detach a VelocityRule from a PaymentCard

Output:DetachPaymentCardVelocityRulePayload

Detaches, or removes, a spend rule from the given Card Product. The spend rule will not be evaluated for future authorizations on a payment card issued under the card product.

Output:DetachSpendRuleFromCardProductPayload

Detaches, or removes, a spend rule from the given FinancialAccount. The spend rule will not be evaluated for future authorizations.

Output:DetachSpendRuleFromFinancialAccountPayload

Detaches, or removes, a spend rule from the given Payment Card. The spend rule will not be evaluated for future authorizations.

Output:DetachSpendRuleFromPaymentCardPayload

Detach a VelocityRule from a FinancialAccount

Output:DetachVelocityRuleFromFinancialAccountPayload

Disable the authorized user feature for a CardProduct.

Output:DisableAuthorizedUserFeaturePayload

Enable the authorized user feature for a CardProduct.

Output:EnableAuthorizedUserFeaturePayload

Enable the Collaborative Application Decisioning feature for a CardProduct. This feature is only available for the COMMERCIAL_CREDIT_PAY_IN_FULL product. If this feature is enabled, all application will wait for customer to use actual API to update underwriting status and until that time the Application will remain in pending state.

Output:EnableCollaborativeApplicationUnderwritingFeaturePayload

Enable the collaborative authorization feature for a CardProduct.

Output:EnableCollaborativeAuthorizationFeaturePayload

Enable a credit card feature for a CardProduct. For example, REVOLVING or CHARGE. This feature is only available for the COMMERCIAL_CREDIT and CONSUMER_CREDIT CardProductVerticals.

Output:EnableCreditCardFeaturePayload

Enable the on-demand funding feature for a CardProduct. If this feature is enabled, on-demand funding source is supported on FinancialAccount of a CardProduct.

Note: Enabling this feature is only supported in the TEST environment.

Output:EnableOnDemandFundingFeaturePayload

Ends the session. The session no longer accepts additional files to be uploaded.

Output:EndDocumentUploadSessionPayload

Generate a token for use in a client-side integration to manage a business account holder.

Output:GenerateBusinessAccountHolderClientTokenPayload

Generate a token for use in a client-side integration to create a scheduled transfer.

Output:GenerateCreateScheduledTransferClientTokenPayload

Generate a token for use in a client-side integration for a specific Financial Account Direct Deposit Details.

Output:GenerateDirectDepositDetailClientTokenPayload

Generate a token for use in a client-side integration to orchestrate document uploads.

Output:GenerateDocumentUploadClientTokenPayload

Generate a token for use in a client-side integration for a specific Financial Account Direct Deposit Details.

Output:GenerateExternalBankAccountDetailClientTokenPayload

Generate a Single Use Client Token for use in a client-side integration for a specific Financial Account.

generateFinancialAccountSingleUseClientToken can only be called once provisioned a restricted key after a security audit.

In Test, Highnote Customer Service can grant a restricted key without a security audit.

In Live, please reach out to Highnote Customer Service to initiate the audit.

Output:GenerateFinancialAccountSingleUseClientTokenPayload

Generate a token for use in a client-side integration to initiate a secure deposit.

Output:GenerateInitiateSecureDepositClientTokenPayload

Generate a token for use in a client-side integration for a specific Payment Card.

Output:GeneratePaymentCardClientTokenPayload

Generate a client token for use in the Secure Inputs SDK when tokenizing a payment method.

Expiry: 15 minutes

Output:GeneratePaymentMethodTokenizationClientTokenPayload

Generate a token for use in a client-side integration to manage a person account holder.

Output:GeneratePersonAccountHolderClientTokenPayload

Generate a token for use in a client-side integration to manage a person authorized user.

Output:GeneratePersonAuthorizedUserClientTokenPayload

Generate risk application sdk session token

Output:GenerateRiskApplicationSDKSessionTokenPayload

Generate a token for use in a client-side integration for a scheduled transfer.

Output:GenerateSecureDepositClientTokenPayload

Generate a token for use in a client-side integration for a secure deposit.

Output:GenerateSecureDepositClientTokenPayload

Generate a token to tokenize input for a new account holder.

The resulting token can be used with createUSPersonAccountHolderFromToken

Output:GenerateTokenizeAccountHolderClientTokenPayload

Generate a token to tokenize input for a new authorized user.

The resulting token can be used with createUSPersonAuthorizedUserFromToken

Output:GenerateTokenizeAuthorizedUserClientTokenPayload

Generate a token for account holder to link external bank accounts

Output:GenerateVerifiedExternalBankAccountLinkTokenPayload

Push or pull funds between a Highnote FinancialAccount and an external financial account (ExternalFinancialBankAccount or NonVerifiedExternalUSFinancialBankAccount) via ACH transfer.

Output:InitiateAchTransferPayload

Initiate add funds to a FinancialAccount via wire.

Output:InitiateAddWiredFundsPayload

Initiate PaymentCardTransactionDispute on a valid card transaction event.

Output:PaymentCardTransactionDisputePayload

Update Credit Limit for the account holder from product funding account. Account Holder financial account has FleetCardFeature as enabled Product has Product Funding Feature as enabled

Output:InitiateFinancialAccountCreditLimitUpdateFromProductFundingPayload

Set and update the pseudo balance on your customers' financial account.

The pseudo balance is the lifetime limit for this financial account. Highnote checks the pseudo balance during the transaction processing and will decline authorizations that would cause the current balance to exceed the pseudo balance. For example, if you allocate a pseudo balance of $100 for this finanacial account, the financial account already has a balance of $100 and the account holder attempts to authorize $1, Highnote would decline the authorization.

Output:FinancialAccountPseudoBalanceUpdatePayload

Add funds to account holder FinancialAccount from funding account . Account holder financial account that has PrepaidCardAccountFeature or DebitCardAccountFeature as enabled Origination account is either a Product financial account that has ProductFundingFeature as enabled or account that has CardFundingAccountFeature enabled

Use initiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccount instead.

Output:InitiateFundPaymentCardFinancialAccountTransferPayload

Send funds from an ExternalFinancialAccount to a FinancialAccount using ACH.

ACH is a method of transferring funds between banks.

Output:InitiateFundsDepositACHTransferPayload

Send funds from a FinancialAccount to an ExternalFinancialAccount using ACH.

ACH is a method of transferring funds between banks.

Output:InitiateFundsWithdrawalACHTransferPayload

Initiates an asynchronous operation to generate a report for an Organization.

Output:InitiateOrganizationReportPayload

Move funds from an employer FinancialAccount to an employee FinancialAccount as a payroll advance. Requires the following FinancialAccountFeatureTypes to be enabled:

• PayrollEmployerAdvanceFinancialAccountFeature on the employer FinancialAccount
• PayrollAdvanceFinancialAccountFeature on the employee FinancialAccount

Output:InitiatePayrollAdvancePayload

Initiate the process of sending a physical check.

Output:InitiatePhysicalCheckPaymentPayload

Transfer funds from an ExternalFinancialAccount to an internal FinancialAccount via ACH for a secure deposit.

ACH is a method of transferring funds between banks.

Output:InitiateSecureDepositACHTransferPayload

Transfer funds between FinancialAccounts.

• When the transfer purpose is REWARD or EARNED_CREDIT.

  • Origination account is either a Business financial account with ProductFundingFeature enabled, or an account with CardFundingAccountFeature enabled.
  • Payment Card Holder financial account has PrepaidCardAccountFeature or DebitCardAccountFeature enabled.

• When the transfer purpose is REWARD_REVERSAL or EARNED_CREDIT_REVERSAL.

  • Payment Card Holder financial account has PrepaidCardAccountFeature or DebitCardAccountFeature enabled.
  • Target account is either a Business financial account with ProductFundingFeature enabled, or an account with CardFundingAccountFeature enabled.

• When the transfer purpose is GENERAL, both financial accounts have the PrepaidCardFeature, DebitCardFeature, ProductFundingFeature, or CardFundingAccountFeature enabled.

Output:InitiateTransferBetweenFinancialAccountsPayload

Add funds to payment card holder FinancialAccount from funding account . Payment Card Holder financial account has PrepaidCardAccountFeature or DebitCardAccountFeature as enabled Origination account is either a Business financial account that has ProductFundingFeature as enabled or account has CardFundingAccountFeature enabled

Output:InitiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPayload

Add funds to funding account from payment card holder FinancialAccount. Payment Card Holder financial account has PrepaidCardAccountFeature or DebitCardAccountFeature as enabled Target account is either a Business financial account that has ProductFundingFeature as enabled or account has CardFundingAccountFeature enabled

Output:InitiateTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPayload

Initiate the request to modify a USBusinessAuthorizedPerson.

Output:InitiateUSBusinessAuthorizedPersonRequestedIdentityUpdatePayload

Initiate the request to modify a USBusinessProfile.

Output:InitiateUSBusinessProfileRequestedIdentityUpdatePayload

Initiate the request to modify a USBusinessUltimateBeneficialOwner.

Output:InitiateUSBusinessUltimateBeneficialOwnerRequestedIdentityUpdatePayload

Invites a User to your Organization.

Output:InviteUserPayload

Issue an Employer Financial Account against a Product.

Output:IssueEmployerFinancialAccountForCardProductPayload

Issue a new Payment Card against an Account Holder Application.

Output:IssueFinancialAccountForApplicationPayload

Issue a new Financial Account with an on-demand funding source.

Output:IssueFinancialAccountForApplicationWithOnDemandFundingSourcePayload

Issue a new Funding Financial Account against an Account Holder Application.

Output:IssueFundingFinancialAccountForApplicationPayload

Issue a new Payment Card against an Account Holder Application.

Use issuePaymentCardForFinancialAccount instead.

Output:IssuePaymentCardForApplicationPayload

Issue a new Payment Card against an Account Holder Application with an on-demand funding source.

Output:IssuePaymentCardForApplicationWithOnDemandFundingSourcePayload

Issue a new Payment Card against an Authorized User Application.

Output:IssuePaymentCardForApplicationPayload

Issue a new Payment Card against an Account Holder Application.

Output:IssuePaymentCardForFinancialAccountPayload

Issues a preprinted payment card financial account for a AccountHolderCardProductApplication.

Output:IssuePreprintedPaymentCardFinancialAccountForApplicationPayload

Order and ship a payment card to an account holder.

Output:OrderPhysicalPaymentCardPayload

Order and ship a payment card to an account holder as part of a group order.

Output:OrderPhysicalPaymentCardPayload

Order and ship a payment card to an account holder using validated address.

Use `orderPhysicalPaymentCardWithValidatedAddressToken` instead.

Output:OrderPhysicalPaymentCardPayload

Order and ship a payment card to an account holder using validated address token.

Output:OrderPhysicalPaymentCardPayload

A workflow which provisions an Account Holder

Output:ProvisionAccountHolderPayload

Redeem reward points accrued.

Output:RewardPointsTransferPayload

Refunds a previously captured payment.

Output:RefundPaymentTransactionPayload

Issue a new Payment Card against an existing payment card.

Output:ReissuePaymentCardPayload

Remove a CollaborativeAuthorizationEndpoint.

Output:RemoveCollaborativeAuthorizationEndpointPayload

Remove the email for a notification target. This mutation is a noop in the test environment.

Output:RemoveEmailFromNotificationTargetPayload

Deletes a notification target.

Output:RemoveNotificationTargetPayload

Removes subscriptions from a notification target.

Output:RemoveSubscriptionsFromNotificationTargetPayload

Removes a User from your Organization.

Output:RemoveUserPayload

Rename a CollaborativeAuthorizationEndpoint.

Output:RenameCollaborativeAuthorizationEndpointPayload

Updates the name of an existing notification target.

Output:RenameNotificationTargetPayload

Replays a given Notification Event to all subscribing notification targets.

Output:ReplayNotificationEventPayload

Revokes an API Key. After revocation, the API Key will be unusable for subsequent requests.

Output:RevokeAPIKeyPayload

Rotate the signing keys for a notification target. Creates a new signing key and sets an expiration date on the old key. The old key will be valid for 24 hours after the new key is created. During that time, signatures for both keys will be sent in the notification payload. There is a maximum of 5 active keys at a time for a target.

Output:RotateNotificationTargetSigningKeyPayload

Sets the email for a notification target. This data is only stored in the live environment. Deactivation emails are not sent in the test environment.

Output:SetEmailForNotificationTargetPayload

Set a pin on a payment card.

Output:SetPinForPaymentCardPayload

Simulates processing of an OriginatedAchTransfer or NonOriginatedAchTransfer. The status is updated to PROCESSED.

Note: This feature is only available in the TEST environment.

Output:SimulateAchTransferProcessingPayload

Simulates return of an OriginatedAchTransfer or NonOriginatedAchTransfer. The status will be updated to RETURNED.

Note: This feature is only available in the TEST environment.

Output:SimulateAchTransferReturnPayload

Simulate updating the review status on a previously created AccountHolderApplicationDocument in the Test environment.

This operation allows you to test various application lifecycle scenarios before going live.

Output:SimulateApplicationDocumentReviewPayload

Simulate updating the application status on a previously created AccountHolderCardProductApplication in the Test environment.

This operation allows you to test various application lifecycle scenarios before going live.

Output:SimulateApplicationUpdatePayload

Simulate updating the verification status for existing AccountHolder on a previously created AccountHolderCardProductApplication in the Test environment.

This operation allows you to test various application lifecycle scenarios before going live.

Output:SimulateApplicationUpdatePayload

Simulate behaviors around authorizations in the Test environment. This operation mirrors Live behavior and allows you to test various scenarios before going live.

Output:SimulateAuthorizationPayload

Shift the statement end period of the current statement for a Financial Account n periods backward, and age the account.

The FinancialAccount must have an OUTSTANDING_BALANCE_PAYABLE > 0, and it cannot have any closed billing statements more recent than the numberOfCyclesToShiftCurrentStatementBackward input.

Note: This feature is only available in the TEST environment.

Output:SimulateFinancialAccountAgingPayload

Simulate the card digital wallet token activated flow.

Note: This feature is only available in the TEST environment.

Output:SimulateCardDigitalWalletTokenPayload

Simulate the card digital wallet token activation flow.

Note: This feature is only available in the TEST environment.

Output:SimulateCardDigitalWalletTokenPayload

Simulate behaviors around clearing authorizations in the Test environment.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Output:SimulateClearingPayload

Simulates moving a FinancialAccount into CLOSED status. The specified FinancialAccount must be in PENDING_CLOSURE status.

Note: This feature is only available in the TEST environment.

Output:SimulateCloseFinancialAccountPayload

Simulated create new fee schedule in the Highnote test environment.

Note: This feature is only available in the TEST environment.

Output:SimulateCreateAndActivateFeeSchedulePayload

Simulate creating the application documents upload sessions.

Output:SimulateApplicationManualReviewPayload

Add funds to an Organization's account in the Highnote test environment.

Output:SimulateDepositPayload

Simulate initiating a new ExternallyInitiatedACHTransfer.

This is only used for testing purposes.

Output:ExternallyInitiatedACHTransferPayload

Simulate finalizing the provisional credit for the card transaction dispute.

Output:PaymentCardTransactionDisputePayload

Simulate initiating the chargeback for the card transaction dispute.

Output:SimulatePaymentCardTransactionDisputePayload

Simulate initiating the dispute for the card transaction.

Output:SimulatePaymentCardTransactionDisputePayload

Simulates moving a FinancialAccount into PENDING_CLOSURE status. The PENDING_CLOSURE account attribute will also be applied.

Note: This feature is only available in the TEST environment.

Output:SimulateInitiateFinancialAccountClosurePayload

Simulate issuing the Credit for a Dispute that has been decided in favor of the Account Holder for cases where the Dispute was not sent as a Chargeback to the Network due to not meeting the DisputeChargebackCardProductFeature.chargebackMinimumThreshold.

Output:SimulatePaymentCardTransactionDisputePayload

Simulate issuing provisional credit for the card transaction dispute when the disputed amount meets the DisputeChargebackCardProductFeature.chargebackMinimumThreshold.

Output:SimulatePaymentCardTransactionDisputePayload

Simulate the authorization of a Mastercard Fleet transaction in the Test environment. This allows for partial authorizations.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateAuthorizationPayload

Simulate an authorization advice event for a Mastercard Fleet transaction in the Test environment.

This creates a ReversalEvent for the difference between the authorized amount and the provided advice amount.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateAuthorizationAdvicePayload

Simulate the ClearingEvent for a Mastercard Fleet transaction in the Test environment.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateClearingPayload

Simulate the MastercardFleetEnhancedData for a Mastercard Fleet transaction in the Test environment.

Allows for the input of enhanced transaction data pertaining to a Mastercard Fleet transaction to mimic what would be received in a Live transaction.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateEnhancedDataPayload

Simulate receiving a new NonOriginatedACHTransfer.

Note: This feature is only available in the TEST environment.

Output:SimulateNonOriginatedAchTransferPayload

Simulate printer approval of the order. This can only be called while the order is in the SENT_TO_PRINTER state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalCardGroupOrderPayload

Simulate sending the order to the printer for fulfillment. This can only be called while the order is in the NEW state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalCardGroupOrderPayload

Simulate a failed shipment by the printer. This can only be called while the order is in the APPROVED state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalCardGroupOrderPayload

Simulate a successful shipment by the printer. This can only be called while the order is in the APPROVED state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalCardGroupOrderPayload

Simulate printer approval of the order. This can only be called while the order is in the SENT_TO_PRINTER state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalPaymentCardPayload

Simulate sending the order to the printer for fulfillment. This can only be called while the order is in the NEW state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalPaymentCardPayload

Simulate a failed shipment by the printer. This can only be called while the order is in the APPROVED state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalPaymentCardPayload

Simulate a successful shipment by the printer. This can only be called while the order is in the APPROVED state.

Note: This feature is only available in the TEST environment.

Output:SimulatePhysicalPaymentCardPayload

Change the status of an IntegratorInitiatedACHTransfer from PROCESSING to PROCESSED.

Note: This feature is only available in the TEST environment.

Output:SimulateProcessedIntegratorInitiatedStatusChangePayload

Change the status of an ExternallyInitiatedACHTransfer from PENDING to PROCESSING.

Note: This feature is only available in the TEST environment.

Output:ExternallyInitiatedACHTransferPayload

Change the status of an IntegratorInitiatedACHTransfer from INITIATED to PROCESSING.

Note: This feature is only available in the TEST environment.

Output:SimulateProcessingIntegratorInitiatedStatusChangePayload

Simulate behaviors around reversing authorizations in the Test environment.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: In Test, the RefundResponseCode will always be APPROVED, however, more response codes may be added in the future.

Output:SimulateRefundPayload

Simulate resolving the payment card transaction chargeback for the dispute. If received amount is 0, the chargeback is resolved as a loss.

Output:SimulatePaymentCardTransactionDisputePayload

Change the status of an IntegratorInitiatedACHTransfer from PROCESSING to RETURNED.

Note: This feature is only available in the TEST environment.

Output:SimulateReturnedIntegratorInitiatedStatusChangePayload

Simulate behaviors around reversing authorizations in the Test environment.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: In Test, the ReversalResponseCode will always be APPROVED, however, more response codes may be added in the future.

Output:SimulateReversalPayload

Rollover the current/next statements. This will simultaneously close the current open statement and open the next statement. If the current open statement's end period is in the future, this will fail. Use simulateShiftCurrentFinancialAccountStatementPeriod mutation to move the end period to now.

Note: This feature is only available in the TEST environment.

Output:SimulateFinancialAccountStatementPayload

Shift the statement end period of the current statement for an account to now.

Note: This feature is only available in the TEST environment.

Output:SimulateFinancialAccountStatementPayload

Simulate behaviors around a single step authorization and clear in the Test environment. This operation mirrors Live behavior and allows you to test various scenarios before going live.

Output:SimulateAuthAndClearPayload

Simulate updating the dispute for the card transaction.

Output:SimulatePaymentCardTransactionDisputePayload

Simulate updating the payment card transaction chargeback for the dispute. If received amount is 0, the chargeback is resolved as a loss.

Output:SimulatePaymentCardTransactionDisputePayload

Simulate the authorization of a Visa Fleet transaction in the Test environment. This allows for partial authorizations.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateAuthorizationPayload

Simulate an authorization advice event for a Visa Fleet transaction in the Test environment.

This creates a ReversalEvent for the difference between the authorized amount and the provided advice amount.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateAuthorizationAdvicePayload

Simulate the ClearingEvent for a Visa Fleet transaction in the Test environment.

Also allows for input of simulated VisaFleetL2TransactionData to mimic what would be received in a Live clearing event.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateClearingPayload

Simulate the VisaFleetL3EnhancedData for a Visa Fleet transaction in the Test environment.

Allows for the input of Level 3 transaction data pertaining to a Visa Fleet transaction to mimic what would be received in a Live transaction.

This operation mirrors Live behavior and allows you to test various scenarios before going live.

Note: This feature is only available in the TEST environment.

Output:SimulateVisaFleetL3EnhancedDataPayload

Initiates a session to allow multiple files to be uploaded.

Output:StartDocumentUploadSessionPayload

Temporarily suspend a card digital wallet token.

Output:SuspendCardDigitalWalletTokenPayload

Suspends a FinancialAccount.

Output:FinancialAccountPayload

Suspend a Payment Card and decline all authorizations until the suspension is lifted.

Output:SuspendPaymentCardPayload

Terminate a card digital wallet token.

Output:TerminateCardDigitalWalletTokenPayload

Creates a single use payment method from a card.

Output:TokenizeCardPaymentMethodPayload

Tokenizes data for a new USBusinessAccountHolder.

Output:TokenizeUSBusinessAccountHolderPayload

Tokenizes data for a new USPersonAccountHolder.

Output:TokenizeUSPersonAccountHolderPayload

Tokenizes data for a new USPersonAuthorizedUser.

Output:TokenizeUSPersonAuthorizedUserPayload

Reactivate a suspended card digital wallet token.

Output:UnsuspendCardDigitalWalletTokenPayload

Unsuspends a FinancialAccount.

Output:FinancialAccountPayload

Update non-terminal AccountHolderCardProductApplicationOffer on an AccountHolderCardProductApplication.

Output:AccountHolderCardProductApplicationOffersPayload

Updates an existing spend rule that limits the amount of authorizations.

Output:UpdateAmountLimitSpendRulePayload

Updates a CardDataInputCapabilitySpendRule that allows or blocks a CardDataInputCapability.

Output:UpdateCardDataInputCapabilitySpendRulePayload

Changes the name of a Card Product.

Output:UpdateCardProductNamePayload

Updates a CardTransactionProcessingTypeConditionSpendRule that allows or blocks a CardTransactionProcessingType.

Output:UpdateCardTransactionProcessingTypeConditionSpendRulePayload

Updates a ConditionalRuleSetSpendRule that combines the results of multiple spend rules.

Output:UpdateConditionalRuleSetSpendRulePayload

Updates an existing spend rule that limits the number of allowed transactions.

Output:UpdateCountLimitSpendRulePayload

Updates CustomFields for an object.

Output:CustomFieldsPayload

Updates an existing spend rule that specifies if the result of a CVV check should be approved or declined.

Output:UpdateCVVSpendRulePayload

Updates a DepositAmountLimitSpendRule that limits the amount of authorizations.

Output:UpdateDepositAmountLimitSpendRulePayload

Updates a DepositCountLimitSpendRule that limits the number of authorizations.

Output:UpdateDepositCountLimitSpendRulePayload

Updates a DepositProcessingNetworkSpendRule which allows or blocks an ATM processing network.

Output:UpdateDepositProcessingNetworkSpendRulePayload

Update the billing cycle configuration for a FinancialAccount. Currently, this enables you to update the day of the month when payment is due for a FinancialAccount. The change only applies to future billing cycles, not the current open cycle or any closed cycles.

Output:UpdateFinancialAccountBillingCycleConfigurationPayload

Changes the name of a Financial Account.

Output:UpdateFinancialAccountNamePayload

Updates a MaximumAmountVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified Amount above the account's original balance'.

Output:UpdateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload

Updates a MaximumPercentVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified percentage over the account's original balance.

Output:UpdateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload

Updates an existing spend rule that specifies the merchant categories that are either allowed or blocked during authorizations.

Output:UpdateMerchantCategorySpendRulePayload

Updates an existing spend rule that specifies the merchant countries that are either allowed or blocked during authorizations.

Output:UpdateMerchantCountrySpendRulePayload

Updates an existing spend rule that specifies which merchant identifiers (MIDs) are either allowed or blocked.

Output:UpdateMerchantIdentifierSpendRulePayload

Updates a MinimumAmountLimitSpendRule that only allows transactions for a specified amount.

Output:UpdateMinimumAmountLimitSpendRulePayload

Update the display name of an organization.

Output:UpdateOrganizationProfileDisplayNamePayload

Updates a PanEntryModeSpendRule that allows or blocks a PanEntryMode.

Output:UpdatePanEntryModeSpendRulePayload

Updates an existing spend rule that specifies which Point of Service (POS) categories are either allowed or blocked.

Output:UpdatePointOfServiceCategorySpendRulePayload

Updates an existing spend rule that specifies which address verification postal codes categories are either allowed or blocked.

Output:UpdatePostalCodeVerificationSpendRulePayload

Update a RewardRedemptionConfigurationAttachment. Note: only the effective through date is modifiable.

Output:UpdateRewardRedemptionConfigurationAttachmentPayload

Update a RewardRuleAttachment. Note: only the effective through date is modifiable.

Output:UpdateRewardRuleAttachmentPayload

Updates an existing spend rule that specifies if the result of street address verification should be approved or declined.

Note Street address verifications only verify a street number. Use createPostalCodeVerificationSpendRule to change how postal codes are verified.

Output:UpdateStreetAddressSpendRulePayload

Update email for existing USAssociatedPersonAccountHolder.

Output:UpdateUSAssociatedPersonAccountHolderPayload

Update address for existing USAssociatedPersonAccountHolder.

Output:UpdateUSAssociatedPersonAccountHolderPayload

Update phone for existing USAssociatedPersonAccountHolder.

Output:UpdateUSAssociatedPersonAccountHolderPayload

Update address for existing USBusinessAccountHolder.

Output:UpdateUSBusinessAccountHolderPayload

Update credit risk attribute for existing USBusinessAccountHolder.

Output:UpdateUSBusinessAccountHolderPayload

Update phone for existing USBusinessAccountHolder.

Output:UpdateUSBusinessAccountHolderPayload

Update website for existing USBusinessAccountHolder.

Output:UpdateUSBusinessAccountHolderPayload

Updates an existing Users data.

Output:UpdateUserPayload

Update billing address for existing USPersonAccountHolder.

Output:UpdateUSPersonAccountHolderPayload

Update credit risk attribute for an existing USPersonAccountHolder.

Output:UpdateUSPersonAccountHolderPayload

Update email for existing USPersonAccountHolder.

Output:UpdateUSPersonAccountHolderPayload

Update phone for existing USPersonAccountHolder.

Output:UpdateUSPersonAccountHolderPayload

Update address for existing USPersonAuthorizedUser.

Output:UpdateUSPersonAuthorizedUserPayload

Update email for existing USPersonAuthorizedUser.

Output:UpdateUSPersonAuthorizedUserPayload

Update phone for existing USPersonAuthorizedUser.

Output:UpdateUSPersonAuthorizedUserPayload

Update an existing VelocityRule

Output:UpdateVelocityRulePayload

Validate provided address.

Output:ValidateAddressPayload

Verifies that the PaymentCardInput is a valid payment card, and able to be used authroization.

Output:VerifyPaymentCardPayload