Input

expirationDate: TimestampFilterInput

cardProductId: IDFilterInput

formFactor: CardFormFactorFilterInput

createDate: TimestampFilterInput

updateDate: TimestampFilterInput

customFields: CustomFieldsFilterInput

ACHDescriptorInput

Input for fields describing an ACH transfer.

Output:INPUT_OBJECT

Input Fields

companyEntryDescription: String!

Company entered value for the type of ACH.

It can be at most 10 characters. The characters should be alphanumeric.

individualName: String!

Receiver’s individual name set by the bank initiating the ACH entry.

networkTransactionIdentifier: String

The network transaction id to use for this transaction.

Required, except when intendToStore is false.

intendToStore: Boolean

Indicates that the PaymentCardInput will be stored externally, after the PaymentCardInput has been used in this transaction successfully.

Required, except when networkTransactionIdentifier is provided.

ActivateCardProductCreditPlanInput

Input fields for activating a CreditPlan for a CardProduct.

Output:INPUT_OBJECT

Input Fields

id: ID!

Global id for the CardProduct

effectiveFromDate: Date

The date this plan starts to be in effect for new FinancialAccounts, in YYYY-MM-DD (ISO 8601 RFC 3339) date format. For example, 2023-01-15. Must be in the future. Must be unique across similar CreditPlans for this CardProduct. Optional; if not included, the CreditPlan will be active immediately and this value will be set to the current date.

effectiveThroughDate: Date

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

ActivateCollaborativeAuthorizationEndpointInput

The input to activate a CollaborativeAuthorizationEndpoint.

The input to add a new CollaborativeAuthorizationEndpoint.

Output:INPUT_OBJECT

Input Fields

A name for the CollaborativeAuthorizationEndpoint.

Must be between 1 and 255 characters.

uri: String!

A valid URI to send collaborative authorization requests. The protocol must be included and is required to be https.

Example: https://mywebhook.com

AddExternalBankAccountFromTokenInput

The details to add the bank account for account holder.

Output:INPUT_OBJECT

Input Fields

accountHolderId: ID!

The Global ID of the account holder for whom bank account is added.

AddFundsToPaymentCardInput

The details to add funds to a Payment Card.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the Payment Card to add funds.

amount: AmountInput!

The amount to add to the Payment Card.

memo: String

A description of the transfer for later reference.

AddNonVerifiedExternalUSFinancialBankAccountInput

The information of the US bank account to be added to an account holder that can only be transferred to

Output:INPUT_OBJECT

Input Fields

routingNumber: String!

The routing number of the bank account

accountNumber: String!

The account number of the bank account

An optional nick name for the bank account

accountHolderId: ID!

The identifier of an Account holder

bankAccountType: BankAccountType!

The type of bank account (Checking or Savings)

AddPaymentCardToApplePayByDevicePushProvisioningInput

Input to Provision a PaymentCard to an Apple Pay Eligible Device via Push Provisioning.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the payment card to be push provisioned.

deviceType: PaymentCardDigitalWalletDeviceType!

Specifies the type of device which is initiating the provisioning.

certificates: [String!]!

A Base64-encoded list of certificates.

nonce: String!

A Base64-encoded, one-time use nonce generated by Apple’s servers.

nonceSignature: String!

A Base64-encoded device and account specific signature of the nonce.

AddPaymentCardToGooglePayByDevicePushProvisioningInput

Input to Provision a PaymentCard to a Google Pay Eligible Device via Push Provisioning.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the payment card to be push provisioned.

deviceType: PaymentCardDigitalWalletDeviceType!

Specifies the type of device which is initiating the provisioning.

displayName: String

Display Name describes the Payment Card in the user interface. Highnote can return this value in the response which the Subscriber’s mobile app can override before calling pushTokenize on the wallet app. If not provided, Highnote will leverage the name of the product.

walletDetails: WalletDetailsInput

Token provisioning wallet details.

AddressFilterInput

Input for filtering by Address.

Output:INPUT_OBJECT

Input Fields

locality: StringFilterInput

region: StringFilterInput

countryCodeAlpha3: ISO3166Alpha3Country

postalCode: StringFilterInput

streetAddress: StringFilterInput

extendedAddress: StringFilterInput

AddressInput

Input representing the parts of an address.

Output:INPUT_OBJECT

Input Fields

streetAddress: String!

The number and street of the address.

The validation for the address uses the following regex pattern ^\s*\S+(?:\s+\S+){1,3}.

This pattern matches two to four groups of non-whitespace characters. These can include special characters like dashes or slashes. For example, 'Cozy Cottage', '200 Lake Rd', '123 Second Street NW', and '111 1/2 Center Street' all match.

When the field is used for creating an application, it will also validate that a PO Box is not included using this regex pattern ^(?:((\S([^pPOo])+)|(?:[0-9]+)))\s(?:[0-9A-Za-z\.]|[^\S\r\n])+$.

When the field is used for creating a physical payment card order or physical payment card group order, it will also support mailing to a PO Box using this regex pattern ^(?:(?:(?:\S[^pPOo\r\n]+)|(?:[0-9\/#]+)))\s(?:[0-9A-Za-z\.]|[^\S\r\n])+$|^\b[P|p]*(?:OST|ost)*\.*\s*[O|o|0]*(?:ffice|FFICE)*\.*\s*[B|b][O|o|0][X|x]\s[0-9A-Za-z]+\b$.

extendedAddress: String

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

The validation for the extendedAddress uses the following regex pattern ^[a-zA-Z\d',. \-#]+(([',. \-#\/][a-zA-Z \d])?[a-zA-Z.]*)*$.

It checks for numeric string with special characters and whitespace.

postalCode: String!

The postal code of the address. The value can include 5 numbers only or a hyphen - and 4 numbers

region: String!

A region for the address based on the two letter state IS0 3166 standard, including districts and outlying areas.

locality: String!

The locality of the address (e.g. town, city)

A name for the target.

Must be between 1 and 255 characters.

uri: String!

A valid URI to send notifications. The protocol must be included and is required to be https.

Example: https://mywebhook.com

email: String

The email address to which target deactivation emails are sent. This data is only stored in the live environment. Deactivation emails are not sent in the test environment.

subscriptions: [NotificationEventName!]!

The event names to receive notifications about.

AdverseActionReasonInput

An explanation given as to why the application was denied.

Output:INPUT_OBJECT

Input Fields

code: AdverseActionCodeInput!

The reason why the application was denied.

AmountInput

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

Output:INPUT_OBJECT

Input Fields

value: UnsignedInt!

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

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

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

Currency	Value
USD	1099
JPY	1099
JOD	10990

currencyCode: ISO4217Alpha3SupportedCurrency!

Three-character ISO 4217 currency code

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

AmountStrategyInput

A strategy for allowing amount calculation. Only one of the strategies below should be requested.

Output:INPUT_OBJECT

Input Fields

balanceAmountType: TransferBalanceAmountCode

A calculated balance amount

transferAmount: AmountInput

An amount to be transferred

ApplicationConfigurationInput

The credit limit after the review.

customerDetails: CreditLimitChangeRequestCustomerDetailsInput

Details collected about the customer, such as their current debt obligations and annual income.

ApproveCreditProductApplicationUnderwritingInput

The input for approving a credit-based AccountHolderCardProductApplication.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

Global id of the application

decisionDate: String!

The date and time, in ISO 8601 format, marking when the underwriting decision was made. For example, 2023-01-01T22:00:00.000Z.

standardPurchaseCreditLimit: AmountInput!

Standard purchase credit limit

AssignPaymentCardToFinancialAccountInput

Input values for assignPaymentCardToFinancialAccount

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the PaymentCard to assign to a FinancialAccount.

assignToFinancialAccountId: ID!

The ID of the FinancialAccount to assign the PaymentCard to.

options: AssignPaymentCardToFinancialAccountOptionsInput!

Options for the newly assigned Payment Card.

idempotencyKey: IdempotencyKey

A value to distinguish unique assignPaymentCardToFinancialAccount request.

This helps prevent duplicate cards from being assigned. If a failure happens and it is unclear if the assignment of a card went through, it is safe to repeat the request with the same idempotency key. If the card gas already been assigned to the assignToFinancialAccountId, the request will be deduped and the original response will be returned instead.

Minimum length: 10 characters Maximum length: 255 characters

AssignPaymentCardToFinancialAccountOptionsInput

Options for assigning a PaymentCard to a FinancialAccount.

Output:INPUT_OBJECT

Input Fields

activateOnAssignment: Boolean!

Whether or not to activate the card when assigned to a FinancialAccount. If not activated on assignment, the card must be activated separately before use.

ATMLocationFilterInput

Filters the ATM Locations by available features per location.

Output:INPUT_OBJECT

Input Fields

includes: [ATMLocationFeature!]

ATMLocationRadiusInput

cardProductId: ID!

CardProduct id to attach to.

effectiveFrom: String

The date and time in ISO 8601 format, representing when the attachment should begin taking effect. This should be a date in the future. Optional; if left blank this field will default to the timestamp when the mutation was called.

effectiveThrough: String

The date and time in ISO 8601 format, representing when the attachment should stop taking effect. This should be a date in the future. Leaving this field blank will result in the attachment remaining in effect indefinitely.

AttachRewardRedemptionConfigurationToProductInput

Attach RewardRedemptionConfiguration to CardProduct.

Output:INPUT_OBJECT

Input Fields

redemptionConfiguration: RewardRedemptionConfigurationAttachmentInput!

RewardRedemptionConfiguration to attach to.

cardProductId: ID!

expirationDate: TimestampFilterInput

cardProductId: IDFilterInput

formFactor: CardFormFactorFilterInput

createDate: TimestampFilterInput

updateDate: TimestampFilterInput

AuthorizeNetworkTokenInput

Input for authorizing a NetworkToken.

Output:INPUT_OBJECT

Input Fields

networkToken: NetworkTokenInput!

The NetworkToken to authorize.

cardHolder: CardHolderInput

The cardHolder to associate the NetworkToken with.

amount: AmountInput!

The amount to authorize.

paymentInitiator: AcquiringPaymentInitiator

How the payment was initiated. If the payment was initiated by the customer, include the way in which payment details were given (i.e. via the web, over the phone, by mail, etc). If the payment was merchant initiated, define the reason for the payment (i.e. recurring, installment, etc).

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentCardInput is stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

AuthorizePaymentCardInput

Input for authorizing a PaymentCard.

Output:INPUT_OBJECT

Input Fields

paymentCard: PaymentCardInput!

The PaymentCard to authorize.

cardHolder: CardHolderInput

The cardHolder to associate the PaymentCard with.

amount: AmountInput!

The amount to authorize.

paymentInitiator: AcquiringPaymentInitiator

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentCardInput is stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

AuthorizePaymentMethodTokenInput

Input for authorizing a PaymentMethodToken.

Output:INPUT_OBJECT

Input Fields

paymentMethodTokenId: ID!

The PaymentMethodToken to authorize.

amount: AmountInput!

The amount to authorize.

paymentInitiator: AcquiringPaymentInitiator

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentMethodToken is stored externally.

AVSResponseCodeFilterInput

Input for filtering AVS response code

Output:INPUT_OBJECT

Input Fields

equals: AVSResponseCode

Value matches the provided AVS response code

notEquals: AVSResponseCode

Value does not match the provided AVS response code

includes: [AVSResponseCode!]

Value exactly matches all of the provided AVS response code

excludes: [AVSResponseCode!]

Value does not match any of the provided AVS response code

BillingCycleFilterInput

The input type for filtering BillingCycle.

Output:INPUT_OBJECT

Input Fields

statementPeriodStartOrEndBetween: TimestampFilterInputRange

This filter input accepts a TimestampFilterInputRange including a start and end timestamp in ISO 8601 format. It returns any cycles where the period start or period end is within the provided range (inclusive).

For example, if the provided range is 2023-01-15 to 2023-02-01 it would return a cycle with a period start of 2023-01-01 and a period end of 2023-02-01, in addition to a cycle with period start of 2023-02-01 and a period end of 2023-03-01.

BillingCycleOverrideInput

An override of the default billing cycle type.

Output:INPUT_OBJECT

Input Fields

billingCycleType: BillingCycleType

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

billingGracePeriod: UnsignedInt

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

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

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

Note: values are inclusive, and capped at the max. (eg, if 91 days is provided for a CHARGE product, it will be set to 90 days).

If not provided, the system will use the default billing cycle associated with the product.

BooleanFilterInput

Boolean value type

Output:INPUT_OBJECT

Input Fields

equals: Boolean!

BusinessAccountHolderBusinessNameFilterInput

Input for filtering Business Account Holder's business by name.

legalBusinessName: String!

The business' legal name. Minimum length: 1 character Maximum length: 255 characters

doingBusinessAsName: String

The business' doing business as name.

Minimum length: 1 character Maximum length: 255 characters

BusinessAccountHolderNameUpdateInput

Input representing updatable fields of a BusinessAccountHolder's name.

Output:INPUT_OBJECT

Input Fields

legalBusinessName: String

The business' legal name. Minimum length: 1 character Maximum length: 255 characters

doingBusinessAsName: String

The business' doing business as name.

Minimum length: 1 character Maximum length: 255 characters

BusinessAccountHolderPrimaryAuthorizedAddressFilterInput

Input for filtering by Business Account Holder's Primary Authorized Person's Address.

Output:INPUT_OBJECT

Input Fields

postalCode: StringFilterInput

BusinessAccountHolderPrimaryAuthorizedPersonFilterInput

Inputs for filtering business account holder's primary authorized person.

Output:INPUT_OBJECT

Input Fields

dateOfBirth: DateFilterInput

homeAddress: BusinessAccountHolderPrimaryAuthorizedAddressFilterInput

socialSecurityNumberLast4: HashedFilterInput

socialSecurityNumber: HashedFilterInput

BusinessAccountHolderPrimaryAuthorizedPersonNameFilterInput

Input for filtering Business Account Holders by name. The matching for these name fields are performed using similar sounding scores. e.g. keywords like Mayer, mayer, Mire & Mary will lead to the same score.

Output:INPUT_OBJECT

Input Fields

title: SoundsLikeFilterInput

givenName: SoundsLikeFilterInput

middleName: SoundsLikeFilterInput

familyName: SoundsLikeFilterInput

suffix: SoundsLikeFilterInput

BusinessAccountHolderUltimateBeneficialOwnerFilterInput

Inputs for filtering USBusinessAccountHolders by USBusinessUltimateBeneficialOwner.

Output:INPUT_OBJECT

Input Fields

dateOfBirth: DateFilterInput

homeAddress: UltimateBeneficialOwnerAddressFilterInput

socialSecurityNumberLast4: HashedFilterInput

The type of indicator attribute.

value: Boolean!

The boolean value for this indicator.

reportedAt: String!

The date this attribute was reported, in YYYY-MM-DD format.

CancelPaymentTransactionInput

Input for canceling the remaining authorized amount from a payment transaction.

Output:INPUT_OBJECT

Input Fields

paymentTransactionId: ID!

The payment transaction to cancel the remaining authorized amount.

amount: AmountInput

The amount to cancel.

Defaults to cancel the remaining authorized amount.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

paymentTransactionId: ID!

The payment transaction to capture.

amount: AmountInput

The amount to capture.

Defaults to capture the remaining authorized amount.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. Highnote will use the contractId provided on the paymentTransactionId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

fullName: String

The full name as represented on the card. Minimum length: 1 character Maximum length: 255 characters

email: String

The email address associated with the Card Holder.

billingAddress: AddressInput

The billing address associated with the card.

CardProductApplicationBusinessMetricFilterInput

Used to filter which application metrics are requested.

Output:INPUT_OBJECT

Input Fields

timeRange: TimestampFilterInputRange

Filters application metrics by TimeRange, start and end are inclusive.

cardProductIds: [String!]

Filters application metrics by CardProductId, optional.

CardProductApplicationFilterInput

Inputs for filtering CardProductApplication data.

Output:INPUT_OBJECT

Input Fields

createdAt: TimestampFilterInput

The date and time, in ISO 8601 format, the Card Product Application was created.

updatedAt: TimestampFilterInput

The date and time, in ISO 8601 format, the Card Product Application was last updated.

status: AccountHolderApplicationStateInput

The status of the Card Product Application.

The id of the Card Product Application.

taskGroupReviewCategory: IdentityTaskGroupReviewCategoryFilterInput

The task group review category associated with the Card Product Application.

CardProductApplicationOfferStatusFilterInput

CardProductApplicationOfferStatus filter input

Output:INPUT_OBJECT

Input Fields

includes: [CardProductApplicationOfferStatus!]

CardProductInput

Details about the Card Product to be created.

Output:INPUT_OBJECT

Input Fields

Human-friendly name for the Card Product to be created.

usage: CardUsage!

Whether the cards issued for this product will be MULTI_USE or SINGLE_USE

vertical: CardProductVertical!

The business use case for the Card Product.

CardProductPaymentCardsFilterInput

Inputs for filtering Payment Card data.

Output:INPUT_OBJECT

Input Fields

expirationDate: TimestampFilterInput

accountHolderId: IDFilterInput

formFactor: CardFormFactorFilterInput

createDate: TimestampFilterInput

updateDate: TimestampFilterInput

customFields: CustomFieldsFilterInput

CardProductPaymentCardTransactionChargebacksFilterInput

Input for filtering PaymentCardTransactionChargeback on CardProduct

Output:INPUT_OBJECT

Input Fields

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

externalNetworkId: StringFilterInput

Chargeback externalNetworkId filter

CardProductPaymentCardTransactionDisputesFilterInput

Input for filtering PaymentCardTransactionDispute on CardProduct

Output:INPUT_OBJECT

Input Fields

disputeId: IDFilterInput

Input to filter by PaymentCardTransactionDispute ID.

disputeStatus: PaymentCardDisputeStatusFilterInput

Input to filter by PaymentCardTransactionDispute status.

disputeCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionDispute created date.

disputeHasChargeback: BooleanFilterInput

Input to filter disputes by whether a PaymentCardTransactionDispute has an associated PaymentCardTransactionChargeback.

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

externalNetworkId: StringFilterInput

Chargeback externalNetworkId filter

CardProductTransactionEventsFilterInput

Inputs for filtering transaction events.

Output:INPUT_OBJECT

Input Fields

operationalCurrency: ISO4217Alpha3CurrencyCode

eventType: TransactionEventFilterInput

requestedAmount: MoneyFilterInput

approvedAmount: MoneyFilterInput

responseCode: TransactionEventResponseCodeFilterInput

avsResponseCode: AVSResponseCodeFilterInput

postalCodeResponseCode: PostalCodeResponseCodeFilterInput

cvvResponseCode: CVVResponseCodeFilterInput

transactionType: TransactionTypeFilterInput

paymentCardId: IDFilterInput

cardProductId: IDFilterInput

transactionId: IDFilterInput

createdAt: TimestampFilterInput

updatedAt: TimestampFilterInput

merchantDetails: MerchantDetailsFilterInput

onlyOpenAuthorizations: BooleanFilterInput

Open authorizations events have the following properties:

Are the first transaction event with a particular public transaction identifier. This means they are the first event in a sequence of events with the same public transaction identifier.
Authorization expiration date is not empty and not in the past.
The approved amount has not been fully reversed or cleared to zero by subsequent transaction events with the same public transaction identifier.

authorizationExpiration: TimestampFilterInput

Authorization expiration date

CardProfileSetStatusInput

The input to filter by card profile set status

Output:INPUT_OBJECT

Input Fields

equals: CardProfileSetStatus

Value matches the provided card profile set status.

excludes: [CardProfileSetStatus!]

Value does not match any of the provided card profile set statuses.

includes: [CardProfileSetStatus!]

Value matches any of the provided card profile set statuses.

notEquals: CardProfileSetStatus

Value does not match the provided card profile set status.

ChargeNetworkTokenInput

Input for charging a NetworkToken.

Output:INPUT_OBJECT

Input Fields

networkToken: NetworkTokenInput!

The NetworkToken to charge.

cardHolder: CardHolderInput

The cardHolder to associate the tokenized NetworkToken with.

amount: AmountInput!

The amount to charge.

paymentInitiator: AcquiringPaymentInitiator

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the NetworkTokenInput is or will be stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

ChargePaymentCardInput

Input for charging a PaymentCard.

Output:INPUT_OBJECT

Input Fields

paymentCard: PaymentCardInput!

The PaymentCard to charge.

cardHolder: CardHolderInput

The cardHolder to associate the tokenized PaymentCard with.

amount: AmountInput!

The amount to charge.

paymentInitiator: AcquiringPaymentInitiator

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentCardInput is or will be stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

ChargePaymentMethodTokenInput

Input for charging a PaymentMethodToken.

Output:INPUT_OBJECT

Input Fields

paymentMethodTokenId: ID!

The PaymentMethodToken to charge.

amount: AmountInput!

The amount to charge.

paymentInitiator: AcquiringPaymentInitiator

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

installmentPayment: MerchantManagedInstallmentPaymentInput

Installment payment information for merchant-managed installment payments.

ChargePaymentOrderInput

Input for charging an PaymentOrder.

Output:INPUT_OBJECT

Input Fields

paymentCard: PaymentCardInput!

The payment card to charge.

cardHolder: CardHolderInput

The cardHolder to associate the tokenized payment card with.

orderId: ID!

The ID of the PaymentOrder to charge.

amount: AmountInput

The amount to charge. If not provided, the remaining authorized amount will be charged.

paymentInitiator: AcquiringPaymentInitiator

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentCardInput is or will be stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

ChargePaymentOrderPaymentMethodTokenInput

Input for charging an PaymentOrder via a PaymentMethodToken.

Output:INPUT_OBJECT

Input Fields

orderId: ID!

The PaymentOrder to charge.

amount: AmountInput

The amount to charge. If not provided, the remaining authorized amount will be charged.

paymentMethodTokenId: ID!

The PaymentMethodToken to charge.

paymentInitiator: AcquiringPaymentInitiator

externalCredentialOnFile: AcquiringExternalCredentialOnFileInput

Indicates that the PaymentCardInput is or will be stored externally.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

merchantAcceptorId: ID

Global identifier of the application in question.

verificationResult: VerifiedApplicationFieldsForFraudAlertInput

The AccountHolderCardProductApplication fields that were confirmed. These must all be confirmed in order to move forward with this application. These fields will also be persisted to the AccountHolderCardProductApplication type under the creditReportFraudAlertVerificationResult field.

accountHolderCreditReportPullConsent: ConsentInput

Details on the account holder's consent to pull their credit report as part of the card product application.

applicationConfiguration: ApplicationConfigurationInput

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

CreateAccountSpendRuleInput

The details of the AccountSpendRule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [ID!]

The Account IDs to allow during authorizations.

Min: 1 Max: 5000

authorizedUserId: ID!

The ID of the authorized user.

accountHolderCardProductApplicationId: ID!

The ID of the account holder application linked to this application. Note: The Application must be APPROVED.

financialAccountId: ID!

The ID of the financial account for which the authorized user is applying to use.

ipAddress: IPAddressInput

The IP address details of the authorized user applicant.

cardHolderAgreementConsent: ConsentInput!

Details on the acceptance of terms and conditions of the card holder agreement.

CreateCardDataInputCapabilitySpendRuleInput

The details of the CardDataInputCapabilitySpendRule spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [CardDataInputCapability!]

The CardDataInputCapability values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [CardDataInputCapability!]

The CardDataInputCapability values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateCardProductCreditPlanInput

Create a CreditPlan for a CardProduct based on a CreditPlanTemplate.

Output:INPUT_OBJECT

Input Fields

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

creditPlanTemplateId: ID!

The id for the CreditPlanTemplate to use when creating this CreditPlan. For plans with a CreditBalanceType of INSTALLMENT, please use createCardProductInstallmentCreditPlan.

productId: ID!

The id for the CardProduct to use when creating this CreditPlan.

percentageOfCreditLimit: UnsignedInt!

The percentage of the FinancialAccount's credit limit that will be available for this CreditPlan. Must be an integer value between 0 and 100 inclusive.

defaultApr: Float!

The interest rate (APR) to apply by default for this CreditPlan. Must be a positive floating point number with up to 3 digit precision after the decimal point.

promotionDuration: UnsignedInt

Optional; currently only used for PROMOTIONAL CreditPlans. This represents the number of units this CreditPlan will be in effect for a given FinancialAccount once it is enrolled in this CreditPlan. Units are set at the template level. Currently we only support units of BILLING_CYCLES.

Note: this is different from the effectiveFromDate and effectiveThroughDate on the CreditPlan, which represent the dates where a CreditPlan is active for a CardProduct.

CreateCardProductInput

Top-level input type.

Output:INPUT_OBJECT

Input Fields

cardProduct: CardProductInput!

Details about the Card Product to be created.

CreateCardProductInstallmentCreditPlanInput

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

Output:INPUT_OBJECT

Input Fields

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

creditPlanTemplateId: ID!

The id for the CreditPlanTemplate to use when creating this CreditPlan. Must have a CreditBalanceType of INSTALLMENT.

productId: ID!

The id for the CardProduct to use when creating this CreditPlan.

minimumPrincipalAmount: AmountInput

The minimum cleared Amount a Transaction can have to be eligible to convert into installments. Optional; if included, will be validated against the provided CreditPlanTemplate.

maximumPrincipalAmount: AmountInput

The maximum cleared Amount a Transaction can have to be eligible to convert into installments. Optional; if included, will be validated against the provided CreditPlanTemplate.

numberOfInstallmentPeriods: UnsignedInt!

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

fee: CreditPlanFeeInput

The fee configuration for this CreditPlan.

CreateCardProductWithTemplateCardProductInput

Input values for createCardProductWithTemplate

Output:INPUT_OBJECT

Input Fields

The name of the card product.

sourceTemplateId: ID!

The ID of the card product template to use.

CreateCardProductWithTemplateInput

Input values for createCardProductWithTemplate

Output:INPUT_OBJECT

Input Fields

cardProduct: CreateCardProductWithTemplateCardProductInput!

The card product to create.

CreateCardTransactionProcessingTypeConditionSpendRuleInput

The details of the CardTransactionProcessingTypeConditionSpendRule to create

Output:INPUT_OBJECT

Input Fields

The name of the CardTransactionProcessingTypeConditionSpendRule

allowed: [CardTransactionProcessingType!]

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

blocked: [CardTransactionProcessingType!]

The list of possible CardTransactionProcessingType that will result in a decline. Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateChargeCreditCardProductConfigurationInput

The input type for creating a charge CardProductCreditConfiguration

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The globally unique id for the CreditProduct

accountAgingConfiguration: CreditAccountAgingProductConfigurationInput!

The input type for the account aging configuration available on a CardProduct. For example, the number of days until a payment is due, and until an account is

billingCycleConfiguration: CreditBillingCycleCardProductConfigurationInput!

The billing statement configuration available on a CardProduct.

CreateCheckPaymentDocumentUploadSessionInput

Input object for the createCheckPaymentDocumentUploadSession mutation.

Output:INPUT_OBJECT

financialAccountId: ID!

The identifier for the FinancialAccount to review.

requestedChange: CreditLimitChangeRequestDetailsInput

Details about the CreditLimitChangeRequest.

CreateCreditLimitPercentageSpendRuleInput

The details of the CreditLimitPercentageSpendRule spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

maximumPercentageOfCreditLimit: UnsignedInt!

The maximum percentage of the credit limit allowed for a transaction before transactions are declined. Minimum: 0 Maximum: 100

The ApplicableRuleUserType for which the rule will be evaluated.

CreateCVVSpendRuleInput

The details of the spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [CVVResponseCode!]

The CVVResponseCode values you want to allow during authorizations.

Min: 1 Max: 5000

A name for the rule for future reference.

allowed: [DepositProcessingNetwork!]

The list of possible DepositProcessingNetwork that will be allowed during cash deposits. Min: 1 Max: 5000

blocked: [DepositProcessingNetwork!]

The list of possible DepositProcessingNetwork that will result in declined cash deposits. Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateDocumentUploadLinkInput

The input to generate a secure upload link

Output:INPUT_OBJECT

Input Fields

documentUploadSessionId: ID!

The ID of the document upload session

documentType: DocumentType!

The document type to be uploaded

CreateGlobalNoteInput

The input details of the GlobalNote being created.

Output:INPUT_OBJECT

Input Fields

message: String!

The message for the GlobalNote.

Regex: ^[a-zA-Z\d$ ',.-_!@#$%^&*+=`?"\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF\n]+$ Note has a max length of 2048 characters. For compliance and security reasons, note should not contain any sensitive information, such as PII or PCI.

primaryEntity: GlobalNotePrimaryEntityInput!

The primary entity input for the GlobalNote.

aggregateEntity: GlobalNoteAggregateEntityInput

The aggregate entity input for the GlobalNote.

CreateMastercardFraudScoreSpendRuleInput

The details of the MastercardFraudScoreSpendRule spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

A name for the rule for future reference.

allowed: [MerchantCategory!]

The merchant categories that will be allowed during authorizations.

Min: 1 Max: 5000

blocked: [MerchantCategory!]

The merchant categories that will result in declined authorizations.

Min: 1 Max: 5000

allowedMcc: [String!]

The merchant category codes that will be allowed during authorizations.

Min: 1 Max: 5000

blockedMcc: [String!]

The merchant category codes that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateMerchantCountrySpendRuleInput

The details of the spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [ISO3166Alpha3Country!]

The merchant countries that will be allowed during authorizations.

Min: 1 Max: 5000

blocked: [ISO3166Alpha3Country!]

The merchant countries that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateMerchantIdentifierSpendRuleInput

The details of the spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [String!]

The merchant identifiers you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [String!]

The merchant identifiers you want to block during authorizations.

Matching values will result in a declined authorization.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateMinimalUSBusinessAccountHolderInput

The input for creating a minimal USBusinessAccountHolder

Output:INPUT_OBJECT

Input Fields

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Minimum length: 5 characters Maximum length: 255 characters

primaryAuthorizedPerson: MinimalUSAuthorizedPersonInput!

The details of the person authorized to act on behalf of business.

businessProfile: MinimalUSBusinessProfileInput!

The details of the business.

externalId: String

An ID representing this account holder in an external system. Provide this field if you create identifiers for this business that you would like us to store for easy access to their information.

CreateMinimumAmountLimitSpendRuleInput

The details of the MinimumAmountLimitSpendRule spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

minimumAmount: AmountInput!

The exact amount to allow for a single authorization.

The ApplicableRuleUserType for which the rule will be evaluated.

CreateOneTimeACHTransferInput

Input to create a one time ACH transfer

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the FinancialAccount the funds will be coming from.

Exactly one of fromFinancialAccountId and toFinancialAccountId will reference an external account id and the other will reference a Highnote account.

toFinancialAccountId: ID!

Exactly one of fromFinancialAccountId and toFinancialAccountId will reference an external account id and the other will reference a Highnote account.

descriptor: ACHDescriptorInput!

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

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the scheduled payment. Included is the mandate template details to be collected to provide auditability of the exact terms accepted.

transferAmountStrategy: AmountStrategyInput!

The amount to be transferred

transferDateStrategy: TransferDateStrategyInput

The strategy for the transfer date

CreatePanEntryModeSpendRuleInput

The details of the PanEntryModeSpendRule to be created.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [PanEntryMode!]

The PanEntryMode values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [PanEntryMode!]

The PanEntryMode values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreatePaymentOrderInput

Input for creating a new PaymentOrder.

Output:INPUT_OBJECT

Input Fields

catalogItems: [PaymentOrderItemFromCatalogItemInput!]

Predefined items to add to the PaymentOrder. These items are defined in the catalog and can be queried independently. CatalogItems can be use to showcase products and services that are available for purchase.

customItems: [PaymentOrderItemFromCustomItemInput!]

Custom items to add to the PaymentOrder. These are one-off items defined at the time the order is created. They cannot be queried outside of the PaymentOrder.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

CreatePhysicalCardGroupOrderInput

Input fields for creating a physical card group order.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

Id of the product with which the group order will be associated.

deliveryDetails: PaymentCardDeliveryDetailsInput!

Delivery details.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the order should not be shipped before a certain date.

If the order should be shipped as soon as possible, omit this field. If the date provided is in the past, the value will be ignored.

cardProfileSetId: ID

ID of the CardProfileSet to be used for the physical card group order.

CreatePhysicalCardGroupOrderWithValidatedAddressInput

Input fields for creating a physical card group order with validated address.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

Id of the product with which the group order will be associated.

deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!

Delivery details.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the order should not be shipped before a certain date.

If the order should be shipped as soon as possible, omit this field. If the date provided is in the past, the value will be ignored.

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Minimum length: 5 characters Maximum length: 255 characters

cardProfileSetId: ID

ID of the CardProfileSet to be used for the physical card group order.

CreatePhysicalCardGroupOrderWithValidatedAddressTokenInput

Input fields for creating a physical card group order with validated address token.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

Id of the product with which the group order will be associated.

deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!

Delivery details.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the order should not be shipped before a certain date.

fromFinancialAccountId: ID!

The financial account id sending the funds.

Exactly one of fromFinancialAccountId and toFinancialAccountId will reference an external account id and the other will reference a Highnote account.

toFinancialAccountId: ID!

The financial account id receiving the funds.

Exactly one of fromFinancialAccountId and toFinancialAccountId will reference an external account id and the other will reference a Highnote account.

frequency: RecurringAchTransferFrequencyCode!

The frequency of the scheduled payment

transferAmountStrategy: AmountStrategyInput!

The strategy for the transfer amount

descriptor: ACHDescriptorInput!

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

transferDayStrategy: TransferDayStrategyInput

The strategy for the transfer day

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the scheduled payment.

This includes the mandate template details to be collected for auditability of the accepted terms.

CreateReusablePaymentMethodTokenInput

Input fields for creating a reusable payment method from a tokenized payment method.

Output:INPUT_OBJECT

Input Fields

paymentMethodTokenId: ID!

The tokenized payment method id to save.

customerIdentifier: String!

An identifier that uniquely identifies the customer associated with the payment method in the subscriber system.

Optionally, pass a Highnote AccountHolder ID to associate this payment method with an existing AccountHolder.

Minimum length: 5 character Maximum length: 255 characters

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Minimum length: 5 characters Maximum length: 255 characters

CreateRevolvingCreditCardProductConfigurationInput

The input type for creating a revolving CardProductCreditConfiguration

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The globally unique id for the CreditProduct

accountAgingConfiguration: CreditAccountAgingProductConfigurationInput!

The input type for the account aging configuration available on a CardProduct. For example, the number of days until a payment is due, and until an account is

minimumPaymentConfiguration: CreditMinimumPaymentCardProductConfigurationInput!

The input type for the minimum payment configuration available on a CardProduct. For example, whether the minimum payment includes the past due amount, interest, and fees.

billingCycleConfiguration: CreditBillingCycleCardProductConfigurationInput!

The billing statement configuration available on a CardProduct. Required for Revolving credit CardProducts.

CreateRewardDefaultEarnRuleInput

Input type for creating a RewardDefaultEarnRule that holds configuration for how transactions should earn rewards.

Output:INPUT_OBJECT

Input Fields

Input Fields

Name of Redemption Configuration Must be between 1 and 255 characters.

rewardPointRedemption: RewardRedemptionRateInput!

Redemption Rate. This rate describes the value of money that can be redeemed for earned points. See RewardRedemptionRateInput.

CreateSecretAPIKeyInput

Top level Relay compatible input type.

Output:INPUT_OBJECT

Input Fields

secretKey: SecretAPIKeyInput!

Details of the new Secret Key

CreateStreetAddressSpendRuleInput

The details of the spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

allowed: [AVSResponseCode!]

The AVSResponseCode values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [AVSResponseCode!]

The AVSResponseCode values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

CreateUnifiedFundsTransferQuoteInput

Input for createUnifiedFundsTransferQuote.

One of source.amount or destination.amount must be provided, but not both. The other amount will be calculated based on the remaining amount after the fee.

Output:INPUT_OBJECT

Input Fields

source: UnifiedFundsTransferSourceInput!

The source of the funds to transfer.

destination: UnifiedFundsTransferDestinationInput!

The destination of the funds to transfer.

externalIdentifier: String

Externally provided ID (255 character limit) to associate this request with an external system.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

memo: String

The reason for the transfer.

Maximum length: 1024 alphanumeric characters.

CreateUSBusinessAccountHolderFromTokenInput

The input for creating a new USBusinessAccountHolder from tokenized data.

Output:INPUT_OBJECT

Input Fields

token: String!

The token from tokenizeUSBusinessAccountHolder to use to create the USBusinessAccountHolder.

CreateUSBusinessAccountHolderInput

Input fields for creating a USBusinessAccountHolder.

Output:INPUT_OBJECT

Input Fields

primaryAuthorizedPerson: USAuthorizedPersonInput!

The details of the person authorized to act on behalf of business.

businessProfile: USBusinessProfileInput!

The details of the business.

externalId: String

An ID representing this account holder in an external system. Provide this field if you create identifiers for this business that you would like us to store for easy access to their information. Maximum length: 255 characters.

The validation for the externalId uses the following regex pattern ^([a-zA-Z\d[\s][_][=][,][-][.][^;]])+$.

CreateUserDefinedFieldDefinitionInput

The input for creating a UserDefinedFieldDefinition.

Output:INPUT_OBJECT

Input Fields

The name for the new field definition.

description: String

Optional description explaining the purpose of this field definition.

dataType: UserDefinedFieldDefinitionDataType!

The data type that values of this field must conform to.

CreateUserDefinedFieldInput

The input to create a UserDefinedField

Output:INPUT_OBJECT

Input Fields

definitionId: ID!

The ID of the field definition to create an instance of.

nodeId: ID!

The ID of the Node entity to attach this field to.

personAuthorizedUser: USPersonAuthorizedUserInput!

The details of the account holder.

accountHolderId: ID!

The identifier of the business account holder for which authorized user should be created.

CreateVelocityRuleInput

The details of the VelocityRule to create

Output:INPUT_OBJECT

Input Fields

The name of the VelocityRule

cumulativeRule: AttachSpendRuleInput!

The following cumulativeRule must be a rule that represents a cumulative amount. When the all of the conditions of the non-cumulative SpendRules are true this amount will increment.

spendRules: [AttachSpendRuleInput!]

The SpendRules to attach to VelocityRule. Note: Up to 3 allowed, 1-2 recommended When all of the compounded SpendRules below are true then the transaction amount will be added to the cumulative sum.

velocityRuleWindow: VelocityRuleWindow!

The velocity cadence time frame

velocityConstraintLevelOverride: VelocityConstraintLevel

Optional VelocityConstraintLevel at which the cumulative spend rule will be evaluated.

Defaults to CARD when VelocityRule is directly attached to a card All other times defaults to ACCOUNT

The ApplicableRuleUserType for which the rule will be evaluated.

CreateVisaRiskScoreSpendRuleInput

The details of the VisaRiskScoreSpendRule spend rule to create.

Output:INPUT_OBJECT

Input Fields

A name for the rule for future reference.

maximumVisaRiskScore: UnsignedInt!

The maximum Visa Risk Score allowed for a transaction before transaction is declined.

Minimum: 0 Maximum: 99

The ApplicableRuleUserType for which the rule will be evaluated.

CreditAccountAgingProductConfigurationInput

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

Output:INPUT_OBJECT

Input Fields

delinquentInDays: UnsignedInt!

The number of days between when a payment is due and when a FinancialAccount becomes delinquent if the payment is not made. Must be greater than zero.

suspendedInDays: UnsignedInt!

The number of days between when a payment is due and when a FinancialAccount becomes suspended if the payment is not made. Must be greater than zero.

chargeOffInDays: UnsignedInt!

The number of days between when a payment is due and when a FinancialAccount becomes closed if the payment is not made. Must be greater than zero.

lateFeeGracePeriodInDays: UnsignedInt!

The number of days between when a late fee is assessed and when it is due. Must be greater than or equal to zero.

CreditBillingCycleCardProductConfigurationInput

The billing statement configuration available on a CardProduct.

Output:INPUT_OBJECT

Input Fields

billingCycleGracePeriodInDays: UnsignedInt

Number of days included in the grace period

CreditLimitChangeRequestCustomerDetailsInput

The input type for details collected about the customer.

Output:INPUT_OBJECT

Input Fields

currentDebtObligations: AmountInput

The current debt obligations amount used for this decision.

annualIncome: AmountInput

The annual income amount used for this decision.

annualRevenue: AmountInput

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

externalFinancialAccountBalance: AmountInput

The external bank balance used for this decision.

CreditLimitChangeRequestDetailsInput

The input type for specifying details about the CreditLimitChangeRequest.

Output:INPUT_OBJECT

Input Fields

requestedChangeType: CreditLimitChangeRequestType

The type of CreditLimitChangeRequest, whether INCREASE or DECREASE.

requestedCreditLimit: AmountInput

The requested credit limit. Optional; can be omitted if the credit limit amount will be determined during the review process.

requestor: CreditLimitChangeRequestor

The type of requestor, whether CUSTOMER or SUBSCRIBER.

CreditMinimumPaymentCardProductConfigurationInput

The input type for the minimum payment configuration available on a CardProduct. For example, whether the minimum payment includes the past due amount, interest, and fees.

Output:INPUT_OBJECT

Input Fields

percentage: Float!

The percentage of the card balance used to calculate the minimum payment. Must be between 0 and 100. A value of '100' indicates '100%'.

thresholdAmount: AmountInput!

The minimum threshold for the minimum payment. For example, minimum payments are at least $25. Must be greater than or equal to zero.

CreditPlanFeeInput

The input type for CreditPlan fee configuration. Currently only used for CreditPlans of CreditBalanceType INSTALLMENT.

Output:INPUT_OBJECT

Input Fields

scheduleId: ID

The identifier for the FeeSchedule to attach to the CreditPlan.

CreditPlanFilterInput

The input type for filtering CreditPlan.

Output:INPUT_OBJECT

Input Fields

planType: CreditPlanType

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

balanceType: CreditBalanceType

The type of balance. For example, PURCHASE or INSTALLMENT.

status: CreditPlanStatus

The status of the CreditPlan. For example, INACTIVE or ACTIVE.

CreditPlanTemplateFilterInput

The value of the custom field.

CustomFieldsFilterInput

Inputs for filtering CustomFields.

Output:INPUT_OBJECT

Input Fields

equals: CustomFieldInput

Value matches the provided String.

notEquals: CustomFieldInput

Value does not match the provided String.

includes: [CustomFieldInput!]

Value exactly matches any of the provided Strings.

excludes: [CustomFieldInput!]

Value does not match any of the provided Strings.

CVVResponseCodeFilterInput

Input for filtering CVV response code

Output:INPUT_OBJECT

Input Fields

equals: CVVResponseCode

Value matches the provided CVV response code

notEquals: CVVResponseCode

Value does not match the provided CVV response code

includes: [CVVResponseCode!]

Value exactly matches all of the provided CVV response code

excludes: [CVVResponseCode!]

Value does not match any of the provided CVV response code

DateFilterInput

Input for filtering dates.

The format for each String field should be in YYYY-MM-DD format.

Example: 2021-11-12

Output:INPUT_OBJECT

Input Fields

equals: String

An ISO 8601 value that exactly matches the provided String.

notEquals: String

An ISO 8601 value that does not match the provided String.

lessThan: String

An ISO 8601 value to filter to dates before the given String.

lessThanOrEquals: String

An ISO 8601 value to filter to dates that match or are before the given String.

greaterThan: String

An ISO 8601 value to filter to dates after the given String.

greaterThanOrEquals: String

An ISO 8601 value to filter to dates that match or are after the given String.

between: DateFilterInputRange

Value to filter to dates that fall between values.

DateFilterInputRange

Input for filtering by date value ranges (inclusive).

The format for each String field should be in YYYY-MM-DD format.

Example: 2021-11-12

Output:INPUT_OBJECT

Input Fields

start: String

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

end: String

An ISO 8601 value (inclusive) for the ending date.

DeactivateCollaborativeAuthorizationEndpointInput

The input to deactivate a CollaborativeAuthorizationEndpoint.

Output:INPUT_OBJECT

Input Fields

endpointId: ID!

The Global ID of the CollaborativeAuthorizationEndpoint to deactivate.

DeactivateNotificationTargetInput

The input to deactivate a notification target.

Output:INPUT_OBJECT

creditLimitChangeRequestId: ID!

The identifier for the CreditLimitChangeRequest to deny.

customerDetails: CreditLimitChangeRequestCustomerDetailsInput

Details collected about the customer, such as their current debt obligations and annual income.

DenyCreditLimitIncreaseInput

The input type for denying a credit limit increase for a CreditLimitChangeRequest.

Output:INPUT_OBJECT

Input Fields

creditLimitChangeRequestId: ID!

The identifier for the CreditLimitChangeRequest to deny.

adverseActionReasons: [AdverseActionCodeInput!]

If the customer requested this credit limit increase, please provide at least one adverse action reason for the deny.

customerDetails: CreditLimitChangeRequestCustomerDetailsInput

Details collected about the customer, such as their current debt obligations and annual income.

DenyCreditProductApplicationUnderwritingInput

The input for denying a credit-based AccountHolderCardProductApplication.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

Global id of the application

counterOffer: AcceptCounterOfferInput

Optional input to accept an Open Offer on the application as an alternative to the primary underwritten offer that is being denied.

decisionDate: String!

The date and time, in ISO 8601 format, marking when the underwriting decision was made. For example, 2023-01-01T22:00:00.000Z.

adverseActionReasons: [AdverseActionReasonInput!]!

A list of reasons why the underwriting decision was adverse.

DetachCardProductVelocityRuleInput

The details of the VelocityRule to detach from the CardProduct

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The Global ID of the CardProduct connected to the VelocityRule.

velocityRule: VelocityRuleInput!

The details of the VelocityRule to detach from the CardProduct.

DetachPaymentCardVelocityRuleInput

The details of the VelocityRule to detach from the PaymentCard

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

DetachVelocityRuleFromFinancialAccountInput

The details of the VelocityRule to detach from the FinancialAccount

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The Global ID of the FinancialAccount connected to the VelocityRule.

velocityRule: VelocityRuleInput!

The details of the VelocityRule to detach from the FinancialAccount.

DisableAuthorizedUserFeatureInput

The input to disable the authorized user product feature.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The Global ID of the CardProduct for which to disable authorized user product feature.

DistanceInput

A representation of size and unit of measurement of a distance.

Output:INPUT_OBJECT

Input Fields

length: Float!

The length of the measurement.

cardProductId: ID!

The Global ID of the CardProduct for which to enable the credit card product feature.

feature: CreditCardProductFeature!

Whether the feature assigned to this credit product will be REVOLVING or CHARGE

EnableOnDemandFundingFeatureInput

The input to configure the On demand product feature.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The Global ID of the CardProduct for which to enable the On Demand product feature.

pseudoBalanceEnabled: Boolean!

Whether or not a pseudo balance will be used for maximum spend on FinancialAccount associated to a card

EndDocumentUploadSessionInput

The input to end a document upload session

companyIdentifier: StringFilterInput

companyName: StringSearchFilterInput

companyEntryDescription: StringSearchFilterInput

transactionAmount: MoneyFilterInput

transactionType: ExternallyInitiatedTransferTypeFilterInput

settlementDate: TimestampFilterInput

status: ExternallyInitiatedACHStatusFilterInput

reasonCode: ExternallyInitiatedACHStatusReasonCodeFilterInput

holdStatus: ExternallyInitiatedACHHoldStatusFilterInput

cardProductId: StringSearchFilterInput

returnDate: TimestampFilterInput

ExternallyInitiatedTransferTypeFilterInput

Input for filtering by ExternallyInitiatedTransferType.

Output:INPUT_OBJECT

Input Fields

equals: ExternallyInitiatedTransferType

notEquals: ExternallyInitiatedTransferType

includes: [ExternallyInitiatedTransferType!]

excludes: [ExternallyInitiatedTransferType!]

ExternalTokenFinicityInput

The Finicity token that can be used to fetch bank account details of account holder.

Output:INPUT_OBJECT

Input Fields

receiptId: ID!

Proof of user consent to share financial data with Highnote.

customerId: ID!

A pseudo customer ID that Highnote will use to retrieve data via Finicity's 3PA integration.

products: [FinicityProduct!]

An array of products/api-endpoints that Highnote can use to retrieve users' financial data.

ExternalTokenInput

The external token that can be used to fetch bank account details of account holder.

Output:INPUT_OBJECT

Input Fields

value: String!

A token provided by a third-party (e.g. Plaid) that Highnote can use to securely fetch an account holder's bank details.

FeeScheduleFilterInput

Inputs for filtering Fee Schedules.

Output:INPUT_OBJECT

Input Fields

activationDate: TimestampFilterInput

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

createDate: TimestampFilterInput

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

updateDate: TimestampFilterInput

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

FeeTransferEventFilterInput

Inputs for filtering Fee Transfer Events.

Output:INPUT_OBJECT

Input Fields

cardProductId: StringFilterInput

The id of the card product associated to the fee transfer event.

originatingAccountId: StringFilterInput

The financial account from where fee is deducted.

receivingAccountId: StringFilterInput

The financial account where fee is transferred.

transferDate: TimestampFilterInput

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

createDate: TimestampFilterInput

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

updateDate: TimestampFilterInput

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

FilteredCardProductCardProfileSetsInput

The input to filter card profile sets on a 'CardProduct'

Output:INPUT_OBJECT

postedAmount: MoneyFilterInput

pendingAmount: MoneyFilterInput

createdAt: TimestampFilterInput

updatedAt: TimestampFilterInput

isComplete: BooleanFilterInput

isSignNegative: BooleanFilterInput

activityType: FinancialAccountActivityTypeFilterInput

FinancialAccountActivityTypeFilterInput

Inputs for filtering Financial Account Activity types

Output:INPUT_OBJECT

Input Fields

equals: FinancialAccountActivityType

Value matches the provided activity type

notEquals: FinancialAccountActivityType

Value does not match the provided activity type

includes: [FinancialAccountActivityType!]

Value exactly matches any of the provided activity types

excludes: [FinancialAccountActivityType!]

Value does not match any of the provided activity types

FinancialAccountBalanceSearchFilter

A filter to search for a FinancialAccountBalanceSearchResult. Each FinancialAccountBalanceSearchFilter must define a searchField, along with the value filter for that field. stringFilter field names:

FINANCIAL_ACCOUNT_ID
CARD_PRODUCT_ID
FINANCIAL_ACCOUNT_OWNER_ID

timestampFilter field names:

FINANCIAL_ACCOUNT_CREATE_DATE

signedBalance field can be used with any *_LEDGER_BALANCE fields to filter by the current balance of the ledger.

creditBalance field for positive amounts:

AVAILABLE_CASH_LEDGER_BALANCE
AVAILABLE_CREDIT_LEDGER_BALANCE
OUTSTANDING_BALANCE_PAYABLE_LEDGER_BALANCE

debitBalance field for positive amounts:

CASH_LEDGER_BALANCE
CREDIT_OUTSTANDING_LEDGER_BALANCE
OUTSTANDING_BALANCE_RECEIVABLE_LEDGER_BALANCE

For negative balances, the creditBalance and debitBalance fields for the respective ledger's NormalBalance will be reversed.

Output:INPUT_OBJECT

Input Fields

searchField: FinancialAccountBalanceSearchField!

The field to search on.

stringFilter: StringFilterInput

String value type

timestampFilter: TimestampFilterInput

Timestamp value type in ISO 8601 format

creditBalance: MoneyFilterInput

Input to filter by amount.

debitBalance: MoneyFilterInput

Input to filter by amount.

signedBalance: SignedMoneyFilterInput

Input to filter by amount by the current balance of the Ledger.

FinancialAccountBalanceSearchFilterInput

Input for filtering FinancialAccountBalanceSearchResults.

Output:INPUT_OBJECT

Input Fields

filters: [FinancialAccountBalanceSearchFilter!]

FinancialAccountFeatureTypeFilterInput

Input for filtering Financial Account feature

Output:INPUT_OBJECT

Input Fields

equals: FinancialAccountFeatureType

Value matches the provided Financial Account feature

notEquals: FinancialAccountFeatureType

Value does not match the provided Financial Account feature

includes: [FinancialAccountFeatureType!]

Value exactly matches all of the provided Financial Account feature

excludes: [FinancialAccountFeatureType!]

Value does not match any of the provided Financial Account feature

FinancialAccountPaymentCardsFilterInput

Inputs for filtering Payment Card data.

Output:INPUT_OBJECT

Input Fields

expirationDate: TimestampFilterInput

accountHolderId: IDFilterInput

formFactor: CardFormFactorFilterInput

createDate: TimestampFilterInput

updateDate: TimestampFilterInput

customFields: CustomFieldsFilterInput

FinancialAccountPaymentCardTransactionChargebacksFilterInput

Input for filtering PaymentCardTransactionChargeback on FinancialAccount

Output:INPUT_OBJECT

Input Fields

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

externalNetworkId: StringFilterInput

Chargeback externalNetworkId filter

FinancialAccountPaymentCardTransactionDisputesFilterInput

Input for filtering PaymentCardTransactionDispute on FinancialAccount

Output:INPUT_OBJECT

Input Fields

disputeId: IDFilterInput

Input to filter by PaymentCardTransactionDispute ID.

disputeStatus: PaymentCardDisputeStatusFilterInput

Input to filter by PaymentCardTransactionDispute status.

disputeCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionDispute created date.

disputeHasChargeback: BooleanFilterInput

Input to filter disputes by whether a PaymentCardTransactionDispute has an associated PaymentCardTransactionChargeback.

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

percentagePerTransaction: Int!

The percentage (in basis points) of the transaction amount that is reserved.

amountPerTransaction: AmountInput!

The fixed amount withheld from each transaction

thresholdAmount: AmountInput

The amount after which no more reserves are collected

reserveType: ReserveType

The type of reserve it is

reserveCollectionMethod: ReserveCollectionMethod

The manner in which the reserve is collected

FinicityProduct

A single product/api-endpoint that Highnote can use to retrieve users' financial data.

Output:INPUT_OBJECT

Input Fields

productType: FinicityProductType!

A specific product type represented by an api endpoint.

accountId: ID!

A pseudo account ID that Highnote will use to retrieve data via Finicity's 3PA integration.

callLimit: Int!

A limit on how many times an api can be called.

expirationDetail: ExpirationDetail!

A time range that an api can be accessed.

ForceCapturePaymentTransactionInput

Input for force capturing a payment transaction.

Output:INPUT_OBJECT

Input Fields

paymentTransactionId: ID!

The payment transaction to capture.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

GenerateAppleWebPushProvisioningTokenInput

Input for generating an Apple Pay Web Push Provisioning token.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the payment card for Apple Pay provisioning.

GenerateBusinessAccountHolderClientTokenInput

Input for creating a Business Account Holder Client Token.

Output:INPUT_OBJECT

Input Fields

accountHolderId: ID!

The global ID of the Business Account holder for this token.

permissions: [BusinessAccountHolderClientTokenPermission!]!

Specify permissions for this token.

GenerateCreateScheduledTransferClientTokenInput

Input for creating a Scheduled Transfer Client Token.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The global ID of financial account.

This must be an external financial account.

toFinancialAccountId: ID!

financialAccountId: ID!

The ID of the financial account.

singleUseToken: String

An optional arbitrary identifier to be passed to ensure the client token can only be used once.

If not provided, Highnote will generate the nonce on behalf of the integrator.

The singleUseToken can be any valid ASCII character and cannot exceed 255 characters.

permissions: [GenerateFinancialAccountSingleUseClientTokenPermission!]!

A set of permissions to be included on the client token.

GenerateInitiateSecureDepositClientTokenInput

Input for creating a Secure Deposit Client Token.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

paymentTransactionId: ID!

The payment transaction to incrementally authorize.

amount: AmountInput

The amount to incrementally authorize.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateAchTransferInput

Input details when initiating an OriginatedAchTransfer.

Output:INPUT_OBJECT

Input Fields

idempotencyKey: String!

A value to uniquely distinguish transfers, e.g. a UUID.

This helps prevent duplicate transfers in error scenarios. If a failure happens and it is unclear if a transfer went through, it is safe to repeat the request with the same idempotency key. If the transfer already exists, the request will be deduped and the original transfer will be returned instead of a new transfer getting created for the same amount. If idempotency key is the same between two requests, the other fields will be ignored and the original transfer will be returned.

This value is required. Maximum length: 255 characters.

fromFinancialAccountId: ID!

The financial account to send funds from.

This must be a verified external financial account (ExternalFinancialBankAccount) id when pulling funds and a Highnote FinancialAccount id when pushing funds.

toFinancialAccountId: ID!

The financial account to send funds to.

This must be a Highnote FinancialAccount id when pulling funds and a verified or non-verified external financial account (ExternalFinancialBankAccount or NonVerifiedExternalUSFinancialBankAccount) id when pushing funds.

purpose: AchTransferPurpose!

The purpose of the transfer, e.g. deposit.

amount: AmountInput!

The monetary amount of the transfer, in cents, e.g. use USD currencyCode and 10000 value for $100.00.

Maximum length: 10 digits, including cents. There may be additional limits on the size based on program.

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the transfer.

This includes the mandate template details to be collected for auditability of the accepted terms.

cancellationPeriodMillis: UnsignedInt

The number of milliseconds after the transfer is initiated during which cancellation is allowed. The transfer will not be processed until the cancellation period elapses.

The default value is 0.

Default Value: 0

sameDay: Boolean

A flag that indicates the desire to process this transaction using same-day ACH. Note that this flag is not a guarantee the transaction will be processed the same day. Funds availability is highly dependent on the ACH network processing schedule.

Default Value: false

companyEntryDescription: String!

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

Maximum length: 10 characters. The characters should be alphanumeric.

individualName: String!

Receiver’s individual name. This could be a person or a business.

Maximum length: 22 characters. The characters should be alphanumeric.

individualIdentificationNumber: String

Receiver’s identification number. This could be a person or a business.

Maximum length: 15 characters. The characters should be alphanumeric.

paymentRelatedInformation: String

Contains payment-related information provided by the originator of the transaction. It can include free-form text, structured data, or codes. The field supports alphanumeric characters, including the following symbols: ! " & ' ( ) * + , - . / : ; ? = % ~ @ [ ] { } \ | < > # $.

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters

InitiateAddWiredFundsToFinancialAccountInput

Input details when initiating an add wire transfer to FinancialAccount.

Output:INPUT_OBJECT

Input Fields

idempotencyKey: String

A value to uniquely distinguish transfers, e.g. a UUID.

If not provided, a unique identifier will be generated. Maximum length: 255 characters.

toFinancialAccountId: ID!

The FinancialAccount to send funds to.

amount: AmountInput!

The monetary amount of the transfer, in cents, e.g. use USD currencyCode and 10000 value for $100.00.

Maximum length: 10 digits, including cents. There may be additional limits on the size based on program.

memo: String

A description of the wire transfer for later reference. Maximum length: 1024 characters

externalIdentifier: String

Additional reference ID Maximum length: 255 characters

InitiateCustomerCardTransactionDisputeInput

Input for initiateCustomerCardTransactionDispute.

Output:INPUT_OBJECT

Input Fields

cardTransactionEventId: ID!

The ID of the transaction event (AuthorizationAndClearEvent or ClearingEvent).

category: PaymentCardDisputeCategoryType!

The category type of the dispute.

amount: AmountInput!

The disputed amount.

customerInitiatedOn: String!

The customer initiated date, in YYYY-MM-DD format, for the card transaction dispute.

customerClaimType: PaymentCardDisputeCustomerClaimType!

The customer claim type for the card transaction dispute.

customerContact: CustomerContactInput!

The customer contact information for the card transaction dispute.

subscriberNote: String

The subscriber note for the card transaction dispute. Maximum length is 2048.

InitiateFinancialAccountCreditLimitUpdateFromProductFundingInput

The details to update credit limit of an account holder Financial Account.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the Financial Account for setting credit limit.

amount: AmountInput!

The amount of credit limit for the Payment Card.

memo: String

A description of the credit limit update for later reference.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateFinancialAccountPseudoBalanceUpdateInput

The input to update a pseudo balance for a financial account.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the financial account to apply the pseudo balance against.

memo: String

A memo that can be tagged with this pseudo balance update. This field accepts up to 1024 alphanumeric characters.

amount: AmountInput!

The amount to set as the pseudo balance.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateFundPaymentCardFinancialAccountTransferInput

The details to fund card to an account holder Financial Account.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the source funding Financial Account.

toFinancialAccountId: ID!

The ID of the target card holder Financial Account.

amount: AmountInput!

The amount to add to the Payment Card.

memo: String

A description of the transfer for later reference.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateFundsDepositACHTransferInput

The details to deposit funds from an ExternalFinancialAccount to a FinancialAccount using ACH.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The financial account the funds will be coming from.

This must be a ExternalFinancialAccount ID.

toFinancialAccountId: ID!

The financial account the funds will be going to.

This must be a FinancialAccount ID.

amount: AmountInput!

Amount of the ACH transfer.

There are at most 10 digits, including cents. There may be additional limits on the size based on program.

descriptor: ACHDescriptorInput!

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

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the ACH transfer.

This includes the mandate template details to be collected for auditability of the accepted terms.

idempotencyKey: String

A value to distinguish unique transfers.

Maximum length: 255 characters

cancellationPeriodMillis: UnsignedInt

The number of milliseconds after ACH transfer creation during which cancellation is allowed. The ACH transfer will not be processed during that period. After the period ends, the cancellation may no longer be possible.

sameDay: Boolean

A flag that indicates the desire to attempt to perform this transaction using Same-Day ACH methods. Note that this is not a guarantee of a same day transaction, but clearing will still be expedited.

paymentRelatedInformation: String

This field contains payment-related information provided by the originator of the transaction. It can include free-form text, structured data, or codes. The field supports alphanumeric characters, including the following symbols: ! " & ' ( ) * + , - . / : ; ? = % ~ @ [ ] { } \ | < > # $.

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters

InitiateFundsWithdrawalACHTransferInput

The details to withdraw funds from a FinancialAccount to an ExternalFinancialAccount using ACH.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The financial account the funds will be coming from.

This must be a FinancialAccount ID.

toFinancialAccountId: ID!

The financial account the funds will be going to.

This must be a ExternalFinancialAccount ID.

amount: AmountInput!

Amount of the ACH transfer.

There are at most 10 digits, including cents. There may be additional limits on the size based on program.

descriptor: ACHDescriptorInput!

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

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the ACH transfer.

This includes the mandate template details to be collected for auditability of the accepted terms.

idempotencyKey: String

A value to distinguish unique transfers.

Maximum length: 255 characters

cancellationPeriodMillis: UnsignedInt

sameDay: Boolean

A flag that indicates the desire to attempt to perform this transaction using Same-Day ACH methods. Note that this is not a guarantee of a same day transaction, but clearing will still be expedited.

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters

InitiateOrganizationReportInput

The details needed in order to generate a report for an Organization.

Output:INPUT_OBJECT

Input Fields

reportType: OrganizationReportType!

The type of report to be generated for an Organization.

parameters: ReportParametersInput!

Parameters used to generate the Report.

InitiatePayrollAdvanceInput

The details to payroll advance to an employee Financial Account.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the employer Financial Account for payroll advance.

toFinancialAccountId: ID!

The ID of the employee Financial Account for payroll advance.

amount: AmountInput!

The amount to add to the Payment Card.

memo: String

A description of the transfer for later reference. May not include the following characters: @ + = ’ " < > &

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiatePhysicalCheckPaymentInput

The input object that defines the fields for the initiatePhysicalCheckPayment mutation.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The FinancialAccount to use to fund the check.

amount: AmountInput!

The amount of the check.

recipient: PhysicalCheckPaymentRecipientInput!

The recipient of the check.

memo: String

Optional memo to include on the check.

shippingTime: CheckPaymentShippingTime

The mail type for a physical check.

If not provided, defaults to the standard mail type.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateSecureDepositACHTransferInput

The details for the integrator to initiate a secure deposit ACH transfer.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The financial account the funds will be coming from.

This must be an ExternalFinancialBankAccount ID.

toFinancialAccountId: ID!

The financial account the funds will be going to.

This must be a FinancialAccount ID.

amount: AmountInput!

Amount of the ACH transfer.

There are at most 10 digits, including cents. There may be additional limits on the size based on program.

descriptor: ACHDescriptorInput!

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

transferAgreementConsent: TransferAgreementConsentInput!

The consent provided by the individual authorizing the ACH transfer.

This includes the mandate template details to be collected for auditability of the accepted terms.

idempotencyKey: String

A value to distinguish unique transfers.

Maximum length: 255 characters

cancellationPeriodMillis: UnsignedInt

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

Please note that this information may or may not be displayed to the recipient, based on the bank's capabilities, and method of access (i.e., online banking, statement, etc.)

Maximum length: 80 characters

InitiateTransferBetweenFinancialAccountsInput

The details to transfer money between financial accounts.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the source financial account.

toFinancialAccountId: ID!

The ID of the target financial account.

amount: AmountInput!

The amount to transfer.

purpose: TransferPurpose!

The purpose for the transfer.

memo: String

A description of the transfer for later reference. Maximum length is 1024, and valid characters are all UTF-8 and ASCII characters.

externalIdentifier: String

Externally provided identifier that can be used to reference the transfer. If not provided, this field will be blank.

The identifier can be any valid ASCII character and cannot exceed 255 characters.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccountInput

The details to transfer money from a funding financial account to a financial account backing a payment card.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the source funding financial account.

toFinancialAccountId: ID!

The ID of the target card holder financial account.

amount: AmountInput!

The amount to add to the Payment Card.

memo: String

A description of the transfer for later reference. Maximum length is 1024, and valid characters are all UTF-8 and ASCII characters.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateTransferFromPaymentCardFinancialAccountToFundingFinancialAccountInput

The details to transfer money from a financial account backing a payment card to a funding financial account.

Output:INPUT_OBJECT

Input Fields

fromFinancialAccountId: ID!

The ID of the source payment card financial account.

toFinancialAccountId: ID!

The ID of the target funding financial account.

amount: AmountInput!

The amount to transfer to the funding financial account.

memo: String

A description of the transfer for later reference. Maximum length is 1024, and valid characters are all UTF-8 and ASCII characters.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

InitiateUnifiedFundsTransferInput

Input for initiateUnifiedFundsTransfer.

Output:INPUT_OBJECT

Input Fields

id: ID!

The id of the UnifiedFundsTransferQuote to initiate.

consent: TransferAgreementConsentInput

Consent agreement information for the transfer. Required when the transfer requires end-user authorization (e.g., RTP transfers).

InitiateUnloadWiredFundsFromFinancialAccountInput

Input details when initiating an unload wire transfer from a FinancialAccount.

Output:INPUT_OBJECT

Input Fields

idempotencyKey: String

A value to uniquely distinguish transfers, e.g. a UUID.

If not provided, a unique identifier will be generated. Maximum length: 255 characters.

fromFinancialAccountId: ID!

The FinancialAccount that funds were wired out from.

amount: AmountInput!

The monetary amount of the transfer, in cents, e.g. use USD currencyCode and 10000 value for $100.00.

Maximum length: 10 digits, including cents. There may be additional limits on the size based on program.

memo: String

A description of the wire transfer for later reference. Maximum length: 1024 characters

externalIdentifier: String

Additional reference ID Maximum length: 255 characters

InitiateUSBusinessAuthorizedPersonRequestedIdentityUpdateInput

The input for initiating an USBusinessAuthorizedPersonRequestedIdentityUpdate.

Output:INPUT_OBJECT

Input Fields

requestedIdentityUpdateId: ID!

The Global ID of the requested identity update.

primaryAuthorizedPerson: USAuthorizedPersonUpdateInput!

Details for updating the USAuthorizedPerson.

InitiateUSBusinessProfileRequestedIdentityUpdateInput

The input for initiating an USBusinessProfileRequestedIdentityUpdate.

Output:INPUT_OBJECT

Input Fields

requestedIdentityUpdateId: ID!

The Global ID of the requested identity update.

businessProfile: USBusinessProfileUpdateInput!

Details for updating the USBusinessProfile.

InitiateUSBusinessUltimateBeneficialOwnerRequestedIdentityUpdateInput

The input for initiating an USBusinessUltimateBeneficialOwnerRequestedIdentityUpdate.

Output:INPUT_OBJECT

Input Fields

requestedIdentityUpdateId: ID!

The Global ID of the requested identity update.

ultimateBeneficialOwner: USUltimateBeneficialOwnerUpdateInput!

Details for updating the USUltimateBeneficialOwner.

InitiateUSPersonAccountHolderRequestedIdentityUpdateInput

The input for initiating an USPersonAccountHolderRequestedIdentityUpdate.

Output:INPUT_OBJECT

Input Fields

requestedIdentityUpdateId: ID!

The Global ID of the requested identity update.

personAccountHolder: USPersonAccountHolderUpdateInput!

Details for updating the USPersonAccountHolder.

InstallmentAgreementFilterInput

The input type for filtering InstallmentAgreement.

Output:INPUT_OBJECT

Input Fields

installmentAgreementStatus: InstallmentAgreementStatus

The status of the InstallmentAgreement. For example, OPEN or REVERSE or PAID_OFF or CHARGE_OFF`.

companyEntryDescription: StringSearchFilterInput

transactionAmount: MoneyFilterInput

transactionType: IntegratorInitiatedTransferTypeFilterInput

settlementDate: TimestampFilterInput

status: IntegratorInitiatedACHStatusFilterInput

amount: MoneyFilterInput

Search for InterFinancialAccountTransfers by transfer amount

createdAt: TimestampFilterInput

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

updatedAt: TimestampFilterInput

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

cardProductId: ID!

The ID of the Card Product to update.

The name of the Employer Advanced Account. Minimum length: 1 character Maximum length: 50 characters Allowed characters: All characters

companyIdentifier: String

The companyIdentifier associated with Employer Advanced Account. Maximum length: 50 characters Allowed characters: All characters

IssueFinancialAccountForApplicationInput

Details for issuing a Financial Account against an Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to issue this Financial Account against.

Note: The Application must be APPROVED.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

The name of the Financial Account.

customFields: [CustomFieldInput!]

The CustomFields for the Financial Account.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

IssueFinancialAccountForApplicationWithOnDemandFundingSourceInput

Details for issuing a Financial Account against an on-demand funding source.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to issue this Financial Account against.

Note: The Application must be APPROVED.

sourceFinancialAccountId: ID!

The source FinancialAccount that will act as the on-demand funding source for this FinancialAccount.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

The name of the Financial Account.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

IssueFundingFinancialAccountForApplicationInput

Details for issuing a Funding Financial Account against an Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to issue this Financial Account against.

Note: The Application must be APPROVED.

The name of the Financial Account.

IssuePaymentCardForApplicationInput

Details for issuing a Payment Card against an Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to issue this Payment Card against.

Note: The Application must be APPROVED.

externalId: String

Externally provided ID (255 character limit) that can be used to refer to the issued payment card's' financial account. This ID is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

Options for the newly issued Payment Card.

customFields: [CustomFieldInput!]

The CustomFields for the Payment Card.

IssuePaymentCardForApplicationWithOnDemandFundingSourceInput

Details for issuing a PaymentCard against an on-demand funding source.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to issue this PaymentCard against.

Note: The Application must be APPROVED.

sourceFinancialAccountId: ID!

The source FinancialAccount that will act as the on-demand funding source for this PaymentCard.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

customFields: [CustomFieldInput!]

The CustomFields for the PaymentCard.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Options for the newly issued PaymentCard.

IssuePaymentCardForAuthorizedUserApplicationInput

Details for issuing a Payment Card against an Authorized User Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the authorizecd user application to issue this Payment Card against.

Note: The Application must be APPROVED.

Options for the newly issued Payment Card.

customFields: [CustomFieldInput!]

The CustomFields for the Payment Card.

IssuePaymentCardForFinancialAccountInput

Details for issuing a Payment Card against Financial Account.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the financial account to issue this Payment Card against.

Note: The Financial Account must have a payment card feature enabled.

Options for the newly issued Payment Card.

customFields: [CustomFieldInput!]

The CustomFields for the Payment Card.

idempotencyKey: IdempotencyKey

A value to distinguish unique IssuePaymentCardForFinancialAccount request. This helps prevent duplicate cards from be issued. If a failure happens and it is unclear if an issue payment card request went through, it is safe to repeat the request with the same idempotency key. If card has already been issued, the request will be deduped and the original payment card response will be returned instead.

Minimum length: 10 characters Maximum length: 255 characters

IssuePaymentCardOptionsInput

Options for the newly issued Payment Card.

Output:INPUT_OBJECT

Input Fields

expirationDate: String!

The exact date and time the payment card will expire. e.g. 2026-01-01T23:59:59Z

activateOnCreate: Boolean!

Whether or not to activate the card when created. If not activated on creation, the card must be activated separately before use.

cardProfileSetId: ID

The card profile set containing the card profile to use for the newly issued Payment Card.

externalId: String

Externally provided ID (255 character limit) that is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

IssuePreprintedPaymentCardFinancialAccountForApplicationInput

Input values for IssuePreprintedPaymentCardFinancialAccountForApplication

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the AccountHolderCardProductApplication to issue a preprinted payment card FinancialAccount.

Note: The Application must be APPROVED.

The name of the FinancialAccount that will be created.

Minimum length: 1 character Maximum length: 50 characters Allowed characters: All characters

externalId: String

An optional externally provided ID (255 character limit) that can be used to refer to the issued payment card's' financial account. This ID is unique per organization and tenant. If not provided, Highnote will generate an ID (ten digit, Base58, all caps).

LedgerEntriesFilterInput

Inputs for filtering ledger entries.

Output:INPUT_OBJECT

Input Fields

ledgerName: LedgerNameFilterInput

createdAt: TimestampFilterInput

LedgerNameFilterInput

Inputs for filtering ledger entries.

Output:INPUT_OBJECT

Input Fields

equals: LedgerName

Value matches the provided ledger name

notEquals: LedgerName

singleAuthorizationMultipleCaptures: Boolean

Indicates whether this is a single authorization with multiple captures.

MerchantCategoryCodeSankeyDataPointsFilterInput

Input filter for querying data points for a Sankey diagram representing flows between account holders and merchant categories.

Output:INPUT_OBJECT

Input Fields

The postal code of the address. The value can include 5 numbers only or a hyphen - and 4 numbers.

region: String!

A region for the address based on the two letter state, including districts and outlying areas.

locality: String!

The locality of the address up to 13 characters (e.g. town, city)

The validation for the locality uses the following regex pattern ^['\p{L}]+(?:[ \p{L},'-:])*$.

It checks to ensure it begins with a single quote or any letter, followed by whitespace, commas, single quote, any letter, or character in this set '()*+,-./0123456789: .

countryCodeAlpha3: ISO3166Alpha3Country!

The three letter country code where the address resides.

MerchantDetailsFilterInput

Inputs for filtering merchant details.

Output:INPUT_OBJECT

Input Fields

category: MerchantCategoryFilterInput

The merchant category for the authorization.

The merchant or institution name.

countryCodeAlpha3: ISO3166Alpha3Country

The merchant country code

description: StringSearchFilterInput

The merchant description

MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

Output:INPUT_OBJECT

Input Fields

category: MerchantCategory

The merchant category for the authorization.

countryCodeAlpha3: ISO3166Alpha3Country

The merchant country code for the authorization.

description: String

The description. a.k.a. "Descriptor"

merchantId: String

The unique ID assigned by the merchant's acquirer to identify the merchant account. This is also referred to as the MID.

The merchant or institution name. Maximum length: 25 characters

address: MerchantDetailsAddressInput

Represents the address of the merchant as sent by the acquirer.

subMerchantIdentifier: String

Sub-merchant identifier for the transaction. Maximum length: 15

MerchantDrilldownSankeyDataPointsFilterInput

Input filter for querying detailed Sankey diagram data points, including flows between account holders, merchant categories, and merchants.

Output:INPUT_OBJECT

Input Fields

sankeyDataPointsFilter: MerchantCategoryCodeSankeyDataPointsFilterInput!

Required filter for querying data points for a Sankey diagram representing flows between account holders and merchant categories.

merchantCategoryCode: StringFilterInput!

Filter for data points under a specific merchant category code.

MerchantManagedInstallmentPaymentInput

Information about a merchant-managed installment payment plan.

Output:INPUT_OBJECT

Input Fields

totalAmount: AmountInput!

The total amount across all installment payments in the plan.

numberOfInstallments: UnsignedInt!

The total number of installment payments in the plan.

paymentAmount: AmountInput!

The amount for each individual payment.

frequency: InstallmentFrequency!

The frequency at which payments occur.

firstPaymentDate: String!

The date of first installment payment, in ISO 8601 format (YYYY-MM-DD).

paymentNumber: UnsignedInt!

The number of this installment payment.

fundedAmount: AmountInput

Optional: The total amount that has been funded so far in the plan.

firstInstallmentPaymentTransactionId: ID

The PaymentTransaction ID from the first installment payment. Used to link all subsequent installment payments in the series.

networkData: InstallmentNetworkDataInput

Network-specific installment payment data.

MinimalUSAuthorizedPersonInput

The input for creating a minimal USAuthorizedPerson

Output:INPUT_OBJECT

Input Fields

The authorized person's legal name.

email: String

The authorized person's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput

The primary phone number for this authorized person.

homeAddress: AddressInput

The authorized person's U.S. physical address.

Provide either homeAddress or homeAddressToken, but not both.

homeAddressToken: ID

A token representing the authorized person's U.S. physical address.

Provide either homeAddress or homeAddressToken, but not both.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

identificationDocument: USIdentificationDocumentInput

The identification document used to verify the authorized person.

percentageOwnership: Int

Percentage ownership of this authorized person in business if any.

authorizingPersonTitle: BusinessTitle

Authorized person's title.

MinimalUSBusinessProfileInput

Input fields for creating a USBusinessProfile with minimum required details.

Output:INPUT_OBJECT

Input Fields

The business' name fields.

businessDescription: String

A short description of what the business does, its purpose, and the products or services it provides.

Max length: 140 characters. Min length: 1 character. Input Regex Validation: ^[a-zA-Z\d$ ',.\-\_!@#$%^&*+=?"\n]+$`

phoneNumber: PhoneInput

The primary phone number for this business.

billingAddress: AddressInput

The business' U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

billingAddressToken: ID

A token representing the business' U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

legalAddress: AddressInput

The address supplied for the business' registration. Supplying the address associated with the business primary SOS filing location is recommended.

Note: Depending on the product that the Account Holder is applying for, the legal entity address may be required. During your implementation review, requirements around conditionally mandatory fields will be outlined.

website: String

Business website URL.

The validation for the website URL uses the following regex pattern ^((((https?|ftps?|gopher|telnet|nntp)://)|(mailto:|news:))(%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@&=+$,A-Za-z0-9])+)([).!';/?:,][[:blank:|:blank:]])?$

businessType: BusinessStructure!

Type of business.

businessCreditRiskAttributes: BusinessCreditRiskAttributesInput

The business' credit risk attributes. Only used for unsecured credit applications.

identificationDocument: USBusinessIdentificationDocumentInput

Business identification document such as employer identification number in USA.

A business identification document is not required for SOLE_PROPRIETORSHIP.

Highnote recommends passing an identification document when available to streamline the onboarding and future product approval processes.

ultimateBeneficialOwners: [MinimalUSUltimateBeneficialOwnerInput!]

Ultimate beneficial owners of business information

MinimalUSUltimateBeneficialOwnerInput

Input fields for creating a USUltimateBeneficialOwner with minimal information.

Output:INPUT_OBJECT

Input Fields

The ultimate beneficial owner's legal name.

homeAddress: AddressInput

The ultimate beneficial owner's U.S. physical address.

Provide either homeAddress or homeAddressToken, but not both.

homeAddressToken: ID

A token representing the ultimate beneficial owner's U.S. physical address.

Provide either homeAddress or homeAddressToken, but not both.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

email: String

The ultimate beneficial owner's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput

The primary phone number for this ultimate beneficial owner.

identificationDocument: USIdentificationDocumentInput

The identification document used to verify the ultimate beneficial owner.

percentageOwnership: Int

Percentage ownership of this ultimate beneficial owner in business if any. Minimum percentage ownership: 25%

MoneyFilterInput

Money value type

Output:INPUT_OBJECT

Input Fields

currencyCode: ISO4217Alpha3CurrencyCode!

equals: UnsignedInt

A value that exactly matches the provided UnsignedInt.

notEquals: UnsignedInt

A value that does not exactly match the provided UnsignedInt.

lessThan: UnsignedInt

A value to filter to numbers less than the given UnsignedInt.

lessThanOrEquals: UnsignedInt

A value to filter to numbers less than or equal to the given UnsignedInt.

greaterThan: UnsignedInt

A value to filter to numbers greater than the given UnsignedInt.

greaterThanOrEquals: UnsignedInt

A value to filter to numbers greater than or equal to the given UnsignedInt.

includes: [UnsignedInt!]

Filter to values that exactly match any of the provided UnsignedInts.

excludes: [UnsignedInt!]

Filter to values that do not match any of the provided UnsignedInts.

between: MoneyFilterInputRange

Filter to values that fall between the provided UnsignedInts.

MoneyFilterInputRange

Money value range (inclusive)

Output:INPUT_OBJECT

Input Fields

start: UnsignedInt

An UnsignedInt value (inclusive) for the beginning of the range.

end: UnsignedInt

An UnsignedInt value (inclusive) for the end of the range.

NameInput

Input representing common fields of a person's name.

Output:INPUT_OBJECT

Input Fields

givenName: String!

The part of the name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters

The validation for the input uses the following regex pattern ^[a-zA-Z]+(([',. -][a-zA-Z ])?[a-zA-Z]*)*$.

middleName: String

Additional part of name that identifies a person.

Maximum length: 255 characters

The validation for the input uses the following regex pattern ^[a-zA-Z]+(([',. -][a-zA-Z ])?[a-zA-Z]*)*$.

familyName: String!

Part of a personal name that identifies a family, tribe, or community.

Minimum length: 2 character Maximum length: 255 characters

The validation for the input uses the following regex pattern ^[a-zA-Z]+(([',. -][a-zA-Z ])?[a-zA-Z]*)*$.

suffix: String

amount: MoneyFilterInput

type: AchTransferTypeFilterInput

purpose: AchTransferPurposeFilterInput

sign: AchTransferSignFilterInput

cardProductId: StringSearchFilterInput

companyIdentifier: StringFilterInput

companyName: StringSearchFilterInput

companyEntryDescription: StringSearchFilterInput

traceNumber: StringFilterInput

status: NonOriginatedAchTransferStatusFilterInput

statusFailureReason: AchTransferStatusFailureReasonFilterInput

holdStatus: AchHoldStatusFilterInput

createdAt: TimestampFilterInput

settlementDate: DateFilterInput

returnSentToBankAt: TimestampFilterInput

NonOriginatedAchTransferStatusFilterInput

Input for filtering by AchTransferPurpose.

Output:INPUT_OBJECT

Input Fields

equals: NonOriginatedAchTransferStatus

notEquals: NonOriginatedAchTransferStatus

includes: [NonOriginatedAchTransferStatus!]

excludes: [NonOriginatedAchTransferStatus!]

NotificationEventsFilterInput

The input to provide filters for the notificationEvents query.

Output:INPUT_OBJECT

Input Fields

createdAt: NotificationTimestampFilterInput

Filter by the createdAt timestamp of the notification event.

Filter by the name of the notification event.

NotificationTimestampFilterInput

Input for filtering dates.

The format for each String field should be in YYYY-MM-DD format.

Example: 2021-11-12

Output:INPUT_OBJECT

Input Fields

equals: String

An ISO 8601 value that exactly matches the provided String.

notEquals: String

An ISO 8601 value that does not match the provided String.

lessThan: String

An ISO 8601 value to filter to dates before the given String.

lessThanOrEquals: String

An ISO 8601 value to filter to dates that match or are before the given String.

greaterThan: String

An ISO 8601 value to filter to dates after the given String.

greaterThanOrEquals: String

An ISO 8601 value to filter to dates that match or are after the given String.

between: NotificationTimestampFilterInputRange

Value to filter to dates that fall between values.

NotificationTimestampFilterInputRange

Input for filtering by date value ranges (inclusive).

The format for each String field should be in YYYY-MM-DD format.

Example: 2021-11-12

Output:INPUT_OBJECT

Input Fields

start: String

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

end: String

An ISO 8601 value (inclusive) for the ending date.

OnboardPayfacMerchantBusinessOrganizationInput

Input type for onboarding a Payfac merchant business Organization

Output:INPUT_OBJECT

Input Fields

productId: ID!

The global identifier for the CardProduct to use for onboarding this Payfac merchant business Organization.

merchantApplicantOrganizationId: ID!

The global identifier for the Payfac merchant business Organization to onboard.

affiliateOrganizationId: ID

Optional; the global identifier for the Organization this Payfac merchant is affiliated with, such as an Independent Sales Organization (ISO) or Independent Software Vendor (ISV).

pricingPlanId: ID!

The global identifier for the pricing plan to use for onboarding this Payfac merchant business Organization.

processingCapabilities: [ProcessingCapabilityInput!]!

A list of ProcessingCapability to use for onboarding this Payfac merchant business Organization.

financialReserves: [FinancialReserveInput!]

The financial reserves to use for onboarding this Payfac merchant business Organization.

consent: ConsentInput!

Consent to onboard this Payfac merchant business Organization.

OnboardPayfacPartnerBusinessOrganizationInput

Input type for onboarding a Payfac partner business Organization

Output:INPUT_OBJECT

Input Fields

productId: ID!

The global identifier for the product to use for onboarding this Payfac merchant business Organization.

merchantApplicantPartyId: ID!

The global identifier for the Payfac partner business Organization to onboard.

consent: ConsentInput!

Consent to onboard this Payfac partner business Organization.

OrderPhysicalPaymentCardForGroupInput

Input fields for ordering a payment card.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

Id of the payment card.

groupOrderId: ID!

Id of the group order.

deliveryDetails: PaymentCardDeliveryDetailsInput

Delivery details.

cardPersonalization: PaymentCardPersonalizationInput!

Card personalization.

OrderPhysicalPaymentCardInput

Input fields for ordering a payment card.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

Id of the payment card.

deliveryDetails: PaymentCardDeliveryDetailsInput!

Delivery details.

cardPersonalization: PaymentCardPersonalizationInput!

Card personalization.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the fulfillment should not happen before a certain date.

If the card should be shipped as soon as possible, omit this field. If the date provided is in the past, the value will be ignored.

OrderPhysicalPaymentCardWithValidatedAddressInput

Input fields for ordering a payment card with validated address.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

Id of the payment card.

deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!

Delivery details.

cardPersonalization: PaymentCardPersonalizationInput!

Card personalization.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the fulfillment should not happen before a certain date.

If the card should be shipped as soon as possible, omit this field. If the date provided is in the past, the value will be ignored.

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Minimum length: 5 characters Maximum length: 255 characters

OrderPhysicalPaymentCardWithValidatedAddressTokenInput

Input fields for ordering a payment card with validated address token.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

Id of the payment card.

deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!

Delivery details.

cardPersonalization: PaymentCardPersonalizationInput!

Card personalization.

Courier information.

requestedShipDate: String

Requested ship date in YYYY-MM-DD format.

Use this if the fulfillment should not happen before a certain date.

If the card should be shipped as soon as possible, omit this field. If the date provided is in the past, the value will be ignored.

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

Minimum length: 5 characters Maximum length: 255 characters

OrganizationBusinessRelationshipFilterInput

Inputs for filtering organization business relationships.

Output:INPUT_OBJECT

Input Fields

relationshipStatus: [OrganizationBusinessRelationshipStatus!]

Filter by relationship status (ACTIVE or INACTIVE).

relationshipTypes: [OrganizationBusinessRelationshipType!]

The types of relationships

fromOrganization: ID

The id of the organization from where the relationship originates

OriginatedAchTransferFilterInput

Inputs for filtering originated ACH transfer data.

Output:INPUT_OBJECT

Input Fields

amount: MoneyFilterInput

type: AchTransferTypeFilterInput

purpose: AchTransferPurposeFilterInput

sign: AchTransferSignFilterInput

cardProductId: StringSearchFilterInput

companyEntryDescription: StringSearchFilterInput

traceNumber: StringFilterInput

status: OriginatedAchTransferStatusFilterInput

The name of a person to whom the shipment should be delivered.

companyName: String

The company to whom the shipment should be delivered.

address: AddressInput!

The address to where the shipment should be delivered.

PaymentCardDeliveryDetailsWithValidatedAddressInput

The details of the delivery.

Output:INPUT_OBJECT

Input Fields

The name of a person to whom the shipment should be delivered.

companyName: String

The company to whom the shipment should be delivered.

validatedAddressId: ID!

The ID of validated address to where the shipment should be delivered.

PaymentCardDisputeStatusFilterInput

Input to filter by PaymentCardDisputeStatus.

Output:INPUT_OBJECT

Input Fields

equals: PaymentCardDisputeStatus

notEquals: PaymentCardDisputeStatus

includes: [PaymentCardDisputeStatus!]

excludes: [PaymentCardDisputeStatus!]

PaymentCardFilterInput

Inputs for filtering based on PaymentCard details.

Output:INPUT_OBJECT

Input Fields

paymentCardId: IDFilterInput

Input to filter by payment card ID

Input to filter by payment card bank identification number.

Input to filter by last 4 digits of payment card number.

paymentCardStatus: PaymentCardStatusFilterInput

Input to filter by payment card status.

paymentCardPersonalizationLine1: StringFilterInput

Input to filter by first line of personalization on physical payment card.

paymentCardPersonalizationLine2: StringFilterInput

Input to filter by second line of personalization on physical payment card.

cardProfileSetId: IDFilterInput

Input to filter by card profile set ID.

accountHolderId: IDFilterInput

Input to filter by account holder ID.

paymentCardHolderId: IDFilterInput

Input to filter by payment card holder ID.

PaymentCardGroupOrderStatusFilterInput

Inputs for filtering by PaymentCardGroupOrderStatus

Output:INPUT_OBJECT

Input Fields

equals: PaymentCardGroupOrderStatus

notEquals: PaymentCardGroupOrderStatus

includes: [PaymentCardGroupOrderStatus!]

excludes: [PaymentCardGroupOrderStatus!]

PaymentCardInput

Used to represent a Payment Card.

Output:INPUT_OBJECT

Input Fields

cardNumber: String!

The primary account number for the payment card.

expiryYear: String!

The year the payment card expires.

Must be formatted as YY.

expiryMonth: String!

The month the payment card expires.

textLines: PaymentCardPersonalizationTextLinesInput!

Personalization text lines.

PaymentCardPersonalizationTextLinesInput

Payment card personalization text lines input.

Output:INPUT_OBJECT

Input Fields

line1: String!

First line.

The value provided will be stored and returned fully capitalized.

For example, Jane will be stored as JANE.

Minimum length is 1 and maximum length is 23. Valid characters are all alphanumeric characters, ,, ., ', &, -, \, $, and space. The regex used to validate is ^[0-9A-Za-z \&\-\,\.\/\'\$]*$.

line2: String

Second line.

The value provided will be stored and returned fully capitalized.

For example, Jane will be stored as JANE.

timeRange: TimestampFilterInputRange

Filters transaction metrics by TimeRange, start and end are inclusive.

cardProductIds: [String!]

Filters transaction metrics by CardProductId, optional.

merchantCategoryCodes: [String!]

Filters transaction metrics by merchant category codes, optional.

merchantNames: [String!]

Filters transaction metrics by merchant name, optional.

PaymentCardTransactionChargebacksFilterInput

Input for filtering PaymentCardTransactionChargeback

Output:INPUT_OBJECT

Input Fields

productId: IDFilterInput

Input to filter by CardProduct ID.

accountId: IDFilterInput

Input to filter by FinancialAccount ID.

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

externalNetworkId: StringFilterInput

Chargeback externalNetworkId filter

PaymentCardTransactionDisputesFilterInput

Input for filtering PaymentCardTransactionDispute

Output:INPUT_OBJECT

Input Fields

productId: IDFilterInput

Input to filter by CardProduct ID.

accountId: IDFilterInput

Input to filter by FinancialAccount ID.

disputeId: IDFilterInput

Input to filter by PaymentCardTransactionDispute ID.

disputeStatus: PaymentCardDisputeStatusFilterInput

Input to filter by PaymentCardTransactionDispute status.

disputeCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionDispute created date.

disputeHasChargeback: BooleanFilterInput

Input to filter disputes by whether a PaymentCardTransactionDispute has an associated PaymentCardTransactionChargeback.

chargebackId: IDFilterInput

Input to filter by PaymentCardTransactionChargeback ID.

chargebackStatus: PaymentCardChargebackStatusFilterInput

Input to filter by PaymentCardTransactionChargeback status.

chargebackCreatedAt: TimestampFilterInput

Input to filter by PaymentCardTransactionChargeback created date.

externalNetworkId: StringFilterInput

Chargeback externalNetworkId filter

PaymentCardTransactionEventsFilterInput

Inputs for filtering transaction events.

Output:INPUT_OBJECT

Input Fields

operationalCurrency: ISO4217Alpha3CurrencyCode

eventType: TransactionEventFilterInput

requestedAmount: MoneyFilterInput

approvedAmount: MoneyFilterInput

responseCode: TransactionEventResponseCodeFilterInput

avsResponseCode: AVSResponseCodeFilterInput

postalCodeResponseCode: PostalCodeResponseCodeFilterInput

cvvResponseCode: CVVResponseCodeFilterInput

transactionType: TransactionTypeFilterInput

paymentCardId: IDFilterInput

transactionId: IDFilterInput

createdAt: TimestampFilterInput

updatedAt: TimestampFilterInput

merchantDetails: MerchantDetailsFilterInput

onlyOpenAuthorizations: BooleanFilterInput

Open authorizations events have the following properties:

Are the first transaction event with a particular public transaction identifier. This means they are the first event in a sequence of events with the same public transaction identifier.
Authorization expiration date is not empty and not in the past.
The approved amount has not been fully reversed or cleared to zero by subsequent transaction events with the same public transaction identifier.

authorizationExpiration: TimestampFilterInput

Authorization expiration date

PaymentInstructionInput

Allows for the specification of payment instructions for PaymentOrders, which allows choice on how to disburse funds for each PaymentOrderItem.

Must define either disbursementPercent or disbursementAmount, but not both.

If choosing to specify an amount to disburse, the amount must be in the same currency as the PaymentOrderItem and all disbursementAmount must sum to the total amount of the PaymentOrderItem. If choosing to specify a percentage to disburse, the sum of all disbursementPercent must equal 100.

Output:INPUT_OBJECT

Input Fields

disburseToId: ID!

The Highnote Node ID to disburse funds to. This must be a Highnote FinancialAccount.

disbursementPercent: Int

The amount to disburse for this PaymentOrderItem in percentage.

Where 100 is 100% of the total amount of the PaymentOrderItem.

disbursementAmount: AmountInput

The amount to disburse for this PaymentOrderItem.

The amount must be in the same currency as the PaymentOrderItem and all disbursementAmount must sum to the total amount of the PaymentOrderItem.

PaymentMethodTypeInput

The input to filter by payment method type.

Output:INPUT_OBJECT

Input Fields

equals: PaymentMethodType

Value matches the provided payment method type.

PaymentOrderItemFromCatalogItemInput

Input for creating a new PaymentOrderItemFromCatalogItem.

Output:INPUT_OBJECT

Input Fields

id: ID!

The CatalogItem ID to add to the PaymentOrder.

Overwrite product name for this PaymentOrderItemFromCustomItem.

Supports up to 255 alphanumeric characters.

description: String

Overwrite the product description for this PaymentOrderItemFromCustomItem.

Supports up to 255 alphanumeric characters.

amountPerItem: AmountInput

Overwritten amount for this PaymentOrderItemFromCatalogItem per individual item.

paymentInstructions: [PaymentInstructionInput!]

Specifies the payment instructions for this PaymentOrderItemFromCatalogItem.

quantity: UnsignedInt!

The quantity of the this PaymentOrderItemFromCatalogItem.

externalIdentifier: String

An optional external reference ID for this PaymentOrderItemFromCatalogItem.

Supports up to 255 alphanumeric characters.

PaymentOrderItemFromCustomItemInput

Input for creating a new PaymentOrderItemFromCustomItem.

Output:INPUT_OBJECT

Input Fields

The product name for this PaymentOrderItemFromCustomItem.

Supports up to 255 alphanumeric characters.

description: String

The product description for this PaymentOrderItemFromCustomItem.

Supports up to 255 alphanumeric characters.

amountPerItem: AmountInput!

The amount for this PaymentOrderItemFromCustomItem per individual item.

paymentInstructions: [PaymentInstructionInput!]

Specifies the payment instructions for this PaymentOrderItemFromCustomItem.

quantity: UnsignedInt!

The quantity of the this PaymentOrderItemFromCustomItem.

externalIdentifier: String

An optional external reference ID for this PaymentOrderItemFromCustomItem.

Supports up to 255 alphanumeric characters.

PaymentTransactionFilterInput

The filters used to scope the type of PaymentTransactions returned.

Output:INPUT_OBJECT

Input Fields

cardProductId: IDFilterInput

Filter PaymentTransactions by the CardProduct used to make the payment.

Note: This filter only supports equals currently, all other comparison operators will be ignored.

contractId: IDFilterInput

Filter PaymentTransactions by the contractId used to make the payment.

Note: This filter only supports equals currently, all other comparison operators will be ignored.

cardHolderName: StringFilterInput

Filter PaymentTransactions by the CardHolders name used to make the payment.

Note: This filter only supports equals currently, all other comparison operators will be ignored.

cardHolderEmail: StringFilterInput

Filter PaymentTransactions by the CardHolders email used to make the payment.

Note: This filter only supports equals currently, all other comparison operators will be ignored.

disburseToId: IDFilterInput

Filter PaymentTransactions by it's PaymentInstruction.disburseTo ID.

Note: This filter only supports equals currently, all other comparison operators will be ignored.

transferId: IDFilterInput

Filter PaymentTransactions by transfer IDs created when PaymentInstructions resolve.

authorizationIdentifier: StringFilterInput

Filter PaymentTransactions by authorizationIdentifier created when a PaymentTransaction is captured.

DEPRECATED: Use authorizationCode instead.

authorizationCode: StringFilterInput

Filter PaymentTransactions by authorizationCode created when a PaymentTransaction is captured.

searchQueryLanguage: SearchQueryLanguageInput

Used to search using the Highnote SearchQueryLanguage. Cannot be used in conjunction with other filters.

PersonAccountHolderFilterInput

Inputs for filtering person account holder data.

familyName: String!

Part of a personal name that identifies a family, tribe, or community.

Minimum length: 2 characters Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

PersonAuthorizedUserFilterInput

Inputs for filtering person authorized user data.

Output:INPUT_OBJECT

Input Fields

dateOfBirth: DateFilterInput

billingAddress: AddressFilterInput

socialSecurityNumberLast4: HashedFilterInput

PersonAuthorizedUserNameFilterInput

Input for filtering authorized users by name. The matching for these name fields are performed using similar sounding scores. e.g. keywords like Mayer, mayer, Mire & Mary will lead to the same score.

Output:INPUT_OBJECT

Input Fields

title: SoundsLikeFilterInput

givenName: SoundsLikeFilterInput

middleName: SoundsLikeFilterInput

familyName: SoundsLikeFilterInput

suffix: SoundsLikeFilterInput

PersonAuthorizedUserNameInput

Input representing common fields of a PersonAuthorizedUser's name.

Output:INPUT_OBJECT

Input Fields

givenName: String!

The part of the name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

middleName: String

Additional part of name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

familyName: String!

Part of a personal name that identifies a family, tribe, or community.

Minimum length: 2 characters Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

PersonCreditRiskAttributesInput

Input representing credit risk attributes for person underwriting.

Output:INPUT_OBJECT

Input Fields

totalAnnualIncome: [AmountInput!]

Total annual income expressed as an Amount.

currentDebtObligations: [AmountInput!]

Current debt obligations expressed as an Amount.

employmentStatus: EmploymentStatus

Person's employment status.

monthlyHousingPayment: [AmountInput!]

The rent, mortgage, or other type of housing payment made on a monthly basis as an Amount.

PersonNameFilterInput

Input for filtering persons by name. The matching for these name fields are performed using similar sounding scores. e.g. keywords like Mayer, mayer, Mire & Mary will lead to the same score.

Output:INPUT_OBJECT

Input Fields

title: SoundsLikeFilterInput

givenName: SoundsLikeFilterInput

middleName: SoundsLikeFilterInput

familyName: SoundsLikeFilterInput

suffix: SoundsLikeFilterInput

PhoneFilterInput

Input for filtering phone number.

Output:INPUT_OBJECT

Input Fields

label: PhoneLabelFilterInput

number: StringFilterInput

extension: StringFilterInput

PhoneInput

Input representing parts of a phone number.

Output:INPUT_OBJECT

Input Fields

countryCode: String!

The assigned country code for the number.

number: String!

The phone number in a country specific format.

extension: String

A number representing a specific phone on the same number as the main line.

label: PhoneLabel!

A classification for the type of the device the phone number is attached or how the phone number is used (e.g. home or work)

PhoneLabelFilterInput

Input for filtering by PhoneLabel.

Output:INPUT_OBJECT

Input Fields

equals: PhoneLabel

notEquals: PhoneLabel

includes: [PhoneLabel!]

excludes: [PhoneLabel!]

PhysicalCardGroupOrderFilterInput

Inputs for filtering physical payment card group orders.

Output:INPUT_OBJECT

Input Fields

cardProductId: IDFilterInput

Input to filter by card product ID.

groupOrderState: PaymentCardGroupOrderStatusFilterInput

Input to filter by payment card group order status.

shippingMethod: PaymentCardShippingMethodFilterInput

Input to filter by shipping method.

groupOrderId: IDFilterInput

Input to filter by physical card group order ID.

createdAt: TimestampFilterInput

Input to filter by physical card group order creation date.

actualShipDateLocal: DateFilterInput

Input to filter by physical card group order actual shipping date. Actual ship date should be provided in YYYY-MM-DD format.

PhysicalCheckPaymentRecipientInput

The input object that defines the fields for the recipient input.

There are multiple ways to provide recipient information:

One of validatedAddressTokenId, or address needs to be provided.

Output:INPUT_OBJECT

Input Fields

The name of recipient of the check.

address: AddressInput

The address of the recipient of the check.

externalIdentifier: String

Externally provided ID (255 character limit) to associate this recipient with an external system.

validatedAddressTokenId: ID

The ID of a ValidatedAddressToken to associate with the recipient.

PhysicalPaymentCardGroupOrderFilterInput

Inputs for filtering physical payment card group orders.

Output:INPUT_OBJECT

Input Fields

cardProductId: IDFilterInput

Input to filter by card product ID.

groupOrderState: PaymentCardGroupOrderStatusFilterInput

Input to filter by payment card group order status.

shippingMethod: PaymentCardShippingMethodFilterInput

Input to filter by shipping method.

groupOrderId: IDFilterInput

Input to filter by physical card group order ID.

createdAt: TimestampFilterInput

Input to filter by physical card group order creation date.

actualShipDateLocal: DateFilterInput

Input to filter by physical card group order actual shipping date. Actual ship date should be provided in YYYY-MM-DD format.

PhysicalPaymentCardOrderFilterInput

Inputs for filtering PhysicalPaymentCardOrders.

Output:INPUT_OBJECT

Input Fields

physicalPaymentCardOrderId: IDFilterInput

Input to filter by physical payment card order ID

cardProductId: IDFilterInput

Input to filter by card product ID.

paymentCardOrderStatus: PaymentCardOrderStatusFilterInput

Input to filter by physical payment card order status.

shippingMethod: PaymentCardShippingMethodFilterInput

Input to filter by shipping method.

groupOrderId: IDFilterInput

Input to filter by physical card group order ID.

paymentCardFilterBy: PaymentCardFilterInput

Input to filter based on payment card details.

createdAt: TimestampFilterInput

Input to filter by physical payment card order creation date.

actualShipDateLocal: DateFilterInput

Input to filter by physical payment card order actual shipping date. Actual ship date should be provided in YYYY-MM-DD format.

PointOfServiceDetailsInput

Details about the point of service for the transaction.

Output:INPUT_OBJECT

Input Fields

category: PointOfServiceCategory

The point of service category.

panEntryMode: PanEntryMode

The PAN entry mode.

pinEntryMode: PinEntryMode

The PIN entry mode.

terminalAttendance: TerminalAttendance

The attendance at the terminal.

isCardHolderPresent: Boolean

Represents whether the cardholder is present or not.

isCardPresent: Boolean

Represents whether the card is present or not.

isRecurring: Boolean

Represents whether this transaction is recurring or not. When this field is set to true, isCardholderPresent and isCardPresent should be false.

terminalSupportsPartialApproval: Boolean

Represents whether the terminal supports partial approval or not.

cardDataInputCapability: CardDataInputCapability

Tha capabilities of the terminal to read card data.

PostalCodeResponseCodeFilterInput

Input for filtering Postal code response code

Output:INPUT_OBJECT

Input Fields

equals: PostalCodeResponseCode

Value matches the provided Postal code response code

notEquals: PostalCodeResponseCode

Value does not match the provided Postal code response code

includes: [PostalCodeResponseCode!]

Value exactly matches all of the provided Postal code response code

excludes: [PostalCodeResponseCode!]

Value does not match any of the provided Postal code response code

PreviousProductApplicationFilterInput

Filter input for previous applications

Output:INPUT_OBJECT

Input Fields

includes: [AccountHolderApplicationStatusCode!]

The current relationship status with the previous application

createdAt: TimestampFilterInput

The create date of the previous application

ProcessingCapabilityInput

A processing capability input

Output:INPUT_OBJECT

Input Fields

permittedProcessingNetwork: AcquirerNetwork!

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

permittedPaymentMethod: PaymentMethod!

The permitted payment method, e.g. CARD

permittedMerchantCategoryCode: String

The permitted merchant category code that can be used with acquiring transactions. Use permittedMerchantCategoryValues for multiple categories.

permittedMerchantCategoryValues: [MerchantCategory!]

The permitted merchant category values that can be used with acquiring transactions.

permittedTransactionTypes: [CardTransactionProcessingType!]

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

acquiringProviderType: AcquiringProviderType

The acquiring provider or sponsor bank

merchantDescriptor: String

The merchant description that will be used for individual transactions

ProvisionAccountHolderActionInput

Input object for specifying actions during the provisioning of an account holder.

This type contains the inputs required for various provisioning actions, such as creating an application, setting a financial account credit limit, or issuing a payment card.

Output:INPUT_OBJECT

Input Fields

createAccountHolderCardProductApplicationInput: ProvisionCreateAccountHolderCardProductApplicationInput

Input details required to create an account holder application.

This field provides the necessary parameters for processing an application for the account holder.

issueFinancialAccountForApplicationInput: ProvisionIssueFinancialAccountForApplicationInput

Input details required to issue a financial account for the account holder.

This field includes the necessary parameters to establish and configure a new financial account.

initiateFinancialAccountCreditLimitUpdateFromProductFundingInput: ProvisionInitiateFinancialAccountCreditLimitUpdateFromProductFundingInput

Input details for setting or updating the credit limit of a financial account.

This field contains the parameters needed to define or modify the credit limit for the account holder’s financial account.

issuePaymentCardForFinancialAccountInput: ProvisionIssuePaymentCardForFinancialAccountInput

Input details required to issue a payment card associated with the account holder’s financial account.

This field provides the necessary parameters for issuing a payment card.

linkVerifiedExternalBankAccountInput: LinkVerifiedExternalBankInput

Input details for linking an account holder with verified external bank account.

ProvisionAccountHolderInput

Input to provision an Account Holder

Output:INPUT_OBJECT

Input Fields

idempotencyKey: IdempotencyKey!

A UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

accountHolderId: ID!

The unique identifier of the account holder being provisioned. This field should be a valid ID representing the account holder.

actions: [ProvisionAccountHolderAction!]!

A list of actions to be performed during the provisioning process. Each action represents a specific operation or step to be executed.

actionInput: ProvisionAccountHolderActionInput!

Required input specific to the actions being performed. This allows for additional details or parameters needed for the actions.

ProvisionCreateAccountHolderCardProductApplicationInput

Input for an account holder's application process.

This input type includes fields for consent to terms and conditions, IP address details, and credit report pull consent.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The unique identifier of the card product associated with the account holder. This field should be a valid ID representing the card product.

cardHolderAgreementConsent: ConsentInput!

Details on the acceptance of the terms and conditions of the card holder agreement. This field captures the applicant's consent to the agreement.

accountHolderCreditReportPullConsent: ConsentInput

Details on the account holder's consent to pull their credit report as part of the card product application. This field captures the applicant's consent for this specific action.

applicationConfiguration: ApplicationConfigurationInput

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

ProvisionInitiateFinancialAccountCreditLimitUpdateFromProductFundingInput

Input for setting the credit limit of a financial account.

This input type includes details for specifying the credit limit amount and an optional description.

Output:INPUT_OBJECT

Input Fields

amount: AmountInput!

The amount of credit limit to be set for the payment card. This field specifies the new credit limit amount.

memo: String

An optional description or memo for the credit limit update. This field provides context or notes about the credit limit change for future reference.

ProvisionIssueFinancialAccountForApplicationInput

Input for issuing a new financial account.

This input type includes fields for specifying an external identifier and the name of the financial account.

Output:INPUT_OBJECT

Input Fields

The name of the financial account. This field is required and should provide a meaningful name for the account.

ProvisionIssuePaymentCardForFinancialAccountInput

Input for provisioning an issued payment card for a financial account.

This input type includes options for configuring the newly issued payment card.

Output:INPUT_OBJECT

Input Fields

Options for the newly issued payment card. This field specifies the configuration details and preferences for the card issuance.

QuoteBankTransferDetailsInput

Additional details for bank-to-bank transfers used in createUnifiedFundsTransferQuote.

Consent is not required at quote time. Provide consent on InitiateUnifiedFundsTransferInput.consent when initiating the transfer.

Output:INPUT_OBJECT

Input Fields

paymentRelatedInformation: String!

Example: Invoice 0123456789 Payment 999.99 USD

Please note that payment-related information may or may not be displayed to the recipient. Availability and presentation depend on the receiving financial institution's system capabilities and the access channel used (e.g., online banking, mobile banking, account statement, or integrated receivables systems).

RedeemRewardsForStatementCreditInput

Input type for redeeming reward points.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

Identifier for the FinancialAccount to use for this reward redemption.

redemption: RedemptionCriteriaInput!

Redemption Criteria that will dictate how reward points will be redeemed.

memo: String

Note to be attached to the redemption. Max character length is 1024.

externalTransactionIdentifier: String

An optional tracker for external transaction identifier. Max character length is 255.

RedemptionCriteriaInput

Redemption information required to redeem points.

Output:INPUT_OBJECT

Input Fields

redemptionConfigurationId: ID!

Identifier of the RewardRedemptionConfiguration to use for this redemption. Note this RewardRedemptionConfiguration must have an attachment that is available for the target FinancialAccount"

pointsToRedeem: UnsignedInt

Number of points to redeem. Value should be greater than 0 and less than the reward point balance of the relevant account.

ReevaluateApplicationInput

The input for reevaluating a pre-existing, approved application

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The id of the application to be be reevaluated

productApplicationWorkflowConfigurationId: ID!

The id of the ProductApplicationWorkflowConfiguration

consentAgreement: ConsentInput!

The applicant's consent to reevaluating the existing application.

RefundPaymentTransactionInput

Input for refunding a payment transaction.

Output:INPUT_OBJECT

Input Fields

paymentTransactionId: ID!

The payment transaction to refund.

amount: AmountInput!

The amount to refund.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

refundReason: PaymentCreditTransactionRefundReason!

The reason why the PaymentTransaction was refunded to the original payment method

refundNote: String

Include additional information regarding the refund for tracking and analysis

ReissuePaymentCardFeaturesInput

Options for specifying which attributes of the original card should be copied.

Output:INPUT_OBJECT

Input Fields

copyNumber: Boolean

Whether or not to copy the number from the original card. False if not specified.

copyPin: Boolean

Whether or not to copy the pin from the original card. False if not specified.

ReissuePaymentCardInput

Details for issuing a new Payment Card based on an existing card.

Output:INPUT_OBJECT

Input Fields

originalPaymentCardId: ID!

The ID of the card to issue this Payment Card against.

Note: The card cannot be CLOSED.

options: ReissuePaymentCardOptionsInput!

Options for the newly issued Payment Card.

customFields: [CustomFieldInput!]

The CustomFields for the Payment Card.

idempotencyKey: IdempotencyKey

A value to distinguish unique reissue request.

This helps prevent duplicate cards from be reissued. If a failure happens and it is unclear if a reissue payment card request went through, it is safe to repeat the request with the same idempotency key. If the reissue process has already happened, the request will be deduped and the original response will be returned instead.

Minimum length: 10 characters Maximum length: 255 characters

ReissuePaymentCardOptionsInput

Options for the newly issued Payment Card.

Output:INPUT_OBJECT

Input Fields

expirationDate: String!

The exact date and time the payment card will expire. e.g. 2026-01-01T23:59:59Z If copying the number, cannot be in the same month/year (in UTC timezone) as the original card.

activateOnCreate: Boolean!

Whether or not to activate the card when created. If not activated on creation, the card must be activated separately before use.

reissueFeatures: ReissuePaymentCardFeaturesInput

Options for specifying which attributes of the original card should be copied. If not specified, no attributes will be copied.

reason: ReissueReason

The reason why a card is being reissued

targetId: ID!

RemoveSubscriptionsFromNotificationTargetInput

The input to remove subscriptions from a notification target.

Output:INPUT_OBJECT

Input Fields

targetId: ID!

Target Id

subscriptions: [NotificationEventName!]!

The event names to no longer receive notifications about.

RemoveUserInput

Data needed to remove a new User.

Output:INPUT_OBJECT

Input Fields

email: String!

E-mail of the user to remove.

RenameCollaborativeAuthorizationEndpointInput

The input to rename a CollaborativeAuthorizationEndpoint.

Output:INPUT_OBJECT

Input Fields

endpointId: ID!

The Global ID of the CollaborativeAuthorizationEndpoint to rename.

The new, human-friendly name for your CollaborativeAuthorizationEndpoint.

This value can contain any characters but cannot exceed a length of 255.

RenameNotificationTargetInput

The input to update the name of an existing notification target.

Output:INPUT_OBJECT

Input Fields

targetId: ID!

The notification target ID.

A name for the target. Must be between 1 and 255 characters.

ReplayNotificationEventInput

The input to replay a Notification Event.

Output:INPUT_OBJECT

Input Fields

notificationEventId: ID!

The id of the event to replay.

targetIds: [ID!]

Optional list of target IDs to replay the event for. If absent or empty, the event will be sent to all active targets that subscribe to this event type. If a target ID is provided for a target that does not subscribe to this event type or is not active, the replay request for that target will be ignored.

ReportFilterInput

Used to filter which reports are requested.

Output:INPUT_OBJECT

Input Fields

status: ReportStatusFilterInput

Filters reports by ReportStatus.

includes: [ReportStatus!]

ReportTypeFilterInput

Filters reports by ReportType.

Output:INPUT_OBJECT

Input Fields

includes: [ReportType!]

RequestedDocuments

Input for agent servicing application manual review requested documents.

Output:INPUT_OBJECT

Input Fields

applicantId: ID!

The ID of the applicant.

documentTypes: [DocumentType!]

The requested document types for the applicant.

ResetPseudoBalanceInput

Input for resetting a pseudo balance back to zero or a baseline amount. Used to manually trigger a balance reset outside of the automatic cadence.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the FinancialAccount whose pseudo balance should be reset.

cadence: PseudoBalanceCadence!

Allows setting a new pseudo balance cadence, how often to reset the pseudo balance.

resetAvailableBalance: Boolean!

Whether to reset the available balance to the pseudo balance limit.

true: The available balance will be reset to the value defined as the pseudo balance limit at the start of the new period.
false: The current balance carries over to the new period (useful for rolling balances when resetting cadence).

resetTime: String

An ISO 8601 formatted timestamp that determines when and how often the balance resets. The date and time components are used differently based on the selected cadence. See PseudoBalanceCadence for more details.

If not specified, the current reset time is preserved.

If no existing reset time exists, then the value will default depending on the cadence. See PseudoBalanceCadence for more details on the default value.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

rate: String!

The number of points earned per USD on a transaction. This rate should be between 0.0 and 100.0 with up to 3 digits of precision after the decimal point (i.e. 1.000).

Rounding on fractional points will be rounded down. For example:

rate	transaction amount	points earned
1.0 point per dollar	$1	1 point
1.5 points per dollar	$10	15 points

RewardRedemptionConfigurationAttachmentInput

Input for attaching RewardRedemptionConfiguration to an object.

Output:INPUT_OBJECT

Input Fields

id: ID!

Global identifier of the RewardRedemptionConfiguration to attach.

RewardRedemptionRateInput

The redemption rate for reward points, describing the monetary value per point.

Output:INPUT_OBJECT

Input Fields

rate: String!

Input for entering RewardRedemptionRate. The amount of money that will be redeemed per point earned. This rate should be between 0.0 and 100.0 with up to 3 digits of precision after the decimal point (i.e. 1.000).

Redemption value will be rounded down according to the currency precision. For example:

rate	points redeemed	redemption value
1.0 USD per point	10 points	$10.00
1.5 USD per point	10 points	$15.00
1.001 USD per point	10 points	$10.01

RewardRuleAttachmentInput

Input for attaching reward rules to an object.

accountHolderId: ID

Optional filter for focusing on data specific to a certain account holder.

periodicityType: RiskPeriodicityType!

Specifies the periodicity of the data points (e.g., weekly, monthly).

createdAt: TimestampFilterInput!

Sets the date range for the data points to be included in the scatter plot.

RotateNotificationTargetSigningKeyInput

Input for removing the email for a notification target.

Allows setting a new pseudo balance cadence, how often to reset the pseudo balance.

amount: AmountInput!

The new absolute limit amount for the pseudo balance. This replaces any existing limit.

resetAvailableBalance: Boolean!

Whether to reset the available balance to the pseudo balance limit.

true: The available balance will be reset to the value defined as the pseudo balance limit at the start of the new period.
false: The current balance carries over to the new period (useful for rolling balances when resetting cadence).

resetTime: String

If not specified, the current reset time is preserved.

If no existing reset time exists, then the value will default depending on the cadence. See PseudoBalanceCadence for more details on the default value.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

SignedMoneyFilterInput

Money value type the allows for positive or negative values

Output:INPUT_OBJECT

Input Fields

currencyCode: ISO4217Alpha3CurrencyCode!

equals: Int

A value that exactly matches the provided Int.

notEquals: Int

A value that does not exactly match the provided Int.

lessThan: Int

A value to filter to numbers less than the given Int.

lessThanOrEquals: Int

A value to filter to numbers less than or equal to the given Int.

greaterThan: Int

A value to filter to numbers greater than the given Int.

greaterThanOrEquals: Int

A value to filter to numbers greater than or equal to the given Int.

includes: [Int!]

Filter to values that exactly match any of the provided Ints.

excludes: [Int!]

Filter to values that do not match any of the provided Ints.

between: SignedMoneyFilterInputRange

Filter to values that fall between the provided Ints.

SignedMoneyFilterInputRange

Money value range (inclusive)

Output:INPUT_OBJECT

Input Fields

start: Int

An Int value (inclusive) for the beginning of the range.

end: Int

An Int value (inclusive) for the end of the range.

SimulateAchTransferProcessingInput

Input details when simulating the processing of an OriginatedAchTransfer or NonOriginatedAchTransfer.

transactionId: ID!

The transactionId from the original ClearingEvent or 'AuthorizationAndClearEvent'.

amount: AmountInput!

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

transactionProcessingType: CardTransactionProcessingType!

The type of Adjustment being simulated, should be ADJUSTMENT_CREDIT or ADJUSTMENT_DEBIT.

SimulateApplicationDocumentReviewInput

An input representing the parts of a simulated update to review status on a previously created AccountHolderApplicationDocument.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application containing the document to be reviewed.

documentUploadSessionId: ID!

The ID for an initiated DocumentUploadSession containing the document to be reviewed.

Expected format: du_* (use documentUploadSession.id)

documentUploadLinkId: ID!

The ID for a DocumentUploadLink returned by createDocumentUploadLink. This ID represents an AccountHolderApplicationDocument and serves to specify the document being reviewed.

newReviewStatus: ApplicationDocumentUploadStatus!

The target status representing the decision made by an Agent after reviewing the applicant's uploaded document.

fileReviewReasons: [ApplicationDocumentReviewReason!]

The given reasons for the file review status.

SimulateApplicationStatusChangeInput

An input representing the parts of a simulated update to application status on a previously created Card Product Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application to be updated.

newApplicationStatus: AccountHolderApplicationStatusCode!

The target application status for the specified application representing the outcome of manual identity review by an Agent.

SimulateApplicationVerificationStatusChangeInput

An input representing the parts of a simulated update to verification status for an Account Holder on a previously created Card Product Application.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application containing the applicant whose verification status will be updated.

applicantId: ID!

The ID of the applicant whose verification status will be updated.

newVerificationStatus: AccountHolderVerificationStatusReasonCode!

The target verification status for the specified applicant representing the outcome of manual identity review by an Agent.

SimulateAuthorizationInput

Details to simulate the authorization.

Output:INPUT_OBJECT

Input Fields

id: ID

The optional ID of a previous authorization.

Typically, this is only used to simulate "incremental authorization".

cardId: ID!

The ID of the payment card to be used.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

cashbackAmount: AmountInput

The Amount of cashback requested during the transaction.

SimulateBackwardShiftAndAgeCurrentFinancialAccountStatementPeriodInput

Input fields for shifting the current statement period backward and aging the Financial Account.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

FinancialAccount id

numberOfCyclesToShiftCurrentStatementBackward: UnsignedInt!

The number of billing cycles to shift the current statement backward.

SimulateCardDigitalWalletTokenActivatedInput

Input to simulate a card digital wallet token activation.

Output:INPUT_OBJECT

Input Fields

cardDigitalWalletTokenId: ID!

The ID of the card digital wallet token to be activated.

SimulateCardDigitalWalletTokenActivationInput

Input to simulate a card digital wallet token activation.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the payment card to create digital wallet token.

requesterIdentifier: String

The requester identifier assigned to a Digital Wallet Token. If none provided we would default it to requester identifier of Google Pay.

tokenType: CardDigitalWalletTokenType

The Card Digital Wallet Token type. If none provided then we would default it to DEVICE_SECURE_ELEMENT.

sourceEntryMethod: CardDigitalWalletTokenSourceEntryMethod

The Card Digital Wallet Token source entry method. If none provided then we would default it to MANUAL_ENTRY.

SimulateCheckPaymentEventInput

The input for simulateCheckPaymentEvent. This will trigger a webhook.

Output:INPUT_OBJECT

Input Fields

checkPaymentId: ID!

The CheckPayment ID to simulate a CheckPaymentEvent.

checkEventType: CheckPaymentEventType!

The event to update the CheckPayment to.

SimulateClearingInput

Details to simulate the clearing.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the clearing.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

cashbackAmount: AmountInput

The Amount of cashback to be cleared.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateCloseFinancialAccountInput

Details for simulating FinancialAccount closure.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the FinancialAccount to move into CLOSED status.

SimulateCreateAndActivateFeeScheduleInput

Simulated fee schedule input.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

Fee schedule associated to a card product.

feeConfigurations: [SimulateFeeConfigurationInput!]

Fee configuration details about activity and fee amount to be charged.

SimulateCreateApplicationDocumentsUploadSessionsInput

Input for simulate creating application documents upload sessions.

Output:INPUT_OBJECT

Input Fields

applicationId: ID!

The ID of the application.

memo: String

The memo of the manual review.

requestedDocuments: [RequestedDocuments!]

The requested documents for each applicant.

SimulateDepositInput

The details to simulate a electronic fund transfer in the test environment.

Output:INPUT_OBJECT

Input Fields

amount: AmountInput!

The amount to add to an Organization's account.

source: ElectronicFundTransferSource!

Source used for fund transfer.

toFinancialAccountId: ID!

The ID of the Organization's Financial Account for transfer.

memo: String

A description of the transfer for later reference.

SimulatedFeeAmountInput

Fee amount to be charged.

Output:INPUT_OBJECT

Input Fields

feeAmount: AmountInput

Fee amount to be charged. It cannot be combined with feePercentage or feeBasisPoints.

feeBasisPoints: UnsignedInt

Basis points representation of the fee percentage to be charged. eg: 125 basis points = 1.25%

SimulateDigitalWalletTokenAuthorizationInput

Details to simulate authorization using a digital wallet token.

Output:INPUT_OBJECT

Input Fields

id: ID

The optional ID of a previous authorization.

Typically, this is only used to simulate "incremental authorization".

cardDigitalWalletTokenId: ID!

The digital wallet token identifier to use for this authorization.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetailsInput

The digital wallet token details to be simulated for this authorization.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

cashbackAmount: AmountInput

The Amount of cashback requested during the transaction.

SimulateDigitalWalletTokenMastercardFleetAuthorizationInput

Details to simulate a Mastercard Fleet authorization using a digital wallet token.

Output:INPUT_OBJECT

Input Fields

cardDigitalWalletTokenId: ID!

The digital wallet token identifier to use for this authorization.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetailsInput

The digital wallet token details to be simulated for this authorization.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateMastercardFleetAuthorizationDataInput

Fleet specific details for this authorization.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateDigitalWalletTokenSingleStepAuthAndClearInput

Details to simulate authorization and clear using a digital wallet token.

Output:INPUT_OBJECT

Input Fields

cardDigitalWalletTokenId: ID!

The digital wallet token identifier to use for this transaction.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetailsInput

The digital wallet token details to be simulated for this transaction.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

cashbackAmount: AmountInput

The Amount of cashback requested during the transaction.

SimulateDigitalWalletTokenVisaFleetAuthorizationInput

Details to simulate a Visa Fleet authorization using a digital wallet token. Allows for partial authorizations.

Output:INPUT_OBJECT

Input Fields

id: ID

The optional ID of a previous authorization.

Typically, this is only used to simulate "incremental authorization".

cardDigitalWalletTokenId: ID!

The digital wallet token identifier to use for this authorization.

cardDigitalWalletTokenDetails: CardDigitalWalletTokenDetailsInput

The digital wallet token details to be simulated for this authorization.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateVisaFleetAuthorizationDataInput

Fleet specific details for this authorization.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateExternallyInitiatedACHTransferInput

Input for creating a new simulated ExternallyInitiatedACHTransfer.

This is used only for testing.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The internal FinancialAccount involved in the transfer.

companyIdentifier: String

The identifier of the simulated external organization initiating the transfer.

It can be up to 10 alphanumeric characters. If not specified, it will be populated as 1234567890

companyName: String

The name of the simulated external organization initiating the transfer.

It can be up to 16 alphanumeric characters. If not specified, it will be populated as THESAMPLECOMPANY

companyEntryDescription: String

Arbitrary value describing the transfer entered by the simulated external organization.

It can be up to 10 alphanumeric characters. If not specified, it will be populated as ENTRYDSCPT

individualIdentificationNumber: String

The identification number of the simulated external party initiating the transfer.

This could be either a business or an individual. It can be up to 15 alphanumeric characters. If not specified, it will be populated as RECEIVER_NUMBER

individualName: String

The name of the simulated external party initiating the transfer.

This could be either a business or an individual. It can be up to 22 alphanumric characters. If not specified, it will be populated as THISISTHERECIEVEROFACH

amount: AmountInput

The amount of money being transferred. If not specified, it will be populated as USD 1000

transferType: TransferType

Transfer type denoting the direction of the money, either into or out of the FinancialAccount. If not specified, it will be populated as CREDIT

settlementDate: String

Settlement date in YYYY-MM-DD format. If not specified, current date will be used.

SimulateFeeConfigurationInput

Simulated fee configuration input.

Output:INPUT_OBJECT

Input Fields

feeActivityType: FeeTransferEventFeeActivityTypeInput!

The activity for which the fee is charged.

feeAmount: SimulatedFeeAmountInput!

Fee amount to be charged.

SimulateFinalizeProvisionalCreditForCardTransactionDisputeInput

Input for simulateFinalizeProvisionalCreditForCardTransactionDispute.

Output:INPUT_OBJECT

Input Fields

id: ID!

The ID of the dispute.

liability: PaymentCardDisputeLiability

Indicates whether the Issuer or Merchant is liable for the dispute. Defaults to MERCHANT_LIABLE if not specified.

amount: AmountInput!

The amount to finalize the provisional credit.

SimulateInitiateCardTransactionChargebackInput

Input for simulateInitiateCardTransactionChargeback.

Output:INPUT_OBJECT

Input Fields

disputeId: ID!

The ID of the dispute.

amount: AmountInput!

The requested amount.

SimulateInitiateCardTransactionDisputeInput

Input for simulateInitiateCardTransactionDispute.

Output:INPUT_OBJECT

Input Fields

cardTransactionEventId: ID!

The ID of the transaction event (AuthorizationAndClearEvent or ClearingEvent).

openTwentyFourHours: Boolean

This fuel location is open 24 hours.

eighteenWheelerAccess: Boolean

This fuel location has access for 18 wheelers.

dieselSites: Boolean

This fuel location has diesel sites.

interstateAccess: Boolean

This fuel location has interstate highway access.

convenienceStore: Boolean

This fuel location has a convenience store.

restaurant: Boolean

This fuel location has a restaurant.

hotel: Boolean

This fuel location has a hotel.

showers: Boolean

This fuel location has showers.

repairBays: Boolean

This fuel location has repair bays.

vehicleWash: Boolean

This fuel location has a vehicle washing station.

aviationLocation: Boolean

This fuel location has an aviation location.

marinaLocation: Boolean

This fuel location has a marina location.

alternativeFuel: Boolean

This fuel location has alternative fuel pumps.

payAtPump: Boolean

This fuel location has pay-at-pump support.

SimulateMastercardAdditionalNetworkDataInput

Simulate Mastercard network specific transaction data.

Output:INPUT_OBJECT

Input Fields

aavResultCode: MastercardAavResultCode

Validation result for Mastercard's Accountholder Authentication Value.

threeDSecureCardholderAuthentication: MastercardThreeDSecureCardholderAuthentication

Information about the 3DSecure Cardholder Authentication.

ucafCollectionIndicator: MastercardUcafCollectionIndicator

Information about the collection capabilities of the Universal Cardholder Authentication Field.

fraudScore: UnsignedInt

The fraud score for the transaction provided by Mastercard. Values are between 0-999.

paymentFacilitatorIdentifier: String

Payment facilitator identifier for the transaction. Maximum length: 11

acquiringInstitutionIdentificationCode: String

A number used by Mastercard to identify the acquiring institution.

SimulateMastercardFleetAuthorizationAdviceInput

Details to simulate the authorization advice of a Mastercard Fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput!

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateMastercardFleetAuthorizationDataInput

Fleet specific details for this authorization.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateMastercardFleetAuthorizationDataFuelProductInput

Details of a Mastercard Fleet fuel product available at Authorization and Authorization Advice time

Output:INPUT_OBJECT

Input Fields

code: MastercardFleetFuelProductCode

Indicates the type of fuel product purchased

unitPrice: UnsignedInt

The unit price of the fuel product as a whole number

unitPricePrecision: UnsignedInt

The precision of the UnitPrice value

unitOfMeasure: MastercardFleetUnitOfMeasure

The unit of measure for the product purchased

quantity: UnsignedInt

The quantity for the product purchased as a whole number

quantityPrecision: UnsignedInt

The precision of the Quantity value

saleAmount: AmountInput

Contains the sale amount of the product purchased

SimulateMastercardFleetAuthorizationDataInput

Details pertaining to a Mastercard Fleet transaction available at Authorization and Authorization Advice time

Output:INPUT_OBJECT

Input Fields

driverIdentifier: String

An alphanumeric value representing a Driver ID provided by the cardholder

Maximum length: 255 characters

vehicleIdentifier: String

An alphanumeric value representing a Vehicle ID provided by the cardholder

Maximum length: 255 characters

spendControlOverrideFlag: Boolean

Indicates whether the POS supports overriding the fleet spend controls on the card

prompts: [SimulateMastercardFleetPromptInput!]

A list of prompt codes and cardholder-entered values

fuelProducts: [SimulateMastercardFleetAuthorizationDataFuelProductInput!]

A list of fuel products purchased

nonFuelProducts: [SimulateMastercardFleetAuthorizationDataNonFuelProductInput!]

A list of non-fuel products purchased

SimulateMastercardFleetAuthorizationDataNonFuelProductInput

Details of a Mastercard Fleet non-fuel product available at Authorization and Authorization Advice time

Output:INPUT_OBJECT

Input Fields

code: MastercardFleetNonFuelProductCode

Indicates the type of fuel product purchased

unitOfMeasure: String

The unit of measure for the product purchased

Maximum length: 255 characters

quantity: UnsignedInt

The quantity for the product purchased as a whole number

quantityPrecision: UnsignedInt

The precision of the Quantity value

extendedItemAmount: AmountInput

Contains the individual item amount that is normally calculated as price multiplied by quantity

SimulateMastercardFleetAuthorizationInput

Details to simulate a Mastercard Fleet authorization. Allows for partial authorizations

Output:INPUT_OBJECT

Input Fields

cardId: ID!

The ID of the payment card to be used.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateMastercardFleetAuthorizationDataInput

Fleet specific details for this authorization.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateMastercardFleetClearingEnhancedDataInput

Details to simulate Mastercard Fleet enhanced transaction data included with a clearing. Same as SimulateMastercardFleetEnhancedDataInput but without the transactionId since it is already provided on the parent input.

Output:INPUT_OBJECT

Input Fields

fuelBrand: MastercardFleetFuelBrand

Oil Company Brand Name

purchaseTime: String

The local time the purchase was made. Should be in the format hhmm, with hours in the range 00–23 and minutes in the range 00–59

fuelServiceType: MastercardFleetFuelServiceType

Motor Fuel Service Type

fuelType: MastercardFleetProductCode

Motor Fuel Product Code

fuelUnitPriceValue: UnsignedInt

The raw value received from the network for the motor fuel unit price

fuelUnitPriceValuePrecision: UnsignedInt

The decimal precision for the fuelUnitPriceValue

Precision should be in the range 0–5

fuelUnitOfMeasure: MastercardFleetUnitOfMeasure

Motor Fuel Unit of Measure

fuelQuantity: Float

Motor Fuel Quantity

fuelSaleAmount: AmountInput

Motor Fuel Sale Amount

odometerReading: String

Odometer Reading. Only included if POS prompts for this value

vehicleNumber: String

Vehicle Identification Number. Only included if POS prompts for this value

Maximum length: 255 characters

driverIdentification: String

Driver Identification Number. Only included if POS prompts for this value

Maximum length: 255 characters

productType: MastercardFleetProductType

Product Type Code

fuelDiscountAmount: AmountInput

Fuel Discount Amount

taxAmount1: AmountInput

Tax Amount 1

taxAmount2: AmountInput

Tax Amount 2

fuelLocationDetails: SimulateMastercardAdditionalFuelLocationDetailsInput

Details about the fuel location

lineItems: [SimulateMastercardFleetEnhancedDataLineItemInput!]

Line items on the invoice

SimulateMastercardFleetClearingInput

Details to simulate the clearing of a Mastercard Fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput!

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

merchantDetails: MerchantDetailsInput

Details to set about a merchant submitting the clearing.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

mastercardFleetData: SimulateMastercardFleetClearingEnhancedDataInput

Mastercard Fleet enhanced transaction data to include with the clearing.

SimulateMastercardFleetEnhancedDataInput

Details to simulate Mastercard Fleet enhanced transaction data. These are relevant additional transaction data items pertaining to a fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

fuelBrand: MastercardFleetFuelBrand

Oil Company Brand Name

purchaseTime: String

The local time the purchase was made. Should be in the format hhmm, with hours in the range 00–23 and minutes in the range 00–59

fuelServiceType: MastercardFleetFuelServiceType

Motor Fuel Service Type

fuelType: MastercardFleetProductCode

Motor Fuel Product Code

fuelUnitPriceValue: UnsignedInt

The raw value received from the network for the motor fuel unit price

fuelUnitPriceValuePrecision: UnsignedInt

The decimal precision for the fuelUnitPriceValue

Precision should be in the range 0–5

fuelUnitOfMeasure: MastercardFleetUnitOfMeasure

Motor Fuel Unit of Measure

fuelQuantity: Float

Motor Fuel Quantity

fuelSaleAmount: AmountInput

Motor Fuel Sale Amount

odometerReading: String

Odometer Reading. Only included if POS prompts for this value

vehicleNumber: String

Vehicle Identification Number. Only included if POS prompts for this value

Maximum length: 255 characters

driverIdentification: String

Driver Identification Number. Only included if POS prompts for this value

Maximum length: 255 characters

productType: MastercardFleetProductType

Product Type Code

fuelDiscountAmount: AmountInput

Fuel Discount Amount

taxAmount1: AmountInput

Tax Amount 1

taxAmount2: AmountInput

Tax Amount 2

fuelLocationDetails: SimulateMastercardAdditionalFuelLocationDetailsInput

Details about the fuel location

lineItems: [SimulateMastercardFleetEnhancedDataLineItemInput!]

Line items on the invoice

SimulateMastercardFleetEnhancedDataLineItemInput

An single simulated line item within a MastercardFleetEnhancedData

Output:INPUT_OBJECT

Input Fields

productCode: MastercardFleetProductCode

The product code of the individual item purchased

description: String

Description of the individual item purchased

Maximum length: 255 characters

quantity: Float

Quantity of the item purchased

unitOfMeasure: String

The unit of measurement for the item purchased

Maximum length: 255 characters

unitPriceValue: UnsignedInt

The raw value received from the network for the line item unit price

unitPriceValuePrecision: UnsignedInt

The decimal precision for the unitPriceValuePrecision

Precision should be in the range 0–5

itemAmountValue: UnsignedInt

The raw value received from the network for the individual item amount

itemAmountValuePrecision: UnsignedInt

The decimal precision for the itemAmountValue

Precision should be in the range 0–5

creditOrDebit: MastercardFleetCreditOrDebitIndicator

Indicates whether the item amount, net of discount, taxes, and price, is a debit or credit

SimulateMastercardFleetPromptInput

Details of a Mastercard Fleet Prompt. Contains a prompt code and cardholder-entered value

Output:INPUT_OBJECT

Input Fields

code: MastercardFleetPromptType

Indicates the type of prompted information

value: String

An alphanumeric value indicating the value entered by the cardholder

Maximum length: 255 characters

SimulateNonOriginatedAchTransferInput

Input for creating a new simulated ExternallyInitiatedACHTransfer.

This is used only for testing.

Output:INPUT_OBJECT

Input Fields

idempotencyKey: String!

A value to uniquely distinguish transfers, e.g. a UUID.

This value is required. Maximum length: 255 characters.

financialAccountId: ID!

The Highnote FinancialAccount to pull funds from or push funds to.

This must be a Highnote FinancialAccount.

amount: AmountInput!

The amount of money being transferred.

purpose: AchTransferPurpose!

The purpose of the transfer, e.g. deposit.

settlementDate: String

Settlement date in YYYY-MM-DD format. If not specified, current date will be used.

companyIdentifier: String!

The identifier of the simulated external organization initiating the transfer, e.g. 1234567890.

It can be up to 10 alphanumeric characters.

companyName: String!

The name of the simulated external organization initiating the transfer, e.g. THESAMPLECOMPANY.

It can be up to 16 alphanumeric characters.

companyDiscretionaryData: String

Arbitrary value describing the transfer entered by the simulated external organization.

It can be up to 20 alphanumeric characters. If not specified, it will be undefined.

companyEntryDescription: String!

Provides the receiving financial institution with information about the nature or purpose of the transaction. Examples include "ACCTVERIFY". "PAYROLL", "PAYMENT", etc.

It can be up to 10 alphanumeric characters.

individualIdentificationNumber: String

Receiver’s identification number. This could be a person or a business.

This could be either a business or an individual. It can be up to 15 alphanumeric characters. If not specified, it will be undefined.

individualName: String!

Receiver’s individual name. This could be a person or a business.

This could be either a business or an individual. It can be up to 22 alphanumric characters. If not specified, it will be populated as THISISTHERECIEVEROFACH

paymentRelatedInformation: String

Example: RMR*IV*0123456789**999.99\.

groupOrderId: ID!

Id of the group order.

trackingNumber: String

Tracking number

Maximum length: 50 characters

physicalPaymentCardOrderId: ID!

Physical Payment Card ID

trackingNumber: String

Tracking number

Maximum length: 50 characters

id: ID!

The global ID of the transfer to be changed.

SimulateRefundInput

Details to simulate the authorization reversal.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput

The Amount of the original AuthorizationEvent to refund.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the refund.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Fees to be reversed, if any.

cashbackAmount: AmountInput

The Amount of cashback requested to be refunded.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateResolvePaymentCardTransactionChargebackInput

Input for simulateResolvePaymentCardTransactionChargeback

Output:INPUT_OBJECT

Input Fields

id: ID!

The ID of the chargeback.

disputeId: ID!

The ID of the dispute.

receivedAmount: AmountInput!

The received amount from the external network. If received amount is 0, the chargeback is resolved as a loss.

SimulateReturnedIntegratorInitiatedStatusChangeInput

Input for changing the status of an IntegratorInitiatedACHTransfer to RETURNED.

This will fail if the status of the transfer is not PROCESSING.

Output:INPUT_OBJECT

Input Fields

id: ID!

The global ID of the transfer to be changed.

reasonCode: IntegratorInitiatedACHStatusReasonCode!

The reason for the RETURNED status.

SimulateReversalInput

Details to simulate the authorization reversal.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput

The Amount of the Authorization to reverse. Cannot be above the total amount of the related Authorizations.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the reversal.

issuerExpiredAuthorization: Boolean

Determines whether this is an issuer initiated reversal for an expired authorization.

Fees to be reversed, if any.

cashbackAmount: AmountInput

The Amount of cashback to be reversed.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateRolloverCurrentFinancialAccountStatementPeriodInput

Input fields for rolling over the current statement period

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

Financial Account Id

SimulateShiftCurrentFinancialAccountStatementPeriodInput

Input fields for shifting the current statement period

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

Financial Account Id

periodBoundary: String

The new statement period boundary, in ISO 8601 format. Defaults to 60 seconds from now.

Note: The new period boundary must be at least 60 second from now.

SimulateSingleStepAuthAndClearInput

Details to simulate the authorization and clear.

Output:INPUT_OBJECT

Input Fields

cardId: ID!

The ID of the payment card to be used.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

cashbackAmount: AmountInput

The Amount of cashback requested during the transaction.

SimulateUpdateCardTransactionDisputeInput

Input for simulateUpdateCardTransactionDispute.

Output:INPUT_OBJECT

Input Fields

id: ID!

The ID of the PaymentCardTransactionDispute

status: PaymentCardDisputeStatus

The status of the dispute.

SimulateUpdatePaymentCardTransactionChargebackInput

Input for SimulateUpdatePaymentCardTransactionChargebackInput.

Output:INPUT_OBJECT

Input Fields

id: ID!

The ID of the chargeback.

disputeId: ID!

The ID of the dispute.

status: PaymentCardChargebackStatus

The status of the chargeback

SimulateVisaAdditionalNetworkDataInput

Simulate Visa network specific transaction data.

Output:INPUT_OBJECT

Input Fields

motoAndElectronicCommerceIndicator: VisaMotoAndElectronicCommerceIndicator

Classification information for Mail Order/Telephone Order (MOTO) and Electronic Commerce transactions.

cavvResultCode: VisaCavvResultCode

Information about the Cardholder Authentication Verification Value (CAVV) for this transaction.

threeDSecureIndicator: VisaThreeDSecureIndicator

Information about the verification method used in this transaction.

riskScore: UnsignedInt

The risk score for the transaction provided by Visa. Values are between 0-99.

paymentFacilitatorIdentifier: String

Payment facilitator identifier for the transaction. Maximum length: 11

acquiringInstitutionIdentificationCode: String

A number used by Visa to identify the acquiring institution.

SimulateVisaFleetAuthorizationAdviceInput

Details to simulate the authorization advice of a Visa Fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput!

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateVisaFleetAuthorizationDataInput

Fleet specific details for this authorization advice.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

visaFleetL2TransactionData: VisaFleetL2TransactionDataInput

Visa Fleet details to be simulated

SimulateVisaFleetAuthorizationDataInput

Details pertaining to a Visa Fleet transaction available at Authorization and Authorization Advice time

Output:INPUT_OBJECT

Input Fields

purchaseType: VisaFuelPurchaseType

Indicates whether fuel or non-fuel items are included in the transaction

serviceType: VisaFuelServiceType

Indicates whether the transaction occurred at a self-service or a full-service station

purchaseIdentifierFormat: VisaFleetPurchaseIdentifierFormat

Indicates whether purchaseIdentifier is an Order Number or a Invoice Number provided by the cardholder

purchaseIdentifier: String

An alphanumeric value representing either an Order Number or an Invoice Number provided by the cardholder

Maximum length: 255 characters

fleetIdentifier: String

An alphanumeric value representing either a Vehicle, Driver, or Generic ID provided by the cardholder

Maximum length: 255 characters

odometer: String

The odometer value provided by the cardholder

Maximum length: 255 characters

employeeNumber: String

An alphanumeric value representing the employee’s ID number

Maximum length: 255 characters

trailerNumber: String

An alphanumeric value representing the trailer’s ID number

Maximum length: 255 characters

customPrompt1: String

An alphanumeric value representing the answer to a custom prompt

Maximum length: 255 characters

customPrompt2: String

An alphanumeric value representing the answer to a custom prompt

Maximum length: 255 characters

purchaseRestrictonsFlag: Boolean

Indicates whether the POS supports host-based restriction processing

nonFuelProductCodes: [VisaNonFuelProductCode!]

A list of non-fuel product codes for the products purchased

SimulateVisaFleetAuthorizationInput

Details to simulate a Visa Fleet authorization. Allows for partial authorizations

Output:INPUT_OBJECT

Input Fields

id: ID

The optional ID of a previous authorization.

Typically, this is only used to simulate "incremental authorization".

cardId: ID!

The ID of the payment card to be used.

amount: AmountInput!

The Amount of the authorization provided as per the specifications of the given currency.

verificationOverrides: VerificationOverridesInput

Details to override about a PaymentCard or card holder to test Spend Control Rules.

merchantDetails: MerchantDetailsInput

Details to set about a Merchant submitting the authorization.

You can use these details to test merchant specific spend rules.

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

fleetAuthorizationData: SimulateVisaFleetAuthorizationDataInput

Fleet specific details for this authorization.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

visaFleetL2TransactionData: VisaFleetL2TransactionDataInput

Visa Fleet details to be simulated

SimulateVisaFleetClearingInput

Details to simulate the clearing of a Visa Fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

amount: AmountInput!

The Amount of the Authorization to clear. Cannot be above the total amount of the related Authorizations.

merchantDetails: MerchantDetailsInput

Details to set about a merchant submitting the clearing.

visaFleetL2TransactionData: VisaFleetL2TransactionDataInput

Visa Fleet details to be simulated

transactionProcessingType: CardTransactionProcessingType

Represents the customer transaction type being processed.

pointOfServiceDetails: PointOfServiceDetailsInput

The Point Of Service Details Input.

Optionally simulate fees applied to the transaction.

additionalNetworkData: SimulateAdditionalNetworkDataInput

Simulate network specific transaction data.

SimulateVisaFleetL3EnhancedDataDiscountInput

Discount fields for simulating Visa Fleet Level 3 transaction data.

Output:INPUT_OBJECT

Input Fields

amount: AmountInput

Total amount of discount at invoice level according to the visaDiscountTreatment and the visaTaxTreatment. This figure excludes any discount amounts defined at line item level.

amountSignage: VisaAmountSignage

This field specifies if the invoice-level Discount Amount is a credit or debit value.

treatment: VisaDiscountTreatment

Identifies how to treat the discount if one was applied at the invoice level.

SimulateVisaFleetL3EnhancedDataDutyInput

Duty fields for simulating Visa Fleet Level 3 transaction data.

Output:INPUT_OBJECT

Input Fields

amount: AmountInput

The price of duty.

amountSignage: VisaAmountSignage

This field specifies if the Duty Amount is a credit or debit value.

SimulateVisaFleetL3EnhancedDataInput

Simulated Visa Fleet Level 3 transaction data. These are relevant additional transaction data items pertaining to a fleet transaction.

Output:INPUT_OBJECT

Input Fields

transactionId: ID!

The transactionId from the original AuthorizationEvent.

discount: SimulateVisaFleetL3EnhancedDataDiscountInput

Discount input for this transaction.

duty: SimulateVisaFleetL3EnhancedDataDutyInput

Duty input for this transaction.

invoice: SimulateVisaFleetL3EnhancedDataInvoiceInput

Invoice input for this transaction.

shipping: SimulateVisaFleetL3EnhancedDataShippingInput

Shipping input for this transaction.

tax: SimulateVisaFleetL3EnhancedDataTaxInput

Tax input for this transaction.

SimulateVisaFleetL3EnhancedDataInvoiceInput

Invoice fields for simulating Visa Fleet Level 3 transaction data.

Output:INPUT_OBJECT

Input Fields

referenceNumber: String

The VAT invoice number.

destinationPostalCode: String

Postal code of the destination. The field may contain spaces.

shipFromPostalCode: String

Postal code of the location being shipped from. The field may contain spaces.

destinationCountryCode: String

Country code of the destination. The field may contain spaces.

authorizationCode: String

The Authorization Code of the transaction.

orderDate: String

Date the order was taken. The entry should be in the format YYYY-MM-DD.

lineItems: [SimulateVisaFleetL3EnhancedDataLineItemInput!]

Line items on the invoice.

SimulateVisaFleetL3EnhancedDataLineItemInput

An single simulated line item within a VisaFleetL3EnhancedData

Output:INPUT_OBJECT

Input Fields

commodityCode: VisaItemCommodityCode

The commodity code for the line item.

descriptor: String

Freeform text description of item or service

productCode: String

Typically, an SKU or identifier from the Merchant

quantity: UnsignedInt

The number of items.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

unitOfMeasure: String

A readable unit of measure

unitCost: AmountInput

Unit cost for this item or service in accordance with the taxTreatment.

taxAmount: AmountInput

Amount of sales tax for this item or service in accordance with the taxTreatment.

taxRate: UnsignedInt

Rate of sales tax charged on the item or service (in accordance with the taxTreatment).

The last two digits are implied decimal places.

discountPerItem: AmountInput

Amount of discount if provided for this line item according to the discountTreatment.

discountTreatment: VisaDiscountTreatment

Identifies how to treat the discount if one was applied at the line item level

total: AmountInput

Formula: (quantity * unitCost) - discountPerItem

detailIndicator: VisaLineItemDetailIndicator

Defines the type of line item

SimulateVisaFleetL3EnhancedDataShippingInput

Shipping related fields for simulating Visa Fleet Level 3 transaction data.

Output:INPUT_OBJECT

Input Fields

amount: AmountInput

The price of freight/shipping.

amountSignage: VisaAmountSignage

This field specifies if the Shipping Amount is a credit or debit value.

taxAmount: AmountInput

Amount of Sales Tax charged on the shipping amount (in accordance with the visaTaxTreatment).

taxAmountSignage: VisaAmountSignage

This field specifies if the Duty Amount is a credit or debit value.

taxRate: UnsignedInt

Rate of sales tax charged on the shipping amount (in accordance with the visaTaxTreatment). The last two digits are implied decimal places.

SimulateVisaFleetL3EnhancedDataTaxInput

Value ends with provided String.

contains: String

Value contains provided String.

equals: String

Value matches the provided String.

notEquals: String

Value does not match the provided String.

includes: [String!]

Value exactly matches any of the provided Strings.

excludes: [String!]

Value does not match any of the provided Strings.

SuspendCardDigitalWalletTokenInput

The input to suspend a card digital wallet token.

Output:INPUT_OBJECT

Input Fields

cardDigitalWalletTokenId: ID!

The ID of the card digital wallet token to suspend.

reason: SuspendCardDigitalWalletTokenReason!

The reason for the card digital wallet token to be suspended.

SuspendFinancialAccountInput

The input details for suspending a FinancialAccount.

Output:INPUT_OBJECT

Input Fields

id: ID!

The FinancialAccount ID to be suspended.

suspensionReason: FinancialAccountSuspensionReasonInput!

The reason for suspending the FinancialAccount.

memo: String!

The memo for suspending the FinancialAccount.

Regex: ^[a-zA-Z\d$ ',.-_!@#$%^&*+=`?"\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF\n]+$ Memo has a max length of 2048 characters. For compliance and security reasons, memo should not contain any sensitive information, such as PII or PCI.

SuspendPaymentCardInput

The details of the Payment Card to suspend.

Output:INPUT_OBJECT

Input Fields

paymentCardId: ID!

The ID of the Payment Card to suspend.

TaxIdentificationDocumentInput

An input representing the parts of a tax identification number (e.g. SSN, TIN, EIN).

Output:INPUT_OBJECT

Input Fields

number: String!

The full tax identification number.

countryCodeAlpha3: String!

The three character country code of the issuing country.

taxIdentificationNumberType: TaxIdentificationNumberType

The type of tax identification number.

TerminateCardDigitalWalletTokenInput

The input to terminate a card digital wallet token.

Output:INPUT_OBJECT

Input Fields

cardDigitalWalletTokenId: ID!

The ID of the card digital wallet token to terminate.

reason: TerminateCardDigitalWalletTokenReason!

The reason for the card digital wallet token to be terminated.

TimestampFilterInput

Timestamp value type in ISO 8601 format

Output:INPUT_OBJECT

Input Fields

equals: String

notEquals: String

lessThan: String

lessThanOrEquals: String

greaterThan: String

greaterThanOrEquals: String

between: TimestampFilterInputRange

TimestampFilterInputRange

Timestamp value range in ISO 8601 format

Output:INPUT_OBJECT

Input Fields

start: String

end: String

TokenizeAddressInput

Input representing parts of an address for tokenization.

Output:INPUT_OBJECT

Input Fields

streetAddress: String

The number and street of the address.

The validation for the address uses the following regex pattern ^\s*\S+(?:\s+\S+){1,3} .

This pattern matches two to four groups of non-whitespace characters. These can include special characters like dashes or slashes. For example, 'Cozy Cottage', '200 Lake Road', '123 Second Street NW', and '111 1/2 Center Street' all match.

When the field is used for creating an application, it will also validate that a PO Box is not included using this regex pattern ^(?:((\S([^pPOo])+)|(?:[0-9]+)))\s(?:[0-9A-Za-z\.]|[^\S\r\n])+$.

extendedAddress: String

Additional data about the address, e.g. apartment or unit numbers.

The validation for the extendedAddress uses the following regex pattern ^[a-zA-Z\d',. \-#]+(([',. \-#][a-zA-Z ])?[a-zA-Z.]*)*$.

It checks for numeric string with special characters and whitespace.

postalCode: String!

The postal code of the address. The value can include 5 numbers only or a hyphen - and 4 numbers

region: String

A region for the address based on the two letter state IS0 3166 standard, including districts and outlying areas.

locality: String

The locality of the address (e.g. town, city)

The validation for the locality uses the following regex pattern ^['\p{L}]+(?:[ \p{L},'-:])*$.

It checks to ensure it begins with a single quote or any letter, followed by whitespace, commas, single quote, any letter, or character in this set '()*+,-./0123456789: .

countryCodeAlpha3: String

The three letter country code where the address resides.

TokenizeCardPaymentMethodCardHolderInput

Input for tokenizing a card payment method's card holder information.

Output:INPUT_OBJECT

Input Fields

fullName: String

The full name as represented on the card. Minimum length: 1 character Maximum length: 255 characters

The name of the cardholder, represented in different parts.

billingAddress: TokenizeAddressInput

The billing address associated with the card.

email: String

The e-mail address associated to the card.

phoneNumber: TokenizePhoneInput

The phone number associated to the card.

TokenizeCardPaymentMethodInput

Input for tokenizing a payment card.

Output:INPUT_OBJECT

Input Fields

paymentCard: PaymentCardInput!

The payment card to tokenize.

cardHolder: TokenizeCardPaymentMethodCardHolderInput

The cardHolder to associate the tokenized payment card with.

TokenizePhoneInput

Input representing parts of a phone number for tokenization.

Output:INPUT_OBJECT

Input Fields

countryCode: String!

The assigned country code for the number.

number: String!

The phone number in a country specific format.

extension: String

A number representing a specific phone on the same number as the main line.

TransactionEventFilterInput

TransactionEventFilter value type

Output:INPUT_OBJECT

Input Fields

equals: TransactionEventFilter

notEquals: TransactionEventFilter

includes: [TransactionEventFilter!]

excludes: [TransactionEventFilter!]

TransactionEventResponseCodeFilterInput

Input for filtering transaction event response code

Output:INPUT_OBJECT

Input Fields

equals: TransactionEventResponseCode

Value matches the provided transaction event response code.

notEquals: TransactionEventResponseCode

Value does not match the provided transaction event response code.

includes: [TransactionEventResponseCode!]

Value exactly matches all of the provided transaction event response code.

excludes: [TransactionEventResponseCode!]

Value does not match any of the provided transaction event response code.

TransactionEventsFilterInput

Inputs for filtering transaction events.

Output:INPUT_OBJECT

Input Fields

operationalCurrency: ISO4217Alpha3CurrencyCode

eventType: TransactionEventFilterInput

requestedAmount: MoneyFilterInput

approvedAmount: MoneyFilterInput

responseCode: TransactionEventResponseCodeFilterInput

avsResponseCode: AVSResponseCodeFilterInput

postalCodeResponseCode: PostalCodeResponseCodeFilterInput

cvvResponseCode: CVVResponseCodeFilterInput

transactionType: TransactionTypeFilterInput

paymentCardId: IDFilterInput

cardProductId: IDFilterInput

transactionId: IDFilterInput

createdAt: TimestampFilterInput

updatedAt: TimestampFilterInput

merchantDetails: MerchantDetailsFilterInput

onlyOpenAuthorizations: BooleanFilterInput

Open authorizations events have the following properties:

Are the first transaction event with a particular public transaction identifier. This means they are the first event in a sequence of events with the same public transaction identifier.
Authorization expiration date is not empty and not in the past.
The approved amount has not been fully reversed or cleared to zero by subsequent transaction events with the same public transaction identifier.

authorizationExpiration: TimestampFilterInput

Authorization expiration date

TransactionFeeInput

Details about a fee applied to a simulated transaction.

Output:INPUT_OBJECT

Input Fields

requestedFeeAmount: AmountInput!

The requested fee amount. Note that requestedFeeAmount and approvedFeeAmount may be different currencies.

approvedFeeAmount: AmountInput!

The approved fee amount. Note that requestedFeeAmount and approvedFeeAmount may be different currencies.

transactionFeeType: TransactionFeeType!

The type of fee charged.

TransactionSearchFilterInput

Inputs for filtering TransactionSearchResults.

Output:INPUT_OBJECT

Input Fields

searchQueryLanguage: SearchQueryLanguageInput

Used to search using the Highnote SearchQueryLanguage.

TransactionTypeFilterInput

Input for filtering transaction type

Output:INPUT_OBJECT

Input Fields

equals: TransactionTypeFilter

Value matches the provided transaction type

notEquals: TransactionTypeFilter

Value does not match the provided transaction type

includes: [TransactionTypeFilter!]

Value exactly matches all of the provided transaction type

excludes: [TransactionTypeFilter!]

Value does not match any of the provided transaction type

TransferAgreementConsentInput

Input to consent to the transfer agreement.

Output:INPUT_OBJECT

Input Fields

consentTimestamp: String!

The date and time, in ISO 8601 format, marking when the primary authorized person or person account holder gave consent for the transfer.

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

authorizedPersonId: ID!

The ID of the individual who is authorizing the transfer

The template of the consent

TransferAgreementConsentTemplateInput

The template of the transfer agreement consent.

Output:INPUT_OBJECT

paymentRelatedInformation: String!

Example: Invoice 0123456789 Payment 999.99 USD

consent: TransferAgreementConsentInput!

Transfer agreement consent information. Required when the end user must authorize the transfer.

TransferFundsDestinationInput

Destination for a direct transfer.

Output:INPUT_OBJECT

Input Fields

id: ID

A Highnote Node ID to transfer funds to.

usBankAccount: TransferFundsUSBankAccountInput

Raw US bank account details (account/routing number).

bankTransferDetails: TransferFundsBankTransferDetailsInput

Additional details for bank-to-bank transfers (RTP, ACH).

amount: AmountInput

The amount of funds to deposit at the destination. If provided, source.amount will be calculated based on fees.

TransferFundsInput

Input for transferFunds mutation.

One of source.amount or destination.amount must be provided, but not both. The other amount will be calculated based on the remaining amount after fees.

Output:INPUT_OBJECT

Input Fields

source: TransferFundsSourceInput

Source of funds for the transfer. Required when quoteId is not provided.

destination: TransferFundsDestinationInput

Destination for the funds. Required when quoteId is not provided.

idempotencyKey: IdempotencyKey

Idempotency key to prevent duplicate transfers. Must be a valid UUID v4.

memo: String

Optional memo/description for the transfer.

externalIdentifier: String

External identifier for tracking in your system (max 255 chars).

strategy: TransferFundsPaymentStrategyInput

Payment strategy configuration.

quoteId: ID

Optional: a previously created quote ID to use for this transfer instead of creating new quotes.

TransferFundsPaymentStrategyInput

Payment strategy configuration.

Output:INPUT_OBJECT

Input Fields

preferredPaymentStrategy: [TransferFundsPaymentPreference!]

Ordered list of payment preferences.

The system evaluates each preference in order and uses the first one that is supported for the given source and destination combination.

If no preference in the list is supported for the source and destination, the request will fail with a USER_ERROR indicating which payment strategies are supported for the given input.

If not specified, the request will fail with a USER_ERROR indicating which payment strategies are supported for the given input.

Examples:

[RTP] => Uses RTP if supported, otherwise fails with supported strategies
[RTP, INSTANT_NETWORK_TRANSFER] => Uses RTP if supported, otherwise Instant Network Transfer if supported

TransferFundsSourceInput

Source of funds for a direct transfer.

Output:INPUT_OBJECT

Input Fields

id: ID

A Highnote Node ID to transfer funds from.

usBankAccount: TransferFundsUSBankAccountInput

Raw US bank account details (account/routing number).

bankTransferDetails: TransferFundsBankTransferDetailsInput

Additional details for bank-to-bank transfers (RTP, ACH).

amount: AmountInput

The amount of funds to transfer from the source. If provided, destination.amount will be calculated based on fees.

TransferFundsUSBankAccountInput

Raw US bank account input.

Output:INPUT_OBJECT

Input Fields

accountNumber: String!

Bank account number.

routingNumber: String!

Bank routing number (ABA).

accountType: BankAccountType!

Type of bank account.

firstName: String!

Account holder's first name.

middleName: String

Account holder's middle name (optional).

lastName: String!

Account holder's last name.

UltimateBeneficialOwnerAddressFilterInput

Input for filtering by USBusinessUltimateBeneficialOwner's Address.

Output:INPUT_OBJECT

Input Fields

postalCode: StringFilterInput

UnifiedFundsTransferDestinationInput

The destination of the funds to transfer.

One of id or usBankAccount must be provided.

Output:INPUT_OBJECT

Input Fields

id: ID

The ID of a Highnote Node representing the destination of the funds.

Currently these Node types are supported as destination IDs:

FinancialAccount
PaymentMethodToken

usBankAccount: TransferFundsUSBankAccountInput

Raw US bank account details (account/routing number).

Use this when the destination is an external bank account not registered as a Highnote Node.

bankTransferDetails: QuoteBankTransferDetailsInput

Additional details for bank-to-bank transfers (RTP, ACH).

amount: AmountInput

The amount of funds to deposit in the destination.

If this is provided, the source.amount will be calculated based on the exchange rate.

UnifiedFundsTransferSourceInput

The source of the funds to transfer.

One of id or usBankAccount must be provided.

Output:INPUT_OBJECT

Input Fields

id: ID

The ID of a Highnote Node representing the source of the funds.

Currently these Node types are supported as source IDs:

FinancialAccount
PaymentMethodToken

usBankAccount: TransferFundsUSBankAccountInput

Raw US bank account details (account/routing number).

Use this when the source is an external bank account not registered as a Highnote Node.

bankTransferDetails: QuoteBankTransferDetailsInput

spendRuleId: ID!

The Global ID of the AccountSpendRule to update.

The name for the rule for future reference.

allowed: [ID!]

offerId: ID!

The ID of the offer to accept.

offerStatus: CardProductApplicationOfferStatus!

The requested status update to the offer.

UpdateCardDataInputCapabilitySpendRuleInput

The details of the CardDataInputCapabilitySpendRule spend rule to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the CardDataInputCapabilitySpendRule to update.

A name for the rule for future reference.

allowed: [CardDataInputCapability!]

The CardDataInputCapability values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [CardDataInputCapability!]

The CardDataInputCapability values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateCardProductNameInput

The details of the Card Product name change.

Output:INPUT_OBJECT

Input Fields

cardProductId: ID!

The ID of the Card Product to update.

The value to update the name to.

Maximum length is 50 characters.

UpdateCardTransactionProcessingTypeConditionSpendRuleInput

The details of the CardTransactionProcessingTypeConditionSpendRule to update

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

Global ID of the CardTransactionProcessingTypeConditionSpendRule to update.

The name of the CardTransactionProcessingTypeConditionSpendRule

allowed: [CardTransactionProcessingType!]

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

blocked: [CardTransactionProcessingType!]

The list of possible CardTransactionProcessingType that will result in a decline. Min: 1 Max: 5000

The list of possible DepositProcessingNetwork that will be allowed during cash deposits. Min: 1 Max: 5000

blocked: [DepositProcessingNetwork!]

The list of possible DepositProcessingNetwork that will result in declined cash deposits. Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateFinancialAccountBillingCycleConfigurationInput

The input to update the billing cycle configuration for a FinancialAccount.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The Global ID of the FinancialAccount to update.

paymentDueDayOfMonth: UnsignedInt!

The day of the month when payment will be due for this FinancialAccount. Must be an integer between 1 and 28. Must be different from the current due date. Any change will only apply to future billing cycles, not the current open cycle or any past cycles.

UpdateFinancialAccountNameInput

The Global ID of the Merchant Category Spend Rule to update.

The name for the rule for future reference.

allowed: [MerchantCategory!]

The merchant categories that will be allowed during authorizations.

Min: 1 Max: 5000

blocked: [MerchantCategory!]

The merchant categories that will result in declined authorizations.

Min: 1 Max: 5000

allowedMcc: [String!]

The merchant category codes that will be allowed during authorizations.

Min: 1 Max: 5000

blockedMcc: [String!]

The merchant category codes that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateMerchantCountrySpendRuleInput

The details of the MerchantCountrySpendRule spend rule you want to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the Merchant Country Spend Rule to update.

The name for the rule for future reference.

allowed: [ISO3166Alpha3Country!]

The merchant countries that will be allowed during authorizations.

Min: 1 Max: 5000

blocked: [ISO3166Alpha3Country!]

The merchant countries that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateMerchantIdentifierSpendRuleInput

The details of the MerchantIdentifierSpendRule spend rule you want to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the MerchantIdentifierSpendRule to update.

The name for the rule for future reference.

allowed: [String!]

The merchant identifiers you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [String!]

The merchant identifiers you want to block during authorizations.

Matching values will result in a declined authorization.

Min: 1 Max: 5000

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdatePointOfServiceCategorySpendRuleInput

The details of the PointOfServiceCategorySpendRule spend rule to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the Merchant Category Spend Rule to update.

A name for the rule for future reference.

allowed: [PointOfServiceCategoryCondition!]

The PointOfServiceCondition values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [PointOfServiceCategoryCondition!]

The PointOfServiceCondition values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdatePostalCodeVerificationSpendRuleInput

The details of the PostalCodeVerificationSpendRule spend rule to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the Postal Code Verification Spend Rule to update.

A name for the rule for future reference.

allowed: [PostalCodeResponseCode!]

The PostalCodeResponseCode values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [PostalCodeResponseCode!]

The PostalCodeResponseCode values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdatePseudoBalanceInput

Input for adjusting the current pseudo balance amount. Allows manual increases or decreases to the tracked spending balance.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the FinancialAccount whose pseudo balance should be updated.

sign: PseudoBalanceAmountSign!

Whether to increase (POSITIVE) or decrease (NEGATIVE) the current balance.

amount: AmountInput!

The amount to add or subtract from the current pseudo balance.

idempotencyKey: String

The idempotency key for this request.

This is a UUIDv4 string used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.

UpdatePseudoLimitInput

Input for updating the pseudo limit. Allows increasing or decreasing the maximum allowed balance.

Output:INPUT_OBJECT

Input Fields

financialAccountId: ID!

The ID of the FinancialAccount whose pseudo balance limit should be updated.

sign: PseudoBalanceAmountSign!

Whether to increase (POSITIVE) or decrease (NEGATIVE) the current limit.

amount: AmountInput!

The amount to add or subtract from the current limit.

idempotencyKey: String

The idempotency key for this request.

spendRuleId: ID!

The Global ID of the StreetAddressSpendRule to update.

The name for the rule for future reference.

allowed: [AVSResponseCode!]

The AVSResponseCode values you want to allow during authorizations.

Min: 1 Max: 5000

blocked: [AVSResponseCode!]

The AVSResponseCode values that will result in declined authorizations.

Min: 1 Max: 5000

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateUSAssociatedPersonAccountHolderEmailInput

An input representing the parts of an update for an associated person's account holder email

Output:INPUT_OBJECT

Input Fields

email: String!

The account holder's email.

accountHolderId: ID!

The identifier of an account holder

businessAccountHolderId: ID!

The identifier of the business account holder that the associated person falls under

UpdateUSAssociatedPersonAccountHolderHomeAddressInput

An input representing the parts of an update for an associated person's account holder home address

Output:INPUT_OBJECT

Input Fields

homeAddress: AddressInput!

The account holder's U.S. home address.

accountHolderId: ID!

The identifier of an account holder

businessAccountHolderId: ID!

The identifier of the business account holder that the associated person falls under

updatePaymentCardBillingAddress: Boolean

Setting this value to true will update the billing address for all payment cards belonging to this account holder.

Note: The update to the payment card may not be reflected immediately.

Default Value: false

UpdateUSAssociatedPersonAccountHolderPhoneInput

An input representing the parts of an update for an associated person's account holder phone

Output:INPUT_OBJECT

Input Fields

phoneNumber: PhoneInput!

The account holder's phone.

accountHolderId: ID!

The identifier of an account holder

businessAccountHolderId: ID!

The identifier of the business account holder that the associated person falls under

UpdateUSBusinessAccountHolderBillingAddressInput

An input representing the parts of an update for a business account holder billing address

Output:INPUT_OBJECT

Input Fields

billingAddress: AddressInput!

The account holder's U.S. billing address.

accountHolderId: ID!

The identifier of an account holder

id: ID!

The ID of the field definition to update.

The updated name for the field definition.

description: String

The updated description for the field definition.

UpdateUserDefinedFieldInput

The input to update a UserDefinedField

Output:INPUT_OBJECT

Input Fields

id: ID!

The ID of the field instance to update.

value: UserDefinedFieldValueInput!

The new value to store in this field instance.

UpdateUserInput

Data needed to login a User.

Output:INPUT_OBJECT

Input Fields

externalId: ID

The external ID of the User.

email: String!

The email address of the User.

roles: [UserRole!]!

The list of users' roles that determine a user's permissions within the organization. All roles must be present.

UpdateUSPersonAccountHolderBillingAddressInput

An input representing the parts of an update for a person account holder billing address

Output:INPUT_OBJECT

Input Fields

billingAddress: AddressInput!

The account holder's U.S. billing address.

accountHolderId: ID!

The global ID of an Account holder

billingAddress: AddressInput!

The authorized user's U.S. billing address.

updatePaymentCardBillingAddress: Boolean

Setting this value to true will update the billing address for all payment cards belonging to this authorized user.

velocityRuleId: ID!

Global ID of the VelocityRule to update.

A name for the rule for future reference.

The ApplicableRuleUserType for which the rule will be evaluated.

UpdateVisaRiskScoreSpendRuleInput

The details of the VisaRiskScoreSpendRule spend rule you want to update.

Output:INPUT_OBJECT

Input Fields

spendRuleId: ID!

The Global ID of the VisaRiskScoreSpendRule to update.

The name for the rule for future reference.

maximumVisaRiskScore: UnsignedInt!

The maximum Visa Risk Score allowed for a transaction before transaction is declined.

Minimum: 0 Maximum: 99

The ApplicableRuleUserType for which the rule will be evaluated.

USAssociatedPersonNameInput

Input representing common fields of the name of a person associated with a business.

Output:INPUT_OBJECT

Input Fields

givenName: String!

The part of the name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

middleName: String

Additional part of name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

familyName: String!

Part of a personal name that identifies a family, tribe, or community.

Minimum length: 2 characters Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

USAssociatedPersonNameUpdateInput

Input representing common fields to update the name of a person associated with a business.

Output:INPUT_OBJECT

Input Fields

givenName: String

The part of the name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

middleName: String

Additional part of name that identifies a person.

Minimum length: 1 character Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

familyName: String

Part of a personal name that identifies a family, tribe, or community.

Minimum length: 2 characters Maximum length: 255 characters Allowed characters: Lower and upper case Latin letters (without diacritical marks) and any of: ''', ',', '.', ' ','-'

suffix: String

Provides additional information about the person (e.g. Jr., Sr.)

title: String

One or more words used before the person's name (e.g. Mx., Dr.).

USAuthorizedPersonInput

The details of the USAuthorizedPersonInput.

Output:INPUT_OBJECT

Input Fields

The authorized person's legal name.

email: String!

The authorized person's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput!

The primary phone number for this authorized person.

homeAddress: AddressInput

The authorized person's U.S. physical address.

Exactly one of homeAddress or homeAddressToken must be provided.

homeAddressToken: ID

A token representing the authorized person's U.S. physical address.

Exactly one of homeAddress or homeAddressToken must be provided.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

identificationDocument: USIdentificationDocumentInput!

The identification document used to verify the authorized person.

percentageOwnership: Int

Percentage ownership of this authorized person in business if any.

authorizingPersonTitle: BusinessTitle

Authorized person's title.

USAuthorizedPersonUpdateInput

Input fields for updating a USAuthorizedPerson.

Output:INPUT_OBJECT

Input Fields

The authorized person's legal name.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

homeAddress: AddressInput

The authorized person's U.S. physical address.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

dateOfBirth: String

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

identificationDocument: USIdentificationDocumentInput

The identification document used to verify the authorized person.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

USBusinessIdentificationDocumentInput

The US Business identification documents for verification.

Output:INPUT_OBJECT

Input Fields

employerIdentificationNumber: TaxIdentificationDocumentInput!

Business's employer identification number (USA only).

The validation for the input uses the following regex pattern ^\d{2}-\d{7}$.

USBusinessProfileInput

Input fields for creating a USBusinessProfile.

Output:INPUT_OBJECT

Input Fields

The business' name fields.

businessDescription: String

A short description of what the business does, its purpose, and the products or services it provides.

Max length: 140 characters. Min length: 1 character. Input Regex Validation: ^[a-zA-Z\d$ ',.\-\_!@#$%^&*+=?"\n]+$`

phoneNumber: PhoneInput!

The primary phone number for this business.

billingAddress: AddressInput

The business' U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

billingAddressToken: ID

A token representing the business' U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

legalAddress: AddressInput

The address supplied for the business' registration. Supplying the address associated with the business primary SOS filing location is recommended.

website: String

Business website URL.

businessType: BusinessStructure!

Type of business.

creditRiskAttributes: CreditRiskAttributesInput

The business' credit risk attributes. Only used for unsecured credit applications. *Note This attribute is deprecated and will be removed in a future release. Please use businessCreditRiskAttributes.

businessCreditRiskAttributes: BusinessCreditRiskAttributesInput

The business' credit risk attributes. Only used for unsecured credit applications.

businessPlanAttributes: [BusinessPlanAttributeInput!]

Business plan indicator attributes for this business.

identificationDocument: USBusinessIdentificationDocumentInput

Business identification document such as employer identification number in USA.

A business identification document is not required for SOLE_PROPRIETORSHIP.

Highnote recommends passing an identification document when available to streamline the onboarding and future product approval processes.

ultimateBeneficialOwners: [USUltimateBeneficialOwnerInput]

Ultimate beneficial owners of business information

USBusinessProfileUpdateInput

Input fields for updating a USBusinessProfile.

Output:INPUT_OBJECT

Input Fields

The business' name fields.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

billingAddress: AddressInput

The business' U.S. billing address.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

identificationDocument: USBusinessIdentificationDocumentInput

stringValue: String

A string value.

integerValue: Int

An integer value.

booleanValue: Boolean

A boolean value.

USIdentificationDocumentInput

The US identification documents for verification.

Output:INPUT_OBJECT

Input Fields

socialSecurityNumber: TaxIdentificationDocumentInput!

A person's social security number (USA only).

Can be one of

9 digits divided into 3 parts by hyphen. For example, 123-45-6789.
9 concurrent digits such as 123456789. When supplied, the SSN will be formatted to 123-45-6789 to enforce social security number validity.

The following outlines rules around a valid social security number:

The first part should have 3 digits and should not be 000, 666, or between 900 and 999.
The second part should have 2 digits and it should be from 01 to 99.
The third part should have 4 digits and it should be from 0001 to 9999.

The validation for the input uses the following regex pattern ^((?!666|000|9\d{2})\d{3}-(?!00)\d{2}-(?!0{4})\d{4})|(\d{9})$.

USPersonAccountHolderInput

The details of the PersonAccountHolder.

Output:INPUT_OBJECT

Input Fields

The account holder's legal name.

email: String

The account holder's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput

The primary phone number for this account holder.

billingAddress: AddressInput

The account holder's U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

billingAddressToken: ID

A token representing the account holder's U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 10 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

identificationDocument: USIdentificationDocumentInput

The identification documents used to verify the account holder.

personCreditRiskAttributes: PersonCreditRiskAttributesInput

The credit risk attributes used to verify the USPersonAccountHolder's underwriting details.

externalId: String

An ID representing this account holder in an external system. Provide this field if you create identifiers for this person that you would like us to store for easy access to their information. Maximum length: 255 characters.

The validation for the externalId uses the following regex pattern ^([a-zA-Z\d[\s][_][=][,][-][.][^;]])+$.

USPersonAccountHolderUpdateInput

Input fields for updating a USPersonAccountHolder.

Output:INPUT_OBJECT

Input Fields

The person's legal name.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

billingAddress: AddressInput

The person's U.S. billing address.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

dateOfBirth: String

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

identificationDocument: USIdentificationDocumentInput

The identification document used to verify the person.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

email: String

The person account holder's e-mail address.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

phoneNumber: PhoneInput

The primary phone number for this person account holder.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

USPersonAuthorizedUserInput

The details of the PersonAuthorizedUser.

Output:INPUT_OBJECT

Input Fields

The authorized user's legal name.

email: String!

The authorized user's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput!

The primary phone number for this authorized user.

billingAddress: AddressInput

The authorized user's U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

billingAddressToken: ID

A token representing the authorized user's U.S. billing address.

Exactly one of billingAddress or billingAddressToken must be provided.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

identificationDocument: USIdentificationDocumentInput

The identification documents used to verify the authorized user.

externalId: String

An ID representing this authorized user in an external system. Provide this field if you create identifiers for this person that you would like us to store for easy access to their information. Maximum length: 255 characters.

The validation for the externalId uses the following regex pattern ^([a-zA-Z\d[\s][_][=][,][-][.][^;]])+$.

USUltimateBeneficialOwnerInput

Input fields for creating a USUltimateBeneficialOwner.

Output:INPUT_OBJECT

Input Fields

The ultimate beneficial owner's legal name.

homeAddress: AddressInput

The ultimate beneficial owner's U.S. physical address.

Exactly one of homeAddress or homeAddressToken must be provided.

homeAddressToken: ID

A token representing the ultimate beneficial owner's U.S. physical address.

Exactly one of homeAddress or homeAddressToken must be provided.

dateOfBirth: String!

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

email: String!

The ultimate beneficial owner's e-mail address.

Note: Highnote does not verify the e-mail address.

phoneNumber: PhoneInput!

The primary phone number for this ultimate beneficial owner.

identificationDocument: USIdentificationDocumentInput!

The identification document used to verify the ultimate beneficial owner.

percentageOwnership: Int

Percentage ownership of this ultimate beneficial owner in business if any. Minimum percentage ownership: 25%

USUltimateBeneficialOwnerUpdateInput

Input fields for updating a USUltimateBeneficialOwner.

Output:INPUT_OBJECT

Input Fields

The ultimate beneficial owner's legal name.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

homeAddress: AddressInput

The ultimate beneficial owner's U.S. physical address.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

dateOfBirth: String

Date of birth in YYYY-MM-DD format. Minimum age: 18 years. Maximum age: 100 years, in place to combat fraud and potential elder financial abuse.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

identificationDocument: USIdentificationDocumentInput

The identification document used to verify the ultimate beneficial owner.

Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.

email: String

The ultimate beneficial owner's e-mail address.

cvv: String

Optional card security code value to verify (also referred to as CVV, CSC, CVC). Use this field to override the CVV generated when the PaymentCard was issued.

Minimum length: 3 characters

Maximum length: 4 characters

cardholderAddress: AddressInput

Optional card holder address to use for AVS verification.

Use this field to override the address present on the card holder.

pin: String

Optionally simulate a PIN entered during the transaction.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

VerifyPaymentCardInput

Input for verifying a PaymentCard.

Output:INPUT_OBJECT

Input Fields

paymentCard: PaymentCardInput!

The PaymentCard to verify.

cardHolder: CardHolderInput

The cardHolder to associate the PaymentCard with.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

VerifyPaymentMethodTokenInput

Input for verifying a payment method token.

Output:INPUT_OBJECT

Input Fields

paymentMethodTokenId: ID!

The PaymentMethodToken to authorize.

contractId: ID

Optional contract ID to use for this transaction.

If not provided, the default contract ID will be used.

DEPRECATED: This field is no longer needed. If you currently are using contractId contact Highnote for details on switching to merchantAcceptorId.

idempotencyKey: IdempotencyKey

The idempotency key for this request.

merchantAcceptorId: ID

Optional merchant acceptor ID for this transaction.

This is used to identify the specific merchant location or terminal accepting the payment.

merchantDescriptor: MerchantDescriptorInput

Optional Merchant descriptor information for this transaction.

ViewportCoordinatesInput

An input of coordinates to form a viewport

Output:INPUT_OBJECT

Input Fields

northernLatitude: String!

A latitude coordinate representing the northern point of the viewport.

northernLongitude: String!

A longitude coordinate representing the northern point of the viewport.

southernLatitude: String!

A latitude coordinate representing the southern point of the viewport.

southernLongitude: String!

A longitude coordinate representing the southern point of the viewport.

VisaFleetL2FuelLineItemInput

Visa Fleet Level 2 fuel line item data. These are relevant data items describing fuel products purchased in a fleet transaction. Also used to provide EV charging information

Output:INPUT_OBJECT

Input Fields

productCode: VisaFuelType

Describes one of the fuels purchased in this transaction

unitPrice: UnsignedInt

Cost of fuel per unit of measure

unitPriceMinorUnit: UnsignedInt

The number of places the decimal point shall be moved to the left, starting from the right-most numeric digit of unit price

unitOfMeasure: VisaFuelUnitOfMeasure

Unit of measure used to measure this fuel item

quantity: UnsignedInt

Quantity of fuel purchased

quantityMinorUnit: UnsignedInt

The number of places the decimal point shall be moved to the left, starting from the right-most numeric digit of quantity

totalTimePluggedIn: String

Total amount of time the vehicle was plugged in, in the format HHMMSS

totalTimeCharging: String

Total amount of time taken to charge the vehicle, in the format HHMMSS

chargingStartTime: String

Start time of the charge expressed in local time of the card acceptor location, in the format HHMMSS

chargingFinishTime: String

Finish time of the charge expressed in local time of the card acceptor location, in the format HHMMSS

totalAmount: AmountInput

Total amount for this fuel code line item, including tax

fuelIndicator: Boolean

Indicates whether the line item represents a fuel product or service or not

serviceType: VisaFuelServiceType

The type of service provided at the card acceptor location

productCategoryOrDescription: String

The product category or detail description

discountRatePercentage: UnsignedInt

The discount rate in basis points. Two decimal places are implied

discountPerUnit: AmountInput

The discount amount per unit

discountPerTransaction: AmountInput

The discount amount per transaction

totalDiscountAmount: AmountInput

The total discount amount for this line item

netAmount: AmountInput

The net line item amount less than tax exempted or discounts

notTaxableIndicator: Boolean

An indicator to show whether the item is taxable or not

localTaxIncludedIndicator: Boolean

An indicator to show whether the local tax is included in the unit cost or not

localTaxAmount: AmountInput

The Amount of local tax

localTaxRate: UnsignedInt

The VAT/Local tax rate in basis points for fuel purchased. Two decimal places are implied

nationalTaxIncludedIndicator: Boolean

An indicator to show whether national tax is included in the unit cost or not

nationalTaxAmount: AmountInput

The Amount of national tax

nationalTaxRate: UnsignedInt

The national tax rate in basis points for fuel purchased. Two decimal places are implied

otherTaxIncludedIndicator: Boolean

Indicates whether other tax is included in the unit cost or not

otherTaxAmount: AmountInput

The Amount of other tax

otherTaxRate: UnsignedInt

The other tax rate in basis points for fuel purchased. Two decimal places are implied

VisaFleetL2TransactionDataInput

Simulated Visa Fleet L2 transaction data. These are relevant additional transaction data items pertaining to a fleet transaction.

Output:INPUT_OBJECT

Input Fields

visaFuelPurchaseType: VisaFuelPurchaseType

Describes the type of items included in the transaction. (Gas, non-fuel, fuel, and non-fuel)

visaFuelServiceType: VisaFuelServiceType

Indicates whether the transaction occurred at a self-service or a full-service station

visaFuelType: VisaFuelType

The variety of fuel purchased during the transaction

visaFuelQuantity: UnsignedInt

The amount of fuel purchased during the transaction.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelUnitOfMeasure: VisaFuelUnitOfMeasure

The dimension utilized in conjunction with quantity

visaFuelUnitCost: UnsignedInt

The price per unit of measure for the fuel.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelNetAmount: UnsignedInt

The fuel amount less any exempted taxes or discounts. The value will equal visaFuelQuantity * visaFuelUnitCost exclusive of taxes.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaFuelGrossAmount: UnsignedInt

The total amount for only the fuel purchased in the transaction. The value will equal visaFuelQuantity * visaFuelUnitCost inclusive of taxes.

There are 4 implied decimal places, thus a value of “1” is populated in this field as 10000.

visaNonFuelNetAmount: UnsignedInt

The non-fuel amount less any exempted taxes or discounts. The value will equal the sum of the line item(s) exclusive of taxes.

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaNonFuelGrossAmount: UnsignedInt

The total amount for only the non-fuel products purchased in the transaction. The value will equal the sum of the line item(s) inclusive of taxes.

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaTaxRate: UnsignedInt

The VAT or tax rate applied for the transaction

There are 2 implied decimal places, thus a value of “1” is populated in this field as 100.

visaExpandedFuelType: VisaFuelType

An additional identifier to further differentiate the fuel product

visaAdditionalDataIndicator: Boolean

Indicates whether the Merchant will send more additional (Level 3) information in the future

visaFleetIdentifier: String

An alphanumeric value representing either a Vehicle, Driver, or Generic ID

Maximum length: 255 characters

visaOdometerReading: UnsignedInt

A numeric value indicating the vehicle’s odometer reading at the time of the transaction.

Up to 7 digits.

visaPurchaseIdentifierFormat: VisaFleetPurchaseIdentifierFormat

Indicates whether Purchase Identifier is an order or invoice number

visaPurchaseIdentifier: String

An alphanumeric value representing an order or invoice number

Maximum length: 255 characters

visaFleetEmployeeNumber: String

An alphanumeric value representing the employee’s ID number

Maximum length: 255 characters

visaFleetTrailerNumber: String

An alphanumeric value representing the trailer’s ID number

Maximum length: 255 characters

visaFleetCustomPrompt1: String

An alphanumeric value representing the answer to a custom prompt

Maximum length: 255 characters

visaFleetCustomPrompt2: String

An alphanumeric value representing the answer to a custom prompt

Maximum length: 255 characters

visaNonFuelProductCodes: [VisaNonFuelProductCode!]

A list of up to eight visaNonFuelProductCode values for products in the transaction

visaChargingPowerCapacity: UnsignedInt

Charging station power output capacity represented in kW

visaEvChargingReasonCode: VisaEvChargingReasonCode

Specific charging reason code for this transaction

visaEstimatedKmMilesAdded: UnsignedInt

Estimate of the total distance added in km/miles, based on the kWh added and the type of vehicle engine charged

visaCarbonFootprintAvoided: UnsignedInt

Carbon footprint avoidance (how much was saved from this charge) measurement for the purchase on the transaction – measured in grams of carbon dioxide equivalent (CO2e)

visaEstimatedKmMilesAvailable: UnsignedInt

Estimated range in Km/Miles the car will have, after completion of the charge, once it leaves the electric vehicle charging station

visaMaxPowerDispensed: UnsignedInt

Maximum power dispensed during the specific charge session from that charging station. This could be different to the power output capacity of the station based on power management by the site operator

visaEvConnectorType: VisaEvConnectorType

Visa-defined code for a specific connector type to identify the connection for the charge session

visaFleetFuelLineItems: [VisaFleetL2FuelLineItemInput!]

A list of fuel products purchased if this transaction contained multiple fuel types

visaNationalTaxRate: UnsignedInt

The national tax rate in basis points for fuel purchased. Two decimal places are implied

visaOtherTaxRate: UnsignedInt

Other tax rate in basis points for fuel purchased. Two decimal places are implied

visaDiscountMethod: VisaFleetDiscountMethod

Discount method applied to the transaction

visaDiscountAgent: VisaFleetDiscountAgent

Identifies the entity that calculated the discount

visaDiscountPlanIdentifier: String

Identifies the discount plan applied to the transaction

Maximum length: 255 characters

visaClientIdentifier: String

Identifies the fleet client

Maximum length: 255 characters

WaiveFeeTransferInput

Waive fee input.

Output:INPUT_OBJECT

Input Fields

feeTransferEventId: ID!

Fee transfer event to be reversed.

idempotencyKey: IdempotencyKey!

The idempotency key for this request.

This is a random string such as UUIDv4 used to uniquely identify requests.

If a request with the same IdempotencyKey is received multiple times, only the first request will be processed. Subsequent requests will return the same response as the first request.