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.
AcceptAndFinalizeCardPaymentDisputePayload
Result of accepting and finalizing a CardPaymentDispute.
Output:UNION
Possible Types
Possible Types
USBusinessAccountHolder: USBusinessAccountHolder
USPersonAccountHolder: USPersonAccountHolder
Organization: Organization
Business: Business
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
Possible Types
USPersonAccountHolderSnapshot: USPersonAccountHolderSnapshot
USBusinessAccountHolderSnapshot: USBusinessAccountHolderSnapshot
BusinessProductApplicantSnapshot: BusinessProductApplicantSnapshot
Possible Types
Possible Types
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 or non-verified external financial account (ExternalFinancialBankAccount
or NonVerifiedExternalUSFinancialBankAccount).
Output:UNION
Possible Types
FinancialAccount: FinancialAccount
ExternalFinancialBankAccount: ExternalFinancialBankAccount
NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount
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
Possible Types
NonFailureACHTransferStatus: NonFailureACHTransferStatus
FailureACHTransferStatus: FailureACHTransferStatus
ActivateCardProductCreditPlanPayload
Types that can be returned for ActivateCardProductCreditPlan.
Output:UNION
Possible Types
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
ActivateNotificationTargetPayload
The return types when activating a notification target.
Output:UNION
Possible Types
WebhookNotificationTarget: WebhookNotificationTarget
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
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
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
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
Possible Types
FinancialAccount: FinancialAccount
ExternalFinancialBankAccount: ExternalFinancialBankAccount
NonVerifiedExternalUSFinancialBankAccount: NonVerifiedExternalUSFinancialBankAccount
ApplicationContractConnectionPayload
The return types when querying a paginated list of ApplicationContract;
Output:UNION
Possible Types
ApplicationContractConnection: ApplicationContractConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
AccountHolderApplicationDocument: AccountHolderApplicationDocument
Possible Types
CardProduct: CardProduct
ApproveCreditProductApplicationUnderwritingPayload
The response type for approving a credit-product AccountHolderCardProductApplication.
Output:UNION
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
UserError: UserError
AccessDeniedError: AccessDeniedError
AssignFinancialBankAccountToBusinessPayload
The result of assignFinancialBankAccountToBusiness.
Returns the BusinessAccountConfiguration or error details.
Output:UNION
Possible Types
BusinessAccountConfiguration: BusinessAccountConfiguration
UserError: UserError
AccessDeniedError: AccessDeniedError
AssignPaymentCardToFinancialAccountPayload
The return types for assignPaymentCardToFinancialAccount
Output:UNION
Possible Types
Possible Types
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
AttachPaymentCardVelocityRulePayload
The return types when attaching a VelocityRule to a PaymentCard.
Output:UNION
Possible Types
VelocityRuleAssociation: VelocityRuleAssociation
UserError: UserError
AccessDeniedError: AccessDeniedError
AttachRealtimeRiskRuleToCardProductPayload
The return types when attaching a realtime risk rule to a card product.
Output:UNION
Possible Types
AttachRealtimeRiskRuleToFinancialAccountPayload
The return types when attaching a realtime risk rule to a financial account.
Output:UNION
Possible Types
AttachRealtimeRiskRuleToPaymentCardPayload
The return types when attaching a realtime risk rule to a payment card.
Output:UNION
Possible Types
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
AttachSpendRuleToFinancialAccountPayload
The return types when attaching a SpendRule to a FinancialAccount.
Output:UNION
Possible Types
AttachSpendRuleToPaymentCardPayload
The return types when attaching a spend control rule to a payment card.
Output:UNION
Possible Types
AttachVelocityRuleToFinancialAccountPayload
The return types when attaching a VelocityRule to a FinancialAccount.
Output:UNION
Possible Types
AuthorizedAccountHolderRelationship
Represents all possible types of authorized account holder relationships, whether a person or business.
Output:UNION
Possible Types
AuthorizedAccountHolderPersonRelationship: AuthorizedAccountHolderPersonRelationship
AuthorizedPersonRelationship
Represents the types of individuals that can be an authorized party.
Output:UNION
Possible Types
AuthorizedPersonUser: AuthorizedPersonUser
AuthorizedPersonAccountHolder: AuthorizedPersonAccountHolder
Possible Types
USPersonAuthorizedUserSnapshot: USPersonAuthorizedUserSnapshot
USPersonAccountHolderSnapshot: USPersonAccountHolderSnapshot
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationStepSummary: CardAuthorizationStepSummary
AuthorizePaymentCardForPosPayload
Result of authorizing a PaymentCard for point of service.
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationPosStepSummary: CardAuthorizationPosStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationStepSummary: CardAuthorizationStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationStepSummary: CardAuthorizationStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationStepSummary: CardAuthorizationStepSummary
BindCardAuthenticationContactAddressPayload
The return types when calling bindCardAuthenticationContactAddress.
Output:UNION
Possible Types
CardAuthenticationContact: CardAuthenticationContact
UserError: UserError
AccessDeniedError: AccessDeniedError
BindCardAuthenticationContactChannelPayload
The return types when calling bindCardAuthenticationContactChannel.
Output:UNION
Possible Types
CardAuthenticationContact: CardAuthenticationContact
UserError: UserError
AccessDeniedError: AccessDeniedError
BusinessAuthorizedPersonSnapshot
The snapshot details of the person authorized to act on behalf of business.
Output:UNION
Possible Types
USBusinessAuthorizedPersonSnapshot: USBusinessAuthorizedPersonSnapshot
BusinessConnectionPayload
The result of a businesses query, containing a list of Business entities or an error.
Output:UNION
Possible Types
Possible Types
NationalIdentificationDocument: NationalIdentificationDocument
Possible Types
BusinessPlanOperatingModelSeasonal: BusinessPlanOperatingModelSeasonal
BusinessPlanOperatingModelForwardCommitment: BusinessPlanOperatingModelForwardCommitment
BusinessPlanOperatingModelGoodsAndService: BusinessPlanOperatingModelGoodsAndService
Possible Types
BusinessCustomerRelationship: BusinessCustomerRelationship
BusinessPartnerRelationship: BusinessPartnerRelationship
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
Possible Types
RecurringACHTransfer: RecurringACHTransfer
OneTimeACHTransfer: OneTimeACHTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCaptureStepSummary: CardCaptureStepSummary
CardAuthenticationContactScope
What a contact is bound to. A contact scoped to a FinancialAccount applies to every
card issued against it; one scoped to a PaymentCard applies to that card alone.
Output:UNION
Possible Types
PaymentCard: PaymentCard
FinancialAccount: FinancialAccount
CardPaymentDisputeStageActionDetails
Action-specific details for a dispute stage action.
Output:UNION
Possible Types
CardPaymentDisputeStageDecisionActionDetails: CardPaymentDisputeStageDecisionActionDetails
CardPaymentDisputeStageFileUploadActionDetails: CardPaymentDisputeStageFileUploadActionDetails
CardPaymentDisputeStageQuestionnaireActionDetails: CardPaymentDisputeStageQuestionnaireActionDetails
CardPaymentDisputeStageEvidenceDetails
Output:UNION
Possible Types
CardPaymentDisputeStageFileEvidenceDetails: CardPaymentDisputeStageFileEvidenceDetails
CardPaymentDisputeStageGlobalNoteEvidenceDetails: CardPaymentDisputeStageGlobalNoteEvidenceDetails
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
Possible Types
CardProfileSetConnection: CardProfileSetConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCaptureStepSummary: CardCaptureStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCapturePosStepSummary: CardCapturePosStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCaptureStepSummary: CardCaptureStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCaptureStepSummary: CardCaptureStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCapturePaymentOrderSummary: CardCapturePaymentOrderSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCaptureStepSummary: CardCaptureStepSummary
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
Possible Types
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CloseTransactionBatch: CloseTransactionBatch
CompleteAcquiringThreeDSecureAuthenticationChallengePayload
The possible return types of completeAcquiringThreeDSecureAuthenticationChallenge.
Output:UNION
Possible Types
AcquiringThreeDSecureAuthenticationResult: AcquiringThreeDSecureAuthenticationResult
AccessDeniedError: AccessDeniedError
UserError: UserError
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
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
Possible Types
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
USPersonAuthorizedUser: USPersonAuthorizedUser
USPersonAccountHolder: USPersonAccountHolder
BusinessAuthorizedPerson: BusinessAuthorizedPerson
CreateAccountHolderCardProductApplicationPayload
Response type for creating an Account Holder Card Product Application.
Output:UNION
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
CreateAccountTransactionCountSpendRulePayload
The return types when creating a AccountTransactionCountSpendRule.
Output:UNION
Possible Types
AccountTransactionCountSpendRule: AccountTransactionCountSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateAmountLimitSpendRulePayload
The return types when creating a new amount limit rule.
Output:UNION
Possible Types
CreateAuthorizedUserCardProductApplicationPayload
Response type for creating an Authorized User Card Product Application.
Output:UNION
Possible Types
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
CreateCardDataInputCapabilitySpendRulePayload
The return types when creating a CardDataInputCapabilitySpendRule.
Output:UNION
Possible Types
CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateCardPaymentDisputeEvidenceUploadLinkPayload
Output:UNION
Possible Types
CardPaymentDisputeEvidenceUploadLink: CardPaymentDisputeEvidenceUploadLink
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateCardProductCreditPlanPayload
Types which can be returned when creating a CreditPlan for a CardProduct.
Output:UNION
Possible Types
CreateCardProductInstallmentCreditPlanPayload
Types which can be returned when creating a CreditPlan with CreditBalanceType of INSTALLMENT for a CardProduct.
Output:UNION
Possible Types
Possible Types
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
Possible Types
CreateCreditCardProductConfigurationPayload
Types that can be returned when creating a CardProductCreditConfiguration.
Output:UNION
Possible Types
CreditCardProductConfiguration: CreditCardProductConfiguration
AccessDeniedError: AccessDeniedError
UserError: UserError
CreateCreditLimitPercentageSpendRulePayload
The return types when creating a CreditLimitPercentageSpendRule.
Output:UNION
Possible Types
CreditLimitPercentageSpendRule: CreditLimitPercentageSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
CreateDaysWithinAccountCreateDateSpendRulePayload
The return types when creating a DaysWithinAccountCreateDateSpendRule.
Output:UNION
Possible Types
DaysWithinAccountCreateDateSpendRule: DaysWithinAccountCreateDateSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateDaysWithinCardCreateDateSpendRulePayload
The return types when creating a DaysWithinCardCreateDateSpendRule.
Output:UNION
Possible Types
DaysWithinCardCreateDateSpendRule: DaysWithinCardCreateDateSpendRule
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
CreateMastercardFraudScoreSpendRulePayload
The return types when creating a MastercardFraudScoreSpendRule.
Output:UNION
Possible Types
MastercardFraudScoreSpendRule: MastercardFraudScoreSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateMaximumAmountVarianceOnCreditLimitSpendRulePayload
The return types when creating a MaximumAmountVarianceOnCreditLimitSpendRule.
Output:UNION
Possible Types
MaximumAmountVarianceOnCreditLimitSpendRule: MaximumAmountVarianceOnCreditLimitSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload
The return types when creating a MaximumAmountVarianceOnPseudoBalanceSpendRule.
Output:UNION
Possible Types
MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateMaximumPercentVarianceOnCreditLimitSpendRulePayload
The return types when creating a MaximumPercentVarianceOnCreditLimitSpendRule.
Output:UNION
Possible Types
MaximumPercentVarianceOnCreditLimitSpendRule: MaximumPercentVarianceOnCreditLimitSpendRule
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
Possible Types
CreatePanEntryModeSpendRulePayload
The return types when creating a PanEntryModeSpendRule.
Output:UNION
Possible Types
PanEntryModeSpendRule: PanEntryModeSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
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
CreatePricingPlanPayload
The result of creating a PricingPlan.
Returns the newly created pricing plan or error details.
Output:UNION
Possible Types
CreateRecurringACHTransferPayload
The return types when a recurring transfer is created.
Output:UNION
Possible Types
CreateReusablePaymentMethodTokenPayload
Types which can be returned when saving payment method
Output:UNION
Possible Types
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
Possible Types
CreateStreetAddressSpendRulePayload
The return types when creating a new street address rule.
Output:UNION
Possible Types
StreetAddressSpendRule: StreetAddressSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateUnifiedFundsTransferQuotePayload
The possible results of createUnifiedFundsTransferQuote
Output:UNION
Possible Types
UserError: UserError
AccessDeniedError: AccessDeniedError
CreateUnifiedFundsTransferQuoteResult: CreateUnifiedFundsTransferQuoteResult
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
Possible Types
CreateVisaRiskScoreSpendRulePayload
The return types when creating a VisaRiskScoreSpendRule.
Output:UNION
Possible Types
VisaRiskScoreSpendRule: VisaRiskScoreSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
CreditCardInterestTransfer
The union type for CreditCardInterestTransfer, which supports accrual and reversal.
Output:UNION
Possible Types
CreditCardInterestAccrual: CreditCardInterestAccrual
CreditCardInterestReversal: CreditCardInterestReversal
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
Possible Types
Possible Types
USPersonAccountHolder: USPersonAccountHolder
USBusinessAccountHolder: USBusinessAccountHolder
USPersonAuthorizedUser: USPersonAuthorizedUser
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
Possible Types
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
Possible Types
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
DetachRealtimeRiskRuleFromCardProductPayload
The return types when detaching a realtime risk rule from a card product.
Output:UNION
Possible Types
DetachRealtimeRiskRuleFromFinancialAccountPayload
The return types when detaching a realtime risk rule from a financial account.
Output:UNION
Possible Types
DetachRealtimeRiskRuleFromPaymentCardPayload
The return types when detaching a realtime risk rule from a payment card.
Output:UNION
Possible Types
DetachSpendRuleFromCardProductPayload
The return types when detaching a spend rule from a card product.
Output:UNION
Possible Types
DetachSpendRuleFromFinancialAccountPayload
The return types when detaching a SpendRule from a FinancialAccount.
Output:UNION
Possible Types
DetachSpendRuleFromPaymentCardPayload
The return types when detaching a spend control rule from a payment card.
Output:UNION
Possible Types
DetachVelocityRuleFromFinancialAccountPayload
The return types when detaching a VelocityRule from a FinancialAccount.
Output:UNION
Possible Types
DirectDepositDetailRestrictedDetailsResult
Output:UNION
Possible Types
DirectDepositDetailRestrictedDetails: DirectDepositDetailRestrictedDetails
AccessDeniedError: AccessDeniedError
DisableAuthorizedUserFeaturePayload
The return types when calling disableAuthorizedUserFeature on a CardProduct.
Output:UNION
Possible Types
DisputeQuestionnaire
A dispute questionnaire for a single dispute stage; its concrete type depends on the
dispute's category. Fraud and authorization disputes carry no questionnaire
(document-only evidence), so a stage's questionnaire is null for those categories.
Output:UNION
Possible Types
ProcessingErrorQuestionnaire: ProcessingErrorQuestionnaire
ConsumerDisputeQuestionnaire: ConsumerDisputeQuestionnaire
DocumentCollectionAggregateEntity
Among authorized-person types only the non-US BusinessAuthorizedPerson is a member. The US
USBusinessAuthorizedPerson is intentionally excluded: a US authorized person is represented only
as a DocumentCollectionOwnerEntity, and its absence here is unchanged from before non-US support.
Output:UNION
Possible Types
USBusinessAccountHolder: USBusinessAccountHolder
USPersonAccountHolder: USPersonAccountHolder
FinancialAccount: FinancialAccount
Organization: Organization
CardProduct: CardProduct
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
BusinessAuthorizedPerson: BusinessAuthorizedPerson
DocumentCollectionOwnerEntity
Output:UNION
Possible Types
USBusinessAccountHolder: USBusinessAccountHolder
Organization: Organization
USPersonAccountHolder: USPersonAccountHolder
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
BusinessAuthorizedPerson: BusinessAuthorizedPerson
DocumentCollectionPrimaryEntity
Among authorized-person types only the non-US BusinessAuthorizedPerson is a member. The US
USBusinessAuthorizedPerson is intentionally excluded: a US authorized person is represented only
as a DocumentCollectionOwnerEntity, and its absence here is unchanged from before non-US support.
Output:UNION
Possible Types
FinancialAccount: FinancialAccount
Organization: Organization
CardProduct: CardProduct
AccountHolderCardProductApplication: AccountHolderCardProductApplication
USPersonAccountHolder: USPersonAccountHolder
USBusinessAccountHolder: USBusinessAccountHolder
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
ReviewWorkflowEvent: ReviewWorkflowEvent
BusinessAuthorizedPerson: BusinessAuthorizedPerson
Possible Types
DocumentUploadLinkDocumentDetails: DocumentUploadLinkDocumentDetails
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
AccountHolderApplicationDocumentUploadSessionContext: AccountHolderApplicationDocumentUploadSessionContext
EnableAuthorizedUserFeaturePayload
The return types when calling enableAuthorizedUserFeature on a CardProduct.
Output:UNION
Possible Types
EnableCollaborativeApplicationUnderwritingFeaturePayload
The return types when calling enableCollaborativeApplicationUnderwritingFeature on a CardProduct.
Output:UNION
Possible Types
EnableCollaborativeAuthorizationFeaturePayload
The return types when enabling the Collaborative Authorization product feature.
Output:UNION
Possible Types
EnableCreditCardFeaturePayload
The return types when calling enableCreditCardFeature on a CardProduct.
Output:UNION
Possible Types
EnableOnDemandFundingFeaturePayload
The return types when calling enableOnDemandFundingFeature on a CardProduct.
Output:UNION
Possible Types
EndDocumentUploadSessionPayload
Output:UNION
Possible Types
USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession
CardProfileDocumentUploadSession: CardProfileDocumentUploadSession
IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession
CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession
ManualDocumentRequestUploadSession: ManualDocumentRequestUploadSession
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
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
Possible Types
FinancialAccount: FinancialAccount
USBankAccount: USBankAccount
Possible Types
FinancialAccount: FinancialAccount
USBankAccount: USBankAccount
Possible Types
PhysicalPaymentCardOrder: PhysicalPaymentCardOrder
PaymentCard: PaymentCard
FinancialAccount: FinancialAccount
SecureDepositACHTransfer: SecureDepositACHTransfer
SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer
IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer
IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer
AuthorizationAndClearEvent: AuthorizationAndClearEvent
ClearingEvent: ClearingEvent
BalanceInquiryEvent: BalanceInquiryEvent
Possible Types
FeeChargeRuleAmountCondition: FeeChargeRuleAmountCondition
FeeChargeRuleCountCondition: FeeChargeRuleCountCondition
Possible Types
FixedFeeChargeValue: FixedFeeChargeValue
VariableFeeChargeValue: VariableFeeChargeValue
Possible Types
CardProduct: CardProduct
Possible Types
ChargedFeeTransfer: ChargedFeeTransfer
ReversedFeeTransfer: ReversedFeeTransfer
Possible Types
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
FinancialAccountBalanceSearchResultPayload
The possible return types of searchFinancialAccountBalances.
Output:UNION
Possible Types
FinancialAccountBalanceSearchResultConnection: FinancialAccountBalanceSearchResultConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
Business: Business
Organization: Organization
PaymentCard: PaymentCard
USPersonAccountHolder: USPersonAccountHolder
USBusinessAccountHolder: USBusinessAccountHolder
FinancialAccountPayload
Output:UNION
Possible Types
FinancialAccountPseudoBalanceUpdatePayload
One of the possible return types for FinancialAccountPseudoBalanceUpdatePayload.
Output:UNION
Possible Types
FinancialAccountPseudoBalanceUpdate: FinancialAccountPseudoBalanceUpdate
InterFinancialAccountTransfer: InterFinancialAccountTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
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
InstantNetworkTransferEvent: InstantNetworkTransferEvent
InstantSettlementTransactionEvent: InstantSettlementTransactionEvent
AdjustmentEvent: AdjustmentEvent
OriginatedRtpTransferEvent: OriginatedRtpTransferEvent
NonOriginatedRtpTransferEvent: NonOriginatedRtpTransferEvent
CryptoFundingFlowProcessedEvent: CryptoFundingFlowProcessedEvent
FlexibleCredentialInstantCreditActivationPayload
The return types for activateFlexibleCredentialInstantCredit and
flexibleCredentialInstantCreditActivation.
Output:UNION
Possible Types
FlexibleCredentialInstantCreditActivation: FlexibleCredentialInstantCreditActivation
UserError: UserError
AccessDeniedError: AccessDeniedError
GenerateAppleWebPushProvisioningTokenPayload
The possible return types from generateAppleWebPushProvisioningToken.
Output:UNION
Possible Types
AppleWebPushProvisioningToken: AppleWebPushProvisioningToken
UserError: UserError
AccessDeniedError: AccessDeniedError
GenerateBusinessAccountHolderClientTokenPayload
The possible return types of generateBusinessAccountHolderClientToken
Output:UNION
Possible Types
GenerateCreateScheduledTransferClientTokenPayload
The possible return types of generateCreateScheduledTransferClientToken
Output:UNION
Possible Types
GenerateDirectDepositDetailClientTokenPayload
The possible return types of generateDirectDepositDetailClientToken
Output:UNION
Possible Types
GenerateDocumentUploadClientTokenPayload
The possible return types of generateDocumentUploadClientToken
Output:UNION
Possible Types
GenerateExternalBankAccountDetailClientTokenPayload
The possible return types of generateDirectDepositDetailClientToken
Output:UNION
Possible Types
GenerateFinancialAccountSingleUseClientTokenPayload
The possible return types of generateFinancialAccountSingleUseClientToken
Output:UNION
Possible Types
GenerateInitiateSecureDepositClientTokenPayload
The possible return types of generateInitiateSecureDepositClientToken
Output:UNION
Possible Types
GeneratePaymentCardClientTokenPayload
The possible return types of generatePaymentCardClientToken
Output:UNION
Possible Types
GeneratePaymentMethodTokenizationClientTokenPayload
The possible return types of generatePaymentMethodTokenizationClientToken
Output:UNION
Possible Types
GeneratePersonAccountHolderClientTokenPayload
The possible return types of generatePersonAccountHolderClientToken
Output:UNION
Possible Types
GeneratePersonAuthorizedUserClientTokenPayload
The possible return types of generatePersonAuthorizedUserClientToken
Output:UNION
Possible Types
GenerateRiskApplicationSDKSessionTokenPayload
The possible return types from generateRiskApplicationSDKSessionToken.
Output:UNION
Possible Types
RiskApplicationSDKSessionToken: RiskApplicationSDKSessionToken
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
GenerateSecureDepositClientTokenPayload
The possible return types of generateSecureDepositClientToken
Output:UNION
Possible Types
GenerateTokenizeAccountHolderClientTokenPayload
The possible return types of generateTokenizeAccountHolderClientToken
Output:UNION
Possible Types
GenerateTokenizeAuthorizedUserClientTokenPayload
The possible return types of generateTokenizeAuthorizedUserClientToken
Output:UNION
Possible Types
GenerateVerifiedExternalBankAccountLinkTokenPayload
Output:UNION
Possible Types
GenerateVerifiedExternalBankAccountExternalLinkToken: GenerateVerifiedExternalBankAccountExternalLinkToken
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
USPersonAccountHolder: USPersonAccountHolder
USBusinessAccountHolder: USBusinessAccountHolder
GlobalNoteConnectionPayload
Output:UNION
Possible Types
Possible Types
Possible Types
FinancialAccount: FinancialAccount
AccountHolderCardProductApplication: AccountHolderCardProductApplication
IdentityVerificationSubject
The subject of an identity verification on a ProductApplicationWorkflow IDENTITY
step. Members are the live (non-snapshot) party entities so consumers always resolve
current data.
Note: USPersonAccountHolder, USPersonAuthorizedUser, and USBusinessAuthorizedPerson
are legacy, jurisdiction-prefixed types that remain in active use. Business and
BusinessAuthorizedPerson are the modern, non-jurisdictional shapes. Additional members
(e.g. a future generic Person type) can be added without a breaking change.
Output:UNION
Possible Types
Business: Business
BusinessAuthorizedPerson: BusinessAuthorizedPerson
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
USPersonAccountHolder: USPersonAccountHolder
USPersonAuthorizedUser: USPersonAuthorizedUser
IncrementalAuthorizePaymentTransactionPayload
Result of incrementally authorizing a PaymentTransaction.
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardAuthorizationStepSummary: CardAuthorizationStepSummary
Possible Types
OriginatedAchTransfer: OriginatedAchTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
InitiateAcquiringThreeDSecureAuthenticationPayload
The possible return types of initiateAcquiringThreeDSecureAuthentication.
Output:UNION
Possible Types
AcquiringThreeDSecureAuthenticationResult: AcquiringThreeDSecureAuthenticationResult
AcquiringThreeDSecureChallengeRequired: AcquiringThreeDSecureChallengeRequired
AccessDeniedError: AccessDeniedError
UserError: UserError
InitiateAcquiringThreeDSecureDataExchangePayload
The possible return types of initiateAcquiringThreeDSecureDataExchange.
Output:UNION
Possible Types
AcquiringThreeDSecureDataExchangeResult: AcquiringThreeDSecureDataExchangeResult
AccessDeniedError: AccessDeniedError
UserError: UserError
InitiateAddWiredFundsPayload
The return types when initiating add funds to a FinancialAccount via wire.
Output:UNION
Possible Types
InitiateCardPaymentDisputeEvidenceUploadPayload
Result of opening an evidence upload session.
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardPaymentDisputeEvidenceUploadSession: CardPaymentDisputeEvidenceUploadSession
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
InitiateOnDemandPricingChargePayload
The result of initiating an on-demand pricing charge. Returns the charge details or error information.
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
OnDemandPricingCharge: OnDemandPricingCharge
InitiateOrganizationReportPayload
The return types when calling initiateOrganizationReport.
Output:UNION
Possible Types
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
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
InitiateUnifiedFundsTransferPayload
The possible results of initiateUnifiedFundsTransfer
Output:UNION
Possible Types
InitiateUnloadWiredFundsPayload
The return types when initiating unloading funds from a FinancialAccount via wire.
Output:UNION
Possible Types
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
InitiateUSPersonAccountHolderRequestedIdentityUpdatePayload
The response type when applying an update for a USPersonAccountHolderRequestedIdentityUpdate
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
Possible Types
MastercardInstallmentData: MastercardInstallmentData
InstallmentOffersForTransactionEventPayload
Types which can be returned when querying InstallmentOffersForTransaction.
Output:UNION
Possible Types
InstallmentOffersForTransactionEvent: InstallmentOffersForTransactionEvent
UserError: UserError
AccessDeniedError: AccessDeniedError
InstantNetworkTransferDestinationNode
The possible destinations of the InstantNetworkTransfer.
Output:UNION
Possible Types
FinancialAccount: FinancialAccount
PaymentMethodToken: PaymentMethodToken
Possible Types
FinancialAccount: FinancialAccount
PaymentMethodToken: PaymentMethodToken
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
Possible Types
Possible Types
InvoiceItemPerItemCalculation: InvoiceItemPerItemCalculation
InvoiceItemPercentageCalculation: InvoiceItemPercentageCalculation
InvoiceItemServicePeriod
The service period an InvoiceItem covers. Exactly one variant is populated.
Output:UNION
Possible Types
InvoiceItemServicePeriodRange: InvoiceItemServicePeriodRange
InvoiceItemServiceDate: InvoiceItemServiceDate
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
IssueFinancialAccountForApplicationWithOnDemandFundingSourcePayload
The return types when creating a new Financial Account with an on-demand funding source.
Output:UNION
Possible Types
IssueFundingFinancialAccountForApplicationPayload
The return types when creating a new Funding Financial Account against an Application.
Output:UNION
Possible Types
IssuePaymentCardForApplicationPayload
The return types when creating a new Payment Card against an Application.
Output:UNION
Possible Types
IssuePaymentCardForApplicationWithOnDemandFundingSourcePayload
The return types when creating a new PaymentCard with an on-demand funding source.
Output:UNION
Possible Types
IssuePaymentCardForFinancialAccountPayload
The return types when creating a new Payment Card against a Financial Account.
Output:UNION
Possible Types
IssuePaymentCardForFinancialAccountResponse: IssuePaymentCardForFinancialAccountResponse
UserError: UserError
AccessDeniedError: AccessDeniedError
PaymentCard: PaymentCard
IssuePreprintedPaymentCardFinancialAccountForApplicationPayload
The return types for issuePreprintedPaymentCardFinancialAccountForApplication
Output:UNION
Possible Types
ManualAdjustmentDetail
Output:UNION
Possible Types
CreditManualAdjustmentDetail: CreditManualAdjustmentDetail
DebitManualAdjustmentDetail: DebitManualAdjustmentDetail
MerchantCategoryCodeSankeyDataPointsPayload
Union type for the Sankey data points query response, which can include data points, user errors, or access denial messages.
Output:UNION
Possible Types
MerchantDrilldownSankeyDataPointsPayload
Union type for the detailed Sankey data points query response, which can include data points, user errors, or access denial messages.
Output:UNION
Possible Types
MerchantIdentifierPayload
Output:UNION
Possible Types
MerchantIdentifierDetails: MerchantIdentifierDetails
UserError: UserError
AccessDeniedError: AccessDeniedError
NonOriginatedAchTransferPayload
Output:UNION
Possible Types
NonOriginatedAchTransferConnection: NonOriginatedAchTransferConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
NonVerifiedExternalUSFinancialBankAccountDetailRestrictedDetailsResult
Output:UNION
Possible Types
NonVerifiedExternalUSFinancialBankAccountRestrictedDetails: NonVerifiedExternalUSFinancialBankAccountRestrictedDetails
AccessDeniedError: AccessDeniedError
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
PaymentCardAdjustmentEvent: PaymentCardAdjustmentEvent
PaymentCardAuthorizationApprovedEvent: PaymentCardAuthorizationApprovedEvent
PaymentCardAuthorizationCreatedEvent: PaymentCardAuthorizationCreatedEvent
PaymentCardAuthorizationDeclinedEvent: PaymentCardAuthorizationDeclinedEvent
PaymentCardAuthorizationReversedEvent: PaymentCardAuthorizationReversedEvent
PaymentCardAuthorizationAndClearApprovedEvent: PaymentCardAuthorizationAndClearApprovedEvent
PaymentCardAuthorizationAndClearDeclinedEvent: PaymentCardAuthorizationAndClearDeclinedEvent
PaymentCardClearedEvent: PaymentCardClearedEvent
PaymentCardEnhancedDataEvent: PaymentCardEnhancedDataEvent
PaymentCardVerificationApprovedEvent: PaymentCardVerificationApprovedEvent
PaymentCardVerificationDeclinedEvent: PaymentCardVerificationDeclinedEvent
PaymentCardIssuedEvent: PaymentCardIssuedEvent
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
CardDigitalWalletTokenProvisioningEvent: CardDigitalWalletTokenProvisioningEvent
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
FlexibleCredentialInstantCreditActivationStatusChangedEvent: FlexibleCredentialInstantCreditActivationStatusChangedEvent
AchTransferHoldAddedEvent: AchTransferHoldAddedEvent
AchTransferHoldRemovedEvent: AchTransferHoldRemovedEvent
LinkVerifiedExternalBankAccountFailedEvent: LinkVerifiedExternalBankAccountFailedEvent
LinkVerifiedExternalBankAccountVerificationRequiredEvent: LinkVerifiedExternalBankAccountVerificationRequiredEvent
LinkVerifiedExternalBankAccountExpiredEvent: LinkVerifiedExternalBankAccountExpiredEvent
CheckPaymentEvent: CheckPaymentEvent
UpcomingStatementDueDateEvent: UpcomingStatementDueDateEvent
AccountHolderProvisioning: AccountHolderProvisioning
AccountHolderProvisioningWorkflowAction: AccountHolderProvisioningWorkflowAction
FeeChargeEvent: FeeChargeEvent
FeeReversalEvent: FeeReversalEvent
InstantNetworkTransfer: InstantNetworkTransfer
UnifiedFundsTransfer: UnifiedFundsTransfer
WireTransfer: WireTransfer
OriginatedRtpTransferEvent: OriginatedRtpTransferEvent
NonOriginatedRtpTransferEvent: NonOriginatedRtpTransferEvent
OriginatedFedNowTransferEvent: OriginatedFedNowTransferEvent
NonOriginatedFedNowTransferEvent: NonOriginatedFedNowTransferEvent
ManualDocumentRequestUploadSession: ManualDocumentRequestUploadSession
FileUploadCompleteEvent: FileUploadCompleteEvent
DocumentUploadSessionCompleteEvent: DocumentUploadSessionCompleteEvent
CardPaymentAuthorizingEvent: CardPaymentAuthorizingEvent
CardPaymentAuthorizedEvent: CardPaymentAuthorizedEvent
CardPaymentIncrementalAuthorizedEvent: CardPaymentIncrementalAuthorizedEvent
CardPaymentReversedEvent: CardPaymentReversedEvent
CardPaymentPartialReversedEvent: CardPaymentPartialReversedEvent
CardPaymentCapturingEvent: CardPaymentCapturingEvent
CardPaymentCaptureProcessingEvent: CardPaymentCaptureProcessingEvent
CardPaymentClearedEvent: CardPaymentClearedEvent
CardPaymentClearingFailedEvent: CardPaymentClearingFailedEvent
CardPaymentDisbursedEvent: CardPaymentDisbursedEvent
CardPaymentAuthorizationDeclinedEvent: CardPaymentAuthorizationDeclinedEvent
CardPaymentIncrementalAuthorizationDeclinedEvent: CardPaymentIncrementalAuthorizationDeclinedEvent
CardPaymentReversalDeclinedEvent: CardPaymentReversalDeclinedEvent
CardPaymentCaptureDeclinedEvent: CardPaymentCaptureDeclinedEvent
CardPaymentPayoutEvent: CardPaymentPayoutEvent
PayoutTransferCompletedEvent: PayoutTransferCompletedEvent
CardPaymentVerificationPendingEvent: CardPaymentVerificationPendingEvent
CardPaymentVerifiedEvent: CardPaymentVerifiedEvent
CardPaymentVerificationDeclinedEvent: CardPaymentVerificationDeclinedEvent
CardPaymentDispute: CardPaymentDispute
PaymentMethodCapabilityEnabledEvent: PaymentMethodCapabilityEnabledEvent
PaymentMethodCapabilityDisabledEvent: PaymentMethodCapabilityDisabledEvent
PaymentMethodCapabilityRequiresReviewEvent: PaymentMethodCapabilityRequiresReviewEvent
PaymentMethodCapabilityReviewedEvent: PaymentMethodCapabilityReviewedEvent
BalanceNotificationEvent: BalanceNotificationEvent
CryptoFundingFlowReceivedEvent: CryptoFundingFlowReceivedEvent
CryptoFundingFlowProcessingEvent: CryptoFundingFlowProcessingEvent
CryptoFundingFlowProcessedEvent: CryptoFundingFlowProcessedEvent
CryptoFundingFlowFailedEvent: CryptoFundingFlowFailedEvent
ProcessingCapabilityActivatedEvent: ProcessingCapabilityActivatedEvent
ProductApplication: ProductApplication
Possible Types
WebhookNotificationTarget: WebhookNotificationTarget
Possible Types
OrderPhysicalPaymentCardPayload
Types which can be returned for ordering a payment card.
Output:UNION
Possible Types
PhysicalPaymentCardOrder: PhysicalPaymentCardOrder
UserError: UserError
AccessDeniedError: AccessDeniedError
OrganizationBusinessRelationship
Represents all possible types of organization business relationships.
Output:UNION
Possible Types
OrganizationBusinessCustomerRelationship: OrganizationBusinessCustomerRelationship
OrganizationBusinessPartnerRelationship: OrganizationBusinessPartnerRelationship
OriginatedAchTransferPayload
Output:UNION
Possible Types
OriginatedAchTransferConnection: OriginatedAchTransferConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
USPersonAccountHolder: USPersonAccountHolder
USPersonAuthorizedUser: USPersonAuthorizedUser
BusinessAuthorizedPerson: BusinessAuthorizedPerson
PaymentCardInstrumentCapability
Output:UNION
Possible Types
InstantNetworkTransferDestinationPaymentInstrumentCapability: InstantNetworkTransferDestinationPaymentInstrumentCapability
InstantNetworkTransferSourcePaymentInstrumentCapability: InstantNetworkTransferSourcePaymentInstrumentCapability
ComplianceScreeningPaymentInstrumentCapability: ComplianceScreeningPaymentInstrumentCapability
UserError: UserError
AccessDeniedError: AccessDeniedError
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
Possible Types
PaymentCardInstrument: PaymentCardInstrument
Possible Types
PaymentMethodConnection: PaymentMethodConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
PaymentMethodToken: PaymentMethodToken
PaymentTransactionsConnectionPayload
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
PaymentTransactionsConnection: PaymentTransactionsConnection
Possible Types
NationalIdentificationDocument: NationalIdentificationDocument
PassportIdentificationDocument: PassportIdentificationDocument
Possible Types
PhysicalCardGroupOrder: PhysicalCardGroupOrder
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
Possible Types
PricingRuleParameterValueSingle: PricingRuleParameterValueSingle
PrimaryAuthorizedPerson
The primary person authorized to act on behalf of a business account holder.
A person identified by a passport or non-US national identification is
returned as a BusinessAuthorizedPerson; otherwise (a US Social Security
Number, a US Individual Taxpayer Identification Number, or no distinguishing
document) the person is returned as a USBusinessAuthorizedPerson.
A Social Security Number decides on its own: a person holding one is returned
as a USBusinessAuthorizedPerson even when a passport is also present. An
Individual Taxpayer Identification Number does not, so a person holding one
together with a passport is returned as a BusinessAuthorizedPerson.
Output:UNION
Possible Types
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
BusinessAuthorizedPerson: BusinessAuthorizedPerson
ProcessingCapability
Output:UNION
Possible Types
CardProcessingCapability: CardProcessingCapability
ProductApplicantBusinessProfileSnapshot
Snapshot of the product applicant's business profile.
Output:UNION
Possible Types
USBusinessProfileSnapshot: USBusinessProfileSnapshot
ProductApplicationConnectionPayload
The return types when querying a paginated list of ProductApplication;
Output:UNION
Possible Types
ProductApplicationConnection: ProductApplicationConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
ProductApplicationWorkflowResult
The result detail for a ProductApplicationWorkflow step. The concrete member type corresponds to the workflow's workflowType.
Output:UNION
Possible Types
IdentityVerification: IdentityVerification
TerminatedMerchantScreeningResult: TerminatedMerchantScreeningResult
BusinessUnderwritingResult: BusinessUnderwritingResult
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
Possible Types
PublishPricingPlanPayload
The result of publishing a PricingPlan.
Returns the published pricing plan or error details.
Output:UNION
Possible Types
RealtimeRiskRuleConnectionPayload
The return types for searching for realtime risk rules.
Output:UNION
Possible Types
RealtimeRiskRuleConnection: RealtimeRiskRuleConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
ReevaluateApplicationPayload
The response type for reevaluating an existing, APPROVED application.
Output:UNION
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCreditStepSummary: CardCreditStepSummary
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardCreditStepSummary: CardCreditStepSummary
ReissueFlexibleCredentialCardsPayload
The return types when reissuing the member Payment Cards of a Flexible Credential.
Output:UNION
Possible Types
ReissuePaymentCardPayload
The return types when creating a new Payment Card based on an existing card.
Output:UNION
Possible Types
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
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
Possible Types
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
Possible Types
Possible Types
USBusinessProfile: USBusinessProfile
USBusinessAuthorizedPerson: USBusinessAuthorizedPerson
USBusinessUltimateBeneficialOwner: USBusinessUltimateBeneficialOwner
USPersonAccountHolder: USPersonAccountHolder
USPersonAuthorizedUser: USPersonAuthorizedUser
Possible Types
AccountHolderCardProductApplication: AccountHolderCardProductApplication
AuthorizedUserCardProductApplication: AuthorizedUserCardProductApplication
ResetPseudoBalancePayload
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
ReverseInstallmentAgreementPayload
Types which can be returned when reversing an InstallmentAgreement.
Output:UNION
Possible Types
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
CardReversalStepSummary: CardReversalStepSummary
Possible Types
ReviewWorkflowEventConnection: ReviewWorkflowEventConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
ReviewWorkflowEventTransfer
Output:UNION
Possible Types
WireTransfer: WireTransfer
Possible Types
RevokeCardAuthenticationContactPayload
The return types when calling revokeCardAuthenticationContact.
Output:UNION
Possible Types
CardAuthenticationContact: CardAuthenticationContact
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
RewardPointsTransferConnection: RewardPointsTransferConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
RewardPointsTransferStatusDetails
Details about the status of the reward points transfer.
Output:UNION
Possible Types
RewardPointsTransferSuccessStatus: RewardPointsTransferSuccessStatus
RewardPointsTransferFailureStatus: RewardPointsTransferFailureStatus
RiskGeolocationDensityPayload
Union type for the response payload of the geolocation density query, which can include density points, user errors, or access denial messages.
Output:UNION
Possible Types
RiskGeolocationDensity: RiskGeolocationDensity
UserError: UserError
AccessDeniedError: AccessDeniedError
RiskGeolocationPathsPayload
Union type for the response payload of the geolocation paths query, which can include paths, user errors, or access denial messages.
Output:UNION
Possible Types
RiskScatterDataPointsPayload
Union type for the response payload of the scatter data points query, which can include data points, user errors, or access denial messages.
Output:UNION
Possible Types
RiskScatterDataPoints: RiskScatterDataPoints
UserError: UserError
AccessDeniedError: AccessDeniedError
RiskSmsMessageConnectionPayload
The return types when querying for SMS messages by transaction risk event.
Output:UNION
Possible Types
RiskSmsMessageConnection: RiskSmsMessageConnection
UserError: UserError
AccessDeniedError: AccessDeniedError
RotateNotificationTargetSigningKeyPayload
The return types when removing subscriptions from an existing webhook notification target.
Output:UNION
Possible Types
WebhookNotificationTarget: WebhookNotificationTarget
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
FinancialAccount: FinancialAccount
USBankAccount: USBankAccount
Possible Types
FinancialAccount: FinancialAccount
USBankAccount: USBankAccount
ScopedCustomerAddressTokenPayload
Types to expect while requesting a scoped payment method token.
Output:UNION
Possible Types
ScopedCustomerAddressToken: ScopedCustomerAddressToken
UserError: UserError
AccessDeniedError: AccessDeniedError
ScopedPaymentMethodTokenPayload
Types to expect while requesting a scoped payment method token.
Output:UNION
Possible Types
ScopedPaymentMethodToken: ScopedPaymentMethodToken
UserError: UserError
AccessDeniedError: AccessDeniedError
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
SetPseudoLimitPayload
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
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
SimulateAdjustmentPayload
Output:UNION
Possible Types
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
Possible Types
CardDigitalWalletToken: CardDigitalWalletToken
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
SimulateCheckbookUserVerificationPayload
Output:UNION
Possible Types
SimulateCheckbookUserVerificationSuccess: SimulateCheckbookUserVerificationSuccess
UserError: UserError
AccessDeniedError: AccessDeniedError
SimulateCheckPaymentEventChangePayload
Output:UNION
Possible Types
SimulateClearingPayload
Output:UNION
Possible Types
Possible Types
SimulateCreateAndActivateFeeSchedulePayload
Response type for simulate create fee schedule.
Output:UNION
Possible Types
SimulateCreateMerchantMatchConfigPayload
Response for simulateCreateMerchantMatchConfig.
Output:UNION
Possible Types
AcquiringMerchantMatchConfig: AcquiringMerchantMatchConfig
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
SimulateFinancialAccountAgingPayload
Types which can be returned for simulating account aging.
Output:UNION
Possible Types
SimulateFinancialAccountStatementPayload
Types which can be returned for simulating statement period shift and rollover
Output:UNION
Possible Types
SimulateInitiateFinancialAccountClosurePayload
The return types for simulateInitiateFinancialAccountClosure
Output:UNION
Possible Types
SimulateNonOriginatedAchTransferPayload
The return types when simulating receiving a NonOriginatedAchTransfer.
Output:UNION
Possible Types
NonOriginatedAchTransfer: NonOriginatedAchTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
SimulateNonOriginatedRtpTransferPayload
The return types when simulating receiving a NonOriginatedRtpTransfer.
Output:UNION
Possible Types
NonOriginatedRtpTransfer: NonOriginatedRtpTransfer
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
SimulatePricingPlanPayload
The result of simulating a PricingPlan.
Returns the simulation results or error details.
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
PricingPlanSimulationResult: PricingPlanSimulationResult
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
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
SimulateVisaFleetL3EnhancedDataPayload
Output:UNION
Possible Types
StartDocumentUploadSessionPayload
The return types when a document upload session is started.
Output:UNION
Possible Types
USAccountHolderApplicationDocumentUploadSession: USAccountHolderApplicationDocumentUploadSession
CardProfileDocumentUploadSession: CardProfileDocumentUploadSession
IdentityVerificationDocumentUploadSession: IdentityVerificationDocumentUploadSession
CheckPaymentDocumentUploadSession: CheckPaymentDocumentUploadSession
ManualDocumentRequestUploadSession: ManualDocumentRequestUploadSession
UserError: UserError
AccessDeniedError: AccessDeniedError
SubmitCardPaymentDisputeEvidencePayload
Result of submitting the evidence uploaded for a CardPaymentDispute.
Output:UNION
Possible Types
SuspendCardDigitalWalletTokenPayload
The return types when suspending a card digital wallet token.
Output:UNION
Possible Types
CardDigitalWalletToken: CardDigitalWalletToken
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
TerminateCardDigitalWalletTokenPayload
The return types when terminating a card digital wallet token.
Output:UNION
Possible Types
CardDigitalWalletToken: CardDigitalWalletToken
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
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
Possible Types
CreditTransaction: CreditTransaction
DebitTransaction: DebitTransaction
TransactionBatchConnectionPayload
Output:UNION
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
TransactionBatchConnection: TransactionBatchConnection
TransactionSearchResultPayload
Output:UNION
Possible Types
TransactionSearchResultConnection: TransactionSearchResultConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
TransactionSearchSource
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
ManualAdjustmentEvent: ManualAdjustmentEvent
Transfer: Transfer
WireTransfer: WireTransfer
CreditFundsACHTransferEvent: CreditFundsACHTransferEvent
DebitFundsACHTransferEvent: DebitFundsACHTransferEvent
PayrollACHTransferEvent: PayrollACHTransferEvent
SecureDepositTransferEvent: SecureDepositTransferEvent
SecureDepositACHTransferEvent: SecureDepositACHTransferEvent
IntegratorInitiatedFundsDepositACHTransferEvent: IntegratorInitiatedFundsDepositACHTransferEvent
IntegratorInitiatedFundsWithdrawalACHTransferEvent: IntegratorInitiatedFundsWithdrawalACHTransferEvent
SecureCardBalanceRepaymentACHTransferEvent: SecureCardBalanceRepaymentACHTransferEvent
PayrollTransfer: PayrollTransfer
CreditFunds: CreditFunds
DebitFunds: DebitFunds
SecureDepositACHTransfer: SecureDepositACHTransfer
SecureDeposit: SecureDeposit
IntegratorInitiatedFundsWithdrawalACHTransfer: IntegratorInitiatedFundsWithdrawalACHTransfer
IntegratorInitiatedFundsDepositACHTransfer: IntegratorInitiatedFundsDepositACHTransfer
SecureCardBalanceRepaymentACHTransfer: SecureCardBalanceRepaymentACHTransfer
ExternallyInitiatedWireTransfer: ExternallyInitiatedWireTransfer
OriginatedAchTransfer: OriginatedAchTransfer
NonOriginatedAchTransfer: NonOriginatedAchTransfer
ReversalEvent: ReversalEvent
ClearingEvent: ClearingEvent
EnhancedDataEvent: EnhancedDataEvent
AuthorizationEvent: AuthorizationEvent
IssuerPreliminaryAuthorizationEvent: IssuerPreliminaryAuthorizationEvent
AuthorizationAndClearEvent: AuthorizationAndClearEvent
VerificationEvent: VerificationEvent
BalanceInquiryEvent: BalanceInquiryEvent
AdjustmentEvent: AdjustmentEvent
FlexibleCredentialAttemptEvent: FlexibleCredentialAttemptEvent
CheckPayment: CheckPayment
CheckPaymentEvent: CheckPaymentEvent
DisbursementTransferEvent: DisbursementTransferEvent
InstantNetworkTransfer: InstantNetworkTransfer
InstantNetworkTransferEvent: InstantNetworkTransferEvent
InstantSettlementTransaction: InstantSettlementTransaction
InstantSettlementTransactionEvent: InstantSettlementTransactionEvent
OriginatedRtpTransfer: OriginatedRtpTransfer
OriginatedRtpTransferEvent: OriginatedRtpTransferEvent
NonOriginatedRtpTransfer: NonOriginatedRtpTransfer
NonOriginatedRtpTransferEvent: NonOriginatedRtpTransferEvent
TransferAmountStrategy
Output:UNION
Possible Types
TransferAmountCalculation: TransferAmountCalculation
ManualTransferAmount: ManualTransferAmount
Possible Types
TransferredEventNode
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
ManualAdjustmentEvent: ManualAdjustmentEvent
UltimateBeneficialOwner
An ultimate beneficial owner of a business.
An owner identified by a passport or non-US national identification is
returned as a BusinessAuthorizedPerson; otherwise (a US Social Security
Number, a US Individual Taxpayer Identification Number, or no distinguishing
document) the owner is returned as a USBusinessUltimateBeneficialOwner.
A Social Security Number decides on its own: an owner holding one is returned
as a USBusinessUltimateBeneficialOwner even when a passport is also present.
An Individual Taxpayer Identification Number does not, so an owner holding one
together with a passport is returned as a BusinessAuthorizedPerson.
Output:UNION
Possible Types
USBusinessUltimateBeneficialOwner: USBusinessUltimateBeneficialOwner
BusinessAuthorizedPerson: BusinessAuthorizedPerson
Possible Types
UnderwriterPositiveDecision: UnderwriterPositiveDecision
UnderwriterAdverseDecision: UnderwriterAdverseDecision
UnifiedFundsTransferDestinationNode
The possible destinations of the UnifiedFundsTransfer.
Output:UNION
Possible Types
FinancialAccount: FinancialAccount
PaymentMethodToken: PaymentMethodToken
USBankAccount: USBankAccount
Possible Types
FinancialAccount: FinancialAccount
PaymentMethodToken: PaymentMethodToken
USBankAccount: USBankAccount
UnifiedFundsTransferStep
Output:UNION
Possible Types
UnifiedFundsTransferInitiateRequestStep: UnifiedFundsTransferInitiateRequestStep
UnifiedFundsTransferInstantNetworkTransferStep: UnifiedFundsTransferInstantNetworkTransferStep
UnifiedFundsTransferRtpStep: UnifiedFundsTransferRtpStep
UnifiedFundsTransferFedNowStep: UnifiedFundsTransferFedNowStep
UnifiedFundsTransferCryptoFundingFlowStep: UnifiedFundsTransferCryptoFundingFlowStep
UnifiedFundsTransferStepTransfer
The types of transfers that the UnifiedFundsTransfer may start.
Output:UNION
Possible Types
InstantNetworkTransfer: InstantNetworkTransfer
UnsuspendCardDigitalWalletTokenPayload
The return types when unsuspending a card digital wallet token.
Output:UNION
Possible Types
CardDigitalWalletToken: CardDigitalWalletToken
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateAccountSpendRulePayload
The return types when updating an existing AccountSpendRule.
Output:UNION
Possible Types
UpdateAccountTransactionCountSpendRulePayload
The return types when updating an existing AccountTransactionCountSpendRule.
Output:UNION
Possible Types
AccountTransactionCountSpendRule: AccountTransactionCountSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateAmountLimitSpendRulePayload
The return types when updating an existing amount limit rule.
Output:UNION
Possible Types
UpdateCardDataInputCapabilitySpendRulePayload
The return types when updating an existing CardDataInputCapabilitySpendRule.
Output:UNION
Possible Types
CardDataInputCapabilitySpendRule: CardDataInputCapabilitySpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
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
UpdateCreditLimitPercentageSpendRulePayload
The return types when updating an existing CreditLimitPercentageSpendRule.
Output:UNION
Possible Types
CreditLimitPercentageSpendRule: CreditLimitPercentageSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
Possible Types
UpdateDaysWithinAccountCreateDateSpendRulePayload
The return types when updating an existing DaysWithinAccountCreateDateSpendRule.
Output:UNION
Possible Types
DaysWithinAccountCreateDateSpendRule: DaysWithinAccountCreateDateSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateDaysWithinCardCreateDateSpendRulePayload
The return types when updating an existing DaysWithinCardCreateDateSpendRule.
Output:UNION
Possible Types
DaysWithinCardCreateDateSpendRule: DaysWithinCardCreateDateSpendRule
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
UpdateFinancialAccountNamePayload
The return types when updating a Financial Account name.
Output:UNION
Possible Types
UpdateMastercardFraudScoreSpendRulePayload
The return types when updating an existing MastercardFraudScoreSpendRule.
Output:UNION
Possible Types
MastercardFraudScoreSpendRule: MastercardFraudScoreSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateMaximumAmountVarianceOnCreditLimitSpendRulePayload
The return types when updating an existing MaximumAmountVarianceOnCreditLimitSpendRule.
Output:UNION
Possible Types
MaximumAmountVarianceOnCreditLimitSpendRule: MaximumAmountVarianceOnCreditLimitSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateMaximumAmountVarianceOnPseudoBalanceSpendRulePayload
The return types when updating an existing MaximumAmountVarianceOnPseudoBalanceSpendRule.
Output:UNION
Possible Types
MaximumAmountVarianceOnPseudoBalanceSpendRule: MaximumAmountVarianceOnPseudoBalanceSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdateMaximumPercentVarianceOnCreditLimitSpendRulePayload
The return types when updating an existing MaximumPercentVarianceOnCreditLimitSpendRule.
Output:UNION
Possible Types
MaximumPercentVarianceOnCreditLimitSpendRule: MaximumPercentVarianceOnCreditLimitSpendRule
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
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
UpdatePseudoBalancePayload
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
UserError: UserError
AccessDeniedError: AccessDeniedError
UpdatePseudoLimitPayload
Output:UNION
Possible Types
InterFinancialAccountTransfer: InterFinancialAccountTransfer
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
Possible Types
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
Possible Types
UpdateVisaRiskScoreSpendRulePayload
The return types when updating an existing VisaRiskScoreSpendRule.
Output:UNION
Possible Types
VisaRiskScoreSpendRule: VisaRiskScoreSpendRule
UserError: UserError
AccessDeniedError: AccessDeniedError
UploadRequirementConstraint
Output:UNION
Possible Types
DocumentUploadRequirementConstraint: DocumentUploadRequirementConstraint
UserDefinedFieldDefinitionPayload
Output:UNION
Possible Types
UserDefinedFieldDefinition: UserDefinedFieldDefinition
AccessDeniedError: AccessDeniedError
UserError: UserError
UserDefinedFieldDefinitionRevisionPayload
Output:UNION
Possible Types
UserDefinedFieldDefinitionRevisionConnection: UserDefinedFieldDefinitionRevisionConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
UserDefinedFieldPayload
Output:UNION
Possible Types
UserDefinedStringField: UserDefinedStringField
UserDefinedBooleanField: UserDefinedBooleanField
UserDefinedIntegerField: UserDefinedIntegerField
AccessDeniedError: AccessDeniedError
UserError: UserError
UserDefinedFieldRevisionPayload
Output:UNION
Possible Types
UserDefinedFieldRevisionConnection: UserDefinedFieldRevisionConnection
AccessDeniedError: AccessDeniedError
UserError: UserError
Possible Types
User: User
Organization: Organization
PlatformAgent: PlatformAgent
AccessDeniedError: AccessDeniedError
UserError: UserError
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
Possible Types
PaymentCard: PaymentCard
CardProduct: CardProduct
Possible Types
VelocitySpendRuleAmountBalance: VelocitySpendRuleAmountBalance
VelocitySpendRuleCountBalance: VelocitySpendRuleCountBalance
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
PaymentCardVerification: PaymentCardVerification
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
PaymentCardVerification: PaymentCardVerification
Possible Types
AccessDeniedError: AccessDeniedError
UserError: UserError
PaymentCardVerification: PaymentCardVerification
WaiveInterestAmountForClosedStatementPayload
Types which can be returned when waiving full interest for a given InterestAssessmentEvent associated with a closed FinancialAccountStatement
Output:UNION
Possible Types
CreditCardTransferEvent: CreditCardTransferEvent
UserError: UserError
AccessDeniedError: AccessDeniedError
WireTransferReviewItem
Output:UNION
Possible Types
WireTransferReview: WireTransferReview
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