Mutation
The Mutation type is a special type that is used to write or modify data. A mutation's response reflects the data after it has been updated. While query fields are executed in parallel, mutation fields run in series. This ensures each operation completes before the next begins.
acceptAccountHolderCardProductApplicationOffer
Accept an extended AccountHolderCardProductApplicationOffer.
Input Arguments
acceptAndFinalizeCardPaymentDispute
Accepts and finalizes a CardPaymentDispute.
Input Arguments
activateCardProductCreditPlan
Activate a CreditPlan for a CardProduct.
Input Arguments
activateCollaborativeAuthorizationEndpoint
Activate a CollaborativeAuthorizationEndpoint.
Input Arguments
activateFlexibleCredentialInstantCredit
Activate Instant Credit on a FlexibleCredential for a bounded window,
setting or topping up the available credit that gates authorizations during
it. Asynchronous: returns the activation status in PENDING; poll
flexibleCredentialInstantCreditActivation or await the completion webhook
for the terminal result.
Input Arguments
activateInstallmentAgreementForTransactionEvent
Activate an InstallmentAgreement for a Transaction by providing a TransactionEvent.
Output:ActivateInstallmentAgreementForTransactionEventPayload
Input Arguments
activateNotificationTarget
Reactivates a previously deactivated notification target.
Input Arguments
input: ActivateNotificationTargetInput!
The input to activate a notification target.
Input Arguments
input: ActivatePaymentCardInput!
addBeneficialOwners
Add beneficial owners to the Business behind an APPROVED AccountHolderCardProductApplication.
Each person is created and attached to the business as an ultimate beneficial owner, then a new
edition of the application is opened to verify the identity of the added owners. The returned
application is that edition, in PENDING status; poll it for the outcome. The business, its
financial accounts, and its cards stay attached throughout.
Currently one beneficial owner is accepted per call.
Output:AddBeneficialOwnersPayload
Input Arguments
input: AddBeneficialOwnersInput!
addCollaborativeAuthorizationEndpoint
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.
Input Arguments
addExternalBankAccountFromTokenDeprecated
Add a bank account for account holder using external token.
Use Mutation.addExternalBankAccountVerifiedThroughPlaid instead.
Input Arguments
addExternalBankAccountVerifiedThroughFinicity
Add a bank account for account holder using external token. (Finicity specific)
Input Arguments
addExternalBankAccountVerifiedThroughPlaid
Add a bank account for account holder using external token. (Plaid specific)
Input Arguments
addExternalBankAccountVerifiedThroughPlaidUsingThirdPartyProcessorToken
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.
Input Arguments
addFundsToPaymentCardDeprecated
Transfer funds from a funding account of the Organization to a payment card.
Transfer is deprecated in favor of initiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccount
Output:AddFundsToPaymentCardPayload
Input Arguments
input: AddFundsToPaymentCardInput!
addNonVerifiedExternalUSFinancialBankAccount
Add a non-verified US bank account for an account holder. Can only be used to initiateFundsWithdrawalACHTransfer
Input Arguments
addPaymentCardToApplePayByDevicePushProvisioning
Request encrypted and activation data required to push provision a PaymentCard directly from your mobile application to an Apple Pay enabled device.
Output:AddPaymentCardDigitalWalletTokenApplePayDevicePushProvisioningPayload
Input Arguments
addPaymentCardToGooglePayByDevicePushProvisioning
Request encrypted and activation data required to push provision a PaymentCard directly from your mobile application to a Google Pay enabled device.
Output:AddPaymentCardDigitalWalletTokenGooglePayPushProvisioningPayload
Input Arguments
addSubscriptionsToNotificationTarget
Adds subscriptions to a notification target.
Input Arguments
input: AddSubscriptionsToNotificationTargetInput!
The input to add subscriptions to a notification target.
addUserDefinedFieldDefinitionRelationship
Adds a relationship between a UserDefinedFieldDefinition and the given
entity type.
Input Arguments
addWebhookNotificationTarget
Adds a new https target for webhook notifications.
Input Arguments
input: AddWebhookNotificationTargetInput!
The input to add a new webhook notification target.
approveCreditLimitDecrease
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.
Input Arguments
approveCreditLimitIncrease
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.
Input Arguments
approveCreditProductApplicationUnderwriting
Approve a credit-based AccountHolderCardProductApplication.
Input Arguments
assignFinancialBankAccountToBusiness
Assigns a financial account to a business.
Input Arguments
assignPaymentCardToFinancialAccount
Assigns a PaymentCard to a FinancialAccount.
This is used in addition to the issuePreprintedPaymentCardFinancialAccountForApplication mutation.
The billing address used for address verification (AVS) on the card is the card holder's billing address at the time the card is assigned: the account holder's, or the authorized user's for an authorized user's financial account. To assign the card with a different address, update that billing address first. That update also changes the billing address on the card holder's existing cards.
Input Arguments
attachCardProductVelocityRule
Attach a VelocityRule to a CardProduct
Input Arguments
attachFeeScheduleToFinancialAccount
Attach a FeeSchedule to a FinancialAccount.
The fee schedule's fees apply to the account from the time of the request. A FinancialAccount can
have at most one FeeSchedule attached at a time.
Retrying an attach that already succeeded, for example after a timeout, returns a UserError
because the account already has a FeeSchedule attached; check the account's attached fee
schedules before retrying.
Input Arguments
Input Arguments
input: AttachFeeToCreditPlanInput!
attachPaymentCardVelocityRule
Attach a VelocityRule to a PaymentCard
Input Arguments
attachRealtimeRiskRuleToCardProduct
Attaches a realtime risk rule to the given Card Product. The risk rule will be evaluated in realtime for every authorization on a payment card issued under the card product.
Input Arguments
attachRealtimeRiskRuleToFinancialAccount
Attaches a realtime risk rule to the given Financial Account. The risk rule will be evaluated in realtime for every authorization.
Input Arguments
attachRealtimeRiskRuleToPaymentCard
Attaches a realtime risk rule to the given Payment Card. The risk rule will be evaluated in realtime for every authorization.
Input Arguments
attachRewardEarnRuleToProduct
Attach a reward earn rule to a product.
Input Arguments
attachRewardRedemptionConfigurationToProduct
Attach Reward RewardRedemptionConfiguration to a CardProduct.
Input Arguments
attachSpendRuleToCardProduct
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.
Input Arguments
attachSpendRuleToFinancialAccount
Attaches a spend rule to the given FinancialAccount. The spend control rule will be evaluated for every authorization.
Input Arguments
attachSpendRuleToPaymentCard
Attaches a spend control rule to the given Payment Card. The spend control rule will be evaluated for every authorization.
Input Arguments
attachVelocityRuleToFinancialAccount
Attach a VelocityRule to a FinancialAccount
Input Arguments
authorizeNetworkTokenDeprecated
Authorizes a NetworkToken for later capture.
Use `authorizePaymentTransaction` with `credential: { networkToken: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Output:AuthorizeNetworkTokenPayload
Input Arguments
input: AuthorizeNetworkTokenInput!
authorizePaymentCardDeprecated
Authorizes a PaymentCard for later capture.
Use `authorizePaymentTransaction` with `credential: { paymentCard: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Output:AuthorizePaymentCardPayload
Input Arguments
input: AuthorizePaymentCardInput!
authorizePaymentCardForPos
Authorizes a PaymentCard for later capture for point of service.
Input Arguments
authorizePaymentMethodTokenDeprecated
Authorizes a PaymentMethodToken for later capture.
Use `authorizePaymentTransaction` with `credential: { paymentMethodToken: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Input Arguments
authorizePaymentTransaction
Authorizes a payment for later capture.
Possible UserError codes
Any credential:
INVALID_CONTRACT_ID— No merchant configuration was found for this request.INVALID_PAN— The card number failed validation or is not supported. For apaymentMethodToken, the card resolved from the token is validated the same way.INVALID_PAYMENT_TRANSACTION_AMOUNT— The payment amount must be greater than zero.MERCHANT_DESCRIPTOR_NOT_CONFIGURED— No merchant descriptor is configured for this merchant. Contact support.IDEMPOTENCY_KEY_CONFLICT— A concurrent request with the same idempotency key is still being processed; retry once it completes.
When using the paymentCard credential:
INVALID_BILLING_COUNTRY_CODE— The cardholder billing country code is not a valid country code.INVALID_SECURITY_CODE_FORMAT— The security code must contain only digits.INVALID_SECURITY_CODE_LENGTH— The security code length is invalid for the card brand.
When using the networkToken credential:
INVALID_BILLING_COUNTRY_CODE— The cardholder billing country code is not a valid country code.MISSING_CRYPTOGRAM— A cryptogram is required when a network token is provided. A Mastercard card-on-file authorization with a merchant-initiatedpaymentInitiatorand anetworkTokenization.tokenRequestorIdentifiermay be accepted without one, depending on your Mastercard configuration.INVALID_CRYPTOGRAM_FORMAT— The cryptogram is not in a valid format.
When using the paymentMethodToken credential:
INVALID_TOKEN— No card was found for the given payment method token.
When using the walletPaymentMethod credential, the authorization places a hold for the amount on the wallet's funding account:
INVALID_WALLET_PAYMENT_METHOD: The ID is missing or is not aWalletPaymentMethodID. No payment is created.WALLET_PAYMENT_METHOD_NOT_FOUND: NoWalletPaymentMethodwith this ID exists in your organization. No payment is created.MERCHANT_NOT_ENABLED_FOR_WALLET: ThemerchantAcceptorIdis omitted, or names a merchant acceptor that is not enabled to accept aWalletPaymentMethod. No payment is created.WALLET_PAYMENT_METHOD_NOT_SUPPORTED: The request sets a field that cannot be sent with aWalletPaymentMethod, such asinstallmentPaymentorenhancedData; the error's path names that field. No payment is created.
For installment payments:
INVALID_PAYMENT_INITIATOR_FOR_INSTALLMENT— Installment payments require an installment payment initiator.INVALID_INSTALLMENT_PAYMENT_NUMBER— The installment payment number cannot exceed the total number of installments.INSTALLMENT_PAYMENTS_NOT_SUPPORTED— Installment payments are not supported for this card.INVALID_INSTALLMENT_PAYMENT_LINK— The original payment for this installment link was not found, or its credentials do not match.INVALID_TOTAL_INSTALLMENT_AMOUNT— The total installment amount must be greater than zero.INVALID_AMOUNT_PER_INSTALLMENT— The amount per installment must be greater than zero.INVALID_TOTAL_AMOUNT_FUNDED— The total amount funded cannot be negative.
For single-authorization / multiple-clearing:
SINGLE_AUTH_MULTI_CLEAR_FEATURE_NOT_ENABLED— Single-authorization/multiple-clearing is not enabled for this organization.SINGLE_AUTH_MULTI_CLEAR_NOT_SUPPORTED_FOR_PROCESSOR— Single-authorization/multiple-clearing is not supported for this card's processor.
When providing enhancedData:
ENHANCED_DATA_NOT_ENABLED: Enhanced data is not enabled for your organization. Contact Highnote support to request enablement.ENHANCED_DATA_INVALID: The enhanced data cannot be accepted:visawas sent with neither aheaderfield nor a line item;purchaseIdentifierwas sent withoutpurchaseIdentifierFormat; a text field is blank, contains characters other than printable ASCII, or contains a card number; an amount is in a currency other than the payment's;visaenhanced data was sent for a card that is not a Visa card;mastercardwas sent for a card that is not a Mastercard card, or with aheaderthat has none ofcustomerCode,totalTaxandtaxExemptset totrue;taxExemptistruewith atotalTaxother than0;customerCodestarts with a space; a Mastercard line item is sent withoutdebitCreditIndicator; ortotalTaxis longer than 12 digits, counting the minor units. Correct or remove the field named by the error path.ENHANCED_DATA_FIELD_TOO_LONG: An enhanced data field is longer than the maximum length in its description. Shorten the field named by the error path.INVALID_INPUT(fieldlineItems,quantity,taxRate,quantityDecimalPlacesorunitCostDecimalPlaces): More than 998 line items were sent; a line item'squantityortaxRateis greater than 9007199254740991; a line item'squantityDecimalPlacesorunitCostDecimalPlacesis greater than 4; or a line item'sunitCostDecimalPlaceswas sent without aunitCost.
Input Arguments
bindCardAuthenticationContactAddress
Bind a postal address to a PaymentCard or a FinancialAccount for use during
authentication, independent of the account holder's identity record.
Binding again supersedes the address contact in force and returns the result. An address contact and a channel contact are bound independently and do not affect each other.
A purpose must be enabled on the card product before it can be switched on here.
Input Arguments
input: BindCardAuthenticationContactAddressInput!
The address contact to bind.
bindCardAuthenticationContactChannel
Bind an email address, a phone number, or both, to a PaymentCard for use during
authentication, independent of the account holder's identity record.
Binding again supersedes the channel contact in force on the card and returns the result, so read the returned contact to confirm which channels are now in force. Channel and address contacts are bound independently and do not affect each other.
A purpose must be enabled on the card product before it can be switched on here.
Input Arguments
input: BindCardAuthenticationContactChannelInput!
The channel contact to bind.
cancelPaymentTransactionDeprecated
Cancels remaining held authorized amount.
For a payment authorized with a WalletPaymentMethod, use reversePaymentTransaction, which answers a WalletReversalStepSummary.
Use `reversePaymentTransaction`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Input Arguments
cancelPhysicalCardGroupOrder
Cancels a group order, and all the fulfillments in it.
Input Arguments
cancelPhysicalPaymentCardOrder
Cancel an order for a physical payment card. This can only be called while the
order is in the NEW state.
Input Arguments
cancelRequestedIdentityUpdate
Cancels the RequestedIdentityUpdate. The individual or business has acknowledged the accuracy and correctness of the provided information.
Requested updates will not be applied.
Input Arguments
cancelScheduledTransfer
Cancel a scheduled transfer between financial accounts.
Input Arguments
capturePaymentTransaction
Captures a previously authorized payment.
UserError codes specific to enhancedData
This list covers only enhancedData; a capture can also return other UserError codes.
ENHANCED_DATA_NOT_ENABLED: Enhanced data is not enabled for your organization. Contact Highnote support to request enablement.ENHANCED_DATA_INVALID: The enhanced data cannot be accepted:visawas sent with neither aheaderfield nor a line item;purchaseIdentifierwas sent withoutpurchaseIdentifierFormat; a text field is blank, contains characters other than printable ASCII, or contains a card number; an amount is in a currency other than the payment's;visaenhanced data was sent for a card that is not a Visa card;mastercardwas sent for a card that is not a Mastercard card, or with aheaderthat has none ofcustomerCode,totalTaxandtaxExemptset totrue;taxExemptistruewith atotalTaxother than0;customerCodestarts with a space; a Mastercard line item is sent withoutdebitCreditIndicator; ortotalTaxis longer than 12 digits, counting the minor units. Correct or remove the field named by the error path.ENHANCED_DATA_FIELD_TOO_LONG: An enhanced data field is longer than the maximum length in its description. Shorten the field named by the error path.INVALID_INPUT(fieldlineItems,quantity,taxRate,quantityDecimalPlacesorunitCostDecimalPlaces): More than 998 line items were sent; a line item'squantityortaxRateis greater than 9007199254740991; a line item'squantityDecimalPlacesorunitCostDecimalPlacesis greater than 4; or a line item'sunitCostDecimalPlaceswas sent without aunitCost.
When capturing a payment authorized with a WalletPaymentMethod
The result is a WalletCaptureStepSummary. An approved capture takes its amount and releases the rest of the authorization, so a wallet authorization is captured at most once. Send an idempotencyKey with every wallet capture: only a repeat under the same key settles a capture whose outcome is not known. Each of these UserError codes means this request captured nothing:
REQUIRES_APPROVED_AUTHORIZATION: The payment has no approved authorization to capture.PARTIAL_CAPTURE_NOT_SUPPORTED:captureTypeisMULTI_CAPTURE. OmitcaptureType, or sendFINAL_CAPTURE. The error path isamount.CAPTURE_AMOUNT_MUST_BE_POSITIVE: Theamountis zero. To release the whole authorization, reverse it withreversePaymentTransaction.CAPTURE_AMOUNT_GREATER_REMAINING_AUTHORIZED_AMOUNT: Theamountis greater than the authorized amount.WALLET_CAPTURE_FIELD_NOT_SUPPORTED: The request setsenhancedData, which a wallet capture does not carry. The error path ispaymentTransactionId.WALLET_REVERSAL_IN_PROGRESS: A reversal of this payment has not been answered yet.
REMAINING_AUTHORIZED_AMOUNT_IS_ZERO means the authorization holds nothing more to capture: it was already captured or reversed, or the payment is a charge. After an earlier capture of this payment was answered WALLET_CAPTURE_IN_PROGRESS, it can mean that earlier capture took the amount.
WALLET_CAPTURE_IN_PROGRESS means a capture of this payment has been sent and its outcome is not known yet, so the amount may already be captured. Send that capture again with its own idempotencyKey to get the outcome; until it is answered, a capture under any other idempotencyKey is answered WALLET_CAPTURE_IN_PROGRESS. A capture sent without an idempotencyKey cannot be sent again as the same capture: each request without a key is a new capture. Do not capture or charge the amount another way.
A declined capture is answered with a WalletCaptureStepSummary, not a UserError: read transaction.responseCode.processorResponseCode. Nothing is captured. Two declines say what to do next:
PROCESSOR_NETWORK_NOT_AVAILABLE: The capture was not sent, and the authorization stays open. Send it again with a newidempotencyKey.PRE_AUTHORIZATION_EXPIRED: The authorization has expired and can no longer be captured. Charge the amount instead.
Input Arguments
chargeNetworkTokenDeprecated
One step authorization and capture of a NetworkToken.
Use `chargePaymentTransaction` with `credential: { networkToken: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Output:ChargeNetworkTokenPayload
Input Arguments
input: ChargeNetworkTokenInput!
chargePaymentCardDeprecated
One step authorization and capture of a PaymentCard.
Use `chargePaymentTransaction` with `credential: { paymentCard: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Output:ChargePaymentCardPayload
Input Arguments
input: ChargePaymentCardInput!
chargePaymentCardForPos
One step authorization and capture of a PaymentCard for point of service.
Input Arguments
chargePaymentMethodTokenDeprecated
One step authorization and capture of a PaymentMethodToken.
Use `chargePaymentTransaction` with `credential: { paymentMethodToken: { ... } }`. See the migration guide: https://docs.highnote.com/docs/acquiring/payments/migrate-payment-mutations
Input Arguments
Input Arguments
input: ChargePaymentOrderInput!
chargePaymentOrderFromPaymentMethodToken
One step authorization and capture of an PaymentOrder.
Output:ChargePaymentOrderPayload
Input Arguments
chargePaymentTransaction
Authorizes and captures a payment in a single round trip. Set accountFunding to pull
funds from a card into an account instead of making a purchase (an account funding
transaction).
Possible UserError codes
Any credential:
INVALID_CONTRACT_ID— No merchant configuration was found for this request.INVALID_PAN— The card number failed validation or is not supported. For apaymentMethodToken, the card resolved from the token is validated the same way.INVALID_PAYMENT_TRANSACTION_AMOUNT— The payment amount must be greater than zero.MERCHANT_DESCRIPTOR_NOT_CONFIGURED— No merchant descriptor is configured for this merchant. Contact support.IDEMPOTENCY_KEY_CONFLICT— A concurrent request with the same idempotency key is still being processed; retry once it completes.
When using the paymentCard credential:
INVALID_BILLING_COUNTRY_CODE— The cardholder billing country code is not a valid country code.INVALID_SECURITY_CODE_FORMAT— The security code must contain only digits.INVALID_SECURITY_CODE_LENGTH— The security code length is invalid for the card brand.
When using the networkToken credential:
INVALID_BILLING_COUNTRY_CODE— The cardholder billing country code is not a valid country code.MISSING_CRYPTOGRAM— A cryptogram is required when a network token is provided.INVALID_CRYPTOGRAM_FORMAT— The cryptogram is not in a valid format.
When using the paymentMethodToken credential:
INVALID_TOKEN— No card was found for the given payment method token.
When using the walletPaymentMethod credential:
INVALID_WALLET_PAYMENT_METHOD: The ID is missing or is not aWalletPaymentMethodID. No payment is created.WALLET_PAYMENT_METHOD_NOT_FOUND: NoWalletPaymentMethodwith this ID exists in your organization. No payment is created.MERCHANT_NOT_ENABLED_FOR_WALLET: ThemerchantAcceptorIdis omitted, or names a merchant acceptor that is not enabled to accept aWalletPaymentMethod. No payment is created.WALLET_PAYMENT_METHOD_NOT_SUPPORTED: The request sets a field that cannot be sent with aWalletPaymentMethod, such asinstallmentPaymentorenhancedData; the error's path names that field. No payment is created.
For installment payments:
INVALID_PAYMENT_INITIATOR_FOR_INSTALLMENT— Installment payments require an installment payment initiator.INVALID_INSTALLMENT_PAYMENT_NUMBER— The installment payment number cannot exceed the total number of installments.INSTALLMENT_PAYMENTS_NOT_SUPPORTED— Installment payments are not supported for this card.INVALID_INSTALLMENT_PAYMENT_LINK— The original payment for this installment link was not found, or its credentials do not match.INVALID_TOTAL_INSTALLMENT_AMOUNT— The total installment amount must be greater than zero.INVALID_AMOUNT_PER_INSTALLMENT— The amount per installment must be greater than zero.INVALID_TOTAL_AMOUNT_FUNDED— The total amount funded cannot be negative.
For single-authorization / multiple-clearing:
SINGLE_AUTH_MULTI_CLEAR_NOT_SUPPORTED_FOR_CHARGE— Single-authorization/multiple-clearing is not supported on charge; authorize first, then capture.SINGLE_AUTH_MULTI_CLEAR_NOT_SUPPORTED_FOR_PROCESSOR— Single-authorization/multiple-clearing is not supported for this card's processor.
When providing enhancedData:
ENHANCED_DATA_NOT_ENABLED: Enhanced data is not enabled for your organization. Contact Highnote support to request enablement.ENHANCED_DATA_INVALID: The enhanced data cannot be accepted:visawas sent with neither aheaderfield nor a line item;purchaseIdentifierwas sent withoutpurchaseIdentifierFormat; a text field is blank, contains characters other than printable ASCII, or contains a card number; an amount is in a currency other than the payment's;visaenhanced data was sent for a card that is not a Visa card;mastercardwas sent for a card that is not a Mastercard card, or with aheaderthat has none ofcustomerCode,totalTaxandtaxExemptset totrue;taxExemptistruewith atotalTaxother than0;customerCodestarts with a space; a Mastercard line item is sent withoutdebitCreditIndicator; ortotalTaxis longer than 12 digits, counting the minor units. Correct or remove the field named by the error path.ENHANCED_DATA_FIELD_TOO_LONG: An enhanced data field is longer than the maximum length in its description. Shorten the field named by the error path.INVALID_INPUT(fieldlineItems,quantity,taxRate,quantityDecimalPlacesorunitCostDecimalPlaces): More than 998 line items were sent; a line item'squantityortaxRateis greater than 9007199254740991; a line item'squantityDecimalPlacesorunitCostDecimalPlacesis greater than 4; or a line item'sunitCostDecimalPlaceswas sent without aunitCost.
When accountFunding is set, INVALID_CONTRACT_ID, INVALID_PAN, INVALID_PAYMENT_TRANSACTION_AMOUNT, MERCHANT_DESCRIPTOR_NOT_CONFIGURED and IDEMPOTENCY_KEY_CONFLICT above also apply, and:
NON_EMPTY_INPUT_REQUIRED— A required value is missing or blank. An account funding transaction requires anidempotencyKeythat is neither blank nor all zeros, and a cardholder name part that you send must not be blank. The error's path names the field.CARD_TRANSACTION_TYPE_NOT_ENABLED— Account funding is not enabled for your organization. When the error's path namesnetworkToken, account funding is enabled, but not with that credential. Contact support.CREDENTIAL_NOT_SUPPORTED_FOR_TRANSACTION_TYPE— The credential cannot be used for account funding. ApaymentCardorwalletPaymentMethodcredential is never accepted,externalCredentialOnFileis not accepted on any credential, and anetworkTokenis not accepted for this card's processor. The error's path names the field.FIELD_NOT_SUPPORTED_FOR_TRANSACTION_TYPE—paymentInitiator,installmentPaymentandenhancedDatacannot be sent for account funding. Remove the field named by the error's path.TRANSACTION_TYPE_NOT_SUPPORTED_FOR_PROCESSOR— Account funding is not supported for this card's processor.END_CUSTOMER_NOT_FOUND— TheendCustomerIdis not anEndCustomerID, or, with anetworkToken,endCustomernames noEndCustomerin your organization. The error's path names the field.CUSTOMER_IDENTIFIER_REJECTS_END_CUSTOMER_ID— TheexternalCustomerIdentifieris anEndCustomerID. Send it asendCustomerId.CARDHOLDER_NAME_REQUIRED— No cardholder name is available: the credential carries none, and noendCustomerwith a name was sent.INVALID_NAME_FORMAT,MAX_LENGTH_REACHED— A cardholder name is not in a valid format, or is too long. The error's path names the field, or thepaymentMethodTokenwhen the name comes from the saved card.SENDER_COUNTRY_CODE_INVALID— The country of the sender's address is not an ISO 3166-1 alpha-3 code. The sender's address is the card's billing address, or theEndCustomer's address when theEndCustomersupplies the sender.VISA_FUNDS_TRANSFER_FIELDS_REQUIRED— The merchant is not configured for account funding on Visa. Contact support.
When accountFunding is set and using the paymentMethodToken credential:
INVALID_TOKEN— No card was found for the given payment method token.END_CUSTOMER_MISMATCH— TheendCustomeris not theEndCustomerthat saved the card: anotherEndCustomersaved it, none did, orendCustomernames noEndCustomer. Send theEndCustomerthat saved the card, or omitendCustomer.
When accountFunding is set and using the networkToken credential:
MISSING_CRYPTOGRAM— A cryptogram is required when a network token is provided.INVALID_CRYPTOGRAM_FORMAT— The cryptogram is not in a valid format.INVALID_TOKEN_REQUESTOR_ID_FORMAT—networkTokenization.tokenRequestorIdentifieris not 11 digits.INVALID_NETWORK_TOKEN_ECI—networkTokenization.electronicCommerceIndicatoris longer than 10 characters.
Input Arguments
checkInstrumentEligibilityDetails
Check the eligibility details of one or more instruments.
Returns each instrument's card network money movement eligibility along with its attributes, such as funding source and designation. Supports Visa and Mastercard payment cards.
An instrument from another card brand, or one that does not match a known
card range, returns a UserError as the detail of its result. The other
instruments in the request are still checked.
The eligibility returned is what the card network reports for the
instrument. It does not guarantee that Highnote will accept a transfer:
Highnote's own requirements still apply when a transfer is made. For
Highnote's decision on a PaymentCardInstrument, see the
InstantNetworkTransfer capabilities in its capabilities.
Input Arguments
closeExternalFinancialBankAccount
Close previously added external bank account.
Input Arguments
closePaymentCard
Close a Payment Card and decline all future authorizations.
Output:ClosePaymentCardPayload
Input Arguments
input: ClosePaymentCardInput!
closeTransactionBatch
Closes the current TransactionBatch for payout, and opens a new TransactionBatch.
Output:CloseTransactionBatchPayload
Input Arguments
input: CloseTransactionBatchInput!
completeAcquiringThreeDSecureAuthenticationChallenge
Completes a 3-D Secure step-up challenge after the cardholder finishes it. Call it with the
credential from the AcquiringThreeDSecureChallengeRequired result of
initiateAcquiringThreeDSecureAuthentication:
- For a stored
PaymentMethodToken, pass itspaymentMethodToken.idascredential.paymentMethodTokenId, and authorize or charge against thepaymentMethodTokenthis mutation returns. - For a card supplied directly, pass its
threeDSecureSessionToken.tokenascredential.threeDSecureSessionToken. This mutation returns a newthreeDSecureSessionToken; pass itstokenaspaymentCard.threeDSecureAuthenticationTokenwhen you authorize or charge the card. The token from the challenge result cannot be used for that.
Output:CompleteAcquiringThreeDSecureAuthenticationChallengePayload
Input Arguments
completePhysicalCardGroupOrder
Completes a group order, marking it as ready to ship.
Input Arguments
confirmCreditReportUnfrozen
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.
Input Arguments
confirmPayrollDeposit
Confirm that the specified ACH deposit is a payroll deposit.
Output:ConfirmPayrollDepositPayload
Input Arguments
input: ConfirmPayrollDepositInput!
confirmRequestedIdentityUpdate
Confirms the RequestedIdentityUpdate. The individual or business has acknowledged the accuracy and correctness of the supplied information.
Input Arguments
confirmVerificationOfCreditProductApplicationForFraudAlert
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
Input Arguments
createAccountHolderCardProductApplication
Create a new card product application for an AccountHolder.
Input Arguments
createAccountSpendRule
Creates a new spend rule that specifies which accounts are either allowed or blocked.
Input Arguments
input: CreateAccountSpendRuleInput!
createAccountTransactionCountSpendRule
Creates a AccountTransactionCountSpendRule that limits the number of transactions on an account.
Input Arguments
createAmountLimitSpendRule
Creates a new spend rule that limits the amount of authorizations.
Input Arguments
createAuthorizedUserCardProductApplication
Create a new card product application for an AuthorizedUser.
Input Arguments
Input Arguments
input: CreateBusinessInput!
createCardDataInputCapabilitySpendRule
Creates a CardDataInputCapabilitySpendRule that allows or blocks a CardDataInputCapability.
Input Arguments
createCardPaymentDisputeEvidenceUploadLink
Mints a secure upload URL for one evidence file on a CardPaymentDispute
evidence upload session. Any evidenceType is accepted.
Input Arguments
Input Arguments
input: CreateCardProductInput!
createCardProductCreditPlan
Create a CreditPlan for a CardProduct based on a CreditPlanTemplate. For plans with a CreditBalanceType of INSTALLMENT, please use createCardProductInstallmentCreditPlan.
Input Arguments
createCardProductInstallmentCreditPlan
Create a CreditPlan with a CreditBalanceType of INSTALLMENT for a CardProduct based on a CreditPlanTemplate.
Input Arguments
createCardProductWithTemplate
Creates a card product from a template.
Note: This feature is only available in the TEST environment.
Input Arguments
createCardTransactionProcessingTypeConditionSpendRule
Creates a CardTransactionProcessingTypeConditionSpendRule that allows or blocks a CardTransactionProcessingType.
Output:CreateCardTransactionProcessingTypeConditionSpendRulePayload
Input Arguments
createChargeCreditCardProductConfiguration
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.
Input Arguments
createCheckPaymentDocumentUploadSession
Creates a document upload session for check documents.
Input Arguments
createConditionalRuleSetSpendRule
Creates a ConditionalRuleSetSpendRule that combines the results of multiple spend rules.
Input Arguments
createCountLimitSpendRule
Creates a new spend rule that limits the number of allowed transactions.
Input Arguments
createCreditLimitChangeRequest
Create a CreditLimitChangeRequest, to track status and ultimately decision it.
Input Arguments
createCreditLimitPercentageSpendRule
Creates a CreditLimitPercentageSpendRule that limits the amount a transaction can be authorized for to a percentage of the credit limit.
Input Arguments
createCVVSpendRule
Creates a new spend rule that specifies if the result of a CVV check should be approved or declined.
Output:CreateCVVSpendRulePayload
Input Arguments
input: CreateCVVSpendRuleInput!
createDaysWithinAccountCreateDateSpendRule
Creates a DaysWithinAccountCreateDateSpendRule that allows for spending up to a specified number of days since the create date of the card's FinancialAccount.
Input Arguments
createDaysWithinCardCreateDateSpendRule
Creates a DaysWithinCardCreateDateSpendRule that allows for spending up to a specified number of days since the create date of the PaymentCard.
Input Arguments
createDepositAmountLimitSpendRule
Creates a DepositAmountLimitSpendRule that limits the amount of authorizations.
Input Arguments
createDepositCountLimitSpendRule
Creates a new DepositCountLimitSpendRule that limits the number of authorizations.
Input Arguments
createDepositProcessingNetworkSpendRule
Creates a new DepositProcessingNetworkSpendRule which allows or blocks an ATM processing network.
Input Arguments
createDocumentUploadLink
Create a link to upload a document to Highnote.
Input Arguments
createEndCustomer
Create an EndCustomer, the party a reusable payment method is vaulted against.
Output:CreateEndCustomerPayload
Input Arguments
input: CreateEndCustomerInput!
Input Arguments
input: CreateGlobalNoteInput!
createMastercardFraudScoreSpendRule
Creates a MastercardFraudScoreSpendRule that limits the acceptable Mastercard Fraud Score for transactions.
Input Arguments
createMaximumAmountVarianceOnCreditLimitSpendRule
Creates a MaximumAmountVarianceOnCreditLimitSpendRule that allows transactions up to a specified Amount over the credit limit.
Output:CreateMaximumAmountVarianceOnCreditLimitSpendRulePayload
Input Arguments
createMaximumAmountVarianceOnPseudoBalanceSpendRule
Creates a MaximumAmountVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified Amount above the account's original balance.
Output:CreateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload
Input Arguments
createMaximumPercentVarianceOnCreditLimitSpendRule
Creates a MaximumPercentVarianceOnCreditLimitSpendRule that allows transactions up to a specified percentage over the credit limit.
Output:CreateMaximumPercentVarianceOnCreditLimitSpendRulePayload
Input Arguments
createMaximumPercentVarianceOnPseudoBalanceSpendRule
Creates a MaximumPercentVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified percentage over the account's original balance.
Output:CreateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload
Input Arguments
createMerchantCategorySpendRule
Creates a new spend rule that specifies the merchant categories that are either allowed or blocked during authorizations.
Input Arguments
createMerchantCountrySpendRule
Creates a new spend rule that specifies the merchant countries that are either allowed or blocked during authorizations.
Input Arguments
createMerchantIdentifierSpendRule
Creates a new spend rule that specifies which merchant identifiers (MIDs) are either allowed or blocked.
Input Arguments
createMinimalUSBusinessAccountHolder
Create a new USBusinessAccountHolder with minimal information.
Note: The following mutation may not be sufficient for your CardProduct.
Input Arguments
createMinimumAmountLimitSpendRule
Creates a MinimumAmountLimitSpendRule that only allows transactions for a specified amount.
Input Arguments
createOneTimeACHTransfer
Create a one time ACH transfer between financial accounts.
Input Arguments
createPanEntryModeSpendRule
Creates a PanEntryModeSpendRule that allows or blocks a PanEntryMode.
Input Arguments
Input Arguments
input: CreatePaymentOrderInput!
createPhysicalCardGroupOrder
Creates a new group order that can be used to ship multiple physical cards to the same location.
Input Arguments
createPhysicalCardGroupOrderWithValidatedAddressDeprecated
Creates a new group order that can be used to ship multiple physical cards to the same validated address.
Use `createPhysicalCardGroupOrderWithValidatedAddressToken` instead.
Input Arguments
createPhysicalCardGroupOrderWithValidatedAddressToken
Creates a new group order that can be used to ship multiple physical cards to the same validated address.
Input Arguments
createPointOfServiceCategorySpendRule
Creates a new spend rule that specifies which Point of Service (POS) categories are either allowed or blocked.
Input Arguments
createPostalCodeVerificationSpendRule
Creates a new spend rule that specifies which address verification postal codes are either allowed or blocked.
Input Arguments
createPricingPlan
Creates a new PricingPlan for a specific entity with the provided rules.
New plans are created in a DRAFT state by default.
Output:CreatePricingPlanPayload
Input Arguments
input: CreatePricingPlanInput!
The input details for the pricing plan.
createRecurringACHTransfer
Create a recurring ACH transfer between financial accounts.
Input Arguments
createReusablePaymentMethodToken
Create a reusable payment method from a tokenized payment method.
Input Arguments
createRevolvingCreditCardProductConfiguration
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.
Input Arguments
createRewardDefaultEarnRule
Creates a new RewardDefaultEarnRule.
Input Arguments
createRewardMerchantCategoryEarnRule
Creates a new RewardMerchantCategoryEarnRule.
Input Arguments
createRewardPointsAdjustment
Manually Deduct reward points from reward point balance.
Output:RewardPointsTransferPayload
Input Arguments
createRewardRedemptionConfiguration
Creates a new RewardRedemptionConfiguration.
Input Arguments
Input Arguments
input: CreateSecretAPIKeyInput!
createStreetAddressSpendRule
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.
Input Arguments
createUnifiedFundsTransferQuote
Starts the process by creating a UnifiedFundsTransferQuote, which the end user can then accept.
Once the quote is accepted, call initiateUnifiedFundsTransfer with the UnifiedFundsTransferQuote.id to initiate the transfer.
Input Arguments
createUSBusinessAccountHolder
Create a new USBusinessAccountHolder.
Input Arguments
createUSBusinessAccountHolderFromToken
Create a new USBusinessAccountHolder from tokenized data.
Input Arguments
Input Arguments
input: CreateUserDefinedFieldInput!
createUserDefinedFieldDefinition
Creates a UserDefinedFieldDefinition.
Input Arguments
createUSPersonAccountHolder
Create a new USPersonAccountHolder.
Input Arguments
createUSPersonAccountHolderFromToken
Create a new USPersonAccountHolder from tokenized data.
Input Arguments
createUSPersonAuthorizedUser
Create a new USPersonAuthorizedUser.
Input Arguments
createUSPersonAuthorizedUserFromToken
Create a new USPersonAuthorizedUser from tokenized data.
Input Arguments
Input Arguments
input: CreateVelocityRuleInput!
createVisaRiskScoreSpendRule
Creates a VisaRiskScoreSpendRule that limits the acceptable Visa Risk Score for transactions.
Input Arguments
createWallet
Create a Wallet funded by a FinancialAccount, with a WalletPaymentMethod that can be charged.
The Wallet belongs to the organization that makes the request. A Wallet can be created only from a FinancialAccount in a program Highnote has enabled for Wallets; a request for a FinancialAccount in any other program is refused with the UserError code WALLET_CREATION_NOT_CONFIGURED.
Possible UserError codes
INVALID_FUNDING_SOURCE:fundingSourcesis omitted, is empty or has more than one entry; or theFinancialAccountdoes not exist in your organization, is not active, or cannot fund aWallet. NoWalletPaymentMethodis created.FINANCIAL_ACCOUNT_ALREADY_HAS_WALLET: TheFinancialAccountalready funds aWallet, and your organization may fund only oneWalletfrom eachFinancialAccount. NoWalletPaymentMethodis created.FINANCIAL_ACCOUNT_RELEASE_PENDING: TheFinancialAccountis being released from aWalletwhose creation failed, and your organization may fund only oneWalletfrom eachFinancialAccount. Nothing is created. Send the request again shortly with the sameidempotencyKey. If the request is still refused this way after a few minutes, contact Highnote support.INVALID_END_CUSTOMER: The request names anEndCustomer. Naming one is not accepted yet: send the request withoutendCustomerId, and anEndCustomeris created for theWallet. Nothing is created.WALLET_CREATION_IN_PROGRESS: TheWalletis still being created. Send the request again with the sameidempotencyKeyto receive theWallet.IDEMPOTENCY_KEY_REUSED: TheidempotencyKeywas already used for a different request, for example one with a different funding source. A key can be used for one request across all of your organizations, so a request from another of your organizations with the same key is also refused this way. NoWalletPaymentMethodis created. Send this request with a newidempotencyKey.IDEMPOTENCY_KEY_NOT_A_UUID: TheidempotencyKeyis not a UUID of version 1 to 8 with the RFC 9562 variant, in its canonical 36-character form with hyphens, or is the nil or max UUID. Nothing is created. Send the request with such a UUID as itsidempotencyKey.VALUE_REQUIRED: TheidempotencyKeyis empty or contains only whitespace. Nothing is created.VALUE_TOO_LONG: TheidempotencyKeyis longer than 255 characters. Nothing is created.WALLET_CREATION_FAILED: TheWalletcould not be created under thisidempotencyKey. Send the request again with a newidempotencyKey.WALLET_CREATION_NOT_CONFIGURED: Creating aWalletis not configured for your program. NoWalletPaymentMethodis created. Contact Highnote support. Once it is configured, send the request again with a newidempotencyKey.
Output:CreateWalletPayload
Input Arguments
input: CreateWalletInput!
deactivateCollaborativeAuthorizationEndpoint
Deactivate a CollaborativeAuthorizationEndpoint.
Input Arguments
deactivateNotificationTarget
Deactivates a notification target.
Input Arguments
input: DeactivateNotificationTargetInput!
The input to deactivate a notification target.
Input Arguments
input: DeleteCustomFieldsInput!
Input Arguments
input: DeleteSpendRuleInput!
Input Arguments
input: DeleteVelocityRuleInput!
denyCreditLimitDecrease
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.
Input Arguments
denyCreditLimitIncrease
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.
Input Arguments
denyCreditProductApplicationUnderwriting
Deny a credit-based AccountHolderCardProductApplication.
Input Arguments
detachCardProductVelocityRule
Detach a VelocityRule from a CardProduct
Input Arguments
detachFeeScheduleFromFinancialAccount
Detach a FeeSchedule from a FinancialAccount.
Detaching closes the period in which the fee schedule applies to the account. From then on, the
account is charged according to its CardProduct's fee schedule. Detaching a FeeSchedule that is
no longer attached returns the FinancialAccount and changes nothing.
Input Arguments
detachPaymentCardVelocityRule
Detach a VelocityRule from a PaymentCard
Input Arguments
detachRealtimeRiskRuleFromCardProduct
Detaches, or removes, a realtime risk rule from the given Card Product. The risk rule will not be evaluated for future authorizations on a payment card issued under the card product.
Input Arguments
detachRealtimeRiskRuleFromFinancialAccount
Detaches, or removes, a realtime risk rule from the given Financial Account. The risk rule will not be evaluated for future authorizations.
Input Arguments
detachRealtimeRiskRuleFromPaymentCard
Detaches, or removes, a realtime risk rule from the given Payment Card. The risk rule will not be evaluated for future authorizations.
Input Arguments
detachSpendRuleFromCardProduct
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.
Input Arguments
detachSpendRuleFromFinancialAccount
Detaches, or removes, a spend rule from the given FinancialAccount. The spend rule will not be evaluated for future authorizations.
Input Arguments
detachSpendRuleFromPaymentCard
Detaches, or removes, a spend rule from the given Payment Card. The spend rule will not be evaluated for future authorizations.
Input Arguments
detachVelocityRuleFromFinancialAccount
Detach a VelocityRule from a FinancialAccount
Input Arguments
disableAuthorizedUserFeature
Disable the authorized user feature for a CardProduct.
Input Arguments
enableAuthorizedUserFeature
Enable the authorized user feature for a CardProduct.
Input Arguments
enableCollaborativeApplicationUnderwritingFeature
Enable the Collaborative Application Decisioning feature for a CardProduct.
This feature is available for credit products: COMMERCIAL_CREDIT, COMMERCIAL_CREDIT_PAY_IN_FULL,
CONSUMER_CREDIT and FLEET.
If this feature is enabled, every application waits for you to submit the underwriting decision through the
API, and remains pending until then.
Output:EnableCollaborativeApplicationUnderwritingFeaturePayload
Input Arguments
enableCollaborativeAuthorizationFeature
Enable the collaborative authorization feature for a CardProduct.
Input Arguments
enableCreditCardFeature
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.
Input Arguments
enableOnDemandFundingFeature
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.
Input Arguments
endDocumentUploadSession
Ends the session. The session no longer accepts additional files to be uploaded.
Input Arguments
forceCapturePaymentTransaction
Force Captures a payment.
A payment authorized with a WalletPaymentMethod cannot be force captured, and nothing is captured. The request is refused with REQUIRES_SUPPORTED_PROCESSOR, or with the code capturePaymentTransaction answers for the payment's state, such as REQUIRES_APPROVED_AUTHORIZATION for a declined authorization. To capture an open wallet authorization, use capturePaymentTransaction.
Input Arguments
forceStandaloneCapturePayment
Standalone force-capture for an arbitrary amount with no prior authorization. Restricted to allowlisted organizations. Emits a clearing-only forced-post entry; no real-time auth message is sent to the network. Visa and Mastercard only.
Input Arguments
generateAppleWebPushProvisioningToken
Generate a JWT token for Apple Pay Web Push Provisioning session initiation.
Input Arguments
generateBusinessAccountHolderClientToken
Generate a token for use in a client-side integration to manage a business account holder.
Expiry: 15 minutes
Input Arguments
generateCreateScheduledTransferClientToken
Generate a token for use in a client-side integration to create a scheduled transfer.
Expiry: 15 minutes
Input Arguments
generateDirectDepositDetailClientToken
Generate a token for use in a client-side integration for a specific Financial Account Direct Deposit Details.
Expiry: 15 minutes
Input Arguments
generateDocumentUploadClientToken
Generate a token for use in a client-side integration to orchestrate document uploads.
Expiry: 15 minutes
Input Arguments
generateExternalBankAccountDetailClientToken
Generate a token for use in a client-side integration for a specific Financial Account Direct Deposit Details.
Expiry: 15 minutes
Input Arguments
generateFinancialAccountSingleUseClientToken
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.
Input Arguments
generateInitiateSecureDepositClientToken
Generate a token for use in a client-side integration to initiate a secure deposit.
Expiry: 15 minutes
Input Arguments
generatePaymentCardClientToken
Generate a token for use in a client-side integration for a specific Payment Card.
Expiry: 15 minutes
Input Arguments
generatePaymentMethodTokenizationClientToken
Generate a client token for use in the Secure Inputs SDK when tokenizing a payment method.
Expiry: 30 minutes
Input Arguments
generatePersonAccountHolderClientToken
Generate a token for use in a client-side integration to manage a person account holder.
Expiry: 15 minutes
Input Arguments
generatePersonAuthorizedUserClientToken
Generate a token for use in a client-side integration to manage a person authorized user.
Expiry: 15 minutes
Input Arguments
generateRiskApplicationSDKSessionToken
Generate risk application sdk session token
Input Arguments
generateScheduledTransferClientToken
Generate a token for use in a client-side integration for a scheduled transfer.
Expiry: 15 minutes
Input Arguments
generateSecureDepositClientToken
Generate a token for use in a client-side integration for a secure deposit.
Expiry: 15 minutes
Input Arguments
generateTokenizeAccountHolderClientToken
Generate a token to tokenize input for a new account holder.
The resulting token can be used with createUSPersonAccountHolderFromToken
Expiry: 15 minutes
generateTokenizeAuthorizedUserClientToken
Generate a token to tokenize input for a new authorized user.
The resulting token can be used with createUSPersonAuthorizedUserFromToken
Expiry: 15 minutes
generateVerifiedExternalBankAccountLinkToken
Generate a token for account holder to link external bank accounts
Input Arguments
incrementalAuthorizePaymentTransaction
Incrementally authorizes an existing PaymentTransaction, increasing its authorized amount.
Input Arguments
initiateAchTransfer
Push or pull funds between a Highnote FinancialAccount and an external financial account
(ExternalFinancialBankAccount or NonVerifiedExternalUSFinancialBankAccount) via ACH transfer.
Output:InitiateAchTransferPayload
Input Arguments
input: InitiateAchTransferInput!
initiateAcquiringThreeDSecureAuthentication
Initiates a 3-D Secure authentication session for a stored PaymentMethodToken
(credential.paymentMethodTokenId) or a card supplied directly with the session token from the
data-exchange leg (credential.paymentCardCredential). Cardholder-Initiated Transactions (CIT) only — browser fingerprint is required,
collected via DDC and posted by the cardholder browser between
initiateAcquiringThreeDSecureDataExchange and this call. Outcome can be frictionless SUCCESS,
step-up CHALLENGE, or FAIL. Merchant-Initiated (3RI) authentication is handled internally by
Highnote's transaction layer and is not exposed via GraphQL.
Input Arguments
initiateAcquiringThreeDSecureDataExchange
Begins a 3-D Secure authentication by returning the Device Data Collection (DDC) credentials
the cardholder's browser must post before calling
initiateAcquiringThreeDSecureAuthentication. Supply the card either as a stored
PaymentMethodToken (credential.paymentMethodTokenId) or directly (credential.paymentCard);
the response carries a threeDSecureSessionToken whose id threads through the subsequent
authentication legs.
Input Arguments
initiateAddWiredFundsToFinancialAccount
Initiate add funds to a FinancialAccount via wire.
Output:InitiateAddWiredFundsPayload
Input Arguments
initiateCardPaymentDisputeEvidenceUpload
Opens a new document upload session for the active stage of a CardPaymentDispute
and makes it the stage's session. Every call starts the stage's evidence over:
files uploaded to an earlier session are not submitted, and an earlier session
that holds files is closed. Call it once, upload every file to the returned
session, then call submitCardPaymentDisputeEvidence. Upload URLs are minted
per file via createCardPaymentDisputeEvidenceUploadLink.
Input Arguments
initiateCustomerCardTransactionDispute
Initiate PaymentCardTransactionDispute on a valid card transaction event.
Input Arguments
initiateFinancialAccountCreditLimitUpdateFromProductFunding
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
Input Arguments
initiateFinancialAccountPseudoBalanceUpdateDeprecated
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.
Use updatePseudoBalance instead.
Input Arguments
initiateFundPaymentCardFinancialAccountTransferDeprecated
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
Input Arguments
initiateOnDemandPricingCharge
Initiates an on-demand pricing charge to an acquiring entity (ISO, merchant, payfac). The payee is derived from the API key used to make the request.
Input Arguments
input: InitiateOnDemandPricingChargeInput!
The input details for the on-demand pricing charge.
initiateOrganizationReport
Initiates an asynchronous operation to generate a report for an Organization.
Input Arguments
initiatePayrollAdvance
Move funds from an employer FinancialAccount to an employee FinancialAccount as a payroll advance.
Requires the following FinancialAccountFeatureTypes to be enabled:
PayrollEmployerAdvanceFinancialAccountFeatureon the employerFinancialAccountPayrollAdvanceFinancialAccountFeatureon the employeeFinancialAccount
Input Arguments
input: InitiatePayrollAdvanceInput!
initiatePhysicalCheckPayment
Initiate the process of sending a physical check.
Input Arguments
initiateTransferBetweenFinancialAccounts
Transfer funds between FinancialAccounts.
-
When the transfer purpose is
REWARDorEARNED_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_REVERSALorEARNED_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.
Input Arguments
initiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccount
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
Input Arguments
initiateTransferFromPaymentCardFinancialAccountToFundingFinancialAccount
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
Input Arguments
initiateUnifiedFundsTransfer
Accepts a UnifiedFundsTransferQuote initiating the transfer process. OFAC checks are run on the sender and receiver when a UnifiedNetworkTransfer (or Instant Payment) is initiated.
Input Arguments
initiateUnloadWiredFundsFromFinancialAccount
Initiate unloading funds from a FinancialAccount via wire.
Input Arguments
initiateUSBusinessAuthorizedPersonRequestedIdentityUpdate
Initiate the request to modify a USBusinessAuthorizedPerson.
Output:InitiateUSBusinessAuthorizedPersonRequestedIdentityUpdatePayload
Input Arguments
initiateUSBusinessProfileRequestedIdentityUpdate
Initiate the request to modify a USBusinessProfile.
Output:InitiateUSBusinessProfileRequestedIdentityUpdatePayload
Input Arguments
initiateUSBusinessUltimateBeneficialOwnerRequestedIdentityUpdate
Initiate the request to modify a USBusinessUltimateBeneficialOwner.
Output:InitiateUSBusinessUltimateBeneficialOwnerRequestedIdentityUpdatePayload
Input Arguments
initiateUSPersonAccountHolderRequestedIdentityUpdate
Initiate the request to modify a USPersonAccountHolder.
Output:InitiateUSPersonAccountHolderRequestedIdentityUpdatePayload
Input Arguments
Input Arguments
input: InviteUserInput!
issueEmployerFinancialAccountForCardProduct
Issue an Employer Financial Account against a Product.
Input Arguments
issueFinancialAccountForApplication
Issue a new Payment Card against an Account Holder Application.
Input Arguments
issueFinancialAccountForApplicationWithOnDemandFundingSource
Issue a new Financial Account with an on-demand funding source.
Output:IssueFinancialAccountForApplicationWithOnDemandFundingSourcePayload
Input Arguments
issueFundingFinancialAccountForApplication
Issue a new Funding Financial Account against an Account Holder Application.
Input Arguments
issuePaymentCardForApplication
Issue a new Payment Card against an Account Holder Application.
The billing address used for address verification (AVS) on the new card is the Account Holder's billing address at the time the card is issued. To issue the card with a different address, update the Account Holder's billing address first. That update also changes the billing address on the Account Holder's existing cards.
Input Arguments
issuePaymentCardForApplicationWithOnDemandFundingSource
Issue a new Payment Card against an Account Holder Application with an on-demand funding source.
The billing address used for address verification (AVS) on the new card is the Account Holder's billing address at the time the card is issued. To issue the card with a different address, update the Account Holder's billing address first. That update also changes the billing address on the Account Holder's existing cards.
Output:IssuePaymentCardForApplicationWithOnDemandFundingSourcePayload
Input Arguments
issuePaymentCardForAuthorizedUserApplication
Issue a new Payment Card against an authorized user application.
The billing address used for address verification (AVS) on the new card is the authorized user's billing address at the time the card is issued. To issue the card with a different address, update the authorized user's billing address first. That update also changes the billing address on the authorized user's existing cards.
Input Arguments
issuePaymentCardForFinancialAccount
Issue a new Payment Card against a Financial Account.
The billing address used for address verification (AVS) on the new card is the card holder's billing address at the time the card is issued: the account holder's, or the authorized user's for a card on an authorized user's financial account. To issue the card with a different address, update that billing address first. That update also changes the billing address on the card holder's existing cards.
Input Arguments
issuePaymentCardPcvv
Issue a Dynamic Platform CVV for a PaymentCard: a security code the cardholder gives in place of the card's static security code on a card-not-present purchase. The code is valid for a limited time, or until it is replaced, and can be limited to a number of uses, a maximum amount, merchant categories and merchants. The card's pcvvSettings give the defaults and the bounds.
The response carries the code's id, expiry, use limit and restrictions, not its value. Read the value from the card's restrictedDetails.pcvvs while the code is accepted. Whenever the call returns no payload, an entry in the top-level errors of the response, or no response at all, the code may still have been issued: read restrictedDetails.pcvvs before issuing again.
Returns a UserError when:
- no card with
paymentCardIdexists for the caller; - the card's
pcvvSettingshasenabledset tofalse; - Dynamic Platform CVVs are not available yet for the card, and no code was issued;
- the card's Dynamic Platform CVV settings cannot be determined from its card product's setup;
validitySeconds,maxUseCountoroverlapSecondsis outside the card's bounds,overlapSecondsis set withoutOVERLAP, orexpiresisfalsewhere non-expiring codes are not allowed;rotationisKEEPand the card already hasmaxActiveCountaccepted codes;- the call uses a client token generated for a different card;
- the call uses a client token that names no card for reading restricted details, such as one generated for card management or fulfillment;
- the call uses a client token and the code would end or shorten a code already accepted on the card; a client token can only add a code while the card has room for it;
- a restriction is not valid: an empty list; more than 100 merchant category codes across
merchantCategoriesandmerchantCategoryCodes, counting every code each category stands for and every repeat; a merchant category code that is not four digits; more than 100merchantIdentifiers, counting repeats, or one that is blank or longer than 255 characters; or a maximum amount of zero or in a currency other than the card's billing currency.
Returns an AccessDeniedError when the caller may not read this card's restricted details, including a client token generated only to set the card's PIN.
Can be called with an API key, or with a client token generated by generatePaymentCardClientToken for this card with the READ_RESTRICTED_DETAILS permission.
Output:IssuePaymentCardPcvvPayload
Input Arguments
input: IssuePaymentCardPcvvInput!
The code to issue.
issuePreprintedPaymentCardFinancialAccountForApplication
Issues a preprinted payment card financial account for a AccountHolderCardProductApplication.
The billing address used for address verification (AVS) on each card is set when the card is assigned with assignPaymentCardToFinancialAccount.
Output:IssuePreprintedPaymentCardFinancialAccountForApplicationPayload
Input Arguments
onboardBusiness
Onboards a Business for a specific role (third-party agent, merchant, or money movement).
Output:OnboardBusinessPayload
Input Arguments
input: OnboardBusinessInput!
orderPhysicalPaymentCard
Order and ship a payment card to an account holder.
Input Arguments
orderPhysicalPaymentCardForGroup
Order and ship a payment card to an account holder as part of a group order.
Input Arguments
orderPhysicalPaymentCardWithValidatedAddressDeprecated
Order and ship a payment card to an account holder using validated address.
Use `orderPhysicalPaymentCardWithValidatedAddressToken` instead.
Input Arguments
orderPhysicalPaymentCardWithValidatedAddressToken
Order and ship a payment card to an account holder using validated address token.
Input Arguments
provisionAccountHolder
A workflow which provisions an Account Holder
Input Arguments
input: ProvisionAccountHolderInput!
provisionFlexibleCredential
Provisions a FlexibleCredential: creates the backing FinancialAccounts,
issues one primary and zero or more secondary PaymentCards (with per-card
card profile set / BIN selection and per-card expiration), and materializes
the FlexibleCredential parent record and its member card records.
Runs synchronously and returns once provisioning completes. Validation and
provisioning failures surface through the UserError / AccessDeniedError
payload members; a returned ProvisionFlexibleCredentialPayload always
represents a completed request.
Input Arguments
publishPricingPlan
Transitions a PricingPlan from DRAFT to PUBLISHED.
Once published, the plan becomes active and its rules can no longer be modified.
Output:PublishPricingPlanPayload
Input Arguments
input: PublishPricingPlanInput!
The input details for publishing the pricing plan.
Input Arguments
redeemRewardsToFinancialAccount
Redeem reward points accrued and credit the cash value to a separate destination FinancialAccount. The RewardRedemptionConfiguration used must be of type REDEEM_TO_FINANCIAL_ACCOUNT.
Output:RewardPointsTransferPayload
Input Arguments
reevaluateApplication
For a given application that has already been APPROVED, this creates a new, related application using the latest information available for the account holder and runs the card product's reevaluation workflow on it, or the workflow named by productApplicationWorkflowConfigurationId when one is given.
Output:ReevaluateApplicationPayload
Input Arguments
input: ReevaluateApplicationInput!
refundCaptureStep
Refunds a specific capture step on a payment transaction.
When refunding a capture step of a payment made with a WalletPaymentMethod, the result is a WalletRefundStepSummary whose transaction.instrument is the WalletPaymentMethod. A declined refund is answered with a WalletRefundStepSummary, not a UserError: read transaction.responseCode.processorResponseCode. Nothing is refunded.
Output:RefundCaptureStepPayload
Input Arguments
input: RefundCaptureStepInput!
refundPaymentTransaction
Refunds a previously captured payment.
When refunding a payment made with a WalletPaymentMethod, the result is a WalletRefundStepSummary whose transaction.instrument is the WalletPaymentMethod. A declined refund is answered with a WalletRefundStepSummary, not a UserError: read transaction.responseCode.processorResponseCode. Nothing is refunded.
Input Arguments
reissueFlexibleCredentialCards
Reissues the member PaymentCards of a FlexibleCredential and points the
credential at the newly issued cards in one atomic operation. Each card
keeps its default FinancialAccount; reissuing the primary card makes its
replacement the new primary.
scope selects the cards — ALL_MEMBER_CARDS for every member card,
TARGETED for only those listed in targets. The request is
all-or-nothing: if any card fails validation, none are reissued.
Input Arguments
reissuePaymentCard
Issue a new Payment Card against an existing payment card.
Output:ReissuePaymentCardPayload
Input Arguments
input: ReissuePaymentCardInput!
removeCollaborativeAuthorizationEndpoint
Remove a CollaborativeAuthorizationEndpoint.
Input Arguments
removeEmailFromNotificationTarget
Remove the email for a notification target. This mutation is a noop in the test environment.
Input Arguments
input: RemoveEmailFromNotificationTargetInput!
The input to remove the email for a notification target.
Input Arguments
input: RemoveNotificationTargetInput!
The input to delete a notification target.
removeSubscriptionsFromNotificationTarget
Removes subscriptions from a notification target.
Input Arguments
input: RemoveSubscriptionsFromNotificationTargetInput!
The input to remove subscriptions from a notification target.
Input Arguments
input: RemoveUserInput!
renameCollaborativeAuthorizationEndpoint
Rename a CollaborativeAuthorizationEndpoint.
Input Arguments
renameNotificationTarget
Updates the name of an existing notification target.
Input Arguments
input: RenameNotificationTargetInput!
The input to update the name of an existing notification target.
replacePrimaryAuthorizedPerson
Replace the primary authorized person of the Business behind an APPROVED AccountHolderCardProductApplication.
The incoming person is either created in place or an existing person associated with the
business. The outgoing primary authorized person is released from that role and the incoming
person takes it over in a single step; the two never hold the role at the same time. A new
edition of the application is then opened to verify the incoming person's identity. The returned
application is that edition, in PENDING status; poll it for the outcome.
Input Arguments
replayNotificationEvent
Replays a given Notification Event to all subscribing notification targets.
Input Arguments
input: ReplayNotificationEventInput!
The input to replay a Notification Event.
resetPseudoBalance
Resets the pseudo balance for a FinancialAccount to zero.
Output:ResetPseudoBalancePayload
Input Arguments
input: ResetPseudoBalanceInput!
reverseInstallmentAgreement
Reverse an InstallmentAgreement, returning the converted balance to the
standard purchase CreditPlan on the FinancialAccount. Reversal is only
available until the close of the first FinancialAccountStatement that
includes an installment.
Input Arguments
reversePaymentTransaction
Reverses an authorized payment transaction.
The amount is the amount to reverse. When omitted it defaults to the full remaining authorized amount; when supplied it must be greater than zero and no greater than the remaining authorized amount.
Possible UserError codes
INVALID_PAYMENT_ID— No payment was found for the given payment ID.REQUIRES_APPROVED_AUTHORIZATION— The payment has no approved authorization to reverse.REVERSAL_AMOUNT_MUST_BE_POSITIVE— The reversal amount must be greater than zero.REVERSAL_AMOUNT_GREATER_REMAINING_AUTHORIZED_AMOUNT— The reversal amount exceeds the remaining authorized amount.PAYMENT_ALREADY_FINAL_CAPTURED_REVERSAL— The payment is already final-captured and cannot be reversed.PARTIAL_REVERSAL_NOT_SUPPORTED— Partial reversal is not supported for this payment; reverse the full remaining amount.PARTIAL_REVERSAL_NOT_ALLOWED_WITH_CASHBACK— Cash-back payments must be reversed in full.
When reversing a payment authorized with a WalletPaymentMethod, the result is a WalletReversalStepSummary and the reversal releases the whole authorization. Send an idempotencyKey with every wallet reversal: only a repeat under the same key settles a reversal whose outcome is not known. Each of these codes means this request reversed nothing:
PARTIAL_REVERSAL_NOT_SUPPORTED: Theamountis less than the authorization still holds. Omitamount, or send the whole amount.REVERSAL_AMOUNT_MUST_BE_POSITIVE: Theamountis zero, oramountis omitted and the authorization holds nothing more to release.REVERSAL_AMOUNT_GREATER_REMAINING_AUTHORIZED_AMOUNT: Theamountis greater than the authorization still holds.PAYMENT_ALREADY_FINAL_CAPTURED_REVERSAL: The payment was captured, or it is a charge.WALLET_CAPTURE_IN_PROGRESS: A capture of this payment has not been answered yet.
After an earlier reversal of this payment was answered WALLET_REVERSAL_IN_PROGRESS, REVERSAL_AMOUNT_MUST_BE_POSITIVE and REVERSAL_AMOUNT_GREATER_REMAINING_AUTHORIZED_AMOUNT can mean that earlier reversal may already have released the authorization.
WALLET_REVERSAL_IN_PROGRESS means a reversal of this payment has been sent and its outcome is not known yet, so the authorization may already be released. Send that reversal again with its own idempotencyKey to get the outcome; until it is answered, a reversal under any other idempotencyKey is answered WALLET_REVERSAL_IN_PROGRESS. A reversal sent without an idempotencyKey cannot be sent again as the same reversal: each request without a key is a new reversal.
Input validation:
NON_EMPTY_INPUT_REQUIRED(fieldpaymentTransactionId) — the payment transaction ID must not be blank.INVALID_INPUT(fieldpaymentTransactionId) — the payment transaction ID is not a valid ID.
Input Arguments
revokeAPIKey
Revokes an API Key. After revocation, the API Key will be unusable for subsequent requests.
Output:RevokeAPIKeyPayload
Input Arguments
input: RevokeAPIKeyInput!
revokeCardAuthenticationContact
Retire the contact of one kind that is in force on a PaymentCard or a FinancialAccount,
and return it as it stood when it was retired.
Any purpose still open is closed at the same time. Authentication falls back to the account holder's identity record from then on. A later bind starts from no contact in force, so it must supply every purpose it expects again.
Input Arguments
input: RevokeCardAuthenticationContactInput!
The contact to retire.
rotateNotificationTargetSigningKey
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.
Input Arguments
input: RotateNotificationTargetSigningKeyInput!
The ID of the notification target to rotate the signing key for.
setEmailForNotificationTarget
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.
Input Arguments
input: SetEmailForNotificationTargetInput!
The input to set the email for a notification target.
Input Arguments
input: SetPinForPaymentCardInput!
setPseudoLimit
Sets the pseudo balance limit amount for a FinancialAccount.
Output:SetPseudoLimitPayload
Input Arguments
input: SetPseudoLimitInput!
simulateAchTransferProcessing
Simulates processing of an OriginatedAchTransfer or NonOriginatedAchTransfer. The status is updated to PROCESSED.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateAchTransferReturn
Simulates return of an OriginatedAchTransfer or NonOriginatedAchTransfer. The status will be updated to RETURNED.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateAdjustment
Simulate behaviors around a network adjustment in the Test environment.
This operation mirrors Live behavior and allows you to test various scenarios before going live.
Output:SimulateAdjustmentPayload
Input Arguments
input: SimulateAdjustmentInput!
simulateApplicationDocumentReview
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.
Input Arguments
simulateApplicationStatusChange
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.
Input Arguments
simulateApplicationVerificationStatusChange
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.
Input Arguments
simulateAuthorization
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
Input Arguments
input: SimulateAuthorizationInput!
simulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriod
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.
Input Arguments
simulateCardDigitalWalletTokenActivated
Simulate the card digital wallet token activated flow.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateCardDigitalWalletTokenActivation
Simulate the card digital wallet token activation flow.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateCheckbookUserVerification
Simulates a checkbook user KYC verification. Signals the onboarding workflow to proceed with wallet creation. This will only work in test environments.
Input Arguments
simulateCheckPaymentEvent
Simulates a CheckPaymentEvent for an initiated physical check payment. This will only work in the prod-test environment.
Input Arguments
simulateClearing
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
Input Arguments
input: SimulateClearingInput!
simulateCloseFinancialAccount
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.
Input Arguments
simulateCreateAndActivateFeeSchedule
Simulated create new fee schedule in the Highnote test environment.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateCreateApplicationDocumentsUploadSessions
Simulate creating the application documents upload sessions.
Input Arguments
simulateCreateMerchantMatchConfig
Simulates creating a merchant MATCH screening configuration for an acquiring
CardProduct, enabling MATCH screening to trigger during merchant onboarding.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateDeposit
Add funds to an Organization's account in the Highnote test environment.
Output:SimulateDepositPayload
Input Arguments
input: SimulateDepositInput!
simulateDigitalWalletTokenAuthorization
Simulate an authorization using a digital wallet token 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:SimulateAuthorizationPayload
Input Arguments
simulateDigitalWalletTokenFlexibleCredentialAuthorization
Simulate a Visa Flexible Credential authorization using a digital wallet token in the Test environment.
This operation simulates an authorization using a digital wallet token whose underlying primary card is part of a flexible credential, allowing the backend to select an appropriate secondary credential based on transaction context.
Note: This feature is only available in the TEST environment.
Output:SimulateAuthorizationPayload
Input Arguments
simulateDigitalWalletTokenMastercardFleetAuthorization
Simulate the authorization of a Mastercard Fleet transaction using a digital wallet token 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
Input Arguments
simulateDigitalWalletTokenSingleStepAuthAndClear
Simulate a single step authorization and clear using a digital wallet token 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:SimulateAuthAndClearPayload
Input Arguments
simulateDigitalWalletTokenVisaFleetAuthorization
Simulate the authorization of a Visa Fleet transaction using a digital wallet token 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
Input Arguments
simulateExternallyInitiatedACHTransfer
Simulate initiating a new ExternallyInitiatedACHTransfer.
This is only used for testing purposes.
Input Arguments
simulateFinalizeProvisionalCreditForCardTransactionDispute
Simulate finalizing the provisional credit for the card transaction dispute.
Input Arguments
simulateFlexibleCredentialAuthorization
Simulate a Visa Flexible Credential authorization in the Test environment.
This operation simulates an authorization using a primary card of a flexible credential, allowing the backend to select an appropriate secondary credential based on transaction context.
Note: This feature is only available in the TEST environment.
Output:SimulateAuthorizationPayload
Input Arguments
simulateInitiateCardTransactionChargeback
Simulate initiating the chargeback for the card transaction dispute.
Input Arguments
simulateInitiateCardTransactionDispute
Simulate initiating the dispute for the card transaction.
Input Arguments
simulateInitiateFinancialAccountClosure
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.
Input Arguments
simulateIssueCreditForCardTransactionDispute
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.
Input Arguments
simulateIssueProvisionalCreditForCardTransactionDispute
Simulate issuing provisional credit for the card transaction dispute when the disputed amount meets the DisputeChargebackCardProductFeature.chargebackMinimumThreshold.
Input Arguments
simulateIssuerAcceptsFullCardPaymentDispute
Simulates the issuer accepting the CardPaymentDispute in full.
Input Arguments
simulateIssuerAcceptsPartialCardPaymentDispute
Simulates the issuer accepting a CardPaymentDispute in part, with an explicit conceded
(settled) amount. On collaboration disputes the conceded amount is settled and the dispute
closes as won in part; on allocation disputes the partial acceptance is not settled
automatically and the dispute stays open for manual review.
Input Arguments
simulateIssuerFilesPreArbitrationCardPaymentDispute
Simulates the issuer declining the merchant's representment by filing an issuer-initiated
pre-arbitration, opening the acquirer's pre-arbitration-response window. Collaboration
CardPaymentDisputes only.
Input Arguments
simulateIssuerFilesPreArbitrationResponseCardPaymentDispute
Simulates the issuer declining the acquirer's pre-arbitration by filing a pre-arbitration
response, opening the acquirer's arbitration window. Allocation CardPaymentDisputes only.
Input Arguments
simulateIssuerInitiatesCardPaymentDispute
Simulates the issuer initiating a dispute against a captured payment
transaction, creating a new CardPaymentDispute. Available in test
environments only.
Input Arguments
simulateMastercardFleetAuthorization
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
Input Arguments
simulateMastercardFleetAuthorizationAdvice
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.
Input Arguments
simulateMastercardFleetClearing
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
Input Arguments
simulateMastercardFleetEnhancedData
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
Input Arguments
simulateMerchantMatchInReview
Simulates placing an acquiring application's merchant screening into the
IN_REVIEW state, as if the MATCH screening workflow had flagged it.
Note: This feature is only available in the TEST environment.
Output:ProductApplicationPayload
Input Arguments
simulateNonOriginatedAchTransfer
Simulate receiving a new NonOriginatedACHTransfer.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateNonOriginatedFedNowTransfer
Simulate the receipt of an inbound non-originated FedNow credit.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateNonOriginatedRtpTransfer
Simulate the receipt of an inbound non-originated RTP credit.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateNonOriginatedWireTransfer
Simulate the receipt of an inbound wire.
Note: This feature is only available in the TEST environment.
Input Arguments
simulatePhysicalCardGroupOrderApproval
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.
Input Arguments
simulatePhysicalCardGroupOrderSendToPrinter
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.
Input Arguments
simulatePhysicalCardGroupOrderShipmentFailed
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.
Input Arguments
simulatePhysicalCardGroupOrderShipped
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.
Input Arguments
simulatePhysicalPaymentCardOrderApproval
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.
Input Arguments
simulatePhysicalPaymentCardOrderSendToPrinter
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.
Input Arguments
simulatePhysicalPaymentCardOrderShipmentFailed
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.
Input Arguments
simulatePhysicalPaymentCardOrderShipped
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.
Input Arguments
simulatePricingPlan
Simulates pricing calculations for a PricingPlan using provided context data.
The plan can be in any status (PUBLISHED, DRAFT, or ARCHIVED).
Accepts context data as a base64-encoded CSV and returns simulation results as a base64-encoded CSV.
Output:SimulatePricingPlanPayload
Input Arguments
input: SimulatePricingPlanInput!
The input details for the pricing simulation.
simulateProcessedIntegratorInitiatedStatusChange
Change the status of an IntegratorInitiatedACHTransfer from PROCESSING to PROCESSED.
Note: This feature is only available in the TEST environment.
Output:SimulateProcessedIntegratorInitiatedStatusChangePayload
Input Arguments
simulateProcessingExternallyInitiatedStatusChange
Change the status of an ExternallyInitiatedACHTransfer from PENDING to PROCESSING.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateProcessingIntegratorInitiatedStatusChange
Change the status of an IntegratorInitiatedACHTransfer from INITIATED to PROCESSING.
Note: This feature is only available in the TEST environment.
Output:SimulateProcessingIntegratorInitiatedStatusChangePayload
Input Arguments
simulateRefund
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
Input Arguments
input: SimulateRefundInput!
simulateResolvePaymentCardTransactionChargebackDeprecated
Simulate resolving the payment card transaction chargeback for the dispute. If received amount is 0, the chargeback is resolved as a loss.
Use simulateFinalizeProvisionalCreditForCardTransactionDispute instead.
Input Arguments
simulateReturnedIntegratorInitiatedStatusChange
Change the status of an IntegratorInitiatedACHTransfer from PROCESSING to RETURNED.
Note: This feature is only available in the TEST environment.
Output:SimulateReturnedIntegratorInitiatedStatusChangePayload
Input Arguments
simulateReversal
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
Input Arguments
input: SimulateReversalInput!
simulateRolloverCurrentFinancialAccountStatementPeriod
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.
Input Arguments
simulateShiftCurrentFinancialAccountStatementPeriod
Shift the statement end period of the current statement for an account to now.
Note: This feature is only available in the TEST environment.
Input Arguments
simulateSingleStepAuthAndClear
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
Input Arguments
simulateUpdateCardTransactionDispute
Simulate updating the dispute for the card transaction.
Input Arguments
simulateUpdatePaymentCardTransactionChargeback
Simulate updating the payment card transaction chargeback for the dispute. If received amount is 0, the chargeback is resolved as a loss.
Input Arguments
simulateVisaFleetAuthorization
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
Input Arguments
simulateVisaFleetAuthorizationAdvice
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.
Input Arguments
simulateVisaFleetClearing
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
Input Arguments
simulateVisaFleetL3EnhancedData
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.
Input Arguments
startDocumentUploadSession
Initiates a session to allow multiple files to be uploaded.
Input Arguments
submitCardPaymentDisputeEvidence
Finalizes the evidence uploaded to the active stage of a CardPaymentDispute
via the session opened by initiateCardPaymentDisputeEvidenceUpload. Closes
the upload session — no further evidence can be added to the stage afterward.
Input Arguments
suspendCardDigitalWalletToken
Temporarily suspend a card digital wallet token.
Input Arguments
Input Arguments
suspendPaymentCard
Suspend a Payment Card and decline all authorizations until the suspension is lifted.
Output:SuspendPaymentCardPayload
Input Arguments
input: SuspendPaymentCardInput!
terminateCardDigitalWalletToken
Terminate a card digital wallet token.
Input Arguments
tokenizeCardPaymentMethod
Creates a single use payment method from a card.
Input Arguments
tokenizeUSBusinessAccountHolder
Tokenizes data for a new USBusinessAccountHolder.
Input Arguments
tokenizeUSPersonAccountHolder
Tokenizes data for a new USPersonAccountHolder.
Input Arguments
tokenizeUSPersonAuthorizedUser
Tokenizes data for a new USPersonAuthorizedUser.
Input Arguments
Input Arguments
input: TransferFundsInput!
unsuspendCardDigitalWalletToken
Reactivate a suspended card digital wallet token.
Input Arguments
Input Arguments
updateAccountHolderCardProductApplicationOffers
Update non-terminal AccountHolderCardProductApplicationOffer on an AccountHolderCardProductApplication.
Input Arguments
updateAccountSpendRule
Updates an existing spend rule that specifies which accounts are either allowed or blocked.
Input Arguments
input: UpdateAccountSpendRuleInput!
updateAccountTransactionCountSpendRule
Updates a AccountTransactionCountSpendRule that limits the number of transactions on an account.
Input Arguments
updateAmountLimitSpendRule
Updates an existing spend rule that limits the amount of authorizations.
Input Arguments
updateBeneficialOwnership
Change a beneficial owner's percentage ownership of the Business behind an APPROVED AccountHolderCardProductApplication.
The change is applied immediately. No one's identity needs to be verified again, so the returned
application is already APPROVED, keeps the id you sent, and has its reevaluationEdition
incremented. There is nothing to poll, and no application status webhook is sent for this
change: the response is the confirmation. The business, its financial accounts, and its cards
stay attached throughout.
The application's existing consent is kept. If that consent no longer names the business's current primary authorized person, the request is refused; contact Highnote.
Input Arguments
updateCardDataInputCapabilitySpendRule
Updates a CardDataInputCapabilitySpendRule that allows or blocks a CardDataInputCapability.
Input Arguments
Input Arguments
input: UpdateCardProductNameInput!
updateCardTransactionProcessingTypeConditionSpendRule
Updates a CardTransactionProcessingTypeConditionSpendRule that allows or blocks a CardTransactionProcessingType.
Output:UpdateCardTransactionProcessingTypeConditionSpendRulePayload
Input Arguments
updateConditionalRuleSetSpendRule
Updates a ConditionalRuleSetSpendRule that combines the results of multiple spend rules.
Input Arguments
updateCountLimitSpendRule
Updates an existing spend rule that limits the number of allowed transactions.
Input Arguments
updateCreditLimitPercentageSpendRule
Updates a CreditLimitPercentageSpendRule that limits the amount a transaction can be authorized for to a percentage of the credit limit.
Input Arguments
Input Arguments
input: UpdateCustomFieldsInput!
updateCVVSpendRule
Updates an existing spend rule that specifies if the result of a CVV check should be approved or declined.
Output:UpdateCVVSpendRulePayload
Input Arguments
input: UpdateCVVSpendRuleInput!
updateDaysWithinAccountCreateDateSpendRule
Updates a DaysWithinAccountCreateDateSpendRule that allows for spending up to a specified number of days since the create date of the card's FinancialAccount.
Input Arguments
updateDaysWithinCardCreateDateSpendRule
Updates a DaysWithinCardCreateDateSpendRule that allows for spending up to a specified number of days since the create date of the PaymentCard.
Input Arguments
updateDepositAmountLimitSpendRule
Updates a DepositAmountLimitSpendRule that limits the amount of authorizations.
Input Arguments
updateDepositCountLimitSpendRule
Updates a DepositCountLimitSpendRule that limits the number of authorizations.
Input Arguments
updateDepositProcessingNetworkSpendRule
Updates a DepositProcessingNetworkSpendRule which allows or blocks an ATM processing network.
Input Arguments
updateEndCustomer
Update the identity held for an EndCustomer.
Addressed by externalCustomerIdentifier, an update for an identifier that names no customer
creates the customer from this request, for your organization, and returns it with its new id.
Output:UpdateEndCustomerPayload
Input Arguments
input: UpdateEndCustomerInput!
updateFinancialAccountBillingCycleConfiguration
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
Input Arguments
updateFinancialAccountName
Changes the name of a Financial Account.
Input Arguments
updateMastercardFraudScoreSpendRule
Updates a MastercardFraudScoreSpendRule that limits the acceptable Mastercard Fraud Score for transactions.
Input Arguments
updateMaximumAmountVarianceOnCreditLimitSpendRule
Updates a MaximumAmountVarianceOnCreditLimitSpendRule that allows transactions up to a specified Amount over the credit limit.
Output:UpdateMaximumAmountVarianceOnCreditLimitSpendRulePayload
Input Arguments
updateMaximumAmountVarianceOnPseudoBalanceSpendRule
Updates a MaximumAmountVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified Amount above the account's original balance.
Output:UpdateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload
Input Arguments
updateMaximumPercentVarianceOnCreditLimitSpendRule
Updates a MaximumPercentVarianceOnCreditLimitSpendRule that allows transactions up to a specified percentage over the credit limit.
Output:UpdateMaximumPercentVarianceOnCreditLimitSpendRulePayload
Input Arguments
updateMaximumPercentVarianceOnPseudoBalanceSpendRule
Updates a MaximumPercentVarianceOnPseudoBalanceSpendRule that allows for spending up to a specified percentage over the account's original balance.
Output:UpdateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload
Input Arguments
updateMerchantCategorySpendRule
Updates an existing spend rule that specifies the merchant categories that are either allowed or blocked during authorizations.
Input Arguments
updateMerchantCountrySpendRule
Updates an existing spend rule that specifies the merchant countries that are either allowed or blocked during authorizations.
Input Arguments
updateMerchantIdentifierSpendRule
Updates an existing spend rule that specifies which merchant identifiers (MIDs) are either allowed or blocked.
Input Arguments
updateMinimumAmountLimitSpendRule
Updates a MinimumAmountLimitSpendRule that only allows transactions for a specified amount.
Input Arguments
updateOrganizationProfileDisplayName
Update the display name of an organization.
Input Arguments
updatePanEntryModeSpendRule
Updates a PanEntryModeSpendRule that allows or blocks a PanEntryMode.
Input Arguments
updatePointOfServiceCategorySpendRule
Updates an existing spend rule that specifies which Point of Service (POS) categories are either allowed or blocked.
Input Arguments
updatePostalCodeVerificationSpendRule
Updates an existing spend rule that specifies which address verification postal codes categories are either allowed or blocked.
Input Arguments
updatePseudoBalance
Updates the pseudo balance amount for a FinancialAccount.
The amount can be increased or decreased.
Output:UpdatePseudoBalancePayload
Input Arguments
input: UpdatePseudoBalanceInput!
updatePseudoLimit
Updates the pseudo limit amount for a FinancialAccount.
The amount can be increased or decreased.
Output:UpdatePseudoLimitPayload
Input Arguments
input: UpdatePseudoLimitInput!
updateRewardRedemptionConfigurationAttachment
Update a RewardRedemptionConfigurationAttachment. Note: only the effective through date is modifiable.
Input Arguments
updateRewardRuleAttachment
Update a RewardRuleAttachment. Note: only the effective through date is modifiable.
Input Arguments
updateStreetAddressSpendRule
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.
Input Arguments
updateUSAssociatedPersonAccountHolderEmail
Update email for existing USAssociatedPersonAccountHolder.
Input Arguments
updateUSAssociatedPersonAccountHolderHomeAddress
Update address for existing USAssociatedPersonAccountHolder.
Input Arguments
updateUSAssociatedPersonAccountHolderPhone
Update phone for existing USAssociatedPersonAccountHolder.
Input Arguments
updateUSBusinessAccountHolderBillingAddress
Update address for existing USBusinessAccountHolder.
Input Arguments
updateUSBusinessAccountHolderCreditRiskAttribute
Update credit risk attribute for existing USBusinessAccountHolder.
Input Arguments
updateUSBusinessAccountHolderPhone
Update phone for existing USBusinessAccountHolder.
Input Arguments
updateUSBusinessAccountHolderWebsite
Update website for existing USBusinessAccountHolder.
Input Arguments
Input Arguments
input: UpdateUserInput!
Input Arguments
input: UpdateUserDefinedFieldInput!
updateUserDefinedFieldDefinition
Updates a UserDefinedFieldDefinition.
Input Arguments
updateUSPersonAccountHolderBillingAddress
Update billing address for existing USPersonAccountHolder.
Input Arguments
updateUSPersonAccountHolderCreditRiskAttribute
Update credit risk attribute for an existing USPersonAccountHolder.
Input Arguments
updateUSPersonAccountHolderEmail
Update email for existing USPersonAccountHolder.
Input Arguments
updateUSPersonAccountHolderPhone
Update phone for existing USPersonAccountHolder.
Input Arguments
updateUSPersonAuthorizedUserBillingAddress
Update address for existing USPersonAuthorizedUser.
Input Arguments
updateUSPersonAuthorizedUserEmail
Update email for existing USPersonAuthorizedUser.
Input Arguments
updateUSPersonAuthorizedUserPhone
Update phone for existing USPersonAuthorizedUser.
Input Arguments
Input Arguments
input: UpdateVelocityRuleInput!
updateVisaRiskScoreSpendRule
Updates a VisaRiskScoreSpendRule that limits the acceptable Visa Risk Score for transactions.
Input Arguments
Input Arguments
input: ValidateAddressInput!
verifyNetworkToken
Verifies that the NetworkTokenInput is a valid NetworkToken, and able to be used during authorization.
Output:VerifyNetworkTokenPayload
Input Arguments
input: VerifyNetworkTokenInput!
verifyPaymentCard
Verifies that the PaymentCardInput is a valid PaymentCard, and able to be used during authorization.
Output:VerifyPaymentCardPayload
Input Arguments
input: VerifyPaymentCardInput!
verifyPaymentMethodToken
Verifies that the PaymentMethodTokenInput is a valid payment method token, and can be used for authorization.
Input Arguments
waiveFeeTransfer
Waive fee of a fee transfer event.
This will waive fee of already charged fee transfer event.
Output:FeeTransferEventPayload
Input Arguments
input: WaiveFeeTransferInput!
waiveInterestAmountForClosedStatement
Waive full interest for an InterestAssessmentEvent associated with a closed FinancialAccountStatement.