Union

A Union type is an abstract type that enables a schema field to return one of multiple object types. Unlike interfaces, unions do not specify common fields between the types.

AccountHolder

The business account holder

Output:UNION

Possible Types

USBusinessAccountHolder: USBusinessAccountHolder

USPersonAccountHolder: USPersonAccountHolder

AccountHolderApplicationDocumentUploadSession

Return types for an account holder application document upload session

Output:UNION

Possible Types

USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession

AccountHolderCardProductApplicationOffersPayload

The response type for updating AccountHolderCardProductApplicationOffer on an AccountHolderCardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

AccountHolderProvisioningActionNode

Union type representing the different types of nodes involved in account holder provisioning actions.

This union can include various result types, such as account applications, financial accounts, payment cards, or workflow action outcomes.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

FinancialAccount: FinancialAccount

PaymentCard: PaymentCard

InterFinancialAccountTransfer: InterFinancialAccountTransfer

WorkflowActionResultOutcome: WorkflowActionResultOutcome

UserError: UserError

AccountHolderSnapshot

A snapshot of an account holder's data at time of application.

Output:UNION

Possible Types

USPersonAccountHolderSnapshot: USPersonAccountHolderSnapshot

USBusinessAccountHolderSnapshot: USBusinessAccountHolderSnapshot

AccountReviewConnectionPayload

The payload for listing AccountReviews for a FinancialAccount.

Output:UNION

Possible Types

AccountReviewConnection: AccountReviewConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

AchFromFinancialAccount

The financial account sending funds. This can be a Highnote FinancialAccount or a verified external financial account (ExternalFinancialBankAccount).

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

ExternalFinancialBankAccount: ExternalFinancialBankAccount

AchToFinancialAccount

The financial account receiving funds. This can be a Highnote FinancialAccount or a verified or non-verified external financial account (ExternalFinancialBankAccount or NonVerifiedExternalUSFinancialBankAccount).

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

ExternalFinancialBankAccount: ExternalFinancialBankAccount

NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount

ACHTransactionEdgeNode

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

ACHTransferStatusDetails

Details about the status of the ACH transfer.

Output:UNION

Possible Types

NonFailureACHTransferStatus: NonFailureACHTransferStatus

FailureACHTransferStatus: FailureACHTransferStatus

ActivateCardProductCreditPlanPayload

Types that can be returned for ActivateCardProductCreditPlan.

Output:UNION

Possible Types

CreditPlan: CreditPlan

UserError: UserError

AccessDeniedError: AccessDeniedError

ActivateCollaborativeAuthorizationEndpointPayload

The return types when activating a CollaborativeAuthorizationEndpoint.

Output:UNION

Possible Types

CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint

UserError: UserError

AccessDeniedError: AccessDeniedError

ActivateInstallmentAgreementForTransactionEventPayload

Types which can be returned when converting a Transaction into an InstallmentAgreement.

Output:UNION

Possible Types

InstallmentAgreement: InstallmentAgreement

UserError: UserError

AccessDeniedError: AccessDeniedError

ActivateNotificationTargetPayload

The return types when activating a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

ActivatePaymentCardPayload

The return types when activating a Payment Card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

AddCollaborativeAuthorizationEndpointPayload

The return types when adding a CollaborativeAuthorizationEndpoint.

Output:UNION

Possible Types

CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint

UserError: UserError

AccessDeniedError: AccessDeniedError

AddExternalBankAccountFromTokenPayload

The external financial account created while adding bank account for account holder.

Output:UNION

Possible Types

ExternalFinancialBankAccount: ExternalFinancialBankAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

AddFundsToPaymentCardPayload

The return types when adding funds to a payment card.

WARNING: Transfer is deprecated. ElectronicFundsTransfer should be used instead.

Output:UNION

Possible Types

Transfer: Transfer

UserError: UserError

AccessDeniedError: AccessDeniedError

AdditionalNetworkData

Additional network transaction data.

Output:UNION

Possible Types

VisaData: VisaData

MastercardData: MastercardData

AddNonVerifiedExternalUSFinancialBankAccountPayload

Response type for adding a non verified bank account. Will return the last four digits of the account and it's name

Output:UNION

Possible Types

NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

AddPaymentCardDigitalWalletTokenApplePayDevicePushProvisioningPayload

Output:UNION

Possible Types

PaymentCardDigitalWalletTokenApplePayDevicePushProvisioning: PaymentCardDigitalWalletTokenApplePayDevicePushProvisioning

UserError: UserError

AccessDeniedError: AccessDeniedError

AddPaymentCardDigitalWalletTokenGooglePayPushProvisioningPayload

Output:UNION

Possible Types

PaymentCardDigitalWalletTokenGooglePayPushProvisioning: PaymentCardDigitalWalletTokenGooglePayPushProvisioning

UserError: UserError

AccessDeniedError: AccessDeniedError

AddressValidationOutcome

Types which can be returned for validateAddress outcome.

Output:UNION

Possible Types

AddressValidatedResult: AddressValidatedResult

AddressValidatedWithChangesResult: AddressValidatedWithChangesResult

AddressIncompleteResult: AddressIncompleteResult

AddressInvalidResult: AddressInvalidResult

AddSubscriptionsToNotificationTargetPayload

The return types when adding subscriptions to a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

AddWebhookNotificationTargetPayload

The return types when adding webhook notification targets.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

AllFinancialAccount

An internal or external financial account.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

ExternalFinancialBankAccount: ExternalFinancialBankAccount

NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount

ApplicationDocument

Return types for an account holder application document

Output:UNION

Possible Types

AccountHolderApplicationDocument: AccountHolderApplicationDocument

ApproveCreditProductApplicationUnderwritingPayload

The response type for approving a credit-product AccountHolderCardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

AssignPaymentCardToFinancialAccountPayload

The return types for assignPaymentCardToFinancialAccount

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

AtmLocationsResult

The result of the ATM Locations.

Output:UNION

Possible Types

ATMLocations: ATMLocations

AccessDeniedError: AccessDeniedError

UserError: UserError

AttachCardProductVelocityRulePayload

The return types when attaching a VelocityRule to a CardProduct.

Output:UNION

Possible Types

VelocityRuleAssociation: VelocityRuleAssociation

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachFeeToCreditPlanPayload

Types which can be returned when attaching a FeeSchedule to a CreditPlan.

Output:UNION

Possible Types

CreditPlan: CreditPlan

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachPaymentCardVelocityRulePayload

The return types when attaching a VelocityRule to a PaymentCard.

Output:UNION

Possible Types

VelocityRuleAssociation: VelocityRuleAssociation

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachRewardEarnRuleToProductPayload

Types which can be returned for Attach Mcc reward earn rule.

Output:UNION

Possible Types

RewardRuleProductAttachment: RewardRuleProductAttachment

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachRewardRedemptionConfigurationToProductPayload

Types which can be returned for attaching RewardRedemptionConfiguration to CardProduct.

Output:UNION

Possible Types

RewardRedemptionConfigurationProductAttachment: RewardRedemptionConfigurationProductAttachment

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachSpendRuleToCardProductPayload

The return types when attaching a spend control rule to a card product.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachSpendRuleToFinancialAccountPayload

The return types when attaching a SpendRule to a FinancialAccount.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachSpendRuleToPaymentCardPayload

The return types when attaching a spend control rule to a payment card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

AttachVelocityRuleToFinancialAccountPayload

The return types when attaching a VelocityRule to a FinancialAccount.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

AuthorizedUserSnapshot

A snapshot of an authorized user's data at time of application.

Output:UNION

Possible Types

USPersonAuthorizedUserSnapshot: USPersonAuthorizedUserSnapshot

AuthorizePaymentCardPayload

Result of authorizing a payment card.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardAuthorizationStepSummary: CardAuthorizationStepSummary

AuthorizePaymentMethodTokenPayload

Result of authorizing a payment method token.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardAuthorizationStepSummary: CardAuthorizationStepSummary

BusinessPlanOperatingModelDetail

Details about the business plan operating model.

Output:UNION

Possible Types

BusinessPlanOperatingModelSeasonal: BusinessPlanOperatingModelSeasonal

BusinessPlanOperatingModelForwardCommitment: BusinessPlanOperatingModelForwardCommitment

BusinessPlanOperatingModelGoodsAndService: BusinessPlanOperatingModelGoodsAndService

CancelPaymentTransactionPayload

Result of canceling a payment transaction.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardReversalStepSummary: CardReversalStepSummary

CancelPhysicalPaymentCardPayload

Types which can be returned for canceling a physical payment card order

Output:UNION

Possible Types

PhysicalPaymentCardOrder: PhysicalPaymentCardOrder

UserError: UserError

AccessDeniedError: AccessDeniedError

CancelRequestedIdentityUpdatePayload

The response type when canceling a RequestedIdentityUpdate

Output:UNION

Possible Types

RequestedIdentityUpdate: RequestedIdentityUpdate

UserError: UserError

AccessDeniedError: AccessDeniedError

CancelScheduledTransferPayload

The return types when a scheduled transfer is canceled.

Output:UNION

Possible Types

RecurringACHTransfer: RecurringACHTransfer

OneTimeACHTransfer: OneTimeACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

CapturePaymentTransactionPayload

Result of capturing a payment transaction.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardCaptureStepSummary: CardCaptureStepSummary

CardProductApplication

The possible application types

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication

CardProfileSetConnectionPayload

The payload for querying card profile sets

Output:UNION

Possible Types

CardProfileSetConnection: CardProfileSetConnection

AccessDeniedError: AccessDeniedError

UserError: UserError

ChargePaymentCardPayload

Result of charging a payment card.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardCaptureStepSummary: CardCaptureStepSummary

ChargePaymentMethodTokenPayload

Result of charging a payment method token.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardCaptureStepSummary: CardCaptureStepSummary

ChargePaymentOrderPayload

Result of charging an order.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardCapturePaymentOrderSummary: CardCapturePaymentOrderSummary

CloseExternalFinancialBankAccountPayload

The external financial bank account closed while removing bank account for account holder.

The bank account details like routing number, last four and account type will be returned as response to closeExternalFinancialBankAccount mutation.

Once the external financial bank account is closed, querying will not return bank account details.

Output:UNION

Possible Types

ExternalFinancialBankAccount: ExternalFinancialBankAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

ClosePaymentCardPayload

The return types when closing a Payment Card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

ConditionalInterFinancialAccountTransferRule

All possible conditional rules to be used with a VelocityInterFinancialAccountTransferRule

Output:UNION

Possible Types

TransferPurposeInterFinancialAccountTransferRule: TransferPurposeInterFinancialAccountTransferRule

ConfirmCreditReportUnfrozenPayload

The response type for confirming a credit freeze is lifted for a credit-product AccountHolderCardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

ConfirmPayrollDepositPayload

The return types when confirming a payroll deposit.

Output:UNION

Possible Types

PayrollTransfer: PayrollTransfer

CreditFunds: CreditFunds

SecureDeposit: SecureDeposit

NonOriginatedAchTransfer: NonOriginatedAchTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

ConfirmRequestedIdentityUpdatePayload

The response type when confirming a RequestedIdentityUpdate

Output:UNION

Possible Types

RequestedIdentityUpdate: RequestedIdentityUpdate

UserError: UserError

AccessDeniedError: AccessDeniedError

ConfirmVerificationOfCreditProductApplicationForFraudAlertPayload

The response type for verifying a credit-product AccountHolderCardProductApplication in the case of a fraud alert.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

ConsentingParty

Represents a consenting party

Output:UNION

Possible Types

USBusinessAuthorizedPerson: USBusinessAuthorizedPerson

USPersonAuthorizedUser: USPersonAuthorizedUser

USPersonAccountHolder: USPersonAccountHolder

CreateAccountHolderCardProductApplicationPayload

Response type for creating an Account Holder Card Product Application.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateAmountLimitSpendRulePayload

The return types when creating a new amount limit rule.

Output:UNION

Possible Types

AmountLimitSpendRule: AmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateAuthorizedUserCardProductApplicationPayload

Response type for creating an Authorized User Card Product Application.

Output:UNION

Possible Types

AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardDataInputCapabilitySpendRulePayload

The return types when creating a CardDataInputCapabilitySpendRule.

Output:UNION

Possible Types

CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardProductCreditPlanPayload

Types which can be returned when creating a CreditPlan for a CardProduct.

Output:UNION

Possible Types

CreditPlan: CreditPlan

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardProductInstallmentCreditPlanPayload

Types which can be returned when creating a CreditPlan with CreditBalanceType of INSTALLMENT for a CardProduct.

Output:UNION

Possible Types

CreditPlan: CreditPlan

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardProductPayload

Types which can be returned for Card Product operations.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardProductWithTemplatePayload

The return types for createCardProductWithTemplate

Output:UNION

Possible Types

CreateCardProductWithTemplate: CreateCardProductWithTemplate

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCardTransactionProcessingTypeConditionSpendRulePayload

The return types when creating a new CardTransactionProcessingTypeConditionSpendRule.

Output:UNION

Possible Types

CardTransactionProcessingTypeConditionSpendRule: CardTransactionProcessingTypeConditionSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCheckPaymentDocumentUploadSessionPayload

Output:UNION

Possible Types

CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateConditionalRuleSetSpendRulePayload

The return types when creating a new conditional rule set rule.

Output:UNION

Possible Types

ConditionalRuleSetSpendRule: ConditionalRuleSetSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCountLimitSpendRulePayload

The return types when creating a new count limit rule.

Output:UNION

Possible Types

CountLimitSpendRule: CountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateCreditCardProductConfigurationPayload

Types that can be returned when creating a CardProductCreditConfiguration.

Output:UNION

Possible Types

CreditCardProductConfiguration: CreditCardProductConfiguration

AccessDeniedError: AccessDeniedError

UserError: UserError

CreateCVVSpendRulePayload

The return types when creating a new CVV rule.

Output:UNION

Possible Types

CVVSpendRule: CVVSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateDepositAmountLimitSpendRulePayload

The return types when creating a new deposit amount limit rule.

Output:UNION

Possible Types

DepositAmountLimitSpendRule: DepositAmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateDepositCountLimitSpendRulePayload

The return types when creating a new deposit count limit rule.

Output:UNION

Possible Types

DepositCountLimitSpendRule: DepositCountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateDepositProcessingNetworkSpendRulePayload

The return types when creating a new cash deposit processing network rule.

Output:UNION

Possible Types

DepositProcessingNetworkSpendRule: DepositProcessingNetworkSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateDocumentUploadLinkPayload

Output:UNION

Possible Types

DocumentUploadLink: DocumentUploadLink

CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession

CardArtDocument: CardArtDocument

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload

The return types when creating a MaximumAmountVarianceOnPseudoBalanceSpendRule.

Output:UNION

Possible Types

MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload

The return types when creating a MaximumPercentVarianceOnPseudoBalanceSpendRule.

Output:UNION

Possible Types

MaximumPercentVarianceOnPseudoBalanceSpendRule: MaximumPercentVarianceOnPseudoBalanceSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMerchantCategorySpendRulePayload

The return types when creating a new category rule.

Output:UNION

Possible Types

MerchantCategorySpendRule: MerchantCategorySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMerchantCountrySpendRulePayload

The return types when creating a new country rule.

Output:UNION

Possible Types

MerchantCountrySpendRule: MerchantCountrySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMerchantIdentifierSpendRulePayload

The return types when creating a new merchant identifier rule.

Output:UNION

Possible Types

MerchantIdentifierSpendRule: MerchantIdentifierSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMinimalUSBusinessAccountHolderPayload

Response type for creating a minimal USBusinessAccountHolder.

Output:UNION

Possible Types

USBusinessAccountHolder: USBusinessAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateMinimumAmountLimitSpendRulePayload

The return types when creating a MinimumAmountLimitSpendRule.

Output:UNION

Possible Types

MinimumAmountLimitSpendRule: MinimumAmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateOneTimeACHTransferPayload

The return types when a one time transfer is created.

Output:UNION

Possible Types

OneTimeACHTransfer: OneTimeACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

CreatePanEntryModeSpendRulePayload

The return types when creating a PanEntryModeSpendRule.

Output:UNION

Possible Types

PanEntryModeSpendRule: PanEntryModeSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreatePaymentOrderPayload

Result of creating a new PaymentOrder.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

PaymentOrder: PaymentOrder

CreatePointOfServiceCategorySpendRulePayload

The return types when creating a point of service category rule.

Output:UNION

Possible Types

PointOfServiceCategorySpendRule: PointOfServiceCategorySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreatePostalCodeVerificationSpendRulePayload

The return types when creating a postal code verification rule.

Output:UNION

Possible Types

PostalCodeVerificationSpendRule: PostalCodeVerificationSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateRecurringACHTransferPayload

The return types when a recurring transfer is created.

Output:UNION

Possible Types

RecurringACHTransfer: RecurringACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateRewardDefaultEarnRulePayload

Types which can be returned for Create RewardDefaultEarnRule.

Output:UNION

Possible Types

RewardDefaultEarnRule: RewardDefaultEarnRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateRewardMerchantCategoryEarnRulePayload

Types which can be returned for Create RewardMerchantCategoryEarnRule.

Output:UNION

Possible Types

RewardMerchantCategoryEarnRule: RewardMerchantCategoryEarnRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateRewardRedemptionConfigurationPayload

Types which can be returned when creating a RewardRedemptionConfiguration.

Output:UNION

Possible Types

RewardRedemptionConfiguration: RewardRedemptionConfiguration

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateSecretAPIKeyPayload

The possible return types from createSecretAPIKey.

Output:UNION

Possible Types

APIKey: APIKey

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateStreetAddressSpendRulePayload

The return types when creating a new street address rule.

Output:UNION

Possible Types

StreetAddressSpendRule: StreetAddressSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSBusinessAccountHolderFromTokenPayload

Response type for onboarding a USBusinessAccountHolder from a token.

User error paths returned match paths for CreateUSBusinessAccountHolderInput.

Output:UNION

Possible Types

USBusinessAccountHolder: USBusinessAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSBusinessAccountHolderPayload

Response type for creating a USBusinessAccountHolder.

Output:UNION

Possible Types

USBusinessAccountHolder: USBusinessAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSPersonAccountHolderFromTokenPayload

Response type for onboarding a USPersonAccountHolder from a token.

User error paths returned match paths for CreateUSPersonAccountHolderInput.

Output:UNION

Possible Types

USPersonAccountHolder: USPersonAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSPersonAccountHolderPayload

Response type for onboarding a USPersonAccountHolder.

Output:UNION

Possible Types

USPersonAccountHolder: USPersonAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSPersonAuthorizedUserFromTokenPayload

Response type for onboarding a USPersonAuthorizedUser from a token.

User error paths returned match paths for CreateUSPersonAuthorizedUserInput.

Output:UNION

Possible Types

USPersonAuthorizedUser: USPersonAuthorizedUser

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateUSPersonAuthorizedUserPayload

Response type for onboarding a USPersonAuthorizedUser.

Output:UNION

Possible Types

USPersonAuthorizedUser: USPersonAuthorizedUser

UserError: UserError

AccessDeniedError: AccessDeniedError

CreateVelocityRulePayload

The return types when creating a new VelocityRule.

Output:UNION

Possible Types

VelocityRule: VelocityRule

UserError: UserError

AccessDeniedError: AccessDeniedError

CreditLimitChangeRequestPayload

Types that can be returned for CreditLimitChangeRequest.

Output:UNION

Possible Types

CreditLimitChangeRequest: CreditLimitChangeRequest

UserError: UserError

AccessDeniedError: AccessDeniedError

CumulativeInterFinancialAccountTransferRule

All possible cumulative rules to be used with a VelocityInterFinancialAccountTransferRule

Output:UNION

Possible Types

AmountLimitInterFinancialAccountTransferRule: AmountLimitInterFinancialAccountTransferRule

CountLimitInterFinancialAccountTransferRule: CountLimitInterFinancialAccountTransferRule

CustomFieldsPayload

The return types for CustomFields.

Output:UNION

Possible Types

CustomFieldsResult: CustomFieldsResult

UserError: UserError

AccessDeniedError: AccessDeniedError

DeactivateCollaborativeAuthorizationEndpointPayload

The return types when deactivating a CollaborativeAuthorizationEndpoint.

Output:UNION

Possible Types

CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint

UserError: UserError

AccessDeniedError: AccessDeniedError

DeactivateNotificationTargetPayload

The return types when deactivating a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

DeleteSpendRulePayload

The return types when deleting an existing spend rule.

Output:UNION

Possible Types

SpendRuleContainer: SpendRuleContainer

UserError: UserError

AccessDeniedError: AccessDeniedError

DeleteVelocityRulePayload

The return types when deleting an existing velocity rule.

Output:UNION

Possible Types

VelocityRuleContainer: VelocityRuleContainer

UserError: UserError

AccessDeniedError: AccessDeniedError

DenyCreditProductApplicationUnderwritingPayload

The response type for denying a credit-product AccountHolderCardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachCardProductVelocityRulePayload

The return types when detaching a VelocityRule from a CardProduct.

Output:UNION

Possible Types

VelocityRuleAssociation: VelocityRuleAssociation

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachPaymentCardVelocityRulePayload

The return types when detaching a VelocityRule from a PaymentCard.

Output:UNION

Possible Types

VelocityRuleAssociation: VelocityRuleAssociation

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachSpendRuleFromCardProductPayload

The return types when detaching a spend rule from a card product.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachSpendRuleFromFinancialAccountPayload

The return types when detaching a SpendRule from a FinancialAccount.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachSpendRuleFromPaymentCardPayload

The return types when detaching a spend control rule from a payment card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

DetachVelocityRuleFromFinancialAccountPayload

The return types when detaching a VelocityRule from a FinancialAccount.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

DirectDepositDetailRestrictedDetailsResult

Output:UNION

Possible Types

DirectDepositDetailRestrictedDetails: DirectDepositDetailRestrictedDetails

AccessDeniedError: AccessDeniedError

DisableAuthorizedUserFeaturePayload

The return types when calling disableAuthorizedUserFeature on a CardProduct.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

DocumentUploadSessionContext

A union representing a DocumentUploadSessionContext

Output:UNION

Possible Types

AccountHolderApplicationDocumentUploadSessionContext: AccountHolderApplicationDocumentUploadSessionContext

EnableAuthorizedUserFeaturePayload

The return types when calling enableAuthorizedUserFeature on a CardProduct.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

EnableCollaborativeApplicationUnderwritingFeaturePayload

The return types when calling enableCollaborativeApplicationUnderwritingFeature on a CardProduct.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

EnableCollaborativeAuthorizationFeaturePayload

The return types when enabling the Collaborative Authorization product feature.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

EnableCreditCardFeaturePayload

The return types when calling enableCreditCardFeature on a CardProduct.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

EnableOnDemandFundingFeaturePayload

The return types when calling enableOnDemandFundingFeature on a CardProduct.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

EndDocumentUploadSessionPayload

Output:UNION

Possible Types

USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession

CardProfileDocumentUploadSession: CardProfileDocumentUploadSession

IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession

CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession

UserError: UserError

AccessDeniedError: AccessDeniedError

ExternalFinancialAccount

The external financial account created for any external financial instrument of account holder.

Output:UNION

Possible Types

ExternalFinancialBankAccount: ExternalFinancialBankAccount

NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount

ExternallyInitiatedACHStatusDetails

Details about the status of the ACH transfer.

Output:UNION

Possible Types

NonFailureExternallyInitiatedACHStatus: NonFailureExternallyInitiatedACHStatus

FailureExternallyInitiatedACHStatus: FailureExternallyInitiatedACHStatus

ExternallyInitiatedACHTransferEdgeNode

Output:UNION

Possible Types

PayrollTransfer: PayrollTransfer

DebitFunds: DebitFunds

CreditFunds: CreditFunds

SecureDeposit: SecureDeposit

ExternallyInitiatedACHTransferPayload

The return types when initiating a new simulated ExternallyInitiatedACHTransfer.

Output:UNION

Possible Types

PayrollTransfer: PayrollTransfer

CreditFunds: CreditFunds

DebitFunds: DebitFunds

SecureDeposit: SecureDeposit

UserError: UserError

AccessDeniedError: AccessDeniedError

FeeChargeActivity

Activity that is triggering the fee transfer event.

Output:UNION

Possible Types

PhysicalPaymentCardOrder: PhysicalPaymentCardOrder

PaymentCard: PaymentCard

FinancialAccount: FinancialAccount

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

AuthorizationAndClearEvent: AuthorizationAndClearEvent

ClearingEvent: ClearingEvent

BalanceInquiryEvent: BalanceInquiryEvent

FeeChargeRuleCondition

Fee charge rule condition.

Output:UNION

Possible Types

FeeChargeRuleAmountCondition: FeeChargeRuleAmountCondition

FeeChargeRuleCountCondition: FeeChargeRuleCountCondition

FeeChargeValue

Fee charge value.

Output:UNION

Possible Types

FixedFeeChargeValue: FixedFeeChargeValue

VariableFeeChargeValue: VariableFeeChargeValue

FeeScheduleAssociatedTo

Fee schedules associated to.

Output:UNION

Possible Types

CardProduct: CardProduct

FeeTransfer

Union of charged fee transfer and reversed fee transfer.

Output:UNION

Possible Types

ChargedFeeTransfer: ChargedFeeTransfer

ReversedFeeTransfer: ReversedFeeTransfer

FeeTransferStatusDetails

Details about the status of the fee transfer.

Output:UNION

Possible Types

NonFailureFeeTransferStatus: NonFailureFeeTransferStatus

FailureFeeTransferStatus: FailureFeeTransferStatus

FinancialAccountActivitySource

Output:UNION

Possible Types

DebitTransaction: DebitTransaction

CreditTransaction: CreditTransaction

PayrollTransfer: PayrollTransfer

CreditFunds: CreditFunds

DebitFunds: DebitFunds

SecureDeposit: SecureDeposit

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

FeeTransferEvent: FeeTransferEvent

InterFinancialAccountTransfer: InterFinancialAccountTransfer

FinancialAccountOwner

The possible owners of a FinancialAccount

Output:UNION

Possible Types

Organization: Organization

PaymentCard: PaymentCard

USPersonAccountHolder: USPersonAccountHolder

USBusinessAccountHolder: USBusinessAccountHolder

FinancialAccountPayload

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

FinancialAccountPseudoBalanceUpdatePayload

One of the possible return types for FinancialAccountPseudoBalanceUpdatePayload.

Output:UNION

Possible Types

FinancialAccountPseudoBalanceUpdate: FinancialAccountPseudoBalanceUpdate

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

FinancialEvent

The financial event that the LedgerEntry results from.

Output:UNION

Possible Types

AuthorizationEvent: AuthorizationEvent

ClearingEvent: ClearingEvent

ReversalEvent: ReversalEvent

Transfer: Transfer

AuthorizationAndClearEvent: AuthorizationAndClearEvent

RewardPointsTransfer: RewardPointsTransfer

CreditFundsACHTransferEvent: CreditFundsACHTransferEvent

DebitFundsACHTransferEvent: DebitFundsACHTransferEvent

FeeTransferEvent: FeeTransferEvent

PayrollACHTransferEvent: PayrollACHTransferEvent

SecureDepositTransferEvent: SecureDepositTransferEvent

SecureDepositACHTransferEvent: SecureDepositACHTransferEvent

SecureCardBalanceRepaymentACHTransferEvent: SecureCardBalanceRepaymentACHTransferEvent

IntegratorInitiatedFundsWithdrawalACHTransferEvent: IntegratorInitiatedFundsWithdrawalACHTransferEvent

IntegratorInitiatedFundsDepositACHTransferEvent: IntegratorInitiatedFundsDepositACHTransferEvent

FinancialAccountCreditLimitUpdateFromProductFunding: FinancialAccountCreditLimitUpdateFromProductFunding

InterFinancialAccountTransfer: InterFinancialAccountTransfer

ExternallyInitiatedAchReleaseHoldTransfer: ExternallyInitiatedAchReleaseHoldTransfer

PayrollAdvanceWriteoffTransfer: PayrollAdvanceWriteoffTransfer

PayrollAdvanceRepaymentTransfer: PayrollAdvanceRepaymentTransfer

IssuerPreliminaryAuthorizationEvent: IssuerPreliminaryAuthorizationEvent

FinancialAccountPseudoBalanceUpdate: FinancialAccountPseudoBalanceUpdate

ManualAdjustmentEvent: ManualAdjustmentEvent

CreditCardTransferEvent: CreditCardTransferEvent

DisbursementTransferEvent: DisbursementTransferEvent

WireTransfer: WireTransfer

ExternalMoneyMovementTransactionEvent: ExternalMoneyMovementTransactionEvent

CheckPaymentEvent: CheckPaymentEvent

GenerateBusinessAccountHolderClientTokenPayload

The possible return types of generateBusinessAccountHolderClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateCreateScheduledTransferClientTokenPayload

The possible return types of generateCreateScheduledTransferClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateDirectDepositDetailClientTokenPayload

The possible return types of generateDirectDepositDetailClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateDocumentUploadClientTokenPayload

The possible return types of generateDocumentUploadClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateExternalBankAccountDetailClientTokenPayload

The possible return types of generateDirectDepositDetailClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateFinancialAccountSingleUseClientTokenPayload

The possible return types of generateFinancialAccountSingleUseClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateInitiateSecureDepositClientTokenPayload

The possible return types of generateInitiateSecureDepositClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GeneratePaymentCardClientTokenPayload

The possible return types of generatePaymentCardClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GeneratePaymentMethodTokenizationClientTokenPayload

The possible return types of generatePaymentMethodTokenizationClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GeneratePersonAccountHolderClientTokenPayload

The possible return types of generatePersonAccountHolderClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GeneratePersonAuthorizedUserClientTokenPayload

The possible return types of generatePersonAuthorizedUserClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateRiskApplicationSDKSessionTokenPayload

The possible return types from generateRiskApplicationSDKSessionToken.

Output:UNION

Possible Types

RiskApplicationSDKSessionToken: RiskApplicationSDKSessionToken

AccessDeniedError: AccessDeniedError

UserError: UserError

GenerateSecureDepositClientTokenPayload

The possible return types of generateSecureDepositClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateTokenizeAccountHolderClientTokenPayload

The possible return types of generateTokenizeAccountHolderClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateTokenizeAuthorizedUserClientTokenPayload

The possible return types of generateTokenizeAuthorizedUserClientToken

Output:UNION

Possible Types

ClientToken: ClientToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GenerateVerifiedExternalBankAccountLinkTokenPayload

Output:UNION

Possible Types

GenerateVerifiedExternalBankAccountExternalLinkToken: GenerateVerifiedExternalBankAccountExternalLinkToken

UserError: UserError

AccessDeniedError: AccessDeniedError

GlobalNoteAggregateEntity

The potential types for a GlobalNote aggregate entity

Output:UNION

Possible Types

USPersonAccountHolder: USPersonAccountHolder

USBusinessAccountHolder: USBusinessAccountHolder

GlobalNoteConnectionPayload

Output:UNION

Possible Types

GlobalNoteConnection: GlobalNoteConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

GlobalNotePayload

The return types when creating a GlobalNote.

Output:UNION

Possible Types

GlobalNote: GlobalNote

UserError: UserError

AccessDeniedError: AccessDeniedError

GlobalNotePrimaryEntity

The potential types for a GlobalNote primary entity.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

AccountHolderCardProductApplication: AccountHolderCardProductApplication

InitiateAchTransferPayload

The return types when initiating an OriginatedAchTransfer.

Output:UNION

Possible Types

OriginatedAchTransfer: OriginatedAchTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateAddWiredFundsPayload

The return types when initiating add funds to a FinancialAccount via wire.

Output:UNION

Possible Types

ReviewWorkflowEvent: ReviewWorkflowEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateFinancialAccountCreditLimitUpdateFromProductFundingPayload

The return types of credit limit update to an account holder financial account.

Output:UNION

Possible Types

FinancialAccountCreditLimitUpdateFromProductFunding: FinancialAccountCreditLimitUpdateFromProductFunding

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateFundPaymentCardFinancialAccountTransferPayload

The return types when fund card to an account holder financial account.

Output:UNION

Possible Types

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateFundsDepositACHTransferPayload

The return types when the integrator initiates a withdrawal of funds from an ExternalFinancialAccount to a FinancialAccount.

Output:UNION

Possible Types

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateFundsWithdrawalACHTransferPayload

The return types when the integrator initiates a withdrawal of funds from a FinancialAccount to an ExternalFinancialAccount.

Output:UNION

Possible Types

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateOrganizationReportPayload

The return types when calling initiateOrganizationReport.

Output:UNION

Possible Types

Report: Report

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiatePayrollAdvancePayload

The return types when payroll advance funds to an employee financial account.

WARNING: Transfer is deprecated. ElectronicFundsTransfer should be used instead.

Output:UNION

Possible Types

Transfer: Transfer

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiatePhysicalCheckPaymentPayload

Output:UNION

Possible Types

CheckPayment: CheckPayment

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateSecureDepositACHTransferPayload

The return types when the integrator initiates an ACH transfer.

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateTransferBetweenFinancialAccountsPayload

The return types when transfer occurs between financial accounts.

Output:UNION

Possible Types

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPayload

The return types when financial account is used to fund a financial account backing a payment card.

Output:UNION

Possible Types

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPayload

The return types when financial account backing a payment card is used to fund a funding financial account.

Output:UNION

Possible Types

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateUSBusinessAuthorizedPersonRequestedIdentityUpdatePayload

The response type when applying an update for a USBusinessAuthorizedPersonRequestedIdentityUpdate

Output:UNION

Possible Types

RequestedIdentityUpdate: RequestedIdentityUpdate

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateUSBusinessProfileRequestedIdentityUpdatePayload

The response type when initiating an update for a USBusinessProfileRequestedIdentityUpdate

Output:UNION

Possible Types

RequestedIdentityUpdate: RequestedIdentityUpdate

UserError: UserError

AccessDeniedError: AccessDeniedError

InitiateUSBusinessUltimateBeneficialOwnerRequestedIdentityUpdatePayload

The response type when applying an update for a USBusinessUltimateBeneficialOwnerRequestedIdentityUpdate

Output:UNION

Possible Types

RequestedIdentityUpdate: RequestedIdentityUpdate

UserError: UserError

AccessDeniedError: AccessDeniedError

InstallmentEligibilityForTransactionEventsPayload

Types which can be returned when querying InstallmentEligibilityForTransactionEvents.

Output:UNION

Possible Types

InstallmentEligibilityForTransactionEvents: InstallmentEligibilityForTransactionEvents

UserError: UserError

AccessDeniedError: AccessDeniedError

InstallmentOffersForTransactionEventPayload

Types which can be returned when querying InstallmentOffersForTransaction.

Output:UNION

Possible Types

InstallmentOffersForTransactionEvent: InstallmentOffersForTransactionEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

IntegratorInitiatedACHStatusDetails

Details about the status of the ACH transfer.

Output:UNION

Possible Types

NonFailureIntegratorInitiatedACHStatus: NonFailureIntegratorInitiatedACHStatus

FailureIntegratorInitiatedACHStatus: FailureIntegratorInitiatedACHStatus

IntegratorInitiatedACHTransferEdgeNode

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

InterFinancialAccountTransferRuleConnectionPayload

The return types for finding inter financial account transfer rules.

Output:UNION

Possible Types

InterFinancialAccountTransferRuleConnection: InterFinancialAccountTransferRuleConnection

AccessDeniedError: AccessDeniedError

InviteUserPayload

The possible return types of inviteUser.

Output:UNION

Possible Types

User: User

UserError: UserError

AccessDeniedError: AccessDeniedError

IssueEmployerFinancialAccountForCardProductPayload

The return types when creating a new Financial Account against an Application.

Output:UNION

Possible Types

EmployerFinancialAccount: EmployerFinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

IssueFinancialAccountForApplicationPayload

The return types when creating a new Financial Account against an Application.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

IssueFinancialAccountForApplicationWithOnDemandFundingSourcePayload

The return types when creating a new Financial Account with an on-demand funding source.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

IssueFundingFinancialAccountForApplicationPayload

The return types when creating a new Funding Financial Account against an Application.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

IssuePaymentCardForApplicationPayload

The return types when creating a new Payment Card against an Application.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

IssuePaymentCardForApplicationWithOnDemandFundingSourcePayload

The return types when creating a new PaymentCard with an on-demand funding source.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

IssuePaymentCardForFinancialAccountPayload

The return types when creating a new Payment Card against a Financial Account.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

IssuePreprintedPaymentCardFinancialAccountForApplicationPayload

The return types for issuePreprintedPaymentCardFinancialAccountForApplication

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

ManualAdjustmentDetail

Output:UNION

Possible Types

CreditManualAdjustmentDetail: CreditManualAdjustmentDetail

DebitManualAdjustmentDetail: DebitManualAdjustmentDetail

NonOriginatedAchTransferPayload

Output:UNION

Possible Types

NonOriginatedAchTransferConnection: NonOriginatedAchTransferConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

NonVerifiedExternalUSFinancialBankAccountDetailRestrictedDetailsResult

Output:UNION

Possible Types

NonVerifiedExternalUSFinancialBankAccountRestrictedDetails: NonVerifiedExternalUSFinancialBankAccountRestrictedDetails

AccessDeniedError: AccessDeniedError

NotificationEventNode

The types providing more details about the Notification Event.

Output:UNION

Possible Types

AuthorizationEvent: AuthorizationEvent

AccountHolderCardProductApplication: AccountHolderCardProductApplication

AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication

NotificationTargetActivationEvent: NotificationTargetActivationEvent

NotificationPingTestEvent: NotificationPingTestEvent

NotificationEventValidationTestEvent: NotificationEventValidationTestEvent

SecureDepositInitiatedEvent: SecureDepositInitiatedEvent

SecureDepositProcessingEvent: SecureDepositProcessingEvent

SecureDepositProcessedEvent: SecureDepositProcessedEvent

SecureDepositFailedEvent: SecureDepositFailedEvent

SecureDepositReturnedEvent: SecureDepositReturnedEvent

SecureDepositCanceledEvent: SecureDepositCanceledEvent

FundsWithdrawalInitiatedEvent: FundsWithdrawalInitiatedEvent

FundsWithdrawalProcessingEvent: FundsWithdrawalProcessingEvent

FundsWithdrawalProcessedEvent: FundsWithdrawalProcessedEvent

FundsWithdrawalFailedEvent: FundsWithdrawalFailedEvent

FundsWithdrawalReturnedEvent: FundsWithdrawalReturnedEvent

FundsWithdrawalCanceledEvent: FundsWithdrawalCanceledEvent

FundsDepositInitiatedEvent: FundsDepositInitiatedEvent

FundsDepositProcessingEvent: FundsDepositProcessingEvent

FundsDepositProcessedEvent: FundsDepositProcessedEvent

FundsDepositFailedEvent: FundsDepositFailedEvent

FundsDepositReturnedEvent: FundsDepositReturnedEvent

FundsDepositCanceledEvent: FundsDepositCanceledEvent

RepaymentProcessedEvent: RepaymentProcessedEvent

RepaymentProcessingEvent: RepaymentProcessingEvent

RepaymentFailedEvent: RepaymentFailedEvent

RepaymentReturnedEvent: RepaymentReturnedEvent

AchExternallyInitatedDepositReceivedEvent: AchExternallyInitatedDepositReceivedEvent

AchExternallyInitatedDepositProcessedEvent: AchExternallyInitatedDepositProcessedEvent

AchExternallyInitatedDepositFailedEvent: AchExternallyInitatedDepositFailedEvent

AchExternallyInitiatedWithdrawalReceivedEvent: AchExternallyInitiatedWithdrawalReceivedEvent

AchExternallyInitiatedWithdrawalProcessedEvent: AchExternallyInitiatedWithdrawalProcessedEvent

AchExternallyInitiatedWithdrawalFailedEvent: AchExternallyInitiatedWithdrawalFailedEvent

PaymentCardAuthorizationApprovedEvent: PaymentCardAuthorizationApprovedEvent

PaymentCardAuthorizationCreatedEvent: PaymentCardAuthorizationCreatedEvent

PaymentCardAuthorizationDeclinedEvent: PaymentCardAuthorizationDeclinedEvent

PaymentCardAuthorizationReversedEvent: PaymentCardAuthorizationReversedEvent

PaymentCardAuthorizationAndClearApprovedEvent: PaymentCardAuthorizationAndClearApprovedEvent

PaymentCardAuthorizationAndClearDeclinedEvent: PaymentCardAuthorizationAndClearDeclinedEvent

PaymentCardClearedEvent: PaymentCardClearedEvent

PaymentCardEnhancedDataEvent: PaymentCardEnhancedDataEvent

PaymentCardVerificationApprovedEvent: PaymentCardVerificationApprovedEvent

PaymentCardVerificationDeclinedEvent: PaymentCardVerificationDeclinedEvent

PaymentCardActivatedEvent: PaymentCardActivatedEvent

PaymentCardSuspendedEvent: PaymentCardSuspendedEvent

PaymentCardUnsuspendedEvent: PaymentCardUnsuspendedEvent

PaymentCardClosedEvent: PaymentCardClosedEvent

PhysicalPaymentCardShippedEvent: PhysicalPaymentCardShippedEvent

PhysicalPaymentCardShipFailedEvent: PhysicalPaymentCardShipFailedEvent

FinancialAccountStatementReadyEvent: FinancialAccountStatementReadyEvent

InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountPendingEvent

InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountCompletedEvent

InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent: InternalTransferFromFundingFinancialAccountToPaymentCardFinancialAccountFailedEvent

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountPendingEvent

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountCompletedEvent

InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent: InternalTransferFromPaymentCardFinancialAccountToFundingFinancialAccountFailedEvent

PhysicalPaymentCardGroupOrderShippedEvent: PhysicalPaymentCardGroupOrderShippedEvent

PhysicalPaymentCardGroupOrderShipFailedEvent: PhysicalPaymentCardGroupOrderShipFailedEvent

PayrollAdvanceRepaymentCompletedEvent: PayrollAdvanceRepaymentCompletedEvent

PayrollAdvanceWriteOffCompletedEvent: PayrollAdvanceWriteOffCompletedEvent

AccountStatusActiveEvent: AccountStatusActiveEvent

AccountStatusSuspendedEvent: AccountStatusSuspendedEvent

AccountStatusUnderReviewEvent: AccountStatusUnderReviewEvent

AccountStatusPendingClosureEvent: AccountStatusPendingClosureEvent

AccountStatusClosedEvent: AccountStatusClosedEvent

FinancialAccount: FinancialAccount

ExternalBankAccountAddedEvent: ExternalBankAccountAddedEvent

ExternalBankAccountRemovedEvent: ExternalBankAccountRemovedEvent

CardDigitalWalletTokenActivatedEvent: CardDigitalWalletTokenActivatedEvent

CardDigitalWalletTokenSuspendedEvent: CardDigitalWalletTokenSuspendedEvent

CardDigitalWalletTokenTerminatedEvent: CardDigitalWalletTokenTerminatedEvent

AchHoldAddedEvent: AchHoldAddedEvent

AchHoldRemovedEvent: AchHoldRemovedEvent

Report: Report

InterFinancialAccountTransfer: InterFinancialAccountTransfer

PaymentCardTransactionDispute: PaymentCardTransactionDispute

PaymentCardTransactionChargeback: PaymentCardTransactionChargeback

PersonAccountHolderIdentityUpdatedEvent: PersonAccountHolderIdentityUpdatedEvent

BusinessAccountHolderIdentityUpdatedEvent: BusinessAccountHolderIdentityUpdatedEvent

BusinessAuthorizedPersonIdentityUpdatedEvent: BusinessAuthorizedPersonIdentityUpdatedEvent

BusinessUltimateBeneficialOwnerIdentityUpdatedEvent: BusinessUltimateBeneficialOwnerIdentityUpdatedEvent

PersonAccountHolderIdentityDocumentsRequestedEvent: PersonAccountHolderIdentityDocumentsRequestedEvent

BusinessAccountHolderIdentityDocumentsRequestedEvent: BusinessAccountHolderIdentityDocumentsRequestedEvent

BusinessAuthorizedPersonIdentityDocumentsRequestedEvent: BusinessAuthorizedPersonIdentityDocumentsRequestedEvent

BusinessUltimateBeneficialOwnerIdentityDocumentsRequestedEvent: BusinessUltimateBeneficialOwnerIdentityDocumentsRequestedEvent

OriginatedAchTransferInitiatedEvent: OriginatedAchTransferInitiatedEvent

OriginatedAchTransferPendingEvent: OriginatedAchTransferPendingEvent

OriginatedAchTransferProcessingEvent: OriginatedAchTransferProcessingEvent

OriginatedAchTransferProcessedEvent: OriginatedAchTransferProcessedEvent

OriginatedAchTransferCanceledEvent: OriginatedAchTransferCanceledEvent

OriginatedAchTransferFailedEvent: OriginatedAchTransferFailedEvent

OriginatedAchTransferReturnedEvent: OriginatedAchTransferReturnedEvent

NonOriginatedAchTransferReceivedEvent: NonOriginatedAchTransferReceivedEvent

NonOriginatedAchTransferProcessedEvent: NonOriginatedAchTransferProcessedEvent

NonOriginatedAchTransferFailedEvent: NonOriginatedAchTransferFailedEvent

NonOriginatedAchTransferReturnedEvent: NonOriginatedAchTransferReturnedEvent

CreditLimitChangeRequestStatusChangedEvent: CreditLimitChangeRequestStatusChangedEvent

AchTransferHoldAddedEvent: AchTransferHoldAddedEvent

AchTransferHoldRemovedEvent: AchTransferHoldRemovedEvent

LinkVerifiedExternalBankAccountFailedEvent: LinkVerifiedExternalBankAccountFailedEvent

CheckPaymentEvent: CheckPaymentEvent

UpcomingStatementDueDateEvent: UpcomingStatementDueDateEvent

NotificationTarget

The types of notification targets.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

OrderPhysicalPaymentCardPayload

Types which can be returned for ordering a payment card.

Output:UNION

Possible Types

PhysicalPaymentCardOrder: PhysicalPaymentCardOrder

UserError: UserError

AccessDeniedError: AccessDeniedError

OriginatedAchTransferPayload

Output:UNION

Possible Types

OriginatedAchTransferConnection: OriginatedAchTransferConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

PaymentCardHolder

The identity type of a payment card holder.

Output:UNION

Possible Types

USBusinessAuthorizedPerson: USBusinessAuthorizedPerson

USPersonAccountHolder: USPersonAccountHolder

USPersonAuthorizedUser: USPersonAuthorizedUser

PaymentCardRestrictedDetailsResult

Output:UNION

Possible Types

PaymentCardRestrictedDetails: PaymentCardRestrictedDetails

AccessDeniedError: AccessDeniedError

PaymentCardTransactionDisputeConnectionPayload

The possible return types of PaymentCardTransactionDisputeConnectionPayload.

Output:UNION

Possible Types

PaymentCardTransactionDisputeConnection: PaymentCardTransactionDisputeConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

PaymentCardTransactionDisputePayload

The possible return types of PaymentCardTransactionDisputePayload.

Output:UNION

Possible Types

PaymentCardTransactionDispute: PaymentCardTransactionDispute

UserError: UserError

AccessDeniedError: AccessDeniedError

PaymentInstructionDisbursementTarget

The Node types that PaymentInstruction can disburse funds to.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

PaymentInstrument

Used to represent the payment method data.

Output:UNION

Possible Types

PaymentCardInstrument: PaymentCardInstrument

PhysicalCardGroupOrderPayload

Types which can be returned for creating a group order.

Output:UNION

Possible Types

PhysicalCardGroupOrder: PhysicalCardGroupOrder

UserError: UserError

AccessDeniedError: AccessDeniedError

ProvisionAccountHolderPayload

Union type representing the possible payloads for provisioning an account holder.

This union includes the outcomes of provisioning actions, error messages, and access permissions.

Output:UNION

Possible Types

AccountHolderProvisioning: AccountHolderProvisioning

UserError: UserError

AccessDeniedError: AccessDeniedError

RefundPaymentTransactionPayload

Result of refunding a payment transaction.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

CardCreditStepSummary: CardCreditStepSummary

ReissuePaymentCardPayload

The return types when creating a new Payment Card based on an existing card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

RemoveCollaborativeAuthorizationEndpointPayload

The return types when removing a CollaborativeAuthorizationEndpoint.

Output:UNION

Possible Types

CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint

UserError: UserError

AccessDeniedError: AccessDeniedError

RemoveEmailFromNotificationTargetPayload

The return types when unsetting the email for a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

RemoveNotificationTargetPayload

The return types when delete a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

RemoveSubscriptionsFromNotificationTargetPayload

The return types when removing subscriptions from a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

RemoveUserPayload

The possible return types of removeUser.

Output:UNION

Possible Types

User: User

UserError: UserError

AccessDeniedError: AccessDeniedError

RenameCollaborativeAuthorizationEndpointPayload

The return types when renaming a CollaborativeAuthorizationEndpoint.

Output:UNION

Possible Types

CollaborativeAuthorizationEndpoint: CollaborativeAuthorizationEndpoint

UserError: UserError

AccessDeniedError: AccessDeniedError

RenameNotificationTargetPayload

The return types when updating the name of an existing notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

ReplayNotificationEventPayload

The return types when replaying a Notification Event.

Output:UNION

Possible Types

NotificationEvent: NotificationEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

RequestedIdentityUpdateParty

Identities that qualify for a requested update.

Output:UNION

Possible Types

USBusinessProfile: USBusinessProfile

USBusinessAuthorizedPerson: USBusinessAuthorizedPerson

USBusinessUltimateBeneficialOwner: USBusinessUltimateBeneficialOwner

USPersonAccountHolder: USPersonAccountHolder

USPersonAuthorizedUser: USPersonAuthorizedUser

RequestedIdentityUpdateSource

Sources that can refer a requested identity update.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication

ReviewWorkflowEventTransfer

Output:UNION

Possible Types

WireTransfer: WireTransfer

RevokeAPIKeyPayload

The possible return types of revokeAPIKey.

Output:UNION

Possible Types

APIKey: APIKey

UserError: UserError

AccessDeniedError: AccessDeniedError

RewardPointsTransferConnectionPayload

The return types for finding transfer rules

Output:UNION

Possible Types

RewardPointsTransferConnection: RewardPointsTransferConnection

UserError: UserError

AccessDeniedError: AccessDeniedError

RewardPointsTransferPayload

The return types for finding transfer rules

Output:UNION

Possible Types

RewardPointsTransfer: RewardPointsTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

RewardPointsTransferStatusDetails

Details about the status of the reward points transfer.

Output:UNION

Possible Types

RewardPointsTransferSuccessStatus: RewardPointsTransferSuccessStatus

RewardPointsTransferFailureStatus: RewardPointsTransferFailureStatus

RotateNotificationTargetSigningKeyPayload

The return types when removing subscriptions from an existing webhook notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

SearchCardProductApplicationEdge

The edge type for a CardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplicationEdge: AccountHolderCardProductApplicationEdge

AuthorizedUserCardProductApplicationEdge: AuthorizedUserCardProductApplicationEdge

SetEmailForNotificationTargetPayload

The return types when setting the email for a notification target.

Output:UNION

Possible Types

WebhookNotificationTarget: WebhookNotificationTarget

UserError: UserError

AccessDeniedError: AccessDeniedError

SetPinForPaymentCardPayload

Types which can be returned when setting the pin on a payment card

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateAchTransferProcessingPayload

The return types when simulating the processing of an OriginatedAchTransfer or NonOriginatedAchTransfer.

Output:UNION

Possible Types

OriginatedAchTransfer: OriginatedAchTransfer

NonOriginatedAchTransfer: NonOriginatedAchTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateAchTransferReturnPayload

The return types when simulating the return of an OriginatedAchTransfer or NonOriginatedAchTransfer.

Output:UNION

Possible Types

OriginatedAchTransfer: OriginatedAchTransfer

NonOriginatedAchTransfer: NonOriginatedAchTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateApplicationDocumentReviewPayload

Response type for a simulated update to an ApplicationDocument.

Output:UNION

Possible Types

AccountHolderApplicationDocument: AccountHolderApplicationDocument

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateApplicationManualReviewPayload

The possible return types of SimulateApplicationManualReviewPayload.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateApplicationUpdatePayload

Response type for a simulated update to an AccountHolderCardProductApplication.

Output:UNION

Possible Types

AccountHolderCardProductApplication: AccountHolderCardProductApplication

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateAuthAndClearPayload

Output:UNION

Possible Types

AuthorizationAndClearEvent: AuthorizationAndClearEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateAuthorizationAdvicePayload

Output:UNION

Possible Types

AuthorizationEvent: AuthorizationEvent

ReversalEvent: ReversalEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateAuthorizationPayload

Output:UNION

Possible Types

AuthorizationEvent: AuthorizationEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateCardDigitalWalletTokenPayload

Simulate card digital wallet token payload.

Output:UNION

Possible Types

CardDigitalWalletToken: CardDigitalWalletToken

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateClearingPayload

Output:UNION

Possible Types

ClearingEvent: ClearingEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateCloseFinancialAccountPayload

The return types for simulateCloseFinancialAccount

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateCreateAndActivateFeeSchedulePayload

Response type for simulate create fee schedule.

Output:UNION

Possible Types

FeeSchedule: FeeSchedule

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateDepositPayload

The return types when simulating electronic funds transfers into an Organization's account.

WARNING: Transfer is deprecated. ElectronicFundsTransfer should be used instead.

Output:UNION

Possible Types

Transfer: Transfer

WireTransfer: WireTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateEnhancedDataPayload

Output:UNION

Possible Types

EnhancedDataEvent: EnhancedDataEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateFinancialAccountAgingPayload

Types which can be returned for simulating account aging.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

AccessDeniedError: AccessDeniedError

UserError: UserError

SimulateFinancialAccountStatementPayload

Types which can be returned for simulating statement period shift and rollover

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateInitiateFinancialAccountClosurePayload

The return types for simulateInitiateFinancialAccountClosure

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateNonOriginatedAchTransferPayload

The return types when simulating receiving a NonOriginatedAchTransfer.

Output:UNION

Possible Types

NonOriginatedAchTransfer: NonOriginatedAchTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulatePaymentCardTransactionDisputePayload

The possible return types of SimulatePaymentCardTransactionDisputePayload.

Output:UNION

Possible Types

PaymentCardTransactionDispute: PaymentCardTransactionDispute

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulatePhysicalCardGroupOrderPayload

Types which can be returned for simulating physical card group orders

Output:UNION

Possible Types

PhysicalCardGroupOrder: PhysicalCardGroupOrder

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulatePhysicalPaymentCardPayload

Types which can be returned for simulating physical payment card orders

Output:UNION

Possible Types

PhysicalPaymentCardOrder: PhysicalPaymentCardOrder

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateProcessedIntegratorInitiatedStatusChangePayload

The return types when changing an IntegratorInitiatedACHTransfer from PROCESSING to PROCESSED.

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateProcessingIntegratorInitiatedStatusChangePayload

The return types when changing an IntegratorInitiatedACHTransfer from INITIATED to PROCESSING.

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateRefundPayload

Output:UNION

Possible Types

ClearingEvent: ClearingEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateReturnedIntegratorInitiatedStatusChangePayload

The return types when changing an IntegratorInitiatedACHTransfer from PROCESSING to RETURNED.

Output:UNION

Possible Types

SecureDepositACHTransfer: SecureDepositACHTransfer

SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer

IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer

IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateReversalPayload

Output:UNION

Possible Types

ReversalEvent: ReversalEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

SimulateVisaFleetL3EnhancedDataPayload

Output:UNION

Possible Types

EnhancedDataEvent: EnhancedDataEvent

UserError: UserError

AccessDeniedError: AccessDeniedError

StartDocumentUploadSessionPayload

The return types when a document upload session is started.

Output:UNION

Possible Types

USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession

CardProfileDocumentUploadSession: CardProfileDocumentUploadSession

IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession

CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession

UserError: UserError

AccessDeniedError: AccessDeniedError

SuspendCardDigitalWalletTokenPayload

The return types when suspending a card digital wallet token.

Output:UNION

Possible Types

CardDigitalWalletToken: CardDigitalWalletToken

UserError: UserError

AccessDeniedError: AccessDeniedError

SuspendPaymentCardPayload

The return types when suspending a Payment Card.

Output:UNION

Possible Types

PaymentCard: PaymentCard

UserError: UserError

AccessDeniedError: AccessDeniedError

TerminateCardDigitalWalletTokenPayload

The return types when terminating a card digital wallet token.

Output:UNION

Possible Types

CardDigitalWalletToken: CardDigitalWalletToken

UserError: UserError

AccessDeniedError: AccessDeniedError

TokenizeCardPaymentMethodPayload

Result of tokenizing a payment card.

Output:UNION

Possible Types

PaymentMethodToken: PaymentMethodToken

AccessDeniedError: AccessDeniedError

UserError: UserError

TokenizeUSBusinessAccountHolderPayload

Response type for tokenizing a USBusinessAccountHolder.

Output:UNION

Possible Types

USBusinessAccountHolderToken: USBusinessAccountHolderToken

UserError: UserError

AccessDeniedError: AccessDeniedError

TokenizeUSPersonAccountHolderPayload

Response type for tokenizing a USPersonAccountHolder.

Output:UNION

Possible Types

USPersonAccountHolderToken: USPersonAccountHolderToken

UserError: UserError

AccessDeniedError: AccessDeniedError

TokenizeUSPersonAuthorizedUserPayload

Response type for tokenizing a USPersonAuthorizedUser.

Output:UNION

Possible Types

USPersonAuthorizedUserToken: USPersonAuthorizedUserToken

AccessDeniedError: AccessDeniedError

Transaction

The possible types of transactions.

Output:UNION

Possible Types

CreditTransaction: CreditTransaction

DebitTransaction: DebitTransaction

TransferAmountStrategy

Output:UNION

Possible Types

TransferAmountCalculation: TransferAmountCalculation

ManualTransferAmount: ManualTransferAmount

TransferredEventNode

Output:UNION

Possible Types

InterFinancialAccountTransfer: InterFinancialAccountTransfer

UnderwriterDecision

The underwriting decision. Can be positive or adverse.

Output:UNION

Possible Types

UnderwriterPositiveDecision: UnderwriterPositiveDecision

UnderwriterAdverseDecision: UnderwriterAdverseDecision

UnsuspendCardDigitalWalletTokenPayload

The return types when unsuspending a card digital wallet token.

Output:UNION

Possible Types

CardDigitalWalletToken: CardDigitalWalletToken

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateAmountLimitSpendRulePayload

The return types when updating an existing amount limit rule.

Output:UNION

Possible Types

AmountLimitSpendRule: AmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateCardDataInputCapabilitySpendRulePayload

The return types when updating an existing CardDataInputCapabilitySpendRule.

Output:UNION

Possible Types

CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateCardProductNamePayload

The return types when updating a Card Product name.

Output:UNION

Possible Types

CardProduct: CardProduct

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateCardTransactionProcessingTypeConditionSpendRulePayload

The return types when updating an existing CardTransactionProcessingTypeConditionSpendRule.

Output:UNION

Possible Types

CardTransactionProcessingTypeConditionSpendRule: CardTransactionProcessingTypeConditionSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateConditionalRuleSetSpendRulePayload

The return types when updating a conditional rule set rule.

Output:UNION

Possible Types

ConditionalRuleSetSpendRule: ConditionalRuleSetSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateCountLimitSpendRulePayload

The return types when updating an existing count limit rule.

Output:UNION

Possible Types

CountLimitSpendRule: CountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateCVVSpendRulePayload

The return types when updating an existing CVV rule.

Output:UNION

Possible Types

CVVSpendRule: CVVSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateDepositAmountLimitSpendRulePayload

The return types when updating a deposit amount limit rule.

Output:UNION

Possible Types

DepositAmountLimitSpendRule: DepositAmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateDepositCountLimitSpendRulePayload

The return types when updating a deposit count limit rule.

Output:UNION

Possible Types

DepositCountLimitSpendRule: DepositCountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateDepositProcessingNetworkSpendRulePayload

The return types when updating a cash deposit processing network rule.

Output:UNION

Possible Types

DepositProcessingNetworkSpendRule: DepositProcessingNetworkSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateFinancialAccountBillingCycleConfigurationPayload

The return types when calling updateFinancialAccountBillingCycleConfiguration.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateFinancialAccountNamePayload

The return types when updating a Financial Account name.

Output:UNION

Possible Types

FinancialAccount: FinancialAccount

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload

The return types when updating an existing MaximumAmountVarianceOnPseudoBalanceSpendRule.

Output:UNION

Possible Types

MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMaximumPercentVarianceOnPseudoBalanceSpendRulePayload

The return types when updating an existing MaximumPercentVarianceOnPseudoBalanceSpendRule.

Output:UNION

Possible Types

MaximumPercentVarianceOnPseudoBalanceSpendRule: MaximumPercentVarianceOnPseudoBalanceSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMerchantCategorySpendRulePayload

The return types when updating an existing category rule.

Output:UNION

Possible Types

MerchantCategorySpendRule: MerchantCategorySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMerchantCountrySpendRulePayload

The return types when updating an existing country rule.

Output:UNION

Possible Types

MerchantCountrySpendRule: MerchantCountrySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMerchantIdentifierSpendRulePayload

The return types when updating an existing merchant identifier rule.

Output:UNION

Possible Types

MerchantIdentifierSpendRule: MerchantIdentifierSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateMinimumAmountLimitSpendRulePayload

The return types when updating an existing MinimumAmountLimitSpendRule.

Output:UNION

Possible Types

MinimumAmountLimitSpendRule: MinimumAmountLimitSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateOrganizationProfileDisplayNamePayload

Output:UNION

Possible Types

Organization: Organization

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdatePanEntryModeSpendRulePayload

The return types when updating an existing PanEntryModeSpendRule.

Output:UNION

Possible Types

PanEntryModeSpendRule: PanEntryModeSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdatePointOfServiceCategorySpendRulePayload

The return types when updating an existing a point of service category rule.

Output:UNION

Possible Types

PointOfServiceCategorySpendRule: PointOfServiceCategorySpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdatePostalCodeVerificationSpendRulePayload

The return types when updating an existing postal code verification rule.

Output:UNION

Possible Types

PostalCodeVerificationSpendRule: PostalCodeVerificationSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateRewardRedemptionConfigurationAttachmentPayload

Types which can be returned for updating a RewardRedemptionConfigurationAttachment's effective through date'

Output:UNION

Possible Types

RewardRedemptionConfigurationProductAttachment: RewardRedemptionConfigurationProductAttachment

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateRewardRuleAttachmentPayload

Types which can be returned for UpdateRewardRuleAttachment

Output:UNION

Possible Types

RewardRuleProductAttachment: RewardRuleProductAttachment

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateStreetAddressSpendRulePayload

The return types when updating an existing street address rule.

Output:UNION

Possible Types

StreetAddressSpendRule: StreetAddressSpendRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateUSAssociatedPersonAccountHolderPayload

Response type for update of a USAssociatedPersonAccountHolder containing the updates or errors.

Output:UNION

Possible Types

USBusinessAuthorizedPerson: USBusinessAuthorizedPerson

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateUSBusinessAccountHolderPayload

Response type for updating a USBusinessAccountHolder containing the updates or errors.

Output:UNION

Possible Types

USBusinessAccountHolder: USBusinessAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateUserPayload

The possible return types of updateUser.

Output:UNION

Possible Types

User: User

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateUSPersonAccountHolderPayload

Response type for updating a USPersonAccountHolder containing the updates or errors.

Output:UNION

Possible Types

USPersonAccountHolder: USPersonAccountHolder

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateUSPersonAuthorizedUserPayload

Response type for update of a USPersonAuthorizedUser.

Output:UNION

Possible Types

USPersonAuthorizedUser: USPersonAuthorizedUser

UserError: UserError

AccessDeniedError: AccessDeniedError

UpdateVelocityRulePayload

The return types when updating an existing VelocityRule.

Output:UNION

Possible Types

VelocityRule: VelocityRule

UserError: UserError

AccessDeniedError: AccessDeniedError

UploadRequirementConstraint

Output:UNION

Possible Types

DocumentUploadRequirementConstraint: DocumentUploadRequirementConstraint

ValidateAddressPayload

Types which can be returned for validateAddress.

Output:UNION

Possible Types

AddressValidationResult: AddressValidationResult

UserError: UserError

AccessDeniedError: AccessDeniedError

VelocityInterFinancialAccountTransferRuleBalance

The balance, tracking either amount or count.

Output:UNION

Possible Types

VelocityInterFinancialAccountTransferRuleAmountBalance: VelocityInterFinancialAccountTransferRuleAmountBalance

VelocityInterFinancialAccountTransferRuleCountBalance: VelocityInterFinancialAccountTransferRuleCountBalance

VelocityInterFinancialAccountTransferRuleBalanceConnectionPayload

The return type for finding inter financial account transfer rule balances

Output:UNION

Possible Types

VelocityInterFinancialAccountTransferRuleBalanceConnection: VelocityInterFinancialAccountTransferRuleBalanceConnection

VelocityInterFinancialAccountTransferRuleConnectionPayload

The return types for finding velocity inter financial account transfer rules

Output:UNION

Possible Types

VelocityInterFinancialAccountTransferRuleConnection: VelocityInterFinancialAccountTransferRuleConnection

AccessDeniedError: AccessDeniedError

VelocityRuleAssociatedType

The types that a VelocityRule could be associated to.

Output:UNION

Possible Types

PaymentCard: PaymentCard

CardProduct: CardProduct

VelocitySpendRuleBalance

The return types when getting a VelocityRule balance.

Output:UNION

Possible Types

VelocitySpendRuleAmountBalance: VelocitySpendRuleAmountBalance

VelocitySpendRuleCountBalance: VelocitySpendRuleCountBalance

VerifyPaymentCardPayload

Result of verifying a payment card.

Output:UNION

Possible Types

AccessDeniedError: AccessDeniedError

UserError: UserError

PaymentCardVerification: PaymentCardVerification

WireTransferReviewItem

Output:UNION

Possible Types

WireTransferReview: WireTransferReview

WireTransferStatusDetails

Details about the status of the wire transfer.

Output:UNION

Possible Types

NonFailureWireTransferStatus: NonFailureWireTransferStatus

FailureWireTransferStatus: FailureWireTransferStatus

WorkflowActionResult

Union type representing the possible results from a workflow action.

This union can be one of several result types, including email notification results or Visa Payable Automation results.

Output:UNION

Possible Types

WorkflowActionEmailNotificationResult: WorkflowActionEmailNotificationResult

WorkflowActionVisaPayableAutomationResult: WorkflowActionVisaPayableAutomationResult

WorkflowActionLinkVerifiedExternalBankAccountResult: WorkflowActionLinkVerifiedExternalBankAccountResult