Input Object
The input type is a special object type that groups a set of arguments together. This is particularly valuable in the case of mutations, where you might want to pass in a whole object to be created. In the Highnote API we also use inputs for filtering in queries.
Input Fields
applicationId: ID!
Global ID of the AccountHolderCardProductApplication
consentAgreement: ConsentInput!
The AccountHolder's consent and acceptance to the offer agreement.
offerId: ID!
The ID of the AccountHolderCardProductApplicationOffer to accept.
Input Fields
consentAgreement: ConsentInput!
The AccountHolder's consent and acceptance to the counter offer agreement.
offerIdentifier: String!
The ID of the offer to accept.
Input Fields
equals: AccountHolderApplicationStatusCode
Value matches the provided Application Status
notEquals: AccountHolderApplicationStatusCode
Value does not match the provided Application Status
includes: [AccountHolderApplicationStatusCode!]
Value exactly matches any of the provided Application Status
excludes: [AccountHolderApplicationStatusCode!]
Value does not match any of the provided Application Status
Input Fields
offerStatus: CardProductApplicationOfferStatusFilterInput!
A offer status filter input
Input Fields
createdAt: TimestampFilterInput
The date and time, in ISO 8601 format, the Financial Account was created.
updatedAt: TimestampFilterInput
The date and time, in ISO 8601 format, the Financial Account was last updated.
features: FinancialAccountFeatureTypeFilterInput
The list of features for a Financial Account.
cardProductId: StringFilterInput
The id of the card product associated with a Financial Account
externalId: StringFilterInput
The externalId associated with a Financial Account
customFields: CustomFieldsFilterInput
The CustomFields associated with the Financial Account.
Input Fields
bin: StringFilterInput
cardNetwork: PaymentCardNetworkFilterInput
expirationDate: TimestampFilterInput
last4: StringFilterInput
cardProductId: IDFilterInput
status: PaymentCardStatusFilterInput
formFactor: CardFormFactorFilterInput
createDate: TimestampFilterInput
updateDate: TimestampFilterInput
customFields: CustomFieldsFilterInput
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.
This could be a person or a business. It can be at most 22 characters. The characters should be alphanumeric.
individualIdentificationNumber: String
Receiver’s identification number set by the bank initiating the ACH entry.
This can be at most 15 characters. The characters should be alphanumeric.
Input Fields
equals: AchHoldStatus
notEquals: AchHoldStatus
includes: [AchHoldStatus!]
excludes: [AchHoldStatus!]
Input Fields
equals: AchTransferPurpose
notEquals: AchTransferPurpose
includes: [AchTransferPurpose!]
excludes: [AchTransferPurpose!]
Input Fields
equals: AchTransferSign
notEquals: AchTransferSign
includes: [AchTransferSign!]
excludes: [AchTransferSign!]
Input Fields
equals: AchTransferStatusFailureReason
notEquals: AchTransferStatusFailureReason
includes: [AchTransferStatusFailureReason!]
excludes: [AchTransferStatusFailureReason!]
Input Fields
equals: AchTransferType
notEquals: AchTransferType
includes: [AchTransferType!]
excludes: [AchTransferType!]
Input Fields
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.
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.
Input Fields
endpointId: ID!
The Global ID of the CollaborativeAuthorizationEndpoint to activate.
Input Fields
targetId: ID!
Input Fields
paymentCardId: ID!
The ID of the Payment Card to activate.
Input Fields
accountHolderId: ID!
The Global ID of the account holder for whom bank account is added.
externalToken: ExternalTokenInput!
The external token that can be used to fetch bank account details of account holder.
Input Fields
accountHolderId: ID!
The Global ID of the account holder for whom bank account is added.
name: String!
The account name from the institution that Finicity's Get Customer Account API must return.
bankAccountType: BankAccountType!
The type of bank account (Checking or Savings)
externalToken: ExternalTokenFinicityInput!
The external token that can be used to fetch bank account details of account holder.
Input Fields
accountHolderId: ID!
The Global ID of the account holder for whom bank account is added.
externalToken: ExternalTokenInput!
The external token that can be used to fetch bank account details of account holder.
Input Fields
cardProductId: ID!
The card product associated with this request. This mutation is only usable for specific products within the CONSUMER_CREDIT vertical.
accountHolderId: ID!
The Global identifier of the relevant account holder.
externalToken: ExternalTokenInput!
The Highnote processor token provided by Plaid.
thirdPartyProcessorToken: ExternalTokenInput!
The Third Party processor token provided by Plaid.
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.
Input Fields
routingNumber: String!
The routing number of the bank account
accountNumber: String!
The account number of the bank account
name: String
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)
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.
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.
Input Fields
locality: StringFilterInput
region: StringFilterInput
countryCodeAlpha3: ISO3166Alpha3Country
postalCode: StringFilterInput
streetAddress: StringFilterInput
extendedAddress: StringFilterInput
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 or unit numbers.
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)
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.
Input Fields
targetId: ID!
Target Id
subscriptions: [NotificationEventName!]!
The event names to receive notifications about.
Input Fields
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.
Input Fields
code: AdverseActionCodeInput!
The reason why the application was denied.
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"
Input Fields
balanceAmountType: TransferBalanceAmountCode
A calculated balance amount
transferAmount: AmountInput
An amount to be transferred
Input Fields
creditLimitChangeRequestId: ID!
The identifier for the CreditLimitChangeRequest to approve.
updatedCreditLimit: AmountInput
The credit limit after the review.
adverseActionReasons: [AdverseActionCodeInput!]!
If needed, please provide any adverse action reasons for the deny.
customerDetails: CreditLimitChangeRequestCustomerDetailsInput
Details collected about the customer, such as their current debt obligations and annual income.
Input Fields
creditLimitChangeRequestId: ID!
The identifier for the CreditLimitChangeRequest to approve.
updatedCreditLimit: AmountInput!
The credit limit after the review.
customerDetails: CreditLimitChangeRequestCustomerDetailsInput
Details collected about the customer, such as their current debt obligations and annual income.
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
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: 36 characters
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.
Input Fields
includes: [ATMLocationFeature!]
Input Fields
coordinates: ViewportCoordinatesInput!
Input Fields
cardProductId: ID!
The Global ID of the CardProduct to attach the VelocityRule.
velocityRule: VelocityRuleInput!
The details of the VelocityRule to attach to the CardProduct.
Input Fields
fee: CreditPlanFeeInput
The fee configuration to attach to this CreditPlan.
creditPlanId: ID!
The unique identifier for the CreditPlan to attach this FeeSchedule to. This must be of CreditBalanceType INSTALLMENT.
Input Fields
paymentCardId: ID!
The Global ID of the PaymentCard to attach the VelocityRule.
velocityRule: VelocityRuleInput!
The details of the VelocityRule to attach to the PaymentCard.
Input Fields
rewardRule: RewardRuleAttachmentInput!
RewardEarnRule to attach.
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.
Input Fields
redemptionConfiguration: RewardRedemptionConfigurationAttachmentInput!
RewardRedemptionConfiguration to attach to.
cardProductId: ID!
CardProduct id to attach to.
effectiveFrom: String
The date and time in ISO 8601 format, when the attachment should begin taking effect. This should be a date in the future. Optional; leaving this field blank will default it to the timestamp when the mutation was called.
effectiveThrough: String
The date and time in ISO 8601 format, when the attachment should stop taking effect. This should be a date in the future. Optional; leaving this field blank will result in the attachment remaining in effect indefinitely.
Input Fields
cardProductId: ID!
The Global ID of the Card Product to attach the spend rule.
spendRule: AttachSpendRuleInput!
The details of the spend rule to attach to the Card Product.
Input Fields
financialAccountId: ID!
The Global ID of the Payment Card to attach the spend rule.
spendRule: AttachSpendRuleInput!
The details of the spend rule to attach to the Payment Card.
Input Fields
paymentCardId: ID!
The Global ID of the Payment Card to attach the spend rule.
spendRule: AttachSpendRuleInput!
The details of the spend rule to attach to the Payment Card.
Input Fields
financialAccountId: ID!
The Global ID of the FinancialAccount to attach the VelocityRule.
velocityRule: VelocityRuleInput!
The details of the VelocityRule to attach to the FinancialAccount.
Input Fields
bin: StringFilterInput
cardNetwork: PaymentCardNetworkFilterInput
expirationDate: TimestampFilterInput
last4: StringFilterInput
cardProductId: IDFilterInput
status: PaymentCardStatusFilterInput
formFactor: CardFormFactorFilterInput
createDate: TimestampFilterInput
updateDate: TimestampFilterInput
Input Fields
paymentCard: PaymentCardInput!
The payment card to authorize.
cardHolder: CardHolderInput
The cardHolder to associate the payment card 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.
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. Idempotency requests are cached for 24 hours.
Input Fields
paymentMethodTokenId: ID!
The PaymentMethodToken to authorize.
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).
contractId: ID
Optional contract ID to use for this transaction.
If not provided, the default contract ID will be used.
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. Idempotency requests are cached for 24 hours.
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
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.
Input Fields
equals: Boolean!
Input Fields
id: IDFilterInput
externalId: IDFilterInput
businessProfile: BusinessAccountHolderBusinessProfileFilterInput
primaryAuthorizedPerson: BusinessAccountHolderPrimaryAuthorizedPersonFilterInput
Input Fields
postalCode: StringFilterInput
Input Fields
title: SoundsLikeFilterInput
givenName: SoundsLikeFilterInput
middleName: SoundsLikeFilterInput
familyName: SoundsLikeFilterInput
suffix: SoundsLikeFilterInput
Input Fields
annualRevenue: [AmountInput!]
Annual revenue expressed as an AmountInput.
Input Fields
paymentTransactionId: ID!
The payment transaction to cancel the remaining authorized amount.
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. Idempotency requests are cached for 24 hours.
Input Fields
groupOrderId: ID!
Id of the group order.
Input Fields
physicalPaymentCardOrderId: ID!
Physical Payment Card ID
Input Fields
id: ID!
The Global ID of the requested identity update.
Input Fields
scheduledTransferId: ID!
Global ID used to reference the scheduled transfer
Input Fields
paymentTransactionId: ID!
The payment transaction to capture.
contractId: ID
Optional contract ID to use for this transaction.
If not provided, the default contract ID will be used.
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. Idempotency requests are cached for 24 hours.
Input Fields
equals: CardFormFactor
notEquals: CardFormFactor
includes: [CardFormFactor!]
excludes: [CardFormFactor!]
Input Fields
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.
Input Fields
timeRange: TimestampFilterInputRange
Filters application metrics by TimeRange, start and end are inclusive.
cardProductIds: [String!]
Filters application metrics by CardProductId, optional.
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.
id: IDFilterInput
The id of the Card Product Application.
Input Fields
includes: [CardProductApplicationOfferStatus!]
Input Fields
name: String!
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.
Input Fields
bin: StringFilterInput
cardNetwork: PaymentCardNetworkFilterInput
expirationDate: TimestampFilterInput
last4: StringFilterInput
accountHolderId: IDFilterInput
status: PaymentCardStatusFilterInput
formFactor: CardFormFactorFilterInput
createDate: TimestampFilterInput
updateDate: TimestampFilterInput
customFields: CustomFieldsFilterInput
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
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
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
id: 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
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.
Input Fields
paymentCard: PaymentCardInput!
The payment card to charge.
cardHolder: CardHolderInput
The cardHolder to associate the tokenized payment card with.
amount: AmountInput!
The amount to charge.
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 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.
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. Idempotency requests are cached for 24 hours.
Input Fields
paymentMethodTokenId: ID!
The PaymentMethodToken to charge.
amount: AmountInput!
The amount to charge.
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).
contractId: ID
Optional contract ID to use for this transaction.
If not provided, the default contract ID will be used.
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. Idempotency requests are cached for 24 hours.
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
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 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.
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. Idempotency requests are cached for 24 hours.
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
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 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.
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. Idempotency requests are cached for 24 hours.
Input Fields
externalFinancialBankAccountId: ID!
The Global ID of the external financial bank account to be closed.
Input Fields
paymentCardId: ID!
The ID of the Payment Card to close.
Input Fields
groupOrderId: ID!
Id of the group order.
Input Fields
id: ID!
The ACH Credit transfer that will be marked as a Payroll Deposit.
This must be a ElectronicFundsTransfer ID.
isPayrollDeposit: Boolean
If true, the transfer will be considered a PayrollTransfer, if not, it will always remain a CreditFunds transfer. If this flag is omitted then the default value will be true and the transfer will be marked as a PayrollTransfer.
employerFinancialAccountId: ID
The employer financial account. This value is required if isPayrollDeposit
is true.
This must be a FinancialAccount ID.
Input Fields
id: ID!
The Global ID of the requested identity update.
Input Fields
applicationId: 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.
memo: String
An optional note related to this confirmation.
Input Fields
primaryAuthorizedPersonId: ID!
The ID of the primary authorized person of the business or the person card holder. For authorized user applications, the primaryAuthorizedPersonId is the authorized user id.
consentTimestamp: String!
The date and time, in ISO 8601 format, marking when the primary authorized person or person card holder accepted card holder agreement.
For example, 2022-01-01T22:00:00.000Z.
consentIpAddress: IPAddressInput
The IPAddress of the consenting party when they accepted the agreement.
Input Fields
cardProductId: ID!
The ID of the Card Product for which the account holder is applying to use.
accountHolderId: ID!
The ID of the account holder applicant.
ipAddress: IPAddressInput
The IP address details of the account holder applicant.
cardHolderAgreementConsent: ConsentInput!
Details on the acceptance of terms and conditions of the card holder agreement.
accountHolderCreditReportPullConsent: ConsentInput
Details on the account holder's consent to pull their credit report as part of the card product application.
Input Fields
name: String!
A name for the rule for future reference.
maximumAmount: AmountInput!
The maximum amount to allow for a single authorization.
Input Fields
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.
Input Fields
name: String!
A name for the rule for future reference.
allowed: [CardDataInputCapability!]
The CardDataInputCapability values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [CardDataInputCapability!]
The CardDataInputCapability values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
name: String!
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.
Input Fields
cardProduct: CardProductInput!
Details about the Card Product to be created.
Input Fields
name: String!
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.
Input Fields
cardProduct: CreateCardProductWithTemplateCardProductInput!
The card product to create.
Input Fields
name: String
The name of the CardTransactionProcessingTypeConditionSpendRule
allowed: [CardTransactionProcessingType!]
The list of possible CardTransactionProcessingType that will be allowed.
Min: 1
Max: 200
blocked: [CardTransactionProcessingType!]
The list of possible CardTransactionProcessingType that will result in a decline.
Min: 1
Max: 200
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.
Input Fields
financialAccountId: ID!
The FinancialAccount ID to associate the check document with.
documentTypes: [CheckPaymentDocumentType!]!
The type of document to upload.
Input Fields
financialAccountId: ID!
The identifier for the FinancialAccount to review.
requestedChange: CreditLimitChangeRequestDetailsInput
Details about the CreditLimitChangeRequest.
Input Fields
name: String!
A name for the rule for future reference.
allowed: [CVVResponseCode!]
The CVVResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [CVVResponseCode!]
The CVVResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
name: String!
A name for the rule for future reference.
maximumAmount: AmountInput!
The maximum amount to allow for a single deposit.
Input Fields
name: String!
A name for the rule for future reference.
maximumCount: UnsignedInt!
The maximum count of deposits.
Input Fields
name: String!
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: 200
blocked: [DepositProcessingNetwork!]
The list of possible DepositProcessingNetwork that will result in declined cash deposits.
Min: 1
Max: 200
Input Fields
documentUploadSessionId: ID!
The ID of the document upload session
documentType: DocumentType!
The document type to be uploaded
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.
Input Fields
name: String!
A name for the rule for future reference.
amountVariance: AmountInput!
The Amount over the account's original balance that is permitted for additional spending.
Input Fields
name: String!
A name for the rule for future reference.
allowed: [MerchantCategory!]
The merchant categories that will be allowed during authorizations.
Min: 1 Max: 200
blocked: [MerchantCategory!]
The merchant categories that will result in declined authorizations.
Min: 1 Max: 200
allowedMcc: [String!]
The merchant category codes that will be allowed during authorizations.
Min: 1 Max: 200
blockedMcc: [String!]
The merchant category codes that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
name: String!
A name for the rule for future reference.
allowed: [ISO3166Alpha3Country!]
The merchant countries that will be allowed during authorizations.
Min: 1 Max: 200
blocked: [ISO3166Alpha3Country!]
The merchant countries that will result in declined authorizations.
Min: 1 Max: 200
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. Idempotency requests are cached for 24 hours.
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.
Input Fields
name: String!
A name for the rule for future reference.
minimumAmount: AmountInput!
The exact amount to allow for a single authorization.
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
transferDate: String!
The date, in ISO 8601 format, the transfer should be scheduled.
**Note: ** One time payments cannot be scheduled more than 90 days in advance.
Input Fields
name: String!
A name for the rule for future reference.
allowed: [PanEntryMode!]
The PanEntryMode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PanEntryMode!]
The PanEntryMode values that will result in declined authorizations.
Min: 1 Max: 200
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. Idempotency requests are cached for 24 hours.
Input Fields
cardProductId: ID!
Id of the product with which the group order will be associated.
deliveryDetails: PaymentCardDeliveryDetailsInput!
Delivery details.
courier: PaymentCardShipmentCourierInput
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.
Input Fields
cardProductId: ID!
Id of the product with which the group order will be associated.
deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!
Delivery details.
courier: PaymentCardShipmentCourierInput
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. Idempotency requests are cached for 24 hours.
Minimum length: 5 characters Maximum length: 255 characters
cardProfileSetId: ID
ID of the CardProfileSet to be used for the physical card group order.
Input Fields
cardProductId: ID!
Id of the product with which the group order will be associated.
deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!
Delivery details.
courier: PaymentCardShipmentCourierInput
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. Idempotency requests are cached for 24 hours.
Minimum length: 5 characters Maximum length: 255 characters
cardProfileSetId: ID
ID of the CardProfileSet to be used for the physical card group order.
Input Fields
name: String!
A name for the rule for future reference.
allowed: [PointOfServiceCategoryCondition!]
The PointOfServiceCategoryCondition values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PointOfServiceCategoryCondition!]
The PointOfServiceCondition values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
name: String!
A name for the rule for future reference.
allowed: [PostalCodeResponseCode!]
The PostalCodeResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PostalCodeResponseCode!]
The PostalCodeResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
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.
transferDayOfMonth: Int!
Day of the month to schedule the transfer
**Note: ** The scheduled day of transfer should fall between the 1st and the 28th.
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.
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.
Input Fields
name: String!
Name of Earning Rule. Should be between 1 and 255 characters.
rewardPointEarning: RewardEarnRateInput!
Earning Rate. This rate describes the amount of points earn related to the amount of money spent. See RewardEarnRateInput.
Input Fields
name: String!
Name of Earning Rule. Should be between 1 and 255 characters.
rewardPointEarning: RewardEarnRateInput!
Earning Rate. This rate describes the amount of points earned relative to the amount of money spent. See RewardEarnRateInput.
allowedList: [MerchantCategory!]!
Collection of MerchantCategory that a transaction's MCC must exist within in order for this rule to earn reward points. This field must have at least one MerchantCategory
Input Fields
financialAccountId: ID!
Financial Account id that will be the recipient of the adjustment.
activity: RewardPointsActivityTypeInput!
Reward activity operation : AWARD, DEDUCT
pointsToAdjust: UnsignedInt!
Amount of points that will be adjusted. Value should be between 0 and the reward point balance on the account.
memo: String
memo description for the deduction. Max character length is 1024.
Input Fields
name: String!
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.
Input Fields
secretKey: SecretAPIKeyInput!
Details of the new Secret Key
Input Fields
name: String!
A name for the rule for future reference.
allowed: [AVSResponseCode!]
The AVSResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [AVSResponseCode!]
The AVSResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
token: String!
The token from tokenizeUSBusinessAccountHolder to use to create the USBusinessAccountHolder.
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][_][=][,][-][.][^;]])+$.
Input Fields
token: String!
The token from tokenizeUSPersonAccountHolder to use to create the USPersonAccountHolder.
Input Fields
personAccountHolder: USPersonAccountHolderInput!
The details of the account holder.
Input Fields
token: String!
The token from tokenizeUSPersonAuthorizedUser to use to create the USPersonAuthorizedUser.
Input Fields
personAuthorizedUser: USPersonAuthorizedUserInput!
The details of the account holder.
accountHolderId: ID!
The identifier of the business account holder for which authorized user should be created.
Input Fields
name: String!
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
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.
Input Fields
billingCycleGracePeriodInDays: UnsignedInt
Number of days included in the grace period
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.
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.
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.
Input Fields
scheduleId: ID
The identifier for the FeeSchedule to attach to the CreditPlan.
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.
Input Fields
balanceType: CreditBalanceType
The type of balance. For example, PURCHASE or INSTALLMENT.
Input Fields
annualRevenue: [AmountInput]
Annual revenue expressed as an AmountInput.
Input Fields
email: String!
The email of the customer.
givenName: String!
The given name of the customer.
familyName: String!
The family name of the customer.
phone: PhoneInput
The phone number of the customer.
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.
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
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.
Input Fields
endpointId: ID!
The Global ID of the CollaborativeAuthorizationEndpoint to deactivate.
Input Fields
targetId: ID!
Input Fields
id: ID!
The ID of the object associated with the CustomFields.
Input Fields
spendRuleId: ID!
The Global ID of the Spend Rule to delete.
Input Fields
velocityRuleId: ID!
The Global ID of the Velocity Rule to delete.
Input Fields
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.
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.
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.
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.
Input Fields
paymentCardId: ID!
The Global ID of the PaymentCard connected to the VelocityRule.
velocityRule: VelocityRuleInput!
The details of the VelocityRule to detach from the PaymentCard.
NOTE: version does not matter here
Input Fields
cardProductId: ID!
The Global ID of the Card Product to detach the spend rule.
spendRule: DetachSpendRuleInput!
The details of the spend rule to detach from the Card Product.
Input Fields
financialAccountId: ID!
The Global ID of the Payment Card to detach the spend rule.
spendRule: DetachSpendRuleInput!
The details of the spend rule to detach from the Payment Card.
Input Fields
paymentCardId: ID!
The Global ID of the Payment Card to detach the spend rule.
spendRule: DetachSpendRuleInput!
The details of the spend rule to detach from the Payment Card.
Input Fields
id: ID!
The Global ID of the Spend Rule to detach.
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.
Input Fields
cardProductId: ID!
The Global ID of the CardProduct for which to disable authorized user product feature.
Input Fields
cardProductId: ID!
The Global ID of the CardProduct for which to enable authorized user product feature.
Input Fields
cardProductId: ID!
The Global ID of the CardProduct for which to enable the Collaborative Application Decisioning product feature.
Input Fields
cardProductId: ID!
The Global ID of the CardProduct for which to enable the Collaborative Authorization product feature.
Input Fields
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
Input Fields
documentUploadSessionId: ID!
The ID of the document upload session
Input Fields
equals: ExternallyInitiatedACHHoldStatus
notEquals: ExternallyInitiatedACHHoldStatus
includes: [ExternallyInitiatedACHHoldStatus!]
excludes: [ExternallyInitiatedACHHoldStatus!]
Input Fields
equals: ExternallyInitiatedACHStatus
notEquals: ExternallyInitiatedACHStatus
includes: [ExternallyInitiatedACHStatus!]
excludes: [ExternallyInitiatedACHStatus!]
Input Fields
notEquals: ExternallyInitiatedACHStatusReasonCode
Input Fields
companyIdentifier: StringFilterInput
companyName: StringSearchFilterInput
companyEntryDescription: StringSearchFilterInput
transactionAmount: MoneyFilterInput
transactionType: ExternallyInitiatedTransferTypeFilterInput
settlementDate: TimestampFilterInput
holdStatus: ExternallyInitiatedACHHoldStatusFilterInput
cardProductId: StringSearchFilterInput
returnDate: TimestampFilterInput
Input Fields
equals: ExternallyInitiatedTransferType
notEquals: ExternallyInitiatedTransferType
includes: [ExternallyInitiatedTransferType!]
excludes: [ExternallyInitiatedTransferType!]
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.
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.
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.
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.
Input Fields
status: CardProfileSetStatusInput
Input Fields
postedAmount: MoneyFilterInput
pendingAmount: MoneyFilterInput
createdAt: TimestampFilterInput
updatedAt: TimestampFilterInput
isComplete: BooleanFilterInput
isSignNegative: BooleanFilterInput
activityType: FinancialAccountActivityTypeFilterInput
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
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
Input Fields
bin: StringFilterInput
cardNetwork: PaymentCardNetworkFilterInput
expirationDate: TimestampFilterInput
last4: StringFilterInput
accountHolderId: IDFilterInput
status: PaymentCardStatusFilterInput
formFactor: CardFormFactorFilterInput
createDate: TimestampFilterInput
updateDate: TimestampFilterInput
customFields: CustomFieldsFilterInput
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
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
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.
Input Fields
accountHolderId: ID!
The global ID of the Business Account holder for this token.
permissions: [BusinessAccountHolderClientTokenPermission!]!
Specify permissions for this token.
Input Fields
fromFinancialAccountId: ID!
The global ID of financial account.
This must be an external financial account.
toFinancialAccountId: ID!
The global ID of financial account.
This must be an internal financial account.
permissions: [CreateScheduledTransferClientTokenPermission!]!
Specify permissions for this token.
Input Fields
directDepositDetailId: ID!
The global ID of the Direct Deposit Detail for this token.
permissions: [DirectDepositDetailClientTokenPermission!]!
Specify permissions for this token.
Input Fields
documentUploadSessionId: ID!
The global ID of the Document Upload Session for this token.
permissions: [DocumentUploadClientTokenPermission!]!
Specify permissions for this token.
Input Fields
externalBankAccountDetailId: ID!
The global ID of the Direct Deposit Detail for this token.
permissions: [ExternalBankAccountDetailClientTokenPermission!]!
Specify permissions for this token.
Input Fields
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.
Input Fields
fromFinancialAccountId: ID!
The global ID of financial account.
This must be an external financial account.
toFinancialAccountId: ID!
The global ID of financial account.
This must be an internal financial account.
permissions: [InitiateSecureDepositClientTokenPermission!]!
Specify permissions for this token.
Input Fields
paymentCardId: ID!
The global ID of the Payment Card for this token.
permissions: [PaymentCardClientTokenPermission!]!
Specify permissions for this token.
Input Fields
permissions: [GeneratePaymentMethodTokenizationClientTokenPermission!]!
Requested permissions for the GeneratePaymentMethodTokenizationClientToken
Input Fields
accountHolderId: ID!
The global ID of the Person Account holder for this token.
permissions: [PersonAccountHolderClientTokenPermission!]!
Specify permissions for this token.
Input Fields
authorizedUserId: ID!
The global ID of the Person Authorized User for this token.
permissions: [PersonAuthorizedUserClientTokenPermission!]!
Specify permissions for this token.
Input Fields
scheduledTransferId: ID!
The global ID of the secure deposit transfer.
permissions: [ScheduledTransferClientTokenPermission!]!
Specify permissions for this token.
Input Fields
transactionId: ID!
The global ID of the secure deposit transfer.
permissions: [SecureDepositClientTokenPermission!]!
Specify permissions for this token.
Input Fields
accountHolderId: ID!
The global ID of the Person Account holder for this token.
linkExperience: VerifiedExternalBankAccountLinkExperience
Optional link experience configuration. Highnote will default the integration to WEB_SDK if it is not provided.
Input Fields
aggregateEntityId: ID
The aggregate entity id for the GlobalNote. You can use this ID to group notes together that do not have the same primaryEntityId.
aggregateEntityType: GlobalNoteAggregateEntityType
The aggregate entity type for the GlobalNote.
Input Fields
primaryEntityId: ID!
The primary entity id for the GlobalNote.
primaryEntityType: GlobalNotePrimaryEntityType!
The primary entity type for the GlobalNote.
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
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.
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
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.
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.
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.
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.
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.
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.
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
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.
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.
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
Input Fields
reportType: OrganizationReportType!
The type of report to be generated for an Organization.
parameters: ReportParametersInput!
Parameters used to generate the Report.
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.
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. Idempotency requests are cached for 24 hours.
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.
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.
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.
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
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.
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.
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.
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.
Input Fields
requestedIdentityUpdateId: ID!
The Global ID of the requested identity update.
primaryAuthorizedPerson: USAuthorizedPersonUpdateInput!
Details for updating the USAuthorizedPerson.
Input Fields
requestedIdentityUpdateId: ID!
The Global ID of the requested identity update.
businessProfile: USBusinessProfileUpdateInput!
Details for updating the USBusinessProfile.
Input Fields
requestedIdentityUpdateId: ID!
The Global ID of the requested identity update.
ultimateBeneficialOwner: USUltimateBeneficialOwnerUpdateInput!
Details for updating the USUltimateBeneficialOwner.
Input Fields
installmentAgreementStatus: InstallmentAgreementStatus
The status of the InstallmentAgreement. For example, OPEN or REVERSE or PAID_OFF or CHARGE_OFF`.
transactionEventIds: [ID!]
The IDs of TransactionEvents to include in results.
Input Fields
cardTransactionEventIds: [ID!]!
A list of globally unique identifiers for the relevant TransactionEvents. Must be ClearingEvents or AuthorizationAndClearEvents. Must be between 1 and 20 identifiers, inclusive.
Input Fields
cardTransactionEventId: ID!
The globally unique identifier for the relevant TransactionEvent. Must be a ClearingEvent or an AuthorizationAndClearEvent.
Input Fields
equals: IntegratorInitiatedACHHoldStatus
notEquals: IntegratorInitiatedACHHoldStatus
includes: [IntegratorInitiatedACHHoldStatus!]
excludes: [IntegratorInitiatedACHHoldStatus!]
Input Fields
equals: IntegratorInitiatedACHStatus
notEquals: IntegratorInitiatedACHStatus
includes: [IntegratorInitiatedACHStatus!]
excludes: [IntegratorInitiatedACHStatus!]
Input Fields
notEquals: IntegratorInitiatedACHStatusReasonCode
Input Fields
companyEntryDescription: StringSearchFilterInput
transactionAmount: MoneyFilterInput
transactionType: IntegratorInitiatedTransferTypeFilterInput
settlementDate: TimestampFilterInput
holdStatus: IntegratorInitiatedACHHoldStatusFilterInput
cardProductId: StringSearchFilterInput
returnDate: TimestampFilterInput
Input Fields
equals: IntegratorInitiatedTransferType
notEquals: IntegratorInitiatedTransferType
includes: [IntegratorInitiatedTransferType!]
excludes: [IntegratorInitiatedTransferType!]
Input Fields
notEquals: InterFinancialAccountTransferActivityType
Input Fields
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.
transferActivityType: InterFinancialAccountTransferActivityTypeFilterInput
Purpose of the InterFinancialAccountTransfer
status: InterFinancialAccountTransferStatusFilterInput
Status of the InterFinancialAccountTransfer
Input Fields
notEquals: InterFinancialAccountTransferStatus
includes: [InterFinancialAccountTransferStatus!]
excludes: [InterFinancialAccountTransferStatus!]
Input Fields
email: String!
E-mail of the user to invite.
roles: [UserRole!]!
The list of users' roles that determine a user's permissions within the organization.
Input Fields
v4: String
By providing the IPv4 address, Highnote can provide higher confidence during identity verification of the account holder. The IPv4 address provided should be the IP address of your customer and not your hosted server.
v6: String
By providing the IPv6 address, Highnote can provide higher confidence during identity verification of the account holder. The IPv6 address provided should be the IP address of your customer and not your hosted server.
Input Fields
cardProductId: ID!
The ID of the Card Product to update.
name: String!
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
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).
name: String!
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. Idempotency requests are cached for 24 hours.
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 financial account that will act as the on-demand funding source for this financial account.
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).
name: String!
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. Idempotency requests are cached for 24 hours.
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: IssuePaymentCardOptionsInput!
Options for the newly issued Payment Card.
customFields: [CustomFieldInput!]
The CustomFields for the Payment Card.
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).
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. Idempotency requests are cached for 24 hours.
options: IssuePaymentCardOptionsInput!
Options for the newly issued PaymentCard.
Input Fields
applicationId: ID!
The ID of the authorizecd user application to issue this Payment Card against.
Note: The Application must be APPROVED.
options: IssuePaymentCardOptionsInput!
Options for the newly issued Payment Card.
customFields: [CustomFieldInput!]
The CustomFields for the Payment Card.
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: IssuePaymentCardOptionsInput!
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: 36 characters
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).
Input Fields
applicationId: ID!
The ID of the AccountHolderCardProductApplication to issue a preprinted payment card FinancialAccount.
Note: The Application must be APPROVED.
name: String!
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).
Input Fields
equals: LedgerName
Value matches the provided ledger name
notEquals: LedgerName
Value does not match the provided ledger name
includes: [LedgerName!]
Value exactly matches all of the provided ledger name
excludes: [LedgerName!]
Value does not match any of the provided ledger name
Input Fields
ledgerNames: [LedgerName!]
ledger names to be included in the ledger report.
financialAccountNames: [String!]
Financial account names to be included in the ledger report.
financialAccountIds: [ID!]
Financial account ids to be included in the ledger report.
financialEventTypes: [FinancialEventType!]
Financial event names to be included in the ledger report.
Input Fields
publicToken: String!
The token provided by account holder as part of the GenerateVerifiedExternalBankAccountLinkToken process
Input Fields
equals: MerchantCategory
Value matches the provided merchant category.
notEquals: MerchantCategory
Value does not match the provided merchant category.
includes: [MerchantCategory!]
Value exactly matches all of the provided merchant category.
excludes: [MerchantCategory!]
Value does not match any of the provided merchant category.
Input Fields
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, 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.
Input Fields
category: MerchantCategoryFilterInput
The merchant category for the authorization.
name: StringSearchFilterInput
The merchant or institution name.
countryCodeAlpha3: ISO3166Alpha3Country
The merchant country code
description: StringSearchFilterInput
The merchant description
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.
name: String
The merchant or institution name. Maximum length: 25 characters
address: MerchantDetailsAddressInput
Represents the address of the merchant as sent by the acquirer.
Input Fields
name: USAssociatedPersonNameInput!
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.
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.
Input Fields
name: BusinessAccountHolderNameInput!
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.
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
Input Fields
name: USAssociatedPersonNameInput!
The ultimate beneficial owner's legal name.
homeAddress: AddressInput
The ultimate beneficial owner's U.S. physical address.
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%
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.
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.
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
Provides additional information about the person (e.g. Jr., Sr.)
Maximum length: 10 characters
The validation for the input uses the following regex pattern ^[a-zA-Z.]+$.
title: String
One or more words used before the person's name (e.g. Mx., Dr.).
Maximum length: 10 characters
The validation for the input uses the following regex pattern ^[a-zA-Z.]+$.
Input Fields
amount: MoneyFilterInput
purpose: AchTransferPurposeFilterInput
cardProductId: StringSearchFilterInput
companyIdentifier: StringFilterInput
companyName: StringSearchFilterInput
companyEntryDescription: StringSearchFilterInput
traceNumber: StringFilterInput
statusFailureReason: AchTransferStatusFailureReasonFilterInput
holdStatus: AchHoldStatusFilterInput
createdAt: TimestampFilterInput
settlementDate: DateFilterInput
returnSentToBankAt: TimestampFilterInput
Input Fields
equals: NonOriginatedAchTransferStatus
notEquals: NonOriginatedAchTransferStatus
includes: [NonOriginatedAchTransferStatus!]
excludes: [NonOriginatedAchTransferStatus!]
Input Fields
createdAt: NotificationTimestampFilterInput
Filter by the createdAt timestamp of the notification event.
name: [NotificationEventName!]
Filter by the name of the notification event.
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.
Input Fields
paymentCardId: ID!
Id of the payment card.
groupOrderId: ID!
Id of the group order.
deliveryDetails: PaymentCardDeliveryDetailsInput
Delivery details.
cardPersonalization: PaymentCardPersonalizationInput!
Card personalization.
Input Fields
paymentCardId: ID!
Id of the payment card.
deliveryDetails: PaymentCardDeliveryDetailsInput!
Delivery details.
cardPersonalization: PaymentCardPersonalizationInput!
Card personalization.
courier: PaymentCardShipmentCourierInput
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.
Input Fields
paymentCardId: ID!
Id of the payment card.
deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!
Delivery details.
cardPersonalization: PaymentCardPersonalizationInput!
Card personalization.
courier: PaymentCardShipmentCourierInput
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. Idempotency requests are cached for 24 hours.
Minimum length: 5 characters Maximum length: 255 characters
Input Fields
paymentCardId: ID!
Id of the payment card.
deliveryDetails: PaymentCardDeliveryDetailsWithValidatedAddressInput!
Delivery details.
cardPersonalization: PaymentCardPersonalizationInput!
Card personalization.
courier: PaymentCardShipmentCourierInput
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. Idempotency requests are cached for 24 hours.
Minimum length: 5 characters Maximum length: 255 characters
Input Fields
amount: MoneyFilterInput
purpose: AchTransferPurposeFilterInput
cardProductId: StringSearchFilterInput
companyEntryDescription: StringSearchFilterInput
traceNumber: StringFilterInput
statusFailureReason: AchTransferStatusFailureReasonFilterInput
holdStatus: AchHoldStatusFilterInput
createdAt: TimestampFilterInput
returnProcessedAt: TimestampFilterInput
Input Fields
equals: OriginatedAchTransferStatus
notEquals: OriginatedAchTransferStatus
includes: [OriginatedAchTransferStatus!]
excludes: [OriginatedAchTransferStatus!]
Input Fields
equals: PaymentCardChargebackStatus
notEquals: PaymentCardChargebackStatus
includes: [PaymentCardChargebackStatus!]
excludes: [PaymentCardChargebackStatus!]
Input Fields
name: NameInput!
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.
Input Fields
name: NameInput!
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.
Input Fields
equals: PaymentCardDisputeStatus
notEquals: PaymentCardDisputeStatus
includes: [PaymentCardDisputeStatus!]
excludes: [PaymentCardDisputeStatus!]
Input Fields
paymentCardId: IDFilterInput
Input to filter by payment card ID
bin: StringFilterInput
Input to filter by payment card bank identification number.
last4: StringFilterInput
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.
Input Fields
equals: PaymentCardGroupOrderStatus
notEquals: PaymentCardGroupOrderStatus
includes: [PaymentCardGroupOrderStatus!]
excludes: [PaymentCardGroupOrderStatus!]
Input Fields
cardNumber: String!
The primary account number for the payment card.
Input Fields
equals: PaymentCardNetwork
notEquals: PaymentCardNetwork
includes: [PaymentCardNetwork!]
excludes: [PaymentCardNetwork!]
Input Fields
equals: PaymentCardOrderStatus
notEquals: PaymentCardOrderStatus
includes: [PaymentCardOrderStatus!]
excludes: [PaymentCardOrderStatus!]
Input Fields
textLines: PaymentCardPersonalizationTextLinesInput!
Personalization text lines.
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.
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 \&\-\,\.\/\'\$]*$.
Input Fields
method: PaymentCardShippingMethod!
Shipping method.
signatureRequiredOnDelivery: Boolean!
Whether signature is required on delivery.
Input Fields
equals: PaymentCardShippingMethod
notEquals: PaymentCardShippingMethod
includes: [PaymentCardShippingMethod!]
excludes: [PaymentCardShippingMethod!]
Input Fields
equals: PaymentCardStatus
notEquals: PaymentCardStatus
includes: [PaymentCardStatus!]
excludes: [PaymentCardStatus!]
Input Fields
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.
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
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
Input Fields
operationalCurrency: ISO4217Alpha3CurrencyCode
eventType: TransactionEventFilterInput
requestedAmount: MoneyFilterInput
approvedAmount: MoneyFilterInput
responseCode: TransactionEventResponseCodeFilterInput
avsResponseCode: AVSResponseCodeFilterInput
postalCodeResponseCode: PostalCodeResponseCodeFilterInput
cvvResponseCode: CVVResponseCodeFilterInput
transactionType: TransactionTypeFilterInput
paymentCardId: IDFilterInput
transactionId: IDFilterInput
id: 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
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.
Input Fields
id: ID!
The CatalogItem ID to add to the PaymentOrder.
name: String
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.
Input Fields
name: String!
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.
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.
Inputs for filtering person account holder data.
Note: Filtering by a single field will yield accurate results. You may also
combine the dateOfBirth and name fields within the same query for successful
search results. However, combining other fields may not yield the expected results
and is not supported.
Output:INPUT_OBJECT
Input Fields
dateOfBirth: DateFilterInput
phone: PhoneFilterInput
billingAddress: AddressFilterInput
email: StringSearchFilterInput
Input Fields
title: SoundsLikeFilterInput
givenName: SoundsLikeFilterInput
middleName: SoundsLikeFilterInput
familyName: SoundsLikeFilterInput
suffix: SoundsLikeFilterInput
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.).
Input Fields
dateOfBirth: DateFilterInput
billingAddress: AddressFilterInput
socialSecurityNumberLast4: HashedFilterInput
Input Fields
title: SoundsLikeFilterInput
givenName: SoundsLikeFilterInput
middleName: SoundsLikeFilterInput
familyName: SoundsLikeFilterInput
suffix: SoundsLikeFilterInput
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.).
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.
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)
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.
Input Fields
name: String!
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.
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.
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.
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.
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
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.
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. Idempotency requests are cached for 24 hours.
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.
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.
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.
Input Fields
name: String!
The name of the financial account. This field is required and should provide a meaningful name for the account.
Input Fields
options: IssuePaymentCardOptionsInput!
Options for the newly issued payment card. This field specifies the configuration details and preferences for the card issuance.
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.
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.
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. Idempotency requests are cached for 24 hours.
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
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: 36 characters
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
cardLostDate: String
The date on which the card was lost. e.g. 2026-01-01T23:59:59Z
Input Fields
endpointId: ID!
The Global ID of the CollaborativeAuthorizationEndpoint to remove.
Input Fields
targetId: ID!
The notification target ID.
Input Fields
targetId: ID!
Input Fields
targetId: ID!
Target Id
subscriptions: [NotificationEventName!]!
The event names to no longer receive notifications about.
Input Fields
email: String!
E-mail of the user to remove.
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.
Input Fields
status: ReportStatusFilterInput
Filters reports by ReportStatus.
reportType: ReportTypeFilterInput
Filters reports by ReportType.
createDateFilter: TimestampFilterInputRange
Filter reports by timestamp range for createDate
Input Fields
between: ReportParameterTimestampRangeInput!
The date range used to generate the report.
ledgerReportParameters: LedgerReportParametersInput
ledger report specific parameters.
Input Fields
includes: [ReportStatus!]
Input Fields
includes: [ReportType!]
Input Fields
applicantId: ID!
The ID of the applicant.
documentTypes: [DocumentType!]
The requested document types for the applicant.
Input Fields
apiKeyId: ID!
The ID of the API Key to revoke.
Input for entering RewardEarnRate. The number of points earned per USD on a transaction.
This rate should be between 0.0 and 100.0. 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 |
Output:INPUT_OBJECT
Input Fields
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 |
Input Fields
id: ID!
Global identifier of the RewardRedemptionConfiguration to attach.
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 to 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
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 to 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 |
Input Fields
id: ID!
Global identifier of the RewardEarnRule to attach.
Input Fields
targetId: ID!
The notification target ID.
Input Fields
name: String!
Human-friendly name of the Secret API Key.
Input Fields
id: ID!
The Global ID of the NonOriginatedAchTransfer to simulate processing.
Input Fields
id: ID!
The Global ID of the ACH transfer to simulate processing.
statusFailureReason: AchTransferStatusFailureReason!
Additional details about why the OriginatedAchTransfer or NonOriginatedAchTransfer was returned.
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.
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.
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.
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.
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.
Input Fields
financialAccountId: ID!
FinancialAccount id
numberOfCyclesToShiftCurrentStatementBackward: UnsignedInt!
The number of billing cycles to shift the current statement backward.
Input Fields
cardDigitalWalletTokenId: ID!
The ID of the card digital wallet token to be activated.
Input Fields
paymentCardId: ID!
The ID of the payment card to create digital wallet token.
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.
Input Fields
financialAccountId: ID!
The ID of the FinancialAccount to move into CLOSED status.
Input Fields
cardProductId: ID!
Fee schedule associated to a card product.
feeConfigurations: [SimulateFeeConfigurationInput!]
Fee configuration details about activity and fee amount to be charged.
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.
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.
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%
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.
Input Fields
feeActivityType: FeeTransferEventFeeActivityTypeInput!
The activity for which the fee is charged.
feeAmount: SimulatedFeeAmountInput!
Fee amount to be charged.
Input Fields
id: ID!
The ID of the dispute.
liability: PaymentCardDisputeLiability!
The Liability for the dispute.
amount: AmountInput!
The amount to finalize the provisional credit.
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.
Input Fields
financialAccountId: ID!
The ID of the FinancialAccount to move into PENDING_CLOSURE status.
closeWithBalance: Boolean
Whether to close the financial account with a balance.
A value of true is only allowed for accounts with at least one credit FinancialAccountFeature (such as CreditCardAccountFeature) enabled.
Input Fields
id: ID!
The ID of the dispute.
liability: PaymentCardDisputeLiability
Indicates whether the Issuer or Merchant is liable for the dispute.
Input Fields
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.
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.
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
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
Input Fields
code: MastercardFleetNonFuelProductCode
Indicates the type of fuel product purchased
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
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.
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.
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
Input Fields
productCode: MastercardFleetProductCode
The product code of the individual item purchased
quantity: Float
Quantity of the item purchased
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
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
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.
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
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
Input Fields
groupOrderId: ID!
Id of the group order.
Input Fields
groupOrderId: ID!
Id of the group order.
Input Fields
groupOrderId: ID!
Id of the group order.
Input Fields
physicalPaymentCardOrderId: ID!
Physical Payment Card ID
Input Fields
physicalPaymentCardOrderId: ID!
Physical Payment Card ID
Input Fields
physicalPaymentCardOrderId: ID!
Physical Payment Card ID
Input Fields
id: ID!
The global ID of the transfer to be changed.
Input Fields
id: ID!
The global ID of the transfer to be changed.
Input Fields
id: ID!
The global ID of the transfer to be changed.
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.
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.
Input Fields
id: ID!
The global ID of the transfer to be changed.
reasonCode: IntegratorInitiatedACHStatusReasonCode!
The reason for the RETURNED status.
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.
Input Fields
financialAccountId: ID!
Financial Account Id
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.
Input Fields
id: ID!
The ID of the PaymentCardTransactionDispute
status: PaymentCardDisputeStatus
The status of the dispute.
Input Fields
id: ID!
The ID of the chargeback.
disputeId: ID!
The ID of the dispute.
status: PaymentCardChargebackStatus
The status of the chargeback
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.
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
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
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.
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.
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.
Input Fields
amount: AmountInput
The price of duty.
amountSignage: VisaAmountSignage
This field specifies if the Duty Amount is a credit or debit value.
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.
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.
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
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.
Input Fields
treatment: VisaTaxTreatment
Describes how the tax is calculated on the invoice
Input Fields
soundsLike: [String!]
Value matches the data that sounds like the provided Strings.
Input Fields
documentUploadSessionId: ID!
The ID of the document upload session
Input Fields
startsWith: String
Value starts with provided String.
endsWith: String
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.
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.
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.
Input Fields
paymentCardId: ID!
The ID of the Payment Card to suspend.
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.
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.
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.
Input Fields
fullName: String
The full name as represented on the card. Minimum length: 1 character Maximum length: 255 characters
billingAddress: TokenizeAddressInput
The billing address associated with the card.
Input Fields
paymentCard: PaymentCardInput!
The payment card to tokenize.
cardHolder: TokenizeCardPaymentMethodCardHolderInput
The cardHolder to associate the tokenized payment card with.
Input Fields
equals: TransactionEventFilter
notEquals: TransactionEventFilter
includes: [TransactionEventFilter!]
excludes: [TransactionEventFilter!]
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.
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
id: 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
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
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
template: TransferAgreementConsentTemplateInput!
The template of the consent
Input Fields
cardDigitalWalletTokenId: ID!
The ID of the card digital wallet token to reactivate.
reason: UnsuspendCardDigitalWalletTokenReason!
The reason for the card digital wallet token to be reactivated.
Input Fields
id: ID!
The FinancialAccount ID to be unsuspended.
memo: String!
The memo for unsuspending 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.
Input Fields
applicationId: ID!
Global ID of the AccountHolderCardProductApplication
offerUpdates: [UpdateApplicationOfferInput!]!
The list of updates to the AccountHolderCardProductApplicationOffers on the Application
Input Fields
spendRuleId: ID!
The Global ID of the Amount Limit Spend Rule to update.
name: String
The name for the rule for future reference.
maximumAmount: AmountInput!
The maximum amount to allow for a single authorization.
Input Fields
offerId: ID!
The ID of the offer to accept.
offerStatus: CardProductApplicationOfferStatus!
The requested status update to the offer.
Input Fields
spendRuleId: ID!
The Global ID of the CardDataInputCapabilitySpendRule to update.
name: String
A name for the rule for future reference.
allowed: [CardDataInputCapability!]
The CardDataInputCapability values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [CardDataInputCapability!]
The CardDataInputCapability values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
Global ID of the CardTransactionProcessingTypeConditionSpendRule to update.
name: String
The name of the CardTransactionProcessingTypeConditionSpendRule
allowed: [CardTransactionProcessingType!]
The list of possible CardTransactionProcessingType that will be allowed.
Min: 1
Max: 200
blocked: [CardTransactionProcessingType!]
The list of possible CardTransactionProcessingType that will result in a decline.
Min: 1
Max: 200
Input Fields
id: ID!
The ID of the object associated with the CustomFields.
C
customFields: [CustomFieldInput!]
The input to specify CustomFields key value pairs.
Input Fields
spendRuleId: ID!
The Global ID of the CVV Spend Rule to update.
name: String
The name for the rule for future reference.
allowed: [CVVResponseCode!]
The CVVResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [CVVResponseCode!]
The CVVResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
Global ID of the DepositAmountLimitSpendRule to update.
name: String
A name for the rule for future reference.
maximumAmount: AmountInput!
The maximum amount to allow for a single deposit.
Input Fields
spendRuleId: ID!
Global ID of the DepositCountLimitSpendRule to update.
name: String
A name for the rule for future reference.
maximumCount: UnsignedInt!
The maximum count of deposits.
Input Fields
spendRuleId: ID!
The Global ID of the DepositProcessingNetworkSpendRule to update.
name: String!
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: 200
blocked: [DepositProcessingNetwork!]
The list of possible DepositProcessingNetwork that will result in declined cash deposits.
Min: 1
Max: 200
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.
Input Fields
spendRuleId: ID!
The Global ID of the MaximumAmountVarianceOnPseudoBalanceSpendRule to update.
name: String
The name for the rule for future reference.
amountVariance: AmountInput!
The Amount over the account's original balance that is permitted for additional spending.
Input Fields
spendRuleId: ID!
The Global ID of the Merchant Category Spend Rule to update.
name: String
The name for the rule for future reference.
allowed: [MerchantCategory!]
The merchant categories that will be allowed during authorizations.
Min: 1 Max: 200
blocked: [MerchantCategory!]
The merchant categories that will result in declined authorizations.
Min: 1 Max: 200
allowedMcc: [String!]
The merchant category codes that will be allowed during authorizations.
Min: 1 Max: 200
blockedMcc: [String!]
The merchant category codes that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
The Global ID of the Merchant Country Spend Rule to update.
name: String
The name for the rule for future reference.
allowed: [ISO3166Alpha3Country!]
The merchant countries that will be allowed during authorizations.
Min: 1 Max: 200
blocked: [ISO3166Alpha3Country!]
The merchant countries that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
The Global ID of the MinimumAmountLimitSpendRule to update.
name: String
The name for the rule for future reference.
minimumAmount: AmountInput!
The exact amount to allow for a single authorization.
Input Fields
spendRuleId: ID!
The Global ID of the PanEntryModeSpendRule to update.
name: String
A name for the rule for future reference.
allowed: [PanEntryMode!]
The PanEntryMode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PanEntryMode!]
The PanEntryMode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
The Global ID of the Merchant Category Spend Rule to update.
name: String
A name for the rule for future reference.
allowed: [PointOfServiceCategoryCondition!]
The PointOfServiceCondition values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PointOfServiceCategoryCondition!]
The PointOfServiceCondition values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
spendRuleId: ID!
The Global ID of the Postal Code Verification Spend Rule to update.
name: String
A name for the rule for future reference.
allowed: [PostalCodeResponseCode!]
The PostalCodeResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [PostalCodeResponseCode!]
The PostalCodeResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
Input Fields
attachmentId: ID!
Global ID used to reference the RewardRedemptionConfigurationAttachment.
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.
Input Fields
attachmentId: ID!
Global ID used to reference the RewardRuleAttachment.
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.
Input Fields
spendRuleId: ID!
The Global ID of the StreetAddressSpendRule to update.
name: String
The name for the rule for future reference.
allowed: [AVSResponseCode!]
The AVSResponseCode values you want to allow during authorizations.
Min: 1 Max: 200
blocked: [AVSResponseCode!]
The AVSResponseCode values that will result in declined authorizations.
Min: 1 Max: 200
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
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
Input Fields
billingAddress: AddressInput!
The account holder's U.S. billing address.
accountHolderId: ID!
The identifier of an account holder
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
Input Fields
businessCreditRiskAttributes: BusinessCreditRiskAttributesInput!
The credit risk attributes of a business. Only used for unsecured credit applications.
accountHolderId: ID!
The identifier of an account holder
Input Fields
phoneNumber: PhoneInput!
The account holder's phone.
accountHolderId: ID!
The identifier of an account holder
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.
Input Fields
billingAddress: AddressInput!
The account holder's U.S. billing address.
accountHolderId: ID!
The global ID of an Account holder
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
Input Fields
personCreditRiskAttributes: PersonCreditRiskAttributesInput!
The USPersonAccountHolder's credit risk attributes. Only used for unsecured credit applications.
accountHolderId: ID!
The identifier of an account holder
Input Fields
phoneNumber: PhoneInput!
The account holder's phone.
accountHolderId: ID!
The global ID of an Account holder
Input Fields
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.
Note: The update to the payment card may not be reflected immediately.
Default Value: false
authorizedUserId: ID!
The Id of an authorized user.
accountHolderId: ID!
The identifier of the business account holder that the authorized user falls under
Input Fields
phoneNumber: PhoneInput!
The authorized user's phone.
authorizedUserId: ID!
The Id of an authorized user.
accountHolderId: ID!
The identifier of the business account holder that the authorized user falls under
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.).
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.).
Input Fields
name: USAssociatedPersonNameInput!
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.
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.
Input Fields
name: USAssociatedPersonNameUpdateInput
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.
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}$.
Input Fields
name: BusinessAccountHolderNameInput!
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.
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.
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.
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
Input Fields
name: BusinessAccountHolderNameUpdateInput
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
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.
Note: Only fields provided as part of the input will be updated. Fields not provided will remain unchanged.
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})$.
Input Fields
name: PersonAccountHolderNameInput!
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.
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][_][=][,][-][.][^;]])+$.
Input Fields
name: PersonAuthorizedUserNameInput!
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.
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][_][=][,][-][.][^;]])+$.
Input Fields
name: USAssociatedPersonNameInput!
The ultimate beneficial owner's legal name.
homeAddress: AddressInput!
The ultimate beneficial owner's U.S. physical address.
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%
Input Fields
name: USAssociatedPersonNameUpdateInput
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.
Input Fields
address: AddressInput!
Address to be validated.
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. Idempotency requests are cached for 24 hours.
Minimum length: 5 characters Maximum length: 255 characters
Input Fields
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.
Minimum length: 4 characters
Maximum length: 4 characters
Input Fields
accountHolderInitiatedApplication: Boolean!
Whether or not the AccountHolder initiated this application.
name: Boolean!
Whether or not the AccountHolder name on the application matches the applicant.
dateOfBirth: Boolean!
Whether or not the AccountHolder date of birth on the application matches the applicant.
address: Boolean!
Whether or not the AccountHolder mailing address on the application matches the applicant.
Input Fields
flow: VerifiedExternalBankAccountLinkExperienceFlow!
The type of link experience.
redirectUri: String
An optional redirect URI used in the success callback. If a value is provided, it must match the configured URI in the Highnote platform. If no value is provided, we will use the configuration that matches the specified flow.
Input Fields
paymentCard: PaymentCardInput!
The payment card to verify.
cardHolder: CardHolderInput
The cardHolder to associate the payment card with.
contractId: ID
Optional contract ID to use for this transaction.
If not provided, the default contract ID will be used.
idempotencyKey: IdempotencyKey
The idempotency key for this request.
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.
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
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 4 implied decimal places, thus a value of “1” is populated in this field as 10000.
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
Input Fields
clientWalletProvider: WalletProviderType!
The client wallet providers defined in 'WalletProviderType'
clientWalletAccountIdentifier: String!
Client-provided consumer ID that identifies the Wallet Account Holder entity.
clientDeviceIdentifier: String
Stable device identification set by Wallet Provider. Could be computer identifier or ID tied to hardware such as TEE_ID or SE_ID.
Input Fields
eventCreatedAt: NotificationTimestampFilterInput
Filter by the createdAt timestamp of the original notification event.
name: [NotificationEventName!]
Filter by the name of the original notification event.
hasSuccessfulDelivery: Boolean
Filter for the hasSuccessfulDelivery field on the WebhookNotificationTargetEvent object.
