Documentation
¶
Index ¶
- func Bool(value bool) param.Field[bool]
- func F[T any](value T) param.Field[T]
- func Float(value float64) param.Field[float64]
- func Int(value int64) param.Field[int64]
- func Null[T any]() param.Field[T]
- func Raw[T any](value any) param.Field[T]
- func String(value string) param.Field[string]
- type ACHPrenotification
- type ACHPrenotificationCreditDebitIndicator
- type ACHPrenotificationListParams
- type ACHPrenotificationListParamsCreatedAt
- type ACHPrenotificationNewParams
- type ACHPrenotificationNewParamsCreditDebitIndicator
- type ACHPrenotificationNewParamsStandardEntryClassCode
- type ACHPrenotificationNotificationsOfChange
- type ACHPrenotificationNotificationsOfChangeChangeCode
- type ACHPrenotificationPrenotificationReturn
- type ACHPrenotificationService
- func (r *ACHPrenotificationService) Get(ctx context.Context, achPrenotificationID string, opts ...option.RequestOption) (res *ACHPrenotification, err error)
- func (r *ACHPrenotificationService) List(ctx context.Context, query ACHPrenotificationListParams, ...) (res *shared.Page[ACHPrenotification], err error)
- func (r *ACHPrenotificationService) ListAutoPaging(ctx context.Context, query ACHPrenotificationListParams, ...) *shared.PageAutoPager[ACHPrenotification]
- func (r *ACHPrenotificationService) New(ctx context.Context, body ACHPrenotificationNewParams, ...) (res *ACHPrenotification, err error)
- type ACHPrenotificationStatus
- type ACHPrenotificationType
- type ACHTransfer
- type ACHTransferAcknowledgement
- type ACHTransferApproval
- type ACHTransferCancellation
- type ACHTransferCurrency
- type ACHTransferFunding
- type ACHTransferListParams
- type ACHTransferListParamsCreatedAt
- type ACHTransferNetwork
- type ACHTransferNewParams
- type ACHTransferNewParamsFunding
- type ACHTransferNewParamsStandardEntryClassCode
- type ACHTransferNotificationsOfChange
- type ACHTransferNotificationsOfChangeChangeCode
- type ACHTransferReturn
- type ACHTransferReturnReturnReasonCode
- type ACHTransferService
- func (r *ACHTransferService) Approve(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
- func (r *ACHTransferService) Cancel(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
- func (r *ACHTransferService) Get(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
- func (r *ACHTransferService) List(ctx context.Context, query ACHTransferListParams, opts ...option.RequestOption) (res *shared.Page[ACHTransfer], err error)
- func (r *ACHTransferService) ListAutoPaging(ctx context.Context, query ACHTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[ACHTransfer]
- func (r *ACHTransferService) New(ctx context.Context, body ACHTransferNewParams, opts ...option.RequestOption) (res *ACHTransfer, err error)
- type ACHTransferSimulation
- type ACHTransferSimulationDeclinedTransaction
- type ACHTransferSimulationDeclinedTransactionCurrency
- type ACHTransferSimulationDeclinedTransactionRouteType
- type ACHTransferSimulationDeclinedTransactionSource
- type ACHTransferSimulationDeclinedTransactionSourceACHDecline
- type ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason
- type ACHTransferSimulationDeclinedTransactionSourceACHDeclineType
- type ACHTransferSimulationDeclinedTransactionSourceCardDecline
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode
- type ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason
- type ACHTransferSimulationDeclinedTransactionSourceCategory
- type ACHTransferSimulationDeclinedTransactionSourceCheckDecline
- type ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason
- type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline
- type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency
- type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason
- type ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline
- type ACHTransferSimulationDeclinedTransactionSourceWireDecline
- type ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason
- type ACHTransferSimulationDeclinedTransactionType
- type ACHTransferSimulationTransaction
- type ACHTransferSimulationTransactionCurrency
- type ACHTransferSimulationTransactionRouteType
- type ACHTransferSimulationTransactionSource
- type ACHTransferSimulationTransactionSourceACHTransferIntention
- type ACHTransferSimulationTransactionSourceACHTransferRejection
- type ACHTransferSimulationTransactionSourceACHTransferReturn
- type ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode
- type ACHTransferSimulationTransactionSourceAccountTransferIntention
- type ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency
- type ACHTransferSimulationTransactionSourceCardDisputeAcceptance
- type ACHTransferSimulationTransactionSourceCardRefund
- type ACHTransferSimulationTransactionSourceCardRefundCurrency
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg
- type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode
- type ACHTransferSimulationTransactionSourceCardRefundType
- type ACHTransferSimulationTransactionSourceCardRevenuePayment
- type ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency
- type ACHTransferSimulationTransactionSourceCardSettlement
- type ACHTransferSimulationTransactionSourceCardSettlementCurrency
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg
- type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode
- type ACHTransferSimulationTransactionSourceCardSettlementType
- type ACHTransferSimulationTransactionSourceCategory
- type ACHTransferSimulationTransactionSourceCheckDepositAcceptance
- type ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency
- type ACHTransferSimulationTransactionSourceCheckDepositReturn
- type ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency
- type ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason
- type ACHTransferSimulationTransactionSourceCheckTransferDeposit
- type ACHTransferSimulationTransactionSourceCheckTransferDepositType
- type ACHTransferSimulationTransactionSourceCheckTransferIntention
- type ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency
- type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest
- type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason
- type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType
- type ACHTransferSimulationTransactionSourceFeePayment
- type ACHTransferSimulationTransactionSourceFeePaymentCurrency
- type ACHTransferSimulationTransactionSourceInboundACHTransfer
- type ACHTransferSimulationTransactionSourceInboundCheck
- type ACHTransferSimulationTransactionSourceInboundCheckCurrency
- type ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer
- type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation
- type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency
- type ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment
- type ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal
- type ACHTransferSimulationTransactionSourceInboundWireReversal
- type ACHTransferSimulationTransactionSourceInboundWireTransfer
- type ACHTransferSimulationTransactionSourceInterestPayment
- type ACHTransferSimulationTransactionSourceInterestPaymentCurrency
- type ACHTransferSimulationTransactionSourceInternalSource
- type ACHTransferSimulationTransactionSourceInternalSourceCurrency
- type ACHTransferSimulationTransactionSourceInternalSourceReason
- type ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement
- type ACHTransferSimulationTransactionSourceSampleFunds
- type ACHTransferSimulationTransactionSourceWireTransferIntention
- type ACHTransferSimulationTransactionSourceWireTransferRejection
- type ACHTransferSimulationTransactionType
- type ACHTransferSimulationType
- type ACHTransferStandardEntryClassCode
- type ACHTransferStatus
- type ACHTransferSubmission
- type ACHTransferType
- type Account
- type AccountCurrency
- type AccountListParams
- type AccountListParamsCreatedAt
- type AccountListParamsStatus
- type AccountNewParams
- type AccountNumber
- type AccountNumberListParams
- type AccountNumberListParamsCreatedAt
- type AccountNumberListParamsStatus
- type AccountNumberNewParams
- type AccountNumberService
- func (r *AccountNumberService) Get(ctx context.Context, accountNumberID string, opts ...option.RequestOption) (res *AccountNumber, err error)
- func (r *AccountNumberService) List(ctx context.Context, query AccountNumberListParams, ...) (res *shared.Page[AccountNumber], err error)
- func (r *AccountNumberService) ListAutoPaging(ctx context.Context, query AccountNumberListParams, ...) *shared.PageAutoPager[AccountNumber]
- func (r *AccountNumberService) New(ctx context.Context, body AccountNumberNewParams, opts ...option.RequestOption) (res *AccountNumber, err error)
- func (r *AccountNumberService) Update(ctx context.Context, accountNumberID string, body AccountNumberUpdateParams, ...) (res *AccountNumber, err error)
- type AccountNumberStatus
- type AccountNumberType
- type AccountNumberUpdateParams
- type AccountNumberUpdateParamsStatus
- type AccountService
- func (r *AccountService) Close(ctx context.Context, accountID string, opts ...option.RequestOption) (res *Account, err error)
- func (r *AccountService) Get(ctx context.Context, accountID string, opts ...option.RequestOption) (res *Account, err error)
- func (r *AccountService) List(ctx context.Context, query AccountListParams, opts ...option.RequestOption) (res *shared.Page[Account], err error)
- func (r *AccountService) ListAutoPaging(ctx context.Context, query AccountListParams, opts ...option.RequestOption) *shared.PageAutoPager[Account]
- func (r *AccountService) New(ctx context.Context, body AccountNewParams, opts ...option.RequestOption) (res *Account, err error)
- func (r *AccountService) Update(ctx context.Context, accountID string, body AccountUpdateParams, ...) (res *Account, err error)
- type AccountStatement
- type AccountStatementListParams
- type AccountStatementListParamsStatementPeriodStart
- type AccountStatementService
- func (r *AccountStatementService) Get(ctx context.Context, accountStatementID string, opts ...option.RequestOption) (res *AccountStatement, err error)
- func (r *AccountStatementService) List(ctx context.Context, query AccountStatementListParams, ...) (res *shared.Page[AccountStatement], err error)
- func (r *AccountStatementService) ListAutoPaging(ctx context.Context, query AccountStatementListParams, ...) *shared.PageAutoPager[AccountStatement]
- type AccountStatementType
- type AccountStatus
- type AccountTransfer
- type AccountTransferApproval
- type AccountTransferCancellation
- type AccountTransferCurrency
- type AccountTransferListParams
- type AccountTransferListParamsCreatedAt
- type AccountTransferNetwork
- type AccountTransferNewParams
- type AccountTransferService
- func (r *AccountTransferService) Approve(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
- func (r *AccountTransferService) Cancel(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
- func (r *AccountTransferService) Get(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
- func (r *AccountTransferService) List(ctx context.Context, query AccountTransferListParams, ...) (res *shared.Page[AccountTransfer], err error)
- func (r *AccountTransferService) ListAutoPaging(ctx context.Context, query AccountTransferListParams, ...) *shared.PageAutoPager[AccountTransfer]
- func (r *AccountTransferService) New(ctx context.Context, body AccountTransferNewParams, ...) (res *AccountTransfer, err error)
- type AccountTransferStatus
- type AccountTransferType
- type AccountType
- type AccountUpdateParams
- type BalanceLookupLookupParams
- type BalanceLookupLookupResponse
- type BalanceLookupLookupResponseType
- type BalanceLookupService
- type BookkeepingAccount
- type BookkeepingAccountComplianceCategory
- type BookkeepingAccountListParams
- type BookkeepingAccountNewParams
- type BookkeepingAccountNewParamsComplianceCategory
- type BookkeepingAccountService
- func (r *BookkeepingAccountService) List(ctx context.Context, query BookkeepingAccountListParams, ...) (res *shared.Page[BookkeepingAccount], err error)
- func (r *BookkeepingAccountService) ListAutoPaging(ctx context.Context, query BookkeepingAccountListParams, ...) *shared.PageAutoPager[BookkeepingAccount]
- func (r *BookkeepingAccountService) New(ctx context.Context, body BookkeepingAccountNewParams, ...) (res *BookkeepingAccount, err error)
- type BookkeepingAccountType
- type BookkeepingEntry
- type BookkeepingEntryListParams
- type BookkeepingEntryService
- type BookkeepingEntrySet
- type BookkeepingEntrySetEntry
- type BookkeepingEntrySetNewParams
- type BookkeepingEntrySetNewParamsEntry
- type BookkeepingEntrySetService
- type BookkeepingEntrySetType
- type BookkeepingEntryType
- type Card
- type CardAuthorizationSimulation
- type CardAuthorizationSimulationDeclinedTransaction
- type CardAuthorizationSimulationDeclinedTransactionCurrency
- type CardAuthorizationSimulationDeclinedTransactionRouteType
- type CardAuthorizationSimulationDeclinedTransactionSource
- type CardAuthorizationSimulationDeclinedTransactionSourceACHDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason
- type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineType
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode
- type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason
- type CardAuthorizationSimulationDeclinedTransactionSourceCategory
- type CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason
- type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency
- type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason
- type CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceWireDecline
- type CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason
- type CardAuthorizationSimulationDeclinedTransactionType
- type CardAuthorizationSimulationPendingTransaction
- type CardAuthorizationSimulationPendingTransactionCurrency
- type CardAuthorizationSimulationPendingTransactionRouteType
- type CardAuthorizationSimulationPendingTransactionSource
- type CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction
- type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction
- type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorization
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategory
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode
- type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationType
- type CardAuthorizationSimulationPendingTransactionSourceCategory
- type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction
- type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency
- type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction
- type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency
- type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold
- type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency
- type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus
- type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldType
- type CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction
- type CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction
- type CardAuthorizationSimulationPendingTransactionStatus
- type CardAuthorizationSimulationPendingTransactionType
- type CardAuthorizationSimulationType
- type CardBillingAddress
- type CardDetails
- type CardDetailsType
- type CardDigitalWallet
- type CardDispute
- type CardDisputeAcceptance
- type CardDisputeListParams
- type CardDisputeListParamsCreatedAt
- type CardDisputeListParamsStatus
- type CardDisputeListParamsStatusIn
- type CardDisputeNewParams
- type CardDisputeRejection
- type CardDisputeService
- func (r *CardDisputeService) Get(ctx context.Context, cardDisputeID string, opts ...option.RequestOption) (res *CardDispute, err error)
- func (r *CardDisputeService) List(ctx context.Context, query CardDisputeListParams, opts ...option.RequestOption) (res *shared.Page[CardDispute], err error)
- func (r *CardDisputeService) ListAutoPaging(ctx context.Context, query CardDisputeListParams, opts ...option.RequestOption) *shared.PageAutoPager[CardDispute]
- func (r *CardDisputeService) New(ctx context.Context, body CardDisputeNewParams, opts ...option.RequestOption) (res *CardDispute, err error)
- type CardDisputeStatus
- type CardDisputeType
- type CardListParams
- type CardListParamsCreatedAt
- type CardNewParams
- type CardNewParamsBillingAddress
- type CardNewParamsDigitalWallet
- type CardProfile
- type CardProfileDigitalWallets
- type CardProfileDigitalWalletsTextColor
- type CardProfileListParams
- type CardProfileListParamsPhysicalCardsStatus
- type CardProfileListParamsPhysicalCardsStatusIn
- type CardProfileListParamsStatus
- type CardProfileListParamsStatusIn
- type CardProfileNewParams
- type CardProfileNewParamsDigitalWallets
- type CardProfileNewParamsDigitalWalletsTextColor
- type CardProfileNewParamsPhysicalCards
- type CardProfilePhysicalCards
- type CardProfilePhysicalCardsStatus
- type CardProfileService
- func (r *CardProfileService) Archive(ctx context.Context, cardProfileID string, opts ...option.RequestOption) (res *CardProfile, err error)
- func (r *CardProfileService) Get(ctx context.Context, cardProfileID string, opts ...option.RequestOption) (res *CardProfile, err error)
- func (r *CardProfileService) List(ctx context.Context, query CardProfileListParams, opts ...option.RequestOption) (res *shared.Page[CardProfile], err error)
- func (r *CardProfileService) ListAutoPaging(ctx context.Context, query CardProfileListParams, opts ...option.RequestOption) *shared.PageAutoPager[CardProfile]
- func (r *CardProfileService) New(ctx context.Context, body CardProfileNewParams, opts ...option.RequestOption) (res *CardProfile, err error)
- type CardProfileStatus
- type CardProfileType
- type CardPurchaseSupplement
- type CardPurchaseSupplementInvoice
- type CardPurchaseSupplementInvoiceDiscountTreatmentCode
- type CardPurchaseSupplementInvoiceTaxTreatments
- type CardPurchaseSupplementLineItem
- type CardPurchaseSupplementLineItemsDetailIndicator
- type CardPurchaseSupplementLineItemsDiscountTreatmentCode
- type CardPurchaseSupplementListParams
- type CardPurchaseSupplementListParamsCreatedAt
- type CardPurchaseSupplementService
- func (r *CardPurchaseSupplementService) Get(ctx context.Context, cardPurchaseSupplementID string, ...) (res *CardPurchaseSupplement, err error)
- func (r *CardPurchaseSupplementService) List(ctx context.Context, query CardPurchaseSupplementListParams, ...) (res *shared.Page[CardPurchaseSupplement], err error)
- func (r *CardPurchaseSupplementService) ListAutoPaging(ctx context.Context, query CardPurchaseSupplementListParams, ...) *shared.PageAutoPager[CardPurchaseSupplement]
- type CardPurchaseSupplementType
- type CardService
- func (r *CardService) Get(ctx context.Context, cardID string, opts ...option.RequestOption) (res *Card, err error)
- func (r *CardService) GetSensitiveDetails(ctx context.Context, cardID string, opts ...option.RequestOption) (res *CardDetails, err error)
- func (r *CardService) List(ctx context.Context, query CardListParams, opts ...option.RequestOption) (res *shared.Page[Card], err error)
- func (r *CardService) ListAutoPaging(ctx context.Context, query CardListParams, opts ...option.RequestOption) *shared.PageAutoPager[Card]
- func (r *CardService) New(ctx context.Context, body CardNewParams, opts ...option.RequestOption) (res *Card, err error)
- func (r *CardService) Update(ctx context.Context, cardID string, body CardUpdateParams, ...) (res *Card, err error)
- type CardStatus
- type CardType
- type CardUpdateParams
- type CardUpdateParamsBillingAddress
- type CardUpdateParamsDigitalWallet
- type CardUpdateParamsStatus
- type CheckDeposit
- type CheckDepositCurrency
- type CheckDepositDepositAcceptance
- type CheckDepositDepositAcceptanceCurrency
- type CheckDepositDepositRejection
- type CheckDepositDepositRejectionCurrency
- type CheckDepositDepositRejectionReason
- type CheckDepositDepositReturn
- type CheckDepositDepositReturnCurrency
- type CheckDepositDepositReturnReturnReason
- type CheckDepositListParams
- type CheckDepositListParamsCreatedAt
- type CheckDepositNewParams
- type CheckDepositService
- func (r *CheckDepositService) Get(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
- func (r *CheckDepositService) List(ctx context.Context, query CheckDepositListParams, ...) (res *shared.Page[CheckDeposit], err error)
- func (r *CheckDepositService) ListAutoPaging(ctx context.Context, query CheckDepositListParams, ...) *shared.PageAutoPager[CheckDeposit]
- func (r *CheckDepositService) New(ctx context.Context, body CheckDepositNewParams, opts ...option.RequestOption) (res *CheckDeposit, err error)
- type CheckDepositStatus
- type CheckDepositType
- type CheckTransfer
- type CheckTransferApproval
- type CheckTransferCancellation
- type CheckTransferCurrency
- type CheckTransferDeposit
- type CheckTransferDepositType
- type CheckTransferFulfillmentMethod
- type CheckTransferListParams
- type CheckTransferListParamsCreatedAt
- type CheckTransferMailing
- type CheckTransferNewParams
- type CheckTransferNewParamsFulfillmentMethod
- type CheckTransferNewParamsPhysicalCheck
- type CheckTransferNewParamsPhysicalCheckMailingAddress
- type CheckTransferNewParamsPhysicalCheckReturnAddress
- type CheckTransferPhysicalCheck
- type CheckTransferPhysicalCheckMailingAddress
- type CheckTransferPhysicalCheckReturnAddress
- type CheckTransferService
- func (r *CheckTransferService) Approve(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
- func (r *CheckTransferService) Cancel(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
- func (r *CheckTransferService) Get(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
- func (r *CheckTransferService) List(ctx context.Context, query CheckTransferListParams, ...) (res *shared.Page[CheckTransfer], err error)
- func (r *CheckTransferService) ListAutoPaging(ctx context.Context, query CheckTransferListParams, ...) *shared.PageAutoPager[CheckTransfer]
- func (r *CheckTransferService) New(ctx context.Context, body CheckTransferNewParams, opts ...option.RequestOption) (res *CheckTransfer, err error)
- func (r *CheckTransferService) StopPayment(ctx context.Context, checkTransferID string, ...) (res *CheckTransfer, err error)
- type CheckTransferStatus
- type CheckTransferStopPaymentParams
- type CheckTransferStopPaymentParamsReason
- type CheckTransferStopPaymentRequest
- type CheckTransferStopPaymentRequestReason
- type CheckTransferStopPaymentRequestType
- type CheckTransferSubmission
- type CheckTransferType
- type Client
- type DeclinedTransaction
- type DeclinedTransactionCurrency
- type DeclinedTransactionListParams
- type DeclinedTransactionListParamsCategory
- type DeclinedTransactionListParamsCategoryIn
- type DeclinedTransactionListParamsCreatedAt
- type DeclinedTransactionRouteType
- type DeclinedTransactionService
- func (r *DeclinedTransactionService) Get(ctx context.Context, declinedTransactionID string, ...) (res *DeclinedTransaction, err error)
- func (r *DeclinedTransactionService) List(ctx context.Context, query DeclinedTransactionListParams, ...) (res *shared.Page[DeclinedTransaction], err error)
- func (r *DeclinedTransactionService) ListAutoPaging(ctx context.Context, query DeclinedTransactionListParams, ...) *shared.PageAutoPager[DeclinedTransaction]
- type DeclinedTransactionSource
- type DeclinedTransactionSourceACHDecline
- type DeclinedTransactionSourceACHDeclineReason
- type DeclinedTransactionSourceACHDeclineType
- type DeclinedTransactionSourceCardDecline
- type DeclinedTransactionSourceCardDeclineCurrency
- type DeclinedTransactionSourceCardDeclineNetworkDetails
- type DeclinedTransactionSourceCardDeclineNetworkDetailsCategory
- type DeclinedTransactionSourceCardDeclineNetworkDetailsVisa
- type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator
- type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode
- type DeclinedTransactionSourceCardDeclineReason
- type DeclinedTransactionSourceCategory
- type DeclinedTransactionSourceCheckDecline
- type DeclinedTransactionSourceCheckDeclineReason
- type DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline
- type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency
- type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason
- type DeclinedTransactionSourceInternationalACHDecline
- type DeclinedTransactionSourceWireDecline
- type DeclinedTransactionSourceWireDeclineReason
- type DeclinedTransactionType
- type DigitalWalletToken
- type DigitalWalletTokenListParams
- type DigitalWalletTokenListParamsCreatedAt
- type DigitalWalletTokenService
- func (r *DigitalWalletTokenService) Get(ctx context.Context, digitalWalletTokenID string, opts ...option.RequestOption) (res *DigitalWalletToken, err error)
- func (r *DigitalWalletTokenService) List(ctx context.Context, query DigitalWalletTokenListParams, ...) (res *shared.Page[DigitalWalletToken], err error)
- func (r *DigitalWalletTokenService) ListAutoPaging(ctx context.Context, query DigitalWalletTokenListParams, ...) *shared.PageAutoPager[DigitalWalletToken]
- type DigitalWalletTokenStatus
- type DigitalWalletTokenTokenRequestor
- type DigitalWalletTokenType
- type Document
- type DocumentCategory
- type DocumentListParams
- type DocumentListParamsCategory
- type DocumentListParamsCategoryIn
- type DocumentListParamsCreatedAt
- type DocumentService
- func (r *DocumentService) Get(ctx context.Context, documentID string, opts ...option.RequestOption) (res *Document, err error)
- func (r *DocumentService) List(ctx context.Context, query DocumentListParams, opts ...option.RequestOption) (res *shared.Page[Document], err error)
- func (r *DocumentService) ListAutoPaging(ctx context.Context, query DocumentListParams, opts ...option.RequestOption) *shared.PageAutoPager[Document]
- type DocumentType
- type Entity
- type EntityBeneficialOwnerArchiveParams
- type EntityBeneficialOwnerNewParams
- type EntityBeneficialOwnerNewParamsBeneficialOwner
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther
- type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport
- type EntityBeneficialOwnerNewParamsBeneficialOwnerProng
- type EntityBeneficialOwnerService
- type EntityCorporation
- type EntityCorporationAddress
- type EntityCorporationBeneficialOwner
- type EntityCorporationBeneficialOwnersIndividual
- type EntityCorporationBeneficialOwnersIndividualAddress
- type EntityCorporationBeneficialOwnersIndividualIdentification
- type EntityCorporationBeneficialOwnersIndividualIdentificationMethod
- type EntityCorporationBeneficialOwnersProng
- type EntityJoint
- type EntityJointIndividual
- type EntityJointIndividualsAddress
- type EntityJointIndividualsIdentification
- type EntityJointIndividualsIdentificationMethod
- type EntityListParams
- type EntityListParamsCreatedAt
- type EntityNaturalPerson
- type EntityNaturalPersonAddress
- type EntityNaturalPersonIdentification
- type EntityNaturalPersonIdentificationMethod
- type EntityNewParams
- type EntityNewParamsCorporation
- type EntityNewParamsCorporationAddress
- type EntityNewParamsCorporationBeneficialOwner
- type EntityNewParamsCorporationBeneficialOwnersIndividual
- type EntityNewParamsCorporationBeneficialOwnersIndividualAddress
- type EntityNewParamsCorporationBeneficialOwnersIndividualIdentification
- type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense
- type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod
- type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther
- type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport
- type EntityNewParamsCorporationBeneficialOwnersProng
- type EntityNewParamsJoint
- type EntityNewParamsJointIndividual
- type EntityNewParamsJointIndividualsAddress
- type EntityNewParamsJointIndividualsIdentification
- type EntityNewParamsJointIndividualsIdentificationDriversLicense
- type EntityNewParamsJointIndividualsIdentificationMethod
- type EntityNewParamsJointIndividualsIdentificationOther
- type EntityNewParamsJointIndividualsIdentificationPassport
- type EntityNewParamsNaturalPerson
- type EntityNewParamsNaturalPersonAddress
- type EntityNewParamsNaturalPersonIdentification
- type EntityNewParamsNaturalPersonIdentificationDriversLicense
- type EntityNewParamsNaturalPersonIdentificationMethod
- type EntityNewParamsNaturalPersonIdentificationOther
- type EntityNewParamsNaturalPersonIdentificationPassport
- type EntityNewParamsRelationship
- type EntityNewParamsStructure
- type EntityNewParamsSupplementalDocument
- type EntityNewParamsTrust
- type EntityNewParamsTrustAddress
- type EntityNewParamsTrustCategory
- type EntityNewParamsTrustGrantor
- type EntityNewParamsTrustGrantorAddress
- type EntityNewParamsTrustGrantorIdentification
- type EntityNewParamsTrustGrantorIdentificationDriversLicense
- type EntityNewParamsTrustGrantorIdentificationMethod
- type EntityNewParamsTrustGrantorIdentificationOther
- type EntityNewParamsTrustGrantorIdentificationPassport
- type EntityNewParamsTrustTrustee
- type EntityNewParamsTrustTrusteesIndividual
- type EntityNewParamsTrustTrusteesIndividualAddress
- type EntityNewParamsTrustTrusteesIndividualIdentification
- type EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense
- type EntityNewParamsTrustTrusteesIndividualIdentificationMethod
- type EntityNewParamsTrustTrusteesIndividualIdentificationOther
- type EntityNewParamsTrustTrusteesIndividualIdentificationPassport
- type EntityNewParamsTrustTrusteesStructure
- type EntityRelationship
- type EntityService
- func (r *EntityService) Archive(ctx context.Context, entityID string, opts ...option.RequestOption) (res *Entity, err error)
- func (r *EntityService) Get(ctx context.Context, entityID string, opts ...option.RequestOption) (res *Entity, err error)
- func (r *EntityService) List(ctx context.Context, query EntityListParams, opts ...option.RequestOption) (res *shared.Page[Entity], err error)
- func (r *EntityService) ListAutoPaging(ctx context.Context, query EntityListParams, opts ...option.RequestOption) *shared.PageAutoPager[Entity]
- func (r *EntityService) New(ctx context.Context, body EntityNewParams, opts ...option.RequestOption) (res *Entity, err error)
- type EntityStructure
- type EntitySupplementalDocument
- type EntitySupplementalDocumentListParams
- type EntitySupplementalDocumentNewParams
- type EntitySupplementalDocumentService
- func (r *EntitySupplementalDocumentService) List(ctx context.Context, query EntitySupplementalDocumentListParams, ...) (res *shared.Page[SupplementalDocument], err error)
- func (r *EntitySupplementalDocumentService) ListAutoPaging(ctx context.Context, query EntitySupplementalDocumentListParams, ...) *shared.PageAutoPager[SupplementalDocument]
- func (r *EntitySupplementalDocumentService) New(ctx context.Context, entityID string, body EntitySupplementalDocumentNewParams, ...) (res *Entity, err error)
- type EntitySupplementalDocumentsType
- type EntityTrust
- type EntityTrustAddress
- type EntityTrustCategory
- type EntityTrustGrantor
- type EntityTrustGrantorAddress
- type EntityTrustGrantorIdentification
- type EntityTrustGrantorIdentificationMethod
- type EntityTrustTrustee
- type EntityTrustTrusteesIndividual
- type EntityTrustTrusteesIndividualAddress
- type EntityTrustTrusteesIndividualIdentification
- type EntityTrustTrusteesIndividualIdentificationMethod
- type EntityTrustTrusteesStructure
- type EntityType
- type Error
- type Event
- type EventCategory
- type EventListParams
- type EventListParamsCategory
- type EventListParamsCategoryIn
- type EventListParamsCreatedAt
- type EventService
- func (r *EventService) Get(ctx context.Context, eventID string, opts ...option.RequestOption) (res *Event, err error)
- func (r *EventService) List(ctx context.Context, query EventListParams, opts ...option.RequestOption) (res *shared.Page[Event], err error)
- func (r *EventService) ListAutoPaging(ctx context.Context, query EventListParams, opts ...option.RequestOption) *shared.PageAutoPager[Event]
- type EventSubscription
- type EventSubscriptionListParams
- type EventSubscriptionNewParams
- type EventSubscriptionNewParamsSelectedEventCategory
- type EventSubscriptionSelectedEventCategory
- type EventSubscriptionService
- func (r *EventSubscriptionService) Get(ctx context.Context, eventSubscriptionID string, opts ...option.RequestOption) (res *EventSubscription, err error)
- func (r *EventSubscriptionService) List(ctx context.Context, query EventSubscriptionListParams, ...) (res *shared.Page[EventSubscription], err error)
- func (r *EventSubscriptionService) ListAutoPaging(ctx context.Context, query EventSubscriptionListParams, ...) *shared.PageAutoPager[EventSubscription]
- func (r *EventSubscriptionService) New(ctx context.Context, body EventSubscriptionNewParams, ...) (res *EventSubscription, err error)
- func (r *EventSubscriptionService) Update(ctx context.Context, eventSubscriptionID string, ...) (res *EventSubscription, err error)
- type EventSubscriptionStatus
- type EventSubscriptionType
- type EventSubscriptionUpdateParams
- type EventSubscriptionUpdateParamsStatus
- type EventType
- type Export
- type ExportCategory
- type ExportListParams
- type ExportNewParams
- type ExportNewParamsBalanceCsv
- type ExportNewParamsBalanceCsvCreatedAt
- type ExportNewParamsCategory
- type ExportNewParamsTransactionCsv
- type ExportNewParamsTransactionCsvCreatedAt
- type ExportService
- func (r *ExportService) Get(ctx context.Context, exportID string, opts ...option.RequestOption) (res *Export, err error)
- func (r *ExportService) List(ctx context.Context, query ExportListParams, opts ...option.RequestOption) (res *shared.Page[Export], err error)
- func (r *ExportService) ListAutoPaging(ctx context.Context, query ExportListParams, opts ...option.RequestOption) *shared.PageAutoPager[Export]
- func (r *ExportService) New(ctx context.Context, body ExportNewParams, opts ...option.RequestOption) (res *Export, err error)
- type ExportStatus
- type ExportType
- type ExternalAccount
- type ExternalAccountFunding
- type ExternalAccountListParams
- type ExternalAccountListParamsStatus
- type ExternalAccountListParamsStatusIn
- type ExternalAccountNewParams
- type ExternalAccountNewParamsFunding
- type ExternalAccountService
- func (r *ExternalAccountService) Get(ctx context.Context, externalAccountID string, opts ...option.RequestOption) (res *ExternalAccount, err error)
- func (r *ExternalAccountService) List(ctx context.Context, query ExternalAccountListParams, ...) (res *shared.Page[ExternalAccount], err error)
- func (r *ExternalAccountService) ListAutoPaging(ctx context.Context, query ExternalAccountListParams, ...) *shared.PageAutoPager[ExternalAccount]
- func (r *ExternalAccountService) New(ctx context.Context, body ExternalAccountNewParams, ...) (res *ExternalAccount, err error)
- func (r *ExternalAccountService) Update(ctx context.Context, externalAccountID string, ...) (res *ExternalAccount, err error)
- type ExternalAccountStatus
- type ExternalAccountType
- type ExternalAccountUpdateParams
- type ExternalAccountUpdateParamsStatus
- type ExternalAccountVerificationStatus
- type File
- type FileDirection
- type FileListParams
- type FileListParamsCreatedAt
- type FileListParamsPurpose
- type FileListParamsPurposeIn
- type FileNewParams
- type FileNewParamsPurpose
- type FilePurpose
- type FileService
- func (r *FileService) Get(ctx context.Context, fileID string, opts ...option.RequestOption) (res *File, err error)
- func (r *FileService) List(ctx context.Context, query FileListParams, opts ...option.RequestOption) (res *shared.Page[File], err error)
- func (r *FileService) ListAutoPaging(ctx context.Context, query FileListParams, opts ...option.RequestOption) *shared.PageAutoPager[File]
- func (r *FileService) New(ctx context.Context, body FileNewParams, opts ...option.RequestOption) (res *File, err error)
- type FileType
- type Group
- type GroupACHDebitStatus
- type GroupActivationStatus
- type GroupService
- type GroupType
- type InboundACHTransfer
- type InboundACHTransferAcceptance
- type InboundACHTransferDecline
- type InboundACHTransferDeclineReason
- type InboundACHTransferDirection
- type InboundACHTransferListParams
- type InboundACHTransferListParamsCreatedAt
- type InboundACHTransferListParamsStatus
- type InboundACHTransferService
- func (r *InboundACHTransferService) Decline(ctx context.Context, inboundACHTransferID string, opts ...option.RequestOption) (res *InboundACHTransfer, err error)
- func (r *InboundACHTransferService) Get(ctx context.Context, inboundACHTransferID string, opts ...option.RequestOption) (res *InboundACHTransfer, err error)
- func (r *InboundACHTransferService) List(ctx context.Context, query InboundACHTransferListParams, ...) (res *shared.Page[InboundACHTransfer], err error)
- func (r *InboundACHTransferService) ListAutoPaging(ctx context.Context, query InboundACHTransferListParams, ...) *shared.PageAutoPager[InboundACHTransfer]
- func (r *InboundACHTransferService) TransferReturn(ctx context.Context, inboundACHTransferID string, ...) (res *InboundACHTransfer, err error)
- type InboundACHTransferStatus
- type InboundACHTransferTransferReturn
- type InboundACHTransferTransferReturnParams
- type InboundACHTransferTransferReturnParamsReason
- type InboundACHTransferTransferReturnReason
- type InboundACHTransferType
- type InboundRealTimePaymentsTransferSimulationResult
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineType
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategory
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason
- type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionType
- type InboundRealTimePaymentsTransferSimulationResultTransaction
- type InboundRealTimePaymentsTransferSimulationResultTransactionCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionRouteType
- type InboundRealTimePaymentsTransferSimulationResultTransactionSource
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundType
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementType
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositType
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestType
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention
- type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection
- type InboundRealTimePaymentsTransferSimulationResultTransactionType
- type InboundRealTimePaymentsTransferSimulationResultType
- type InboundWireDrawdownRequest
- type InboundWireDrawdownRequestListParams
- type InboundWireDrawdownRequestService
- func (r *InboundWireDrawdownRequestService) Get(ctx context.Context, inboundWireDrawdownRequestID string, ...) (res *InboundWireDrawdownRequest, err error)
- func (r *InboundWireDrawdownRequestService) List(ctx context.Context, query InboundWireDrawdownRequestListParams, ...) (res *shared.Page[InboundWireDrawdownRequest], err error)
- func (r *InboundWireDrawdownRequestService) ListAutoPaging(ctx context.Context, query InboundWireDrawdownRequestListParams, ...) *shared.PageAutoPager[InboundWireDrawdownRequest]
- type InboundWireDrawdownRequestType
- type InterestPaymentSimulationResult
- type InterestPaymentSimulationResultTransaction
- type InterestPaymentSimulationResultTransactionCurrency
- type InterestPaymentSimulationResultTransactionRouteType
- type InterestPaymentSimulationResultTransactionSource
- type InterestPaymentSimulationResultTransactionSourceACHTransferIntention
- type InterestPaymentSimulationResultTransactionSourceACHTransferRejection
- type InterestPaymentSimulationResultTransactionSourceACHTransferReturn
- type InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode
- type InterestPaymentSimulationResultTransactionSourceAccountTransferIntention
- type InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency
- type InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance
- type InterestPaymentSimulationResultTransactionSourceCardRefund
- type InterestPaymentSimulationResultTransactionSourceCardRefundCurrency
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg
- type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode
- type InterestPaymentSimulationResultTransactionSourceCardRefundType
- type InterestPaymentSimulationResultTransactionSourceCardRevenuePayment
- type InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency
- type InterestPaymentSimulationResultTransactionSourceCardSettlement
- type InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg
- type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode
- type InterestPaymentSimulationResultTransactionSourceCardSettlementType
- type InterestPaymentSimulationResultTransactionSourceCategory
- type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance
- type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency
- type InterestPaymentSimulationResultTransactionSourceCheckDepositReturn
- type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency
- type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason
- type InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit
- type InterestPaymentSimulationResultTransactionSourceCheckTransferDepositType
- type InterestPaymentSimulationResultTransactionSourceCheckTransferIntention
- type InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency
- type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest
- type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason
- type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestType
- type InterestPaymentSimulationResultTransactionSourceFeePayment
- type InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency
- type InterestPaymentSimulationResultTransactionSourceInboundACHTransfer
- type InterestPaymentSimulationResultTransactionSourceInboundCheck
- type InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency
- type InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer
- type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation
- type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency
- type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment
- type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal
- type InterestPaymentSimulationResultTransactionSourceInboundWireReversal
- type InterestPaymentSimulationResultTransactionSourceInboundWireTransfer
- type InterestPaymentSimulationResultTransactionSourceInterestPayment
- type InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency
- type InterestPaymentSimulationResultTransactionSourceInternalSource
- type InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency
- type InterestPaymentSimulationResultTransactionSourceInternalSourceReason
- type InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement
- type InterestPaymentSimulationResultTransactionSourceSampleFunds
- type InterestPaymentSimulationResultTransactionSourceWireTransferIntention
- type InterestPaymentSimulationResultTransactionSourceWireTransferRejection
- type InterestPaymentSimulationResultTransactionType
- type InterestPaymentSimulationResultType
- type Limit
- type LimitInterval
- type LimitListParams
- type LimitMetric
- type LimitModelType
- type LimitNewParams
- type LimitNewParamsInterval
- type LimitNewParamsMetric
- type LimitService
- func (r *LimitService) Get(ctx context.Context, limitID string, opts ...option.RequestOption) (res *Limit, err error)
- func (r *LimitService) List(ctx context.Context, query LimitListParams, opts ...option.RequestOption) (res *shared.Page[Limit], err error)
- func (r *LimitService) ListAutoPaging(ctx context.Context, query LimitListParams, opts ...option.RequestOption) *shared.PageAutoPager[Limit]
- func (r *LimitService) New(ctx context.Context, body LimitNewParams, opts ...option.RequestOption) (res *Limit, err error)
- func (r *LimitService) Update(ctx context.Context, limitID string, body LimitUpdateParams, ...) (res *Limit, err error)
- type LimitStatus
- type LimitType
- type LimitUpdateParams
- type LimitUpdateParamsStatus
- type OauthConnection
- type OauthConnectionListParams
- type OauthConnectionService
- func (r *OauthConnectionService) Get(ctx context.Context, oauthConnectionID string, opts ...option.RequestOption) (res *OauthConnection, err error)
- func (r *OauthConnectionService) List(ctx context.Context, query OauthConnectionListParams, ...) (res *shared.Page[OauthConnection], err error)
- func (r *OauthConnectionService) ListAutoPaging(ctx context.Context, query OauthConnectionListParams, ...) *shared.PageAutoPager[OauthConnection]
- type OauthConnectionStatus
- type OauthConnectionType
- type PendingTransaction
- type PendingTransactionCurrency
- type PendingTransactionListParams
- type PendingTransactionListParamsCategory
- type PendingTransactionListParamsCategoryIn
- type PendingTransactionListParamsCreatedAt
- type PendingTransactionListParamsStatus
- type PendingTransactionListParamsStatusIn
- type PendingTransactionRouteType
- type PendingTransactionService
- func (r *PendingTransactionService) Get(ctx context.Context, pendingTransactionID string, opts ...option.RequestOption) (res *PendingTransaction, err error)
- func (r *PendingTransactionService) List(ctx context.Context, query PendingTransactionListParams, ...) (res *shared.Page[PendingTransaction], err error)
- func (r *PendingTransactionService) ListAutoPaging(ctx context.Context, query PendingTransactionListParams, ...) *shared.PageAutoPager[PendingTransaction]
- type PendingTransactionSource
- type PendingTransactionSourceACHTransferInstruction
- type PendingTransactionSourceAccountTransferInstruction
- type PendingTransactionSourceAccountTransferInstructionCurrency
- type PendingTransactionSourceCardAuthorization
- type PendingTransactionSourceCardAuthorizationCurrency
- type PendingTransactionSourceCardAuthorizationNetworkDetails
- type PendingTransactionSourceCardAuthorizationNetworkDetailsCategory
- type PendingTransactionSourceCardAuthorizationNetworkDetailsVisa
- type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator
- type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode
- type PendingTransactionSourceCardAuthorizationType
- type PendingTransactionSourceCategory
- type PendingTransactionSourceCheckDepositInstruction
- type PendingTransactionSourceCheckDepositInstructionCurrency
- type PendingTransactionSourceCheckTransferInstruction
- type PendingTransactionSourceCheckTransferInstructionCurrency
- type PendingTransactionSourceInboundFundsHold
- type PendingTransactionSourceInboundFundsHoldCurrency
- type PendingTransactionSourceInboundFundsHoldStatus
- type PendingTransactionSourceInboundFundsHoldType
- type PendingTransactionSourceRealTimePaymentsTransferInstruction
- type PendingTransactionSourceWireTransferInstruction
- type PendingTransactionStatus
- type PendingTransactionType
- type Program
- type ProgramListParams
- type ProgramService
- func (r *ProgramService) Get(ctx context.Context, programID string, opts ...option.RequestOption) (res *Program, err error)
- func (r *ProgramService) List(ctx context.Context, query ProgramListParams, opts ...option.RequestOption) (res *shared.Page[Program], err error)
- func (r *ProgramService) ListAutoPaging(ctx context.Context, query ProgramListParams, opts ...option.RequestOption) *shared.PageAutoPager[Program]
- type ProgramType
- type RealTimeDecision
- type RealTimeDecisionActionParams
- type RealTimeDecisionActionParamsCardAuthorization
- type RealTimeDecisionActionParamsCardAuthorizationDecision
- type RealTimeDecisionActionParamsDigitalWalletAuthentication
- type RealTimeDecisionActionParamsDigitalWalletAuthenticationResult
- type RealTimeDecisionActionParamsDigitalWalletToken
- type RealTimeDecisionActionParamsDigitalWalletTokenApproval
- type RealTimeDecisionActionParamsDigitalWalletTokenDecline
- type RealTimeDecisionCardAuthorization
- type RealTimeDecisionCardAuthorizationDecision
- type RealTimeDecisionCardAuthorizationNetworkDetails
- type RealTimeDecisionCardAuthorizationNetworkDetailsCategory
- type RealTimeDecisionCardAuthorizationNetworkDetailsVisa
- type RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator
- type RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode
- type RealTimeDecisionCardAuthorizationRequestDetails
- type RealTimeDecisionCardAuthorizationRequestDetailsCategory
- type RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization
- type RealTimeDecisionCategory
- type RealTimeDecisionDigitalWalletAuthentication
- type RealTimeDecisionDigitalWalletAuthenticationChannel
- type RealTimeDecisionDigitalWalletAuthenticationDigitalWallet
- type RealTimeDecisionDigitalWalletAuthenticationResult
- type RealTimeDecisionDigitalWalletToken
- type RealTimeDecisionDigitalWalletTokenDecision
- type RealTimeDecisionDigitalWalletTokenDigitalWallet
- type RealTimeDecisionService
- type RealTimeDecisionStatus
- type RealTimeDecisionType
- type RealTimePaymentsTransfer
- type RealTimePaymentsTransferApproval
- type RealTimePaymentsTransferCancellation
- type RealTimePaymentsTransferCurrency
- type RealTimePaymentsTransferListParams
- type RealTimePaymentsTransferListParamsCreatedAt
- type RealTimePaymentsTransferNewParams
- type RealTimePaymentsTransferRejection
- type RealTimePaymentsTransferRejectionRejectReasonCode
- type RealTimePaymentsTransferService
- func (r *RealTimePaymentsTransferService) Get(ctx context.Context, realTimePaymentsTransferID string, ...) (res *RealTimePaymentsTransfer, err error)
- func (r *RealTimePaymentsTransferService) List(ctx context.Context, query RealTimePaymentsTransferListParams, ...) (res *shared.Page[RealTimePaymentsTransfer], err error)
- func (r *RealTimePaymentsTransferService) ListAutoPaging(ctx context.Context, query RealTimePaymentsTransferListParams, ...) *shared.PageAutoPager[RealTimePaymentsTransfer]
- func (r *RealTimePaymentsTransferService) New(ctx context.Context, body RealTimePaymentsTransferNewParams, ...) (res *RealTimePaymentsTransfer, err error)
- type RealTimePaymentsTransferStatus
- type RealTimePaymentsTransferSubmission
- type RealTimePaymentsTransferType
- type RoutingNumber
- type RoutingNumberACHTransfers
- type RoutingNumberListParams
- type RoutingNumberRealTimePaymentsTransfers
- type RoutingNumberService
- type RoutingNumberType
- type RoutingNumberWireTransfers
- type SimulationACHTransferNewInboundParams
- type SimulationACHTransferReturnParams
- type SimulationACHTransferReturnParamsReason
- type SimulationACHTransferService
- func (r *SimulationACHTransferService) NewInbound(ctx context.Context, body SimulationACHTransferNewInboundParams, ...) (res *ACHTransferSimulation, err error)
- func (r *SimulationACHTransferService) Return(ctx context.Context, achTransferID string, ...) (res *ACHTransfer, err error)
- func (r *SimulationACHTransferService) Submit(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
- type SimulationAccountStatementNewParams
- type SimulationAccountStatementService
- type SimulationAccountTransferService
- type SimulationCardAuthorizeParams
- type SimulationCardDisputeActionParams
- type SimulationCardDisputeActionParamsStatus
- type SimulationCardDisputeService
- type SimulationCardProfileService
- type SimulationCardRefundNewParams
- type SimulationCardRefundService
- type SimulationCardService
- type SimulationCardSettlementParams
- type SimulationCheckDepositService
- func (r *SimulationCheckDepositService) Reject(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
- func (r *SimulationCheckDepositService) Return(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
- func (r *SimulationCheckDepositService) Submit(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
- type SimulationCheckTransferService
- func (r *SimulationCheckTransferService) Deposit(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
- func (r *SimulationCheckTransferService) Mail(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
- type SimulationDigitalWalletTokenRequestNewParams
- type SimulationDigitalWalletTokenRequestNewResponse
- type SimulationDigitalWalletTokenRequestNewResponseDeclineReason
- type SimulationDigitalWalletTokenRequestNewResponseType
- type SimulationDigitalWalletTokenRequestService
- type SimulationDocumentNewParams
- type SimulationDocumentService
- type SimulationInboundFundsHoldReleaseResponse
- type SimulationInboundFundsHoldReleaseResponseCurrency
- type SimulationInboundFundsHoldReleaseResponseStatus
- type SimulationInboundFundsHoldReleaseResponseType
- type SimulationInboundFundsHoldService
- type SimulationInboundWireDrawdownRequestNewParams
- type SimulationInboundWireDrawdownRequestService
- type SimulationInterestPaymentNewParams
- type SimulationInterestPaymentService
- type SimulationProgramNewParams
- type SimulationProgramService
- type SimulationRealTimePaymentsTransferCompleteParams
- type SimulationRealTimePaymentsTransferCompleteParamsRejection
- type SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode
- type SimulationRealTimePaymentsTransferNewInboundParams
- type SimulationRealTimePaymentsTransferService
- func (r *SimulationRealTimePaymentsTransferService) Complete(ctx context.Context, realTimePaymentsTransferID string, ...) (res *RealTimePaymentsTransfer, err error)
- func (r *SimulationRealTimePaymentsTransferService) NewInbound(ctx context.Context, body SimulationRealTimePaymentsTransferNewInboundParams, ...) (res *InboundRealTimePaymentsTransferSimulationResult, err error)
- type SimulationService
- type SimulationWireTransferNewInboundParams
- type SimulationWireTransferService
- type SupplementalDocument
- type SupplementalDocumentType
- type Transaction
- type TransactionCurrency
- type TransactionListParams
- type TransactionListParamsCategory
- type TransactionListParamsCategoryIn
- type TransactionListParamsCreatedAt
- type TransactionRouteType
- type TransactionService
- func (r *TransactionService) Get(ctx context.Context, transactionID string, opts ...option.RequestOption) (res *Transaction, err error)
- func (r *TransactionService) List(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) (res *shared.Page[Transaction], err error)
- func (r *TransactionService) ListAutoPaging(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) *shared.PageAutoPager[Transaction]
- type TransactionSource
- type TransactionSourceACHTransferIntention
- type TransactionSourceACHTransferRejection
- type TransactionSourceACHTransferReturn
- type TransactionSourceACHTransferReturnReturnReasonCode
- type TransactionSourceAccountTransferIntention
- type TransactionSourceAccountTransferIntentionCurrency
- type TransactionSourceCardDisputeAcceptance
- type TransactionSourceCardRefund
- type TransactionSourceCardRefundCurrency
- type TransactionSourceCardRefundPurchaseDetails
- type TransactionSourceCardRefundPurchaseDetailsCarRental
- type TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges
- type TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator
- type TransactionSourceCardRefundPurchaseDetailsLodging
- type TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges
- type TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator
- type TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat
- type TransactionSourceCardRefundPurchaseDetailsTravel
- type TransactionSourceCardRefundPurchaseDetailsTravelAncillary
- type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService
- type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory
- type TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator
- type TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator
- type TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator
- type TransactionSourceCardRefundPurchaseDetailsTravelTripLeg
- type TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode
- type TransactionSourceCardRefundType
- type TransactionSourceCardRevenuePayment
- type TransactionSourceCardRevenuePaymentCurrency
- type TransactionSourceCardSettlement
- type TransactionSourceCardSettlementCurrency
- type TransactionSourceCardSettlementPurchaseDetails
- type TransactionSourceCardSettlementPurchaseDetailsCarRental
- type TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges
- type TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator
- type TransactionSourceCardSettlementPurchaseDetailsLodging
- type TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges
- type TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator
- type TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat
- type TransactionSourceCardSettlementPurchaseDetailsTravel
- type TransactionSourceCardSettlementPurchaseDetailsTravelAncillary
- type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService
- type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory
- type TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator
- type TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator
- type TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator
- type TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg
- type TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode
- type TransactionSourceCardSettlementType
- type TransactionSourceCategory
- type TransactionSourceCheckDepositAcceptance
- type TransactionSourceCheckDepositAcceptanceCurrency
- type TransactionSourceCheckDepositReturn
- type TransactionSourceCheckDepositReturnCurrency
- type TransactionSourceCheckDepositReturnReturnReason
- type TransactionSourceCheckTransferDeposit
- type TransactionSourceCheckTransferDepositType
- type TransactionSourceCheckTransferIntention
- type TransactionSourceCheckTransferIntentionCurrency
- type TransactionSourceCheckTransferStopPaymentRequest
- type TransactionSourceCheckTransferStopPaymentRequestReason
- type TransactionSourceCheckTransferStopPaymentRequestType
- type TransactionSourceFeePayment
- type TransactionSourceFeePaymentCurrency
- type TransactionSourceInboundACHTransfer
- type TransactionSourceInboundCheck
- type TransactionSourceInboundCheckCurrency
- type TransactionSourceInboundInternationalACHTransfer
- type TransactionSourceInboundRealTimePaymentsTransferConfirmation
- type TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency
- type TransactionSourceInboundWireDrawdownPayment
- type TransactionSourceInboundWireDrawdownPaymentReversal
- type TransactionSourceInboundWireReversal
- type TransactionSourceInboundWireTransfer
- type TransactionSourceInterestPayment
- type TransactionSourceInterestPaymentCurrency
- type TransactionSourceInternalSource
- type TransactionSourceInternalSourceCurrency
- type TransactionSourceInternalSourceReason
- type TransactionSourceRealTimePaymentsTransferAcknowledgement
- type TransactionSourceSampleFunds
- type TransactionSourceWireTransferIntention
- type TransactionSourceWireTransferRejection
- type TransactionType
- type WireDrawdownRequest
- type WireDrawdownRequestListParams
- type WireDrawdownRequestNewParams
- type WireDrawdownRequestService
- func (r *WireDrawdownRequestService) Get(ctx context.Context, wireDrawdownRequestID string, ...) (res *WireDrawdownRequest, err error)
- func (r *WireDrawdownRequestService) List(ctx context.Context, query WireDrawdownRequestListParams, ...) (res *shared.Page[WireDrawdownRequest], err error)
- func (r *WireDrawdownRequestService) ListAutoPaging(ctx context.Context, query WireDrawdownRequestListParams, ...) *shared.PageAutoPager[WireDrawdownRequest]
- func (r *WireDrawdownRequestService) New(ctx context.Context, body WireDrawdownRequestNewParams, ...) (res *WireDrawdownRequest, err error)
- type WireDrawdownRequestStatus
- type WireDrawdownRequestSubmission
- type WireDrawdownRequestType
- type WireTransfer
- type WireTransferApproval
- type WireTransferCancellation
- type WireTransferCurrency
- type WireTransferListParams
- type WireTransferListParamsCreatedAt
- type WireTransferNetwork
- type WireTransferNewParams
- type WireTransferReversal
- type WireTransferService
- func (r *WireTransferService) Approve(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
- func (r *WireTransferService) Cancel(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
- func (r *WireTransferService) Get(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
- func (r *WireTransferService) List(ctx context.Context, query WireTransferListParams, ...) (res *shared.Page[WireTransfer], err error)
- func (r *WireTransferService) ListAutoPaging(ctx context.Context, query WireTransferListParams, ...) *shared.PageAutoPager[WireTransfer]
- func (r *WireTransferService) New(ctx context.Context, body WireTransferNewParams, opts ...option.RequestOption) (res *WireTransfer, err error)
- func (r *WireTransferService) Reverse(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
- func (r *WireTransferService) Submit(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
- type WireTransferSimulation
- type WireTransferSimulationTransaction
- type WireTransferSimulationTransactionCurrency
- type WireTransferSimulationTransactionRouteType
- type WireTransferSimulationTransactionSource
- type WireTransferSimulationTransactionSourceACHTransferIntention
- type WireTransferSimulationTransactionSourceACHTransferRejection
- type WireTransferSimulationTransactionSourceACHTransferReturn
- type WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode
- type WireTransferSimulationTransactionSourceAccountTransferIntention
- type WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency
- type WireTransferSimulationTransactionSourceCardDisputeAcceptance
- type WireTransferSimulationTransactionSourceCardRefund
- type WireTransferSimulationTransactionSourceCardRefundCurrency
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetails
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg
- type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode
- type WireTransferSimulationTransactionSourceCardRefundType
- type WireTransferSimulationTransactionSourceCardRevenuePayment
- type WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency
- type WireTransferSimulationTransactionSourceCardSettlement
- type WireTransferSimulationTransactionSourceCardSettlementCurrency
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg
- type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode
- type WireTransferSimulationTransactionSourceCardSettlementType
- type WireTransferSimulationTransactionSourceCategory
- type WireTransferSimulationTransactionSourceCheckDepositAcceptance
- type WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency
- type WireTransferSimulationTransactionSourceCheckDepositReturn
- type WireTransferSimulationTransactionSourceCheckDepositReturnCurrency
- type WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason
- type WireTransferSimulationTransactionSourceCheckTransferDeposit
- type WireTransferSimulationTransactionSourceCheckTransferDepositType
- type WireTransferSimulationTransactionSourceCheckTransferIntention
- type WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency
- type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest
- type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason
- type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType
- type WireTransferSimulationTransactionSourceFeePayment
- type WireTransferSimulationTransactionSourceFeePaymentCurrency
- type WireTransferSimulationTransactionSourceInboundACHTransfer
- type WireTransferSimulationTransactionSourceInboundCheck
- type WireTransferSimulationTransactionSourceInboundCheckCurrency
- type WireTransferSimulationTransactionSourceInboundInternationalACHTransfer
- type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation
- type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency
- type WireTransferSimulationTransactionSourceInboundWireDrawdownPayment
- type WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal
- type WireTransferSimulationTransactionSourceInboundWireReversal
- type WireTransferSimulationTransactionSourceInboundWireTransfer
- type WireTransferSimulationTransactionSourceInterestPayment
- type WireTransferSimulationTransactionSourceInterestPaymentCurrency
- type WireTransferSimulationTransactionSourceInternalSource
- type WireTransferSimulationTransactionSourceInternalSourceCurrency
- type WireTransferSimulationTransactionSourceInternalSourceReason
- type WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement
- type WireTransferSimulationTransactionSourceSampleFunds
- type WireTransferSimulationTransactionSourceWireTransferIntention
- type WireTransferSimulationTransactionSourceWireTransferRejection
- type WireTransferSimulationTransactionType
- type WireTransferSimulationType
- type WireTransferStatus
- type WireTransferSubmission
- type WireTransferType
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func F ¶
F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.
func Int ¶
Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.
func Raw ¶
Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).
Types ¶
type ACHPrenotification ¶
type ACHPrenotification struct {
// The ACH Prenotification's identifier.
ID string `json:"id,required"`
// The destination account number.
AccountNumber string `json:"account_number,required"`
// Additional information for the recipient.
Addendum string `json:"addendum,required,nullable"`
// The description of the date of the notification.
CompanyDescriptiveDate string `json:"company_descriptive_date,required,nullable"`
// Optional data associated with the notification.
CompanyDiscretionaryData string `json:"company_discretionary_data,required,nullable"`
// The description of the notification.
CompanyEntryDescription string `json:"company_entry_description,required,nullable"`
// The name by which you know the company.
CompanyName string `json:"company_name,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the prenotification was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// If the notification is for a future credit or debit.
CreditDebitIndicator ACHPrenotificationCreditDebitIndicator `json:"credit_debit_indicator,required,nullable"`
// The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
EffectiveDate time.Time `json:"effective_date,required,nullable" format:"date-time"`
// If the receiving bank notifies that future transfers should use different
// details, this will contain those details.
NotificationsOfChange []ACHPrenotificationNotificationsOfChange `json:"notifications_of_change,required"`
// If your prenotification is returned, this will contain details of the return.
PrenotificationReturn ACHPrenotificationPrenotificationReturn `json:"prenotification_return,required,nullable"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
// The lifecycle status of the ACH Prenotification.
Status ACHPrenotificationStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `ach_prenotification`.
Type ACHPrenotificationType `json:"type,required"`
JSON achPrenotificationJSON
}
ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
func (*ACHPrenotification) UnmarshalJSON ¶
func (r *ACHPrenotification) UnmarshalJSON(data []byte) (err error)
type ACHPrenotificationCreditDebitIndicator ¶
type ACHPrenotificationCreditDebitIndicator string
If the notification is for a future credit or debit.
const ( // The Prenotification is for an anticipated credit. ACHPrenotificationCreditDebitIndicatorCredit ACHPrenotificationCreditDebitIndicator = "credit" // The Prenotification is for an anticipated debit. ACHPrenotificationCreditDebitIndicatorDebit ACHPrenotificationCreditDebitIndicator = "debit" )
type ACHPrenotificationListParams ¶
type ACHPrenotificationListParams struct {
CreatedAt param.Field[ACHPrenotificationListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (ACHPrenotificationListParams) URLQuery ¶
func (r ACHPrenotificationListParams) URLQuery() (v url.Values)
URLQuery serializes ACHPrenotificationListParams's query parameters as `url.Values`.
type ACHPrenotificationListParamsCreatedAt ¶
type ACHPrenotificationListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (ACHPrenotificationListParamsCreatedAt) URLQuery ¶
func (r ACHPrenotificationListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes ACHPrenotificationListParamsCreatedAt's query parameters as `url.Values`.
type ACHPrenotificationNewParams ¶
type ACHPrenotificationNewParams struct {
// The account number for the destination account.
AccountNumber param.Field[string] `json:"account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
// destination account.
RoutingNumber param.Field[string] `json:"routing_number,required"`
// Additional information that will be sent to the recipient.
Addendum param.Field[string] `json:"addendum"`
// The description of the date of the transfer.
CompanyDescriptiveDate param.Field[string] `json:"company_descriptive_date"`
// The data you choose to associate with the transfer.
CompanyDiscretionaryData param.Field[string] `json:"company_discretionary_data"`
// The description of the transfer you wish to be shown to the recipient.
CompanyEntryDescription param.Field[string] `json:"company_entry_description"`
// The name by which the recipient knows you.
CompanyName param.Field[string] `json:"company_name"`
// Whether the Prenotification is for a future debit or credit.
CreditDebitIndicator param.Field[ACHPrenotificationNewParamsCreditDebitIndicator] `json:"credit_debit_indicator"`
// The transfer effective date in
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
EffectiveDate param.Field[time.Time] `json:"effective_date" format:"date"`
// Your identifier for the transfer recipient.
IndividualID param.Field[string] `json:"individual_id"`
// The name of the transfer recipient. This value is information and not verified
// by the recipient's bank.
IndividualName param.Field[string] `json:"individual_name"`
// The Standard Entry Class (SEC) code to use for the ACH Prenotification.
StandardEntryClassCode param.Field[ACHPrenotificationNewParamsStandardEntryClassCode] `json:"standard_entry_class_code"`
}
func (ACHPrenotificationNewParams) MarshalJSON ¶
func (r ACHPrenotificationNewParams) MarshalJSON() (data []byte, err error)
type ACHPrenotificationNewParamsCreditDebitIndicator ¶
type ACHPrenotificationNewParamsCreditDebitIndicator string
Whether the Prenotification is for a future debit or credit.
const ( // The Prenotification is for an anticipated credit. ACHPrenotificationNewParamsCreditDebitIndicatorCredit ACHPrenotificationNewParamsCreditDebitIndicator = "credit" // The Prenotification is for an anticipated debit. ACHPrenotificationNewParamsCreditDebitIndicatorDebit ACHPrenotificationNewParamsCreditDebitIndicator = "debit" )
type ACHPrenotificationNewParamsStandardEntryClassCode ¶
type ACHPrenotificationNewParamsStandardEntryClassCode string
The Standard Entry Class (SEC) code to use for the ACH Prenotification.
const ( // Corporate Credit and Debit (CCD). ACHPrenotificationNewParamsStandardEntryClassCodeCorporateCreditOrDebit ACHPrenotificationNewParamsStandardEntryClassCode = "corporate_credit_or_debit" // Prearranged Payments and Deposits (PPD). ACHPrenotificationNewParamsStandardEntryClassCodePrearrangedPaymentsAndDeposit ACHPrenotificationNewParamsStandardEntryClassCode = "prearranged_payments_and_deposit" // Internet Initiated (WEB). ACHPrenotificationNewParamsStandardEntryClassCodeInternetInitiated ACHPrenotificationNewParamsStandardEntryClassCode = "internet_initiated" )
type ACHPrenotificationNotificationsOfChange ¶ added in v0.6.3
type ACHPrenotificationNotificationsOfChange struct {
// The type of change that occurred.
ChangeCode ACHPrenotificationNotificationsOfChangeChangeCode `json:"change_code,required"`
// The corrected data.
CorrectedData string `json:"corrected_data,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the notification occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
JSON achPrenotificationNotificationsOfChangeJSON
}
func (*ACHPrenotificationNotificationsOfChange) UnmarshalJSON ¶ added in v0.6.3
func (r *ACHPrenotificationNotificationsOfChange) UnmarshalJSON(data []byte) (err error)
type ACHPrenotificationNotificationsOfChangeChangeCode ¶ added in v0.6.3
type ACHPrenotificationNotificationsOfChangeChangeCode string
The type of change that occurred.
const ( // The account number was incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectAccountNumber ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_account_number" // The routing number was incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectRoutingNumber ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_routing_number" // Both the routing number and the account number were incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectRoutingNumberAndAccountNumber ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_routing_number_and_account_number" // The transaction code was incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectTransactionCode ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_transaction_code" // The account number and the transaction code were incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectAccountNumberAndTransactionCode ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_account_number_and_transaction_code" // The routing number, account number, and transaction code were incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectRoutingNumberAccountNumberAndTransactionCode ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_routing_number_account_number_and_transaction_code" // The receiving depository financial institution identification was incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectReceivingDepositoryFinancialInstitutionIdentification ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_receiving_depository_financial_institution_identification" // The individual identification number was incorrect. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectIndividualIdentificationNumber ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_individual_identification_number" // The addenda had an incorrect format. ACHPrenotificationNotificationsOfChangeChangeCodeAddendaFormatError ACHPrenotificationNotificationsOfChangeChangeCode = "addenda_format_error" // The standard entry class code was incorrect for an outbound international // payment. ACHPrenotificationNotificationsOfChangeChangeCodeIncorrectStandardEntryClassCodeForOutboundInternationalPayment ACHPrenotificationNotificationsOfChangeChangeCode = "incorrect_standard_entry_class_code_for_outbound_international_payment" )
type ACHPrenotificationPrenotificationReturn ¶
type ACHPrenotificationPrenotificationReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Prenotification was returned.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// Why the Prenotification was returned.
ReturnReasonCode string `json:"return_reason_code,required"`
JSON achPrenotificationPrenotificationReturnJSON
}
If your prenotification is returned, this will contain details of the return.
func (*ACHPrenotificationPrenotificationReturn) UnmarshalJSON ¶
func (r *ACHPrenotificationPrenotificationReturn) UnmarshalJSON(data []byte) (err error)
type ACHPrenotificationService ¶
type ACHPrenotificationService struct {
Options []option.RequestOption
}
ACHPrenotificationService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewACHPrenotificationService method instead.
func NewACHPrenotificationService ¶
func NewACHPrenotificationService(opts ...option.RequestOption) (r *ACHPrenotificationService)
NewACHPrenotificationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ACHPrenotificationService) Get ¶
func (r *ACHPrenotificationService) Get(ctx context.Context, achPrenotificationID string, opts ...option.RequestOption) (res *ACHPrenotification, err error)
Retrieve an ACH Prenotification
func (*ACHPrenotificationService) List ¶
func (r *ACHPrenotificationService) List(ctx context.Context, query ACHPrenotificationListParams, opts ...option.RequestOption) (res *shared.Page[ACHPrenotification], err error)
List ACH Prenotifications
func (*ACHPrenotificationService) ListAutoPaging ¶
func (r *ACHPrenotificationService) ListAutoPaging(ctx context.Context, query ACHPrenotificationListParams, opts ...option.RequestOption) *shared.PageAutoPager[ACHPrenotification]
List ACH Prenotifications
func (*ACHPrenotificationService) New ¶
func (r *ACHPrenotificationService) New(ctx context.Context, body ACHPrenotificationNewParams, opts ...option.RequestOption) (res *ACHPrenotification, err error)
Create an ACH Prenotification
type ACHPrenotificationStatus ¶
type ACHPrenotificationStatus string
The lifecycle status of the ACH Prenotification.
const ( // The Prenotification is pending submission. ACHPrenotificationStatusPendingSubmitting ACHPrenotificationStatus = "pending_submitting" // The Prenotification requires attention. ACHPrenotificationStatusRequiresAttention ACHPrenotificationStatus = "requires_attention" // The Prenotification has been returned. ACHPrenotificationStatusReturned ACHPrenotificationStatus = "returned" // The Prenotification is complete. ACHPrenotificationStatusSubmitted ACHPrenotificationStatus = "submitted" )
type ACHPrenotificationType ¶
type ACHPrenotificationType string
A constant representing the object's type. For this resource it will always be `ach_prenotification`.
const (
ACHPrenotificationTypeACHPrenotification ACHPrenotificationType = "ach_prenotification"
)
type ACHTransfer ¶
type ACHTransfer struct {
// The ACH transfer's identifier.
ID string `json:"id,required"`
// The Account to which the transfer belongs.
AccountID string `json:"account_id,required"`
// The destination account number.
AccountNumber string `json:"account_number,required"`
// After the transfer is acknowledged by FedACH, this will contain supplemental
// details. The Federal Reserve sends an acknowledgement message for each file that
// Increase submits.
Acknowledgement ACHTransferAcknowledgement `json:"acknowledgement,required,nullable"`
// Additional information that will be sent to the recipient.
Addendum string `json:"addendum,required,nullable"`
// The transfer amount in USD cents. A positive amount indicates a credit transfer
// pushing funds to the receiving account. A negative amount indicates a debit
// transfer pulling funds from the receiving account.
Amount int64 `json:"amount,required"`
// If your account requires approvals for transfers and the transfer was approved,
// this will contain details of the approval.
Approval ACHTransferApproval `json:"approval,required,nullable"`
// If your account requires approvals for transfers and the transfer was not
// approved, this will contain details of the cancellation.
Cancellation ACHTransferCancellation `json:"cancellation,required,nullable"`
// The description of the date of the transfer.
CompanyDescriptiveDate string `json:"company_descriptive_date,required,nullable"`
// The data you chose to associate with the transfer.
CompanyDiscretionaryData string `json:"company_discretionary_data,required,nullable"`
// The description of the transfer you set to be shown to the recipient.
CompanyEntryDescription string `json:"company_entry_description,required,nullable"`
// The name by which the recipient knows you.
CompanyName string `json:"company_name,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
// currency. For ACH transfers this is always equal to `usd`.
Currency ACHTransferCurrency `json:"currency,required"`
// The transfer effective date in
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
EffectiveDate time.Time `json:"effective_date,required,nullable" format:"date"`
// The identifier of the External Account the transfer was made to, if any.
ExternalAccountID string `json:"external_account_id,required,nullable"`
// The type of the account to which the transfer will be sent.
Funding ACHTransferFunding `json:"funding,required"`
// Your identifier for the transfer recipient.
IndividualID string `json:"individual_id,required,nullable"`
// The name of the transfer recipient. This value is information and not verified
// by the recipient's bank.
IndividualName string `json:"individual_name,required,nullable"`
// The transfer's network.
Network ACHTransferNetwork `json:"network,required"`
// If the receiving bank accepts the transfer but notifies that future transfers
// should use different details, this will contain those details.
NotificationsOfChange []ACHTransferNotificationsOfChange `json:"notifications_of_change,required"`
// The ID for the pending transaction representing the transfer. A pending
// transaction is created when the transfer
// [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
// by someone else in your organization.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// If your transfer is returned, this will contain details of the return.
Return ACHTransferReturn `json:"return,required,nullable"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
// The Standard Entry Class (SEC) code to use for the transfer.
StandardEntryClassCode ACHTransferStandardEntryClassCode `json:"standard_entry_class_code,required"`
// The descriptor that will show on the recipient's bank statement.
StatementDescriptor string `json:"statement_descriptor,required"`
// The lifecycle status of the transfer.
Status ACHTransferStatus `json:"status,required"`
// After the transfer is submitted to FedACH, this will contain supplemental
// details. Increase batches transfers and submits a file to the Federal Reserve
// roughly every 30 minutes. The Federal Reserve processes ACH transfers during
// weekdays according to their (posted
// schedule)[https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html].
Submission ACHTransferSubmission `json:"submission,required,nullable"`
// The ID for the transaction funding the transfer.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `ach_transfer`.
Type ACHTransferType `json:"type,required"`
// The unique identifier you chose for this transfer.
UniqueIdentifier string `json:"unique_identifier,required,nullable"`
JSON achTransferJSON
}
ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
func (*ACHTransfer) UnmarshalJSON ¶
func (r *ACHTransfer) UnmarshalJSON(data []byte) (err error)
type ACHTransferAcknowledgement ¶ added in v0.7.0
type ACHTransferAcknowledgement struct {
// When the Federal Reserve acknowledged the submitted file containing this
// transfer.
AcknowledgedAt string `json:"acknowledged_at,required"`
JSON achTransferAcknowledgementJSON
}
After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.
func (*ACHTransferAcknowledgement) UnmarshalJSON ¶ added in v0.7.0
func (r *ACHTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type ACHTransferApproval ¶
type ACHTransferApproval struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was approved.
ApprovedAt time.Time `json:"approved_at,required" format:"date-time"`
// If the Transfer was approved by a user in the dashboard, the email address of
// that user.
ApprovedBy string `json:"approved_by,required,nullable"`
JSON achTransferApprovalJSON
}
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
func (*ACHTransferApproval) UnmarshalJSON ¶
func (r *ACHTransferApproval) UnmarshalJSON(data []byte) (err error)
type ACHTransferCancellation ¶
type ACHTransferCancellation struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Transfer was canceled.
CanceledAt time.Time `json:"canceled_at,required" format:"date-time"`
// If the Transfer was canceled by a user in the dashboard, the email address of
// that user.
CanceledBy string `json:"canceled_by,required,nullable"`
JSON achTransferCancellationJSON
}
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
func (*ACHTransferCancellation) UnmarshalJSON ¶
func (r *ACHTransferCancellation) UnmarshalJSON(data []byte) (err error)
type ACHTransferCurrency ¶
type ACHTransferCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For ACH transfers this is always equal to `usd`.
const ( // Canadian Dollar (CAD) ACHTransferCurrencyCad ACHTransferCurrency = "CAD" // Swiss Franc (CHF) ACHTransferCurrencyChf ACHTransferCurrency = "CHF" // Euro (EUR) ACHTransferCurrencyEur ACHTransferCurrency = "EUR" // British Pound (GBP) ACHTransferCurrencyGbp ACHTransferCurrency = "GBP" // Japanese Yen (JPY) ACHTransferCurrencyJpy ACHTransferCurrency = "JPY" // US Dollar (USD) ACHTransferCurrencyUsd ACHTransferCurrency = "USD" )
type ACHTransferFunding ¶
type ACHTransferFunding string
The type of the account to which the transfer will be sent.
const ( // A checking account. ACHTransferFundingChecking ACHTransferFunding = "checking" // A savings account. ACHTransferFundingSavings ACHTransferFunding = "savings" )
type ACHTransferListParams ¶
type ACHTransferListParams struct {
// Filter ACH Transfers to those that originated from the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[ACHTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Filter ACH Transfers to those made to the specified External Account.
ExternalAccountID param.Field[string] `query:"external_account_id"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter ACH Transfers to the one with the specified unique identifier.
UniqueIdentifier param.Field[string] `query:"unique_identifier"`
}
func (ACHTransferListParams) URLQuery ¶
func (r ACHTransferListParams) URLQuery() (v url.Values)
URLQuery serializes ACHTransferListParams's query parameters as `url.Values`.
type ACHTransferListParamsCreatedAt ¶
type ACHTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (ACHTransferListParamsCreatedAt) URLQuery ¶
func (r ACHTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes ACHTransferListParamsCreatedAt's query parameters as `url.Values`.
type ACHTransferNetwork ¶
type ACHTransferNetwork string
The transfer's network.
const (
ACHTransferNetworkACH ACHTransferNetwork = "ach"
)
type ACHTransferNewParams ¶
type ACHTransferNewParams struct {
// The Increase identifier for the account that will send the transfer.
AccountID param.Field[string] `json:"account_id,required"`
// The transfer amount in cents. A positive amount originates a credit transfer
// pushing funds to the receiving account. A negative amount originates a debit
// transfer pulling funds from the receiving account.
Amount param.Field[int64] `json:"amount,required"`
// A description you choose to give the transfer. This will be saved with the
// transfer details, displayed in the dashboard, and returned by the API. If
// `individual_name` and `company_name` are not explicitly set by this API, the
// `statement_descriptor` will be sent in those fields to the receiving bank to
// help the customer recognize the transfer. You are highly encouraged to pass
// `individual_name` and `company_name` instead of relying on this fallback.
StatementDescriptor param.Field[string] `json:"statement_descriptor,required"`
// The account number for the destination account.
AccountNumber param.Field[string] `json:"account_number"`
// Additional information that will be sent to the recipient. This is included in
// the transfer data sent to the receiving bank.
Addendum param.Field[string] `json:"addendum"`
// The description of the date of the transfer, usually in the format `YYMMDD`.
// This is included in the transfer data sent to the receiving bank.
CompanyDescriptiveDate param.Field[string] `json:"company_descriptive_date"`
// The data you choose to associate with the transfer. This is included in the
// transfer data sent to the receiving bank.
CompanyDiscretionaryData param.Field[string] `json:"company_discretionary_data"`
// A description of the transfer. This is included in the transfer data sent to the
// receiving bank.
CompanyEntryDescription param.Field[string] `json:"company_entry_description"`
// The name by which the recipient knows you. This is included in the transfer data
// sent to the receiving bank.
CompanyName param.Field[string] `json:"company_name"`
// The transfer effective date in
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
EffectiveDate param.Field[time.Time] `json:"effective_date" format:"date"`
// The ID of an External Account to initiate a transfer to. If this parameter is
// provided, `account_number`, `routing_number`, and `funding` must be absent.
ExternalAccountID param.Field[string] `json:"external_account_id"`
// The type of the account to which the transfer will be sent.
Funding param.Field[ACHTransferNewParamsFunding] `json:"funding"`
// Your identifier for the transfer recipient.
IndividualID param.Field[string] `json:"individual_id"`
// The name of the transfer recipient. This value is informational and not verified
// by the recipient's bank.
IndividualName param.Field[string] `json:"individual_name"`
// Whether the transfer requires explicit approval via the dashboard or API.
RequireApproval param.Field[bool] `json:"require_approval"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
// destination account.
RoutingNumber param.Field[string] `json:"routing_number"`
// The Standard Entry Class (SEC) code to use for the transfer.
StandardEntryClassCode param.Field[ACHTransferNewParamsStandardEntryClassCode] `json:"standard_entry_class_code"`
// A unique identifier you choose for the transfer. Reusing this identifier for
// another transfer will result in an error. You can query for the transfer
// associated with this identifier using the List endpoint.
UniqueIdentifier param.Field[string] `json:"unique_identifier"`
}
func (ACHTransferNewParams) MarshalJSON ¶
func (r ACHTransferNewParams) MarshalJSON() (data []byte, err error)
type ACHTransferNewParamsFunding ¶
type ACHTransferNewParamsFunding string
The type of the account to which the transfer will be sent.
const ( // A checking account. ACHTransferNewParamsFundingChecking ACHTransferNewParamsFunding = "checking" // A savings account. ACHTransferNewParamsFundingSavings ACHTransferNewParamsFunding = "savings" )
type ACHTransferNewParamsStandardEntryClassCode ¶
type ACHTransferNewParamsStandardEntryClassCode string
The Standard Entry Class (SEC) code to use for the transfer.
const ( // Corporate Credit and Debit (CCD). ACHTransferNewParamsStandardEntryClassCodeCorporateCreditOrDebit ACHTransferNewParamsStandardEntryClassCode = "corporate_credit_or_debit" // Prearranged Payments and Deposits (PPD). ACHTransferNewParamsStandardEntryClassCodePrearrangedPaymentsAndDeposit ACHTransferNewParamsStandardEntryClassCode = "prearranged_payments_and_deposit" // Internet Initiated (WEB). ACHTransferNewParamsStandardEntryClassCodeInternetInitiated ACHTransferNewParamsStandardEntryClassCode = "internet_initiated" )
type ACHTransferNotificationsOfChange ¶
type ACHTransferNotificationsOfChange struct {
// The type of change that occurred.
ChangeCode ACHTransferNotificationsOfChangeChangeCode `json:"change_code,required"`
// The corrected data.
CorrectedData string `json:"corrected_data,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the notification occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
JSON achTransferNotificationsOfChangeJSON
}
func (*ACHTransferNotificationsOfChange) UnmarshalJSON ¶
func (r *ACHTransferNotificationsOfChange) UnmarshalJSON(data []byte) (err error)
type ACHTransferNotificationsOfChangeChangeCode ¶ added in v0.5.0
type ACHTransferNotificationsOfChangeChangeCode string
The type of change that occurred.
const ( // The account number was incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectAccountNumber ACHTransferNotificationsOfChangeChangeCode = "incorrect_account_number" // The routing number was incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectRoutingNumber ACHTransferNotificationsOfChangeChangeCode = "incorrect_routing_number" // Both the routing number and the account number were incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectRoutingNumberAndAccountNumber ACHTransferNotificationsOfChangeChangeCode = "incorrect_routing_number_and_account_number" // The transaction code was incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectTransactionCode ACHTransferNotificationsOfChangeChangeCode = "incorrect_transaction_code" // The account number and the transaction code were incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectAccountNumberAndTransactionCode ACHTransferNotificationsOfChangeChangeCode = "incorrect_account_number_and_transaction_code" // The routing number, account number, and transaction code were incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectRoutingNumberAccountNumberAndTransactionCode ACHTransferNotificationsOfChangeChangeCode = "incorrect_routing_number_account_number_and_transaction_code" // The receiving depository financial institution identification was incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectReceivingDepositoryFinancialInstitutionIdentification ACHTransferNotificationsOfChangeChangeCode = "incorrect_receiving_depository_financial_institution_identification" // The individual identification number was incorrect. ACHTransferNotificationsOfChangeChangeCodeIncorrectIndividualIdentificationNumber ACHTransferNotificationsOfChangeChangeCode = "incorrect_individual_identification_number" // The addenda had an incorrect format. ACHTransferNotificationsOfChangeChangeCodeAddendaFormatError ACHTransferNotificationsOfChangeChangeCode = "addenda_format_error" // The standard entry class code was incorrect for an outbound international // payment. ACHTransferNotificationsOfChangeChangeCodeIncorrectStandardEntryClassCodeForOutboundInternationalPayment ACHTransferNotificationsOfChangeChangeCode = "incorrect_standard_entry_class_code_for_outbound_international_payment" )
type ACHTransferReturn ¶
type ACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode ACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON achTransferReturnJSON
}
If your transfer is returned, this will contain details of the return.
func (*ACHTransferReturn) UnmarshalJSON ¶
func (r *ACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type ACHTransferReturnReturnReasonCode ¶
type ACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. ACHTransferReturnReturnReasonCodeInsufficientFund ACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. ACHTransferReturnReturnReasonCodeNoAccount ACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. ACHTransferReturnReturnReasonCodeAccountClosed ACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. ACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure ACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. ACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction ACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. ACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver ACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. ACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode ACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. ACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized ACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. ACHTransferReturnReturnReasonCodePaymentStopped ACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. ACHTransferReturnReturnReasonCodeNonTransactionAccount ACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. ACHTransferReturnReturnReasonCodeUncollectedFunds ACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. ACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError ACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" ACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete ACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. ACHTransferReturnReturnReasonCodeAmountFieldError ACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. ACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer ACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. ACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber ACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. ACHTransferReturnReturnReasonCodeFileRecordEditCriteria ACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. ACHTransferReturnReturnReasonCodeEnrInvalidIndividualName ACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. ACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest ACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. ACHTransferReturnReturnReasonCodeLimitedParticipationDfi ACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. ACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment ACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. ACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi ACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. ACHTransferReturnReturnReasonCodeAddendaError ACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. ACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased ACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. ACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms ACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). ACHTransferReturnReturnReasonCodeCorrectedReturn ACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. ACHTransferReturnReturnReasonCodeDuplicateEntry ACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. ACHTransferReturnReturnReasonCodeDuplicateReturn ACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment ACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber ACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber ACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator ACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode ACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry ACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError ACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. ACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway ACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. ACHTransferReturnReturnReasonCodeFieldError ACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. ACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle ACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. ACHTransferReturnReturnReasonCodeIatEntryCodingError ACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. ACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate ACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. ACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented ACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. ACHTransferReturnReturnReasonCodeInvalidCompanyID ACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. ACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification ACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. ACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber ACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. ACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment ACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. ACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible ACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. ACHTransferReturnReturnReasonCodeMandatoryFieldError ACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. ACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn ACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. ACHTransferReturnReturnReasonCodeMisroutedReturn ACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. ACHTransferReturnReturnReasonCodeNoErrorsFound ACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. ACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn ACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. ACHTransferReturnReturnReasonCodeNonParticipantInIatProgram ACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. ACHTransferReturnReturnReasonCodePermissibleReturnEntry ACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. ACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted ACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. ACHTransferReturnReturnReasonCodeRdfiNonSettlement ACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. ACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram ACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. ACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity ACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. ACHTransferReturnReturnReasonCodeReturnNotADuplicate ACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. ACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit ACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. ACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry ACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. ACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry ACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. ACHTransferReturnReturnReasonCodeReturnOfXckEntry ACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. ACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment ACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. ACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance ACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. ACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry ACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. ACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument ACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. ACHTransferReturnReturnReasonCodeTimelyOriginalReturn ACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. ACHTransferReturnReturnReasonCodeTraceNumberError ACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. ACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn ACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. ACHTransferReturnReturnReasonCodeUntimelyReturn ACHTransferReturnReturnReasonCode = "untimely_return" )
type ACHTransferService ¶
type ACHTransferService struct {
Options []option.RequestOption
}
ACHTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewACHTransferService method instead.
func NewACHTransferService ¶
func NewACHTransferService(opts ...option.RequestOption) (r *ACHTransferService)
NewACHTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ACHTransferService) Approve ¶
func (r *ACHTransferService) Approve(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
Approves an ACH Transfer in a pending_approval state.
func (*ACHTransferService) Cancel ¶
func (r *ACHTransferService) Cancel(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
Cancels an ACH Transfer in a pending_approval state.
func (*ACHTransferService) Get ¶
func (r *ACHTransferService) Get(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
Retrieve an ACH Transfer
func (*ACHTransferService) List ¶
func (r *ACHTransferService) List(ctx context.Context, query ACHTransferListParams, opts ...option.RequestOption) (res *shared.Page[ACHTransfer], err error)
List ACH Transfers
func (*ACHTransferService) ListAutoPaging ¶
func (r *ACHTransferService) ListAutoPaging(ctx context.Context, query ACHTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[ACHTransfer]
List ACH Transfers
func (*ACHTransferService) New ¶
func (r *ACHTransferService) New(ctx context.Context, body ACHTransferNewParams, opts ...option.RequestOption) (res *ACHTransfer, err error)
Create an ACH Transfer
type ACHTransferSimulation ¶
type ACHTransferSimulation struct {
// If the ACH Transfer attempt fails, this will contain the resulting
// [Declined Transaction](#declined-transactions) object. The Declined
// Transaction's `source` will be of `category: inbound_ach_transfer`.
DeclinedTransaction ACHTransferSimulationDeclinedTransaction `json:"declined_transaction,required,nullable"`
// If the ACH Transfer attempt succeeds, this will contain the resulting
// [Transaction](#transactions) object. The Transaction's `source` will be of
// `category: inbound_ach_transfer`.
Transaction ACHTransferSimulationTransaction `json:"transaction,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `inbound_ach_transfer_simulation_result`.
Type ACHTransferSimulationType `json:"type,required"`
JSON achTransferSimulationJSON
}
The results of an inbound ACH Transfer simulation.
func (*ACHTransferSimulation) UnmarshalJSON ¶
func (r *ACHTransferSimulation) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransaction ¶
type ACHTransferSimulationDeclinedTransaction struct {
// The Declined Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Declined Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Declined Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
// Transaction's currency. This will match the currency on the Declined
// Transaction's Account.
Currency ACHTransferSimulationDeclinedTransactionCurrency `json:"currency,required"`
// This is the description the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Declined Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Declined Transaction came through.
RouteType ACHTransferSimulationDeclinedTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Declined Transaction. For example, for a card transaction this lists the
// merchant's industry and location. Note that for backwards compatibility reasons,
// additional undocumented keys may appear in this object. These should be treated
// as deprecated and will be removed in the future.
Source ACHTransferSimulationDeclinedTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `declined_transaction`.
Type ACHTransferSimulationDeclinedTransactionType `json:"type,required"`
JSON achTransferSimulationDeclinedTransactionJSON
}
If the ACH Transfer attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: inbound_ach_transfer`.
func (*ACHTransferSimulationDeclinedTransaction) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransaction) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionCurrency ¶
type ACHTransferSimulationDeclinedTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
const ( // Canadian Dollar (CAD) ACHTransferSimulationDeclinedTransactionCurrencyCad ACHTransferSimulationDeclinedTransactionCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationDeclinedTransactionCurrencyChf ACHTransferSimulationDeclinedTransactionCurrency = "CHF" // Euro (EUR) ACHTransferSimulationDeclinedTransactionCurrencyEur ACHTransferSimulationDeclinedTransactionCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationDeclinedTransactionCurrencyGbp ACHTransferSimulationDeclinedTransactionCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationDeclinedTransactionCurrencyJpy ACHTransferSimulationDeclinedTransactionCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationDeclinedTransactionCurrencyUsd ACHTransferSimulationDeclinedTransactionCurrency = "USD" )
type ACHTransferSimulationDeclinedTransactionRouteType ¶
type ACHTransferSimulationDeclinedTransactionRouteType string
The type of the route this Declined Transaction came through.
const ( // An Account Number. ACHTransferSimulationDeclinedTransactionRouteTypeAccountNumber ACHTransferSimulationDeclinedTransactionRouteType = "account_number" // A Card. ACHTransferSimulationDeclinedTransactionRouteTypeCard ACHTransferSimulationDeclinedTransactionRouteType = "card" )
type ACHTransferSimulationDeclinedTransactionSource ¶
type ACHTransferSimulationDeclinedTransactionSource struct {
// An ACH Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `ach_decline`.
ACHDecline ACHTransferSimulationDeclinedTransactionSourceACHDecline `json:"ach_decline,required,nullable"`
// A Card Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `card_decline`.
CardDecline ACHTransferSimulationDeclinedTransactionSourceCardDecline `json:"card_decline,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category ACHTransferSimulationDeclinedTransactionSourceCategory `json:"category,required"`
// A Check Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `check_decline`.
CheckDecline ACHTransferSimulationDeclinedTransactionSourceCheckDecline `json:"check_decline,required,nullable"`
// An Inbound Real-Time Payments Transfer Decline object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_decline`.
InboundRealTimePaymentsTransferDecline ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline `json:"inbound_real_time_payments_transfer_decline,required,nullable"`
// An International ACH Decline object. This field will be present in the JSON
// response if and only if `category` is equal to `international_ach_decline`.
InternationalACHDecline ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline `json:"international_ach_decline,required,nullable"`
// A Wire Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `wire_decline`.
WireDecline ACHTransferSimulationDeclinedTransactionSourceWireDecline `json:"wire_decline,required,nullable"`
JSON achTransferSimulationDeclinedTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*ACHTransferSimulationDeclinedTransactionSource) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSource) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceACHDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceACHDecline struct {
// The ACH Decline's identifier.
ID string `json:"id,required"`
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The descriptive date of the transfer.
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
// The additional information included with the transfer.
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
// The identifier of the company that initiated the transfer.
OriginatorCompanyID string `json:"originator_company_id,required"`
// The name of the company that initiated the transfer.
OriginatorCompanyName string `json:"originator_company_name,required"`
// Why the ACH transfer was declined.
Reason ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason `json:"reason,required"`
// The id of the receiver of the transfer.
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
// The name of the receiver of the transfer.
ReceiverName string `json:"receiver_name,required,nullable"`
// The trace number of the transfer.
TraceNumber string `json:"trace_number,required"`
// A constant representing the object's type. For this resource it will always be
// `ach_decline`.
Type ACHTransferSimulationDeclinedTransactionSourceACHDeclineType `json:"type,required"`
JSON achTransferSimulationDeclinedTransactionSourceACHDeclineJSON
}
An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceACHDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceACHDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason ¶
type ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason string
Why the ACH transfer was declined.
const ( // The account number is canceled. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonACHRouteCanceled ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "ach_route_canceled" // The account number is disabled. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonACHRouteDisabled ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonBreachesLimit ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "breaches_limit" // A credit was refused. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonCreditEntryRefusedByReceiver ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "credit_entry_refused_by_receiver" // Other. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonDuplicateReturn ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "duplicate_return" // The account's entity is not active. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonEntityNotActive ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "entity_not_active" // Your account is inactive. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonGroupLocked ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "group_locked" // Your account contains insufficient funds. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonInsufficientFunds ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "insufficient_funds" // Other. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonMisroutedReturn ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "misrouted_return" // Other. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonReturnOfErroneousOrReversingDebit ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "return_of_erroneous_or_reversing_debit" // The account number that was debited does not exist. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonNoACHRoute ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "no_ach_route" // Other. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonOriginatorRequest ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "originator_request" // The transaction is not allowed per Increase's terms. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonTransactionNotAllowed ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "transaction_not_allowed" // The user initiated the decline. ACHTransferSimulationDeclinedTransactionSourceACHDeclineReasonUserInitiated ACHTransferSimulationDeclinedTransactionSourceACHDeclineReason = "user_initiated" )
type ACHTransferSimulationDeclinedTransactionSourceACHDeclineType ¶ added in v0.7.1
type ACHTransferSimulationDeclinedTransactionSourceACHDeclineType string
A constant representing the object's type. For this resource it will always be `ach_decline`.
const (
ACHTransferSimulationDeclinedTransactionSourceACHDeclineTypeACHDecline ACHTransferSimulationDeclinedTransactionSourceACHDeclineType = "ach_decline"
)
type ACHTransferSimulationDeclinedTransactionSourceCardDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Fields specific to the `network`
NetworkDetails ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails `json:"network_details,required"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// Why the transaction was declined.
Reason ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason `json:"reason,required"`
JSON achTransferSimulationDeclinedTransactionSourceCardDeclineJSON
}
A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceCardDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceCardDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyCad ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyChf ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "CHF" // Euro (EUR) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyEur ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyGbp ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyJpy ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrencyUsd ACHTransferSimulationDeclinedTransactionSourceCardDeclineCurrency = "USD" )
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails struct {
// The payment network used to process this card authorization
Category ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa `json:"visa,required,nullable"`
JSON achTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsJSON
}
Fields specific to the `network`
func (*ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory ¶ added in v0.6.0
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategoryVisa ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory = "visa" )
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON achTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorRecurring ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorInstallment ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeUnknown ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeManual ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeOpticalCode ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactless ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv ACHTransferSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason ¶
type ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason string
Why the transaction was declined.
const ( // The Card was not active. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonCardNotActive ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "card_not_active" // The Physical Card was not active. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonPhysicalCardNotActive ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "physical_card_not_active" // The account's entity was not active. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonEntityNotActive ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "entity_not_active" // The account was inactive. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonGroupLocked ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "group_locked" // The Card's Account did not have a sufficient available balance. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonInsufficientFunds ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "insufficient_funds" // The given CVV2 did not match the card's value. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonCvv2Mismatch ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "cvv2_mismatch" // The attempted card transaction is not allowed per Increase's terms. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonTransactionNotAllowed ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "transaction_not_allowed" // The transaction was blocked by a Limit. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonBreachesLimit ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "breaches_limit" // Your application declined the transaction via webhook. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonWebhookDeclined ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "webhook_declined" // Your application webhook did not respond without the required timeout. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonWebhookTimedOut ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "webhook_timed_out" // Declined by stand-in processing. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonDeclinedByStandInProcessing ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "declined_by_stand_in_processing" // The card read had an invalid CVV, dCVV, or authorization request cryptogram. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonInvalidPhysicalCard ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "invalid_physical_card" // The original card authorization for this incremental authorization does not // exist. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonMissingOriginalAuthorization ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "missing_original_authorization" // The transaction was suspected to be fraudulent. Please reach out to // support@increase.com for more information. ACHTransferSimulationDeclinedTransactionSourceCardDeclineReasonSuspectedFraud ACHTransferSimulationDeclinedTransactionSourceCardDeclineReason = "suspected_fraud" )
type ACHTransferSimulationDeclinedTransactionSourceCategory ¶
type ACHTransferSimulationDeclinedTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // ACH Decline: details will be under the `ach_decline` object. ACHTransferSimulationDeclinedTransactionSourceCategoryACHDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "ach_decline" // Card Decline: details will be under the `card_decline` object. ACHTransferSimulationDeclinedTransactionSourceCategoryCardDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "card_decline" // Check Decline: details will be under the `check_decline` object. ACHTransferSimulationDeclinedTransactionSourceCategoryCheckDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "check_decline" // Inbound Real-Time Payments Transfer Decline: details will be under the // `inbound_real_time_payments_transfer_decline` object. ACHTransferSimulationDeclinedTransactionSourceCategoryInboundRealTimePaymentsTransferDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "inbound_real_time_payments_transfer_decline" // International ACH Decline: details will be under the `international_ach_decline` // object. ACHTransferSimulationDeclinedTransactionSourceCategoryInternationalACHDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "international_ach_decline" // Wire Decline: details will be under the `wire_decline` object. ACHTransferSimulationDeclinedTransactionSourceCategoryWireDecline ACHTransferSimulationDeclinedTransactionSourceCategory = "wire_decline" // The Declined Transaction was made for an undocumented or deprecated reason. ACHTransferSimulationDeclinedTransactionSourceCategoryOther ACHTransferSimulationDeclinedTransactionSourceCategory = "other" )
type ACHTransferSimulationDeclinedTransactionSourceCheckDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceCheckDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// Why the check was declined.
Reason ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason `json:"reason,required"`
JSON achTransferSimulationDeclinedTransactionSourceCheckDeclineJSON
}
A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceCheckDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceCheckDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason ¶
type ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason string
Why the check was declined.
const ( // The account number is canceled. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonACHRouteCanceled ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "ach_route_canceled" // The account number is disabled. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonACHRouteDisabled ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonBreachesLimit ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "breaches_limit" // The account's entity is not active. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonEntityNotActive ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "entity_not_active" // Your account is inactive. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonGroupLocked ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "group_locked" // Your account contains insufficient funds. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonInsufficientFunds ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "insufficient_funds" // Unable to locate account. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonUnableToLocateAccount ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "unable_to_locate_account" // Routing number on the check is not ours. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonNotOurItem ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "not_our_item" // Unable to process. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonUnableToProcess ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "unable_to_process" // Refer to image. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonReferToImage ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "refer_to_image" // Stop payment requested for this check. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonStopPaymentRequested ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "stop_payment_requested" // Check was returned to sender. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonReturned ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "returned" // The check was a duplicate deposit. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonDuplicatePresentment ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "duplicate_presentment" // The transaction is not allowed. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonNotAuthorized ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "not_authorized" // The check was altered or fictitious. ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReasonAlteredOrFictitious ACHTransferSimulationDeclinedTransactionSourceCheckDeclineReason = "altered_or_fictitious" )
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
// transfer's currency. This will always be "USD" for a Real-Time Payments
// transfer.
Currency ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Why the transfer was declined.
Reason ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason `json:"reason,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the declined transfer.
TransactionIdentification string `json:"transaction_identification,required"`
JSON achTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineJSON
}
An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency ¶
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyCad ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyChf ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CHF" // Euro (EUR) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyEur ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyGbp ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyJpy ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyUsd ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "USD" )
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason ¶
type ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason string
Why the transfer was declined.
const ( // The account number is canceled. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberCanceled ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_canceled" // The account number is disabled. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberDisabled ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_disabled" // Your account is restricted. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountRestricted ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_restricted" // Your account is inactive. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonGroupLocked ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "group_locked" // The account's entity is not active. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonEntityNotActive ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "entity_not_active" // Your account is not enabled to receive Real-Time Payments transfers. ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonRealTimePaymentsNotEnabled ACHTransferSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "real_time_payments_not_enabled" )
type ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON achTransferSimulationDeclinedTransactionSourceInternationalACHDeclineJSON
}
An International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceWireDecline ¶
type ACHTransferSimulationDeclinedTransactionSourceWireDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
// Why the wire transfer was declined.
Reason ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason `json:"reason,required"`
JSON achTransferSimulationDeclinedTransactionSourceWireDeclineJSON
}
A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`.
func (*ACHTransferSimulationDeclinedTransactionSourceWireDecline) UnmarshalJSON ¶
func (r *ACHTransferSimulationDeclinedTransactionSourceWireDecline) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason ¶
type ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason string
Why the wire transfer was declined.
const ( // The account number is canceled. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonAccountNumberCanceled ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "account_number_canceled" // The account number is disabled. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonAccountNumberDisabled ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "account_number_disabled" // The account's entity is not active. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonEntityNotActive ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "entity_not_active" // Your account is inactive. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonGroupLocked ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "group_locked" // The beneficiary account number does not exist. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonNoAccountNumber ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "no_account_number" // The transaction is not allowed per Increase's terms. ACHTransferSimulationDeclinedTransactionSourceWireDeclineReasonTransactionNotAllowed ACHTransferSimulationDeclinedTransactionSourceWireDeclineReason = "transaction_not_allowed" )
type ACHTransferSimulationDeclinedTransactionType ¶
type ACHTransferSimulationDeclinedTransactionType string
A constant representing the object's type. For this resource it will always be `declined_transaction`.
const (
ACHTransferSimulationDeclinedTransactionTypeDeclinedTransaction ACHTransferSimulationDeclinedTransactionType = "declined_transaction"
)
type ACHTransferSimulationTransaction ¶
type ACHTransferSimulationTransaction struct {
// The Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Transaction amount in the minor unit of its currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// Transaction's currency. This will match the currency on the Transaction's
// Account.
Currency ACHTransferSimulationTransactionCurrency `json:"currency,required"`
// An informational message describing this transaction. Use the fields in `source`
// to get more detailed information. This field appears as the line-item on the
// statement.
Description string `json:"description,required"`
// The identifier for the route this Transaction came through. Routes are things
// like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Transaction came through.
RouteType ACHTransferSimulationTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Transaction. Note that for backwards compatibility reasons, additional
// undocumented keys may appear in this object. These should be treated as
// deprecated and will be removed in the future.
Source ACHTransferSimulationTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `transaction`.
Type ACHTransferSimulationTransactionType `json:"type,required"`
JSON achTransferSimulationTransactionJSON
}
If the ACH Transfer attempt succeeds, this will contain the resulting Transaction(#transactions) object. The Transaction's `source` will be of `category: inbound_ach_transfer`.
func (*ACHTransferSimulationTransaction) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransaction) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionCurrency ¶
type ACHTransferSimulationTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionCurrencyCad ACHTransferSimulationTransactionCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionCurrencyChf ACHTransferSimulationTransactionCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionCurrencyEur ACHTransferSimulationTransactionCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionCurrencyGbp ACHTransferSimulationTransactionCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionCurrencyJpy ACHTransferSimulationTransactionCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionCurrencyUsd ACHTransferSimulationTransactionCurrency = "USD" )
type ACHTransferSimulationTransactionRouteType ¶
type ACHTransferSimulationTransactionRouteType string
The type of the route this Transaction came through.
const ( // An Account Number. ACHTransferSimulationTransactionRouteTypeAccountNumber ACHTransferSimulationTransactionRouteType = "account_number" // A Card. ACHTransferSimulationTransactionRouteTypeCard ACHTransferSimulationTransactionRouteType = "card" )
type ACHTransferSimulationTransactionSource ¶
type ACHTransferSimulationTransactionSource struct {
// An Account Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_intention`.
AccountTransferIntention ACHTransferSimulationTransactionSourceAccountTransferIntention `json:"account_transfer_intention,required,nullable"`
// An ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_intention`.
ACHTransferIntention ACHTransferSimulationTransactionSourceACHTransferIntention `json:"ach_transfer_intention,required,nullable"`
// An ACH Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_rejection`.
ACHTransferRejection ACHTransferSimulationTransactionSourceACHTransferRejection `json:"ach_transfer_rejection,required,nullable"`
// An ACH Transfer Return object. This field will be present in the JSON response
// if and only if `category` is equal to `ach_transfer_return`.
ACHTransferReturn ACHTransferSimulationTransactionSourceACHTransferReturn `json:"ach_transfer_return,required,nullable"`
// A Card Dispute Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `card_dispute_acceptance`.
CardDisputeAcceptance ACHTransferSimulationTransactionSourceCardDisputeAcceptance `json:"card_dispute_acceptance,required,nullable"`
// A Card Refund object. This field will be present in the JSON response if and
// only if `category` is equal to `card_refund`.
CardRefund ACHTransferSimulationTransactionSourceCardRefund `json:"card_refund,required,nullable"`
// A Card Revenue Payment object. This field will be present in the JSON response
// if and only if `category` is equal to `card_revenue_payment`.
CardRevenuePayment ACHTransferSimulationTransactionSourceCardRevenuePayment `json:"card_revenue_payment,required,nullable"`
// A Card Settlement object. This field will be present in the JSON response if and
// only if `category` is equal to `card_settlement`.
CardSettlement ACHTransferSimulationTransactionSourceCardSettlement `json:"card_settlement,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category ACHTransferSimulationTransactionSourceCategory `json:"category,required"`
// A Check Deposit Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_acceptance`.
CheckDepositAcceptance ACHTransferSimulationTransactionSourceCheckDepositAcceptance `json:"check_deposit_acceptance,required,nullable"`
// A Check Deposit Return object. This field will be present in the JSON response
// if and only if `category` is equal to `check_deposit_return`.
CheckDepositReturn ACHTransferSimulationTransactionSourceCheckDepositReturn `json:"check_deposit_return,required,nullable"`
// A Check Transfer Deposit object. This field will be present in the JSON response
// if and only if `category` is equal to `check_transfer_deposit`.
CheckTransferDeposit ACHTransferSimulationTransactionSourceCheckTransferDeposit `json:"check_transfer_deposit,required,nullable"`
// A Check Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_intention`.
CheckTransferIntention ACHTransferSimulationTransactionSourceCheckTransferIntention `json:"check_transfer_intention,required,nullable"`
// A Check Transfer Stop Payment Request object. This field will be present in the
// JSON response if and only if `category` is equal to
// `check_transfer_stop_payment_request`.
CheckTransferStopPaymentRequest ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest `json:"check_transfer_stop_payment_request,required,nullable"`
// A Fee Payment object. This field will be present in the JSON response if and
// only if `category` is equal to `fee_payment`.
FeePayment ACHTransferSimulationTransactionSourceFeePayment `json:"fee_payment,required,nullable"`
// An Inbound ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_ach_transfer`.
InboundACHTransfer ACHTransferSimulationTransactionSourceInboundACHTransfer `json:"inbound_ach_transfer,required,nullable"`
// An Inbound Check object. This field will be present in the JSON response if and
// only if `category` is equal to `inbound_check`.
InboundCheck ACHTransferSimulationTransactionSourceInboundCheck `json:"inbound_check,required,nullable"`
// An Inbound International ACH Transfer object. This field will be present in the
// JSON response if and only if `category` is equal to
// `inbound_international_ach_transfer`.
InboundInternationalACHTransfer ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer `json:"inbound_international_ach_transfer,required,nullable"`
// An Inbound Real-Time Payments Transfer Confirmation object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_confirmation`.
InboundRealTimePaymentsTransferConfirmation ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation `json:"inbound_real_time_payments_transfer_confirmation,required,nullable"`
// An Inbound Wire Drawdown Payment object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
InboundWireDrawdownPayment ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment `json:"inbound_wire_drawdown_payment,required,nullable"`
// An Inbound Wire Drawdown Payment Reversal object. This field will be present in
// the JSON response if and only if `category` is equal to
// `inbound_wire_drawdown_payment_reversal`.
InboundWireDrawdownPaymentReversal ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal `json:"inbound_wire_drawdown_payment_reversal,required,nullable"`
// An Inbound Wire Reversal object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_reversal`.
InboundWireReversal ACHTransferSimulationTransactionSourceInboundWireReversal `json:"inbound_wire_reversal,required,nullable"`
// An Inbound Wire Transfer object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_transfer`.
InboundWireTransfer ACHTransferSimulationTransactionSourceInboundWireTransfer `json:"inbound_wire_transfer,required,nullable"`
// An Interest Payment object. This field will be present in the JSON response if
// and only if `category` is equal to `interest_payment`.
InterestPayment ACHTransferSimulationTransactionSourceInterestPayment `json:"interest_payment,required,nullable"`
// An Internal Source object. This field will be present in the JSON response if
// and only if `category` is equal to `internal_source`.
InternalSource ACHTransferSimulationTransactionSourceInternalSource `json:"internal_source,required,nullable"`
// A Real-Time Payments Transfer Acknowledgement object. This field will be present
// in the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_acknowledgement`.
RealTimePaymentsTransferAcknowledgement ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement `json:"real_time_payments_transfer_acknowledgement,required,nullable"`
// A Sample Funds object. This field will be present in the JSON response if and
// only if `category` is equal to `sample_funds`.
SampleFunds ACHTransferSimulationTransactionSourceSampleFunds `json:"sample_funds,required,nullable"`
// A Wire Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_intention`.
WireTransferIntention ACHTransferSimulationTransactionSourceWireTransferIntention `json:"wire_transfer_intention,required,nullable"`
// A Wire Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_rejection`.
WireTransferRejection ACHTransferSimulationTransactionSourceWireTransferRejection `json:"wire_transfer_rejection,required,nullable"`
JSON achTransferSimulationTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*ACHTransferSimulationTransactionSource) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSource) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceACHTransferIntention ¶
type ACHTransferSimulationTransactionSourceACHTransferIntention struct {
AccountNumber string `json:"account_number,required"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
RoutingNumber string `json:"routing_number,required"`
StatementDescriptor string `json:"statement_descriptor,required"`
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceACHTransferIntentionJSON
}
An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
func (*ACHTransferSimulationTransactionSourceACHTransferIntention) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceACHTransferIntention) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceACHTransferRejection ¶
type ACHTransferSimulationTransactionSourceACHTransferRejection struct {
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceACHTransferRejectionJSON
}
An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
func (*ACHTransferSimulationTransactionSourceACHTransferRejection) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceACHTransferRejection) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceACHTransferReturn ¶
type ACHTransferSimulationTransactionSourceACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceACHTransferReturnJSON
}
An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
func (*ACHTransferSimulationTransactionSourceACHTransferReturn) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode ¶
type ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInsufficientFund ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNoAccount ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountClosed ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePaymentStopped ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonTransactionAccount ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUncollectedFunds ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAmountFieldError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeFileRecordEditCriteria ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualName ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeLimitedParticipationDfi ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAddendaError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCorrectedReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeDuplicateEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeDuplicateReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeFieldError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeIatEntryCodingError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidCompanyID ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMandatoryFieldError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMisroutedReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNoErrorsFound ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonParticipantInIatProgram ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRdfiNonSettlement ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnNotADuplicate ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfXckEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeTimelyOriginalReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeTraceNumberError ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUntimelyReturn ACHTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "untimely_return" )
type ACHTransferSimulationTransactionSourceAccountTransferIntention ¶
type ACHTransferSimulationTransactionSourceAccountTransferIntention struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency `json:"currency,required"`
// The description you chose to give the transfer.
Description string `json:"description,required"`
// The identifier of the Account to where the Account Transfer was sent.
DestinationAccountID string `json:"destination_account_id,required"`
// The identifier of the Account from where the Account Transfer was sent.
SourceAccountID string `json:"source_account_id,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceAccountTransferIntentionJSON
}
An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
func (*ACHTransferSimulationTransactionSourceAccountTransferIntention) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceAccountTransferIntention) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency ¶
type ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyCad ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyChf ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyEur ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyGbp ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyJpy ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrencyUsd ACHTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCardDisputeAcceptance ¶
type ACHTransferSimulationTransactionSourceCardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON achTransferSimulationTransactionSourceCardDisputeAcceptanceJSON
}
A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
func (*ACHTransferSimulationTransactionSourceCardDisputeAcceptance) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefund ¶
type ACHTransferSimulationTransactionSourceCardRefund struct {
// The Card Refund identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency ACHTransferSimulationTransactionSourceCardRefundCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_refund`.
Type ACHTransferSimulationTransactionSourceCardRefundType `json:"type,required"`
JSON achTransferSimulationTransactionSourceCardRefundJSON
}
A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
func (*ACHTransferSimulationTransactionSourceCardRefund) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCardRefund) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundCurrency ¶
type ACHTransferSimulationTransactionSourceCardRefundCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCardRefundCurrencyCad ACHTransferSimulationTransactionSourceCardRefundCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCardRefundCurrencyChf ACHTransferSimulationTransactionSourceCardRefundCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCardRefundCurrencyEur ACHTransferSimulationTransactionSourceCardRefundCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCardRefundCurrencyGbp ACHTransferSimulationTransactionSourceCardRefundCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCardRefundCurrencyJpy ACHTransferSimulationTransactionSourceCardRefundCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCardRefundCurrencyUsd ACHTransferSimulationTransactionSourceCardRefundCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails struct {
// Fields specific to car rentals.
CarRental ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesNoExtraCharge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesGas ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesExtraMileage ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesLateReturn ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesOneWayServiceFee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesParkingViolation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNotApplicable ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesNoExtraCharge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesRestaurant ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesGiftShop ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesMiniBar ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesTelephone ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "telephone" // Other ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesOther ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "other" // Laundry ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesLaundry ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "laundry" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNotApplicable ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNoShow ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatFreeText ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatOrderNumber ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServiceJSON
}
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryNone ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBundledService ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryChangeFee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCargo ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGiftCard ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryLounge ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMedical ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryOther ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPets ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategorySeatFees ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStandby ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryServiceFee ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStore ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryTravelService ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUpgrades ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryWifi ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorNoCredit ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorOther ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNone ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNewTicket ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegJSON
}
func (*ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeNone ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed ACHTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type ACHTransferSimulationTransactionSourceCardRefundType ¶
type ACHTransferSimulationTransactionSourceCardRefundType string
A constant representing the object's type. For this resource it will always be `card_refund`.
const (
ACHTransferSimulationTransactionSourceCardRefundTypeCardRefund ACHTransferSimulationTransactionSourceCardRefundType = "card_refund"
)
type ACHTransferSimulationTransactionSourceCardRevenuePayment ¶
type ACHTransferSimulationTransactionSourceCardRevenuePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
// The account the card belonged to.
TransactedOnAccountID string `json:"transacted_on_account_id,required,nullable"`
JSON achTransferSimulationTransactionSourceCardRevenuePaymentJSON
}
A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
func (*ACHTransferSimulationTransactionSourceCardRevenuePayment) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCardRevenuePayment) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency ¶
type ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyCad ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyChf ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyEur ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyGbp ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyJpy ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrencyUsd ACHTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCardSettlement ¶
type ACHTransferSimulationTransactionSourceCardSettlement struct {
// The Card Settlement identifier.
ID string `json:"id,required"`
// The amount in the minor unit of the transaction's settlement currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The Card Authorization that was created prior to this Card Settlement, if on
// exists.
CardAuthorization string `json:"card_authorization,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's settlement currency.
Currency ACHTransferSimulationTransactionSourceCardSettlementCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The amount in the minor unit of the transaction's presentment currency.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's presentment currency.
PresentmentCurrency string `json:"presentment_currency,required"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_settlement`.
Type ACHTransferSimulationTransactionSourceCardSettlementType `json:"type,required"`
JSON achTransferSimulationTransactionSourceCardSettlementJSON
}
A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
func (*ACHTransferSimulationTransactionSourceCardSettlement) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCardSettlement) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementCurrency ¶
type ACHTransferSimulationTransactionSourceCardSettlementCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCardSettlementCurrencyCad ACHTransferSimulationTransactionSourceCardSettlementCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCardSettlementCurrencyChf ACHTransferSimulationTransactionSourceCardSettlementCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCardSettlementCurrencyEur ACHTransferSimulationTransactionSourceCardSettlementCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCardSettlementCurrencyGbp ACHTransferSimulationTransactionSourceCardSettlementCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCardSettlementCurrencyJpy ACHTransferSimulationTransactionSourceCardSettlementCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCardSettlementCurrencyUsd ACHTransferSimulationTransactionSourceCardSettlementCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails struct {
// Fields specific to car rentals.
CarRental ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesNoExtraCharge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesGas ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesExtraMileage ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesLateReturn ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesOneWayServiceFee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesParkingViolation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNotApplicable ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesNoExtraCharge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesRestaurant ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesGiftShop ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesMiniBar ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesTelephone ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "telephone" // Other ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesOther ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "other" // Laundry ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesLaundry ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "laundry" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNotApplicable ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNoShow ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatFreeText ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatOrderNumber ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServiceJSON
}
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryNone ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBundledService ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryChangeFee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCargo ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGiftCard ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryLounge ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMedical ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryOther ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPets ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategorySeatFees ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStandby ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryServiceFee ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStore ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryTravelService ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUpgrades ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryWifi ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorNoCredit ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorOther ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNone ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNewTicket ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON achTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegJSON
}
func (*ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeNone ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed ACHTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type ACHTransferSimulationTransactionSourceCardSettlementType ¶
type ACHTransferSimulationTransactionSourceCardSettlementType string
A constant representing the object's type. For this resource it will always be `card_settlement`.
const (
ACHTransferSimulationTransactionSourceCardSettlementTypeCardSettlement ACHTransferSimulationTransactionSourceCardSettlementType = "card_settlement"
)
type ACHTransferSimulationTransactionSourceCategory ¶
type ACHTransferSimulationTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. ACHTransferSimulationTransactionSourceCategoryAccountTransferIntention ACHTransferSimulationTransactionSourceCategory = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. ACHTransferSimulationTransactionSourceCategoryACHTransferIntention ACHTransferSimulationTransactionSourceCategory = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. ACHTransferSimulationTransactionSourceCategoryACHTransferRejection ACHTransferSimulationTransactionSourceCategory = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. ACHTransferSimulationTransactionSourceCategoryACHTransferReturn ACHTransferSimulationTransactionSourceCategory = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. ACHTransferSimulationTransactionSourceCategoryCardDisputeAcceptance ACHTransferSimulationTransactionSourceCategory = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. ACHTransferSimulationTransactionSourceCategoryCardRefund ACHTransferSimulationTransactionSourceCategory = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. ACHTransferSimulationTransactionSourceCategoryCardRevenuePayment ACHTransferSimulationTransactionSourceCategory = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. ACHTransferSimulationTransactionSourceCategoryCardSettlement ACHTransferSimulationTransactionSourceCategory = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. ACHTransferSimulationTransactionSourceCategoryCheckDepositAcceptance ACHTransferSimulationTransactionSourceCategory = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. ACHTransferSimulationTransactionSourceCategoryCheckDepositReturn ACHTransferSimulationTransactionSourceCategory = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. ACHTransferSimulationTransactionSourceCategoryCheckTransferDeposit ACHTransferSimulationTransactionSourceCategory = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. ACHTransferSimulationTransactionSourceCategoryCheckTransferIntention ACHTransferSimulationTransactionSourceCategory = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. ACHTransferSimulationTransactionSourceCategoryCheckTransferStopPaymentRequest ACHTransferSimulationTransactionSourceCategory = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. ACHTransferSimulationTransactionSourceCategoryFeePayment ACHTransferSimulationTransactionSourceCategory = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. ACHTransferSimulationTransactionSourceCategoryInboundACHTransfer ACHTransferSimulationTransactionSourceCategory = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. ACHTransferSimulationTransactionSourceCategoryInboundACHTransferReturnIntention ACHTransferSimulationTransactionSourceCategory = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. ACHTransferSimulationTransactionSourceCategoryInboundCheck ACHTransferSimulationTransactionSourceCategory = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. ACHTransferSimulationTransactionSourceCategoryInboundInternationalACHTransfer ACHTransferSimulationTransactionSourceCategory = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. ACHTransferSimulationTransactionSourceCategoryInboundRealTimePaymentsTransferConfirmation ACHTransferSimulationTransactionSourceCategory = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. ACHTransferSimulationTransactionSourceCategoryInboundWireDrawdownPayment ACHTransferSimulationTransactionSourceCategory = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. ACHTransferSimulationTransactionSourceCategoryInboundWireDrawdownPaymentReversal ACHTransferSimulationTransactionSourceCategory = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. ACHTransferSimulationTransactionSourceCategoryInboundWireReversal ACHTransferSimulationTransactionSourceCategory = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. ACHTransferSimulationTransactionSourceCategoryInboundWireTransfer ACHTransferSimulationTransactionSourceCategory = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. ACHTransferSimulationTransactionSourceCategoryInterestPayment ACHTransferSimulationTransactionSourceCategory = "interest_payment" // Internal Source: details will be under the `internal_source` object. ACHTransferSimulationTransactionSourceCategoryInternalSource ACHTransferSimulationTransactionSourceCategory = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. ACHTransferSimulationTransactionSourceCategoryRealTimePaymentsTransferAcknowledgement ACHTransferSimulationTransactionSourceCategory = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. ACHTransferSimulationTransactionSourceCategorySampleFunds ACHTransferSimulationTransactionSourceCategory = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. ACHTransferSimulationTransactionSourceCategoryWireTransferIntention ACHTransferSimulationTransactionSourceCategory = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. ACHTransferSimulationTransactionSourceCategoryWireTransferRejection ACHTransferSimulationTransactionSourceCategory = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. ACHTransferSimulationTransactionSourceCategoryOther ACHTransferSimulationTransactionSourceCategory = "other" )
type ACHTransferSimulationTransactionSourceCheckDepositAcceptance ¶
type ACHTransferSimulationTransactionSourceCheckDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON achTransferSimulationTransactionSourceCheckDepositAcceptanceJSON
}
A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
func (*ACHTransferSimulationTransactionSourceCheckDepositAcceptance) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCheckDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency ¶
type ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyCad ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyChf ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyEur ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyGbp ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyJpy ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyUsd ACHTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCheckDepositReturn ¶
type ACHTransferSimulationTransactionSourceCheckDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency `json:"currency,required"`
ReturnReason ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON achTransferSimulationTransactionSourceCheckDepositReturnJSON
}
A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
func (*ACHTransferSimulationTransactionSourceCheckDepositReturn) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCheckDepositReturn) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency ¶
type ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyCad ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyChf ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyEur ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyGbp ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyJpy ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCheckDepositReturnCurrencyUsd ACHTransferSimulationTransactionSourceCheckDepositReturnCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason ¶
type ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonACHConversionNotSupported ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonClosedAccount ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "closed_account" // The check has already been deposited. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonDuplicateSubmission ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "duplicate_submission" // Insufficient funds ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonInsufficientFunds ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonNoAccount ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "no_account" // The check was not authorized. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonNotAuthorized ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "not_authorized" // The check is too old. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonStaleDated ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonStopPayment ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnknownReason ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnmatchedDetails ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unmatched_details" // The image could not be read. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnreadableImage ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReasonEndorsementIrregular ACHTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "endorsement_irregular" )
type ACHTransferSimulationTransactionSourceCheckTransferDeposit ¶ added in v0.3.0
type ACHTransferSimulationTransactionSourceCheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type ACHTransferSimulationTransactionSourceCheckTransferDepositType `json:"type,required"`
JSON achTransferSimulationTransactionSourceCheckTransferDepositJSON
}
A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`.
func (*ACHTransferSimulationTransactionSourceCheckTransferDeposit) UnmarshalJSON ¶ added in v0.3.0
func (r *ACHTransferSimulationTransactionSourceCheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCheckTransferDepositType ¶ added in v0.3.0
type ACHTransferSimulationTransactionSourceCheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
ACHTransferSimulationTransactionSourceCheckTransferDepositTypeCheckTransferDeposit ACHTransferSimulationTransactionSourceCheckTransferDepositType = "check_transfer_deposit"
)
type ACHTransferSimulationTransactionSourceCheckTransferIntention ¶
type ACHTransferSimulationTransactionSourceCheckTransferIntention struct {
// The city of the check's destination.
AddressCity string `json:"address_city,required,nullable"`
// The street address of the check's destination.
AddressLine1 string `json:"address_line1,required,nullable"`
// The second line of the address of the check's destination.
AddressLine2 string `json:"address_line2,required,nullable"`
// The state of the check's destination.
AddressState string `json:"address_state,required,nullable"`
// The postal code of the check's destination.
AddressZip string `json:"address_zip,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency `json:"currency,required"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required,nullable"`
// The identifier of the Check Transfer with which this is associated.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceCheckTransferIntentionJSON
}
A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
func (*ACHTransferSimulationTransactionSourceCheckTransferIntention) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCheckTransferIntention) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency ¶
type ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyCad ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyChf ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyEur ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyGbp ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyJpy ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrencyUsd ACHTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "USD" )
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest ¶
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType `json:"type,required"`
JSON achTransferSimulationTransactionSourceCheckTransferStopPaymentRequestJSON
}
A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
func (*ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonMailDeliveryFailed ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonRejectedByIncrease ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonUnknown ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "unknown" )
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType ¶
type ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest ACHTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type ACHTransferSimulationTransactionSourceFeePayment ¶
type ACHTransferSimulationTransactionSourceFeePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency ACHTransferSimulationTransactionSourceFeePaymentCurrency `json:"currency,required"`
// The start of this payment's fee period, usually the first day of a month.
FeePeriodStart time.Time `json:"fee_period_start,required" format:"date"`
JSON achTransferSimulationTransactionSourceFeePaymentJSON
}
A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
func (*ACHTransferSimulationTransactionSourceFeePayment) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceFeePayment) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceFeePaymentCurrency ¶
type ACHTransferSimulationTransactionSourceFeePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceFeePaymentCurrencyCad ACHTransferSimulationTransactionSourceFeePaymentCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceFeePaymentCurrencyChf ACHTransferSimulationTransactionSourceFeePaymentCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceFeePaymentCurrencyEur ACHTransferSimulationTransactionSourceFeePaymentCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceFeePaymentCurrencyGbp ACHTransferSimulationTransactionSourceFeePaymentCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceFeePaymentCurrencyJpy ACHTransferSimulationTransactionSourceFeePaymentCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceFeePaymentCurrencyUsd ACHTransferSimulationTransactionSourceFeePaymentCurrency = "USD" )
type ACHTransferSimulationTransactionSourceInboundACHTransfer ¶
type ACHTransferSimulationTransactionSourceInboundACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCompanyID string `json:"originator_company_id,required"`
OriginatorCompanyName string `json:"originator_company_name,required"`
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
ReceiverName string `json:"receiver_name,required,nullable"`
TraceNumber string `json:"trace_number,required"`
JSON achTransferSimulationTransactionSourceInboundACHTransferJSON
}
An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
func (*ACHTransferSimulationTransactionSourceInboundACHTransfer) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundCheck ¶
type ACHTransferSimulationTransactionSourceInboundCheck struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
CheckFrontImageFileID string `json:"check_front_image_file_id,required,nullable"`
CheckNumber string `json:"check_number,required,nullable"`
CheckRearImageFileID string `json:"check_rear_image_file_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency ACHTransferSimulationTransactionSourceInboundCheckCurrency `json:"currency,required"`
JSON achTransferSimulationTransactionSourceInboundCheckJSON
}
An Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
func (*ACHTransferSimulationTransactionSourceInboundCheck) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundCheck) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundCheckCurrency ¶
type ACHTransferSimulationTransactionSourceInboundCheckCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceInboundCheckCurrencyCad ACHTransferSimulationTransactionSourceInboundCheckCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceInboundCheckCurrencyChf ACHTransferSimulationTransactionSourceInboundCheckCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceInboundCheckCurrencyEur ACHTransferSimulationTransactionSourceInboundCheckCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceInboundCheckCurrencyGbp ACHTransferSimulationTransactionSourceInboundCheckCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceInboundCheckCurrencyJpy ACHTransferSimulationTransactionSourceInboundCheckCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceInboundCheckCurrencyUsd ACHTransferSimulationTransactionSourceInboundCheckCurrency = "USD" )
type ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer ¶
type ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON achTransferSimulationTransactionSourceInboundInternationalACHTransferJSON
}
An Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
func (*ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation ¶
type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation struct {
// The amount in the minor unit of the transfer's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
// currency. This will always be "USD" for a Real-Time Payments transfer.
Currency ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the transfer
TransactionIdentification string `json:"transaction_identification,required"`
JSON achTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationJSON
}
An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
func (*ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency ¶
type ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyCad ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyChf ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyEur ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyGbp ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyJpy ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyUsd ACHTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "USD" )
type ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment ¶
type ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
JSON achTransferSimulationTransactionSourceInboundWireDrawdownPaymentJSON
}
An Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
func (*ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal ¶
type ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
JSON achTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversalJSON
}
An Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
func (*ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundWireReversal ¶
type ACHTransferSimulationTransactionSourceInboundWireReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON achTransferSimulationTransactionSourceInboundWireReversalJSON
}
An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
func (*ACHTransferSimulationTransactionSourceInboundWireReversal) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundWireReversal) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInboundWireTransfer ¶
type ACHTransferSimulationTransactionSourceInboundWireTransfer struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
JSON achTransferSimulationTransactionSourceInboundWireTransferJSON
}
An Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
func (*ACHTransferSimulationTransactionSourceInboundWireTransfer) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInboundWireTransfer) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInterestPayment ¶
type ACHTransferSimulationTransactionSourceInterestPayment struct {
// The account on which the interest was accrued.
AccruedOnAccountID string `json:"accrued_on_account_id,required,nullable"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency ACHTransferSimulationTransactionSourceInterestPaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
JSON achTransferSimulationTransactionSourceInterestPaymentJSON
}
An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
func (*ACHTransferSimulationTransactionSourceInterestPayment) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInterestPayment) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInterestPaymentCurrency ¶
type ACHTransferSimulationTransactionSourceInterestPaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyCad ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyChf ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyEur ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyGbp ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyJpy ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceInterestPaymentCurrencyUsd ACHTransferSimulationTransactionSourceInterestPaymentCurrency = "USD" )
type ACHTransferSimulationTransactionSourceInternalSource ¶
type ACHTransferSimulationTransactionSourceInternalSource struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency ACHTransferSimulationTransactionSourceInternalSourceCurrency `json:"currency,required"`
Reason ACHTransferSimulationTransactionSourceInternalSourceReason `json:"reason,required"`
JSON achTransferSimulationTransactionSourceInternalSourceJSON
}
An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
func (*ACHTransferSimulationTransactionSourceInternalSource) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceInternalSource) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceInternalSourceCurrency ¶
type ACHTransferSimulationTransactionSourceInternalSourceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) ACHTransferSimulationTransactionSourceInternalSourceCurrencyCad ACHTransferSimulationTransactionSourceInternalSourceCurrency = "CAD" // Swiss Franc (CHF) ACHTransferSimulationTransactionSourceInternalSourceCurrencyChf ACHTransferSimulationTransactionSourceInternalSourceCurrency = "CHF" // Euro (EUR) ACHTransferSimulationTransactionSourceInternalSourceCurrencyEur ACHTransferSimulationTransactionSourceInternalSourceCurrency = "EUR" // British Pound (GBP) ACHTransferSimulationTransactionSourceInternalSourceCurrencyGbp ACHTransferSimulationTransactionSourceInternalSourceCurrency = "GBP" // Japanese Yen (JPY) ACHTransferSimulationTransactionSourceInternalSourceCurrencyJpy ACHTransferSimulationTransactionSourceInternalSourceCurrency = "JPY" // US Dollar (USD) ACHTransferSimulationTransactionSourceInternalSourceCurrencyUsd ACHTransferSimulationTransactionSourceInternalSourceCurrency = "USD" )
type ACHTransferSimulationTransactionSourceInternalSourceReason ¶
type ACHTransferSimulationTransactionSourceInternalSourceReason string
const ( // Account closure ACHTransferSimulationTransactionSourceInternalSourceReasonAccountClosure ACHTransferSimulationTransactionSourceInternalSourceReason = "account_closure" // Bank migration ACHTransferSimulationTransactionSourceInternalSourceReasonBankMigration ACHTransferSimulationTransactionSourceInternalSourceReason = "bank_migration" // Cashback ACHTransferSimulationTransactionSourceInternalSourceReasonCashback ACHTransferSimulationTransactionSourceInternalSourceReason = "cashback" // Check adjustment ACHTransferSimulationTransactionSourceInternalSourceReasonCheckAdjustment ACHTransferSimulationTransactionSourceInternalSourceReason = "check_adjustment" // Collection receivable ACHTransferSimulationTransactionSourceInternalSourceReasonCollectionReceivable ACHTransferSimulationTransactionSourceInternalSourceReason = "collection_receivable" // Empyreal adjustment ACHTransferSimulationTransactionSourceInternalSourceReasonEmpyrealAdjustment ACHTransferSimulationTransactionSourceInternalSourceReason = "empyreal_adjustment" // Error ACHTransferSimulationTransactionSourceInternalSourceReasonError ACHTransferSimulationTransactionSourceInternalSourceReason = "error" // Error correction ACHTransferSimulationTransactionSourceInternalSourceReasonErrorCorrection ACHTransferSimulationTransactionSourceInternalSourceReason = "error_correction" // Fees ACHTransferSimulationTransactionSourceInternalSourceReasonFees ACHTransferSimulationTransactionSourceInternalSourceReason = "fees" // Interest ACHTransferSimulationTransactionSourceInternalSourceReasonInterest ACHTransferSimulationTransactionSourceInternalSourceReason = "interest" // Negative balance forgiveness ACHTransferSimulationTransactionSourceInternalSourceReasonNegativeBalanceForgiveness ACHTransferSimulationTransactionSourceInternalSourceReason = "negative_balance_forgiveness" // Sample funds ACHTransferSimulationTransactionSourceInternalSourceReasonSampleFunds ACHTransferSimulationTransactionSourceInternalSourceReason = "sample_funds" // Sample funds return ACHTransferSimulationTransactionSourceInternalSourceReasonSampleFundsReturn ACHTransferSimulationTransactionSourceInternalSourceReason = "sample_funds_return" )
type ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement ¶
type ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement struct {
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The identifier of the Real-Time Payments Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgementJSON
}
A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
func (*ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceSampleFunds ¶
type ACHTransferSimulationTransactionSourceSampleFunds struct {
// Where the sample funds came from.
Originator string `json:"originator,required"`
JSON achTransferSimulationTransactionSourceSampleFundsJSON
}
A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
func (*ACHTransferSimulationTransactionSourceSampleFunds) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceSampleFunds) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceWireTransferIntention ¶
type ACHTransferSimulationTransactionSourceWireTransferIntention struct {
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceWireTransferIntentionJSON
}
A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
func (*ACHTransferSimulationTransactionSourceWireTransferIntention) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceWireTransferIntention) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionSourceWireTransferRejection ¶
type ACHTransferSimulationTransactionSourceWireTransferRejection struct {
TransferID string `json:"transfer_id,required"`
JSON achTransferSimulationTransactionSourceWireTransferRejectionJSON
}
A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
func (*ACHTransferSimulationTransactionSourceWireTransferRejection) UnmarshalJSON ¶
func (r *ACHTransferSimulationTransactionSourceWireTransferRejection) UnmarshalJSON(data []byte) (err error)
type ACHTransferSimulationTransactionType ¶
type ACHTransferSimulationTransactionType string
A constant representing the object's type. For this resource it will always be `transaction`.
const (
ACHTransferSimulationTransactionTypeTransaction ACHTransferSimulationTransactionType = "transaction"
)
type ACHTransferSimulationType ¶
type ACHTransferSimulationType string
A constant representing the object's type. For this resource it will always be `inbound_ach_transfer_simulation_result`.
const (
ACHTransferSimulationTypeInboundACHTransferSimulationResult ACHTransferSimulationType = "inbound_ach_transfer_simulation_result"
)
type ACHTransferStandardEntryClassCode ¶
type ACHTransferStandardEntryClassCode string
The Standard Entry Class (SEC) code to use for the transfer.
const ( // Corporate Credit and Debit (CCD). ACHTransferStandardEntryClassCodeCorporateCreditOrDebit ACHTransferStandardEntryClassCode = "corporate_credit_or_debit" // Prearranged Payments and Deposits (PPD). ACHTransferStandardEntryClassCodePrearrangedPaymentsAndDeposit ACHTransferStandardEntryClassCode = "prearranged_payments_and_deposit" // Internet Initiated (WEB). ACHTransferStandardEntryClassCodeInternetInitiated ACHTransferStandardEntryClassCode = "internet_initiated" )
type ACHTransferStatus ¶
type ACHTransferStatus string
The lifecycle status of the transfer.
const ( // The transfer is pending approval. ACHTransferStatusPendingApproval ACHTransferStatus = "pending_approval" // The transfer has been canceled. ACHTransferStatusCanceled ACHTransferStatus = "canceled" // The transfer is pending review by Increase. ACHTransferStatusPendingReviewing ACHTransferStatus = "pending_reviewing" // The transfer is pending submission to the Federal Reserve. ACHTransferStatusPendingSubmission ACHTransferStatus = "pending_submission" // The transfer is complete. ACHTransferStatusSubmitted ACHTransferStatus = "submitted" // The transfer has been returned. ACHTransferStatusReturned ACHTransferStatus = "returned" // The transfer requires attention from an Increase operator. ACHTransferStatusRequiresAttention ACHTransferStatus = "requires_attention" // The transfer has been rejected. ACHTransferStatusRejected ACHTransferStatus = "rejected" )
type ACHTransferSubmission ¶
type ACHTransferSubmission struct {
// When the funds transfer is expected to settle in the recipient's account.
// Credits may be available sooner, at the receiving banks discretion. The FedACH
// schedule is published
// [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html).
ExpectedFundsSettlementAt time.Time `json:"expected_funds_settlement_at,required" format:"date-time"`
// When the ACH transfer was sent to FedACH.
SubmittedAt time.Time `json:"submitted_at,required" format:"date-time"`
// The trace number for the submission.
TraceNumber string `json:"trace_number,required"`
JSON achTransferSubmissionJSON
}
After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their (posted schedule)[https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html].
func (*ACHTransferSubmission) UnmarshalJSON ¶
func (r *ACHTransferSubmission) UnmarshalJSON(data []byte) (err error)
type ACHTransferType ¶
type ACHTransferType string
A constant representing the object's type. For this resource it will always be `ach_transfer`.
const (
ACHTransferTypeACHTransfer ACHTransferType = "ach_transfer"
)
type Account ¶
type Account struct {
// The Account identifier.
ID string `json:"id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account
// currency.
Currency AccountCurrency `json:"currency,required"`
// The identifier for the Entity the Account belongs to.
EntityID string `json:"entity_id,required,nullable"`
// The identifier of an Entity that, while not owning the Account, is associated
// with its activity.
InformationalEntityID string `json:"informational_entity_id,required,nullable"`
// The interest accrued but not yet paid, expressed as a string containing a
// floating-point value.
InterestAccrued string `json:"interest_accrued,required"`
// The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which
// interest was accrued.
InterestAccruedAt time.Time `json:"interest_accrued_at,required,nullable" format:"date"`
// The Interest Rate currently being earned on the account, as a string containing
// a decimal number. For example, a 1% interest rate would be represented as
// "0.01".
InterestRate string `json:"interest_rate,required"`
// The name you choose for the Account.
Name string `json:"name,required"`
// The status of the Account.
Status AccountStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `account`.
Type AccountType `json:"type,required"`
JSON accountJSON
}
Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
func (*Account) UnmarshalJSON ¶
type AccountCurrency ¶
type AccountCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.
const ( // Canadian Dollar (CAD) AccountCurrencyCad AccountCurrency = "CAD" // Swiss Franc (CHF) AccountCurrencyChf AccountCurrency = "CHF" // Euro (EUR) AccountCurrencyEur AccountCurrency = "EUR" // British Pound (GBP) AccountCurrencyGbp AccountCurrency = "GBP" // Japanese Yen (JPY) AccountCurrencyJpy AccountCurrency = "JPY" // US Dollar (USD) AccountCurrencyUsd AccountCurrency = "USD" )
type AccountListParams ¶
type AccountListParams struct {
CreatedAt param.Field[AccountListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Filter Accounts for those belonging to the specified Entity.
EntityID param.Field[string] `query:"entity_id"`
// Filter Accounts for those belonging to the specified Entity as informational.
InformationalEntityID param.Field[string] `query:"informational_entity_id"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Accounts for those with the specified status.
Status param.Field[AccountListParamsStatus] `query:"status"`
}
func (AccountListParams) URLQuery ¶
func (r AccountListParams) URLQuery() (v url.Values)
URLQuery serializes AccountListParams's query parameters as `url.Values`.
type AccountListParamsCreatedAt ¶
type AccountListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (AccountListParamsCreatedAt) URLQuery ¶
func (r AccountListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes AccountListParamsCreatedAt's query parameters as `url.Values`.
type AccountListParamsStatus ¶
type AccountListParamsStatus string
Filter Accounts for those with the specified status.
const ( // Open Accounts that are ready to use. AccountListParamsStatusOpen AccountListParamsStatus = "open" // Closed Accounts on which no new activity can occur. AccountListParamsStatusClosed AccountListParamsStatus = "closed" )
type AccountNewParams ¶
type AccountNewParams struct {
// The name you choose for the Account.
Name param.Field[string] `json:"name,required"`
// The identifier for the Entity that will own the Account.
EntityID param.Field[string] `json:"entity_id"`
// The identifier of an Entity that, while not owning the Account, is associated
// with its activity. Its relationship to your group must be `informational`.
InformationalEntityID param.Field[string] `json:"informational_entity_id"`
// The identifier for the Program that this Account falls under. Required if you
// operate more than one Program.
ProgramID param.Field[string] `json:"program_id"`
}
func (AccountNewParams) MarshalJSON ¶
func (r AccountNewParams) MarshalJSON() (data []byte, err error)
type AccountNumber ¶
type AccountNumber struct {
// The Account Number identifier.
ID string `json:"id,required"`
// The identifier for the account this Account Number belongs to.
AccountID string `json:"account_id,required"`
// The account number.
AccountNumber string `json:"account_number,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
// Number was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The name you choose for the Account Number.
Name string `json:"name,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
// This indicates if payments can be made to the Account Number.
Status AccountNumberStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `account_number`.
Type AccountNumberType `json:"type,required"`
JSON accountNumberJSON
}
Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
func (*AccountNumber) UnmarshalJSON ¶
func (r *AccountNumber) UnmarshalJSON(data []byte) (err error)
type AccountNumberListParams ¶
type AccountNumberListParams struct {
// Filter Account Numbers to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[AccountNumberListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// The status to retrieve Account Numbers for.
Status param.Field[AccountNumberListParamsStatus] `query:"status"`
}
func (AccountNumberListParams) URLQuery ¶
func (r AccountNumberListParams) URLQuery() (v url.Values)
URLQuery serializes AccountNumberListParams's query parameters as `url.Values`.
type AccountNumberListParamsCreatedAt ¶
type AccountNumberListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (AccountNumberListParamsCreatedAt) URLQuery ¶
func (r AccountNumberListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes AccountNumberListParamsCreatedAt's query parameters as `url.Values`.
type AccountNumberListParamsStatus ¶
type AccountNumberListParamsStatus string
The status to retrieve Account Numbers for.
const ( // The account number is active. AccountNumberListParamsStatusActive AccountNumberListParamsStatus = "active" // The account number is temporarily disabled. AccountNumberListParamsStatusDisabled AccountNumberListParamsStatus = "disabled" // The account number is permanently disabled. AccountNumberListParamsStatusCanceled AccountNumberListParamsStatus = "canceled" )
type AccountNumberNewParams ¶
type AccountNumberNewParams struct {
// The Account the Account Number should belong to.
AccountID param.Field[string] `json:"account_id,required"`
// The name you choose for the Account Number.
Name param.Field[string] `json:"name,required"`
}
func (AccountNumberNewParams) MarshalJSON ¶
func (r AccountNumberNewParams) MarshalJSON() (data []byte, err error)
type AccountNumberService ¶
type AccountNumberService struct {
Options []option.RequestOption
}
AccountNumberService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountNumberService method instead.
func NewAccountNumberService ¶
func NewAccountNumberService(opts ...option.RequestOption) (r *AccountNumberService)
NewAccountNumberService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AccountNumberService) Get ¶
func (r *AccountNumberService) Get(ctx context.Context, accountNumberID string, opts ...option.RequestOption) (res *AccountNumber, err error)
Retrieve an Account Number
func (*AccountNumberService) List ¶
func (r *AccountNumberService) List(ctx context.Context, query AccountNumberListParams, opts ...option.RequestOption) (res *shared.Page[AccountNumber], err error)
List Account Numbers
func (*AccountNumberService) ListAutoPaging ¶
func (r *AccountNumberService) ListAutoPaging(ctx context.Context, query AccountNumberListParams, opts ...option.RequestOption) *shared.PageAutoPager[AccountNumber]
List Account Numbers
func (*AccountNumberService) New ¶
func (r *AccountNumberService) New(ctx context.Context, body AccountNumberNewParams, opts ...option.RequestOption) (res *AccountNumber, err error)
Create an Account Number
func (*AccountNumberService) Update ¶
func (r *AccountNumberService) Update(ctx context.Context, accountNumberID string, body AccountNumberUpdateParams, opts ...option.RequestOption) (res *AccountNumber, err error)
Update an Account Number
type AccountNumberStatus ¶
type AccountNumberStatus string
This indicates if payments can be made to the Account Number.
const ( // The account number is active. AccountNumberStatusActive AccountNumberStatus = "active" // The account number is temporarily disabled. AccountNumberStatusDisabled AccountNumberStatus = "disabled" // The account number is permanently disabled. AccountNumberStatusCanceled AccountNumberStatus = "canceled" )
type AccountNumberType ¶
type AccountNumberType string
A constant representing the object's type. For this resource it will always be `account_number`.
const (
AccountNumberTypeAccountNumber AccountNumberType = "account_number"
)
type AccountNumberUpdateParams ¶
type AccountNumberUpdateParams struct {
// The name you choose for the Account Number.
Name param.Field[string] `json:"name"`
// This indicates if transfers can be made to the Account Number.
Status param.Field[AccountNumberUpdateParamsStatus] `json:"status"`
}
func (AccountNumberUpdateParams) MarshalJSON ¶
func (r AccountNumberUpdateParams) MarshalJSON() (data []byte, err error)
type AccountNumberUpdateParamsStatus ¶
type AccountNumberUpdateParamsStatus string
This indicates if transfers can be made to the Account Number.
const ( // The account number is active. AccountNumberUpdateParamsStatusActive AccountNumberUpdateParamsStatus = "active" // The account number is temporarily disabled. AccountNumberUpdateParamsStatusDisabled AccountNumberUpdateParamsStatus = "disabled" // The account number is permanently disabled. AccountNumberUpdateParamsStatusCanceled AccountNumberUpdateParamsStatus = "canceled" )
type AccountService ¶
type AccountService struct {
Options []option.RequestOption
}
AccountService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountService method instead.
func NewAccountService ¶
func NewAccountService(opts ...option.RequestOption) (r *AccountService)
NewAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AccountService) Close ¶
func (r *AccountService) Close(ctx context.Context, accountID string, opts ...option.RequestOption) (res *Account, err error)
Close an Account
func (*AccountService) Get ¶
func (r *AccountService) Get(ctx context.Context, accountID string, opts ...option.RequestOption) (res *Account, err error)
Retrieve an Account
func (*AccountService) List ¶
func (r *AccountService) List(ctx context.Context, query AccountListParams, opts ...option.RequestOption) (res *shared.Page[Account], err error)
List Accounts
func (*AccountService) ListAutoPaging ¶
func (r *AccountService) ListAutoPaging(ctx context.Context, query AccountListParams, opts ...option.RequestOption) *shared.PageAutoPager[Account]
List Accounts
func (*AccountService) New ¶
func (r *AccountService) New(ctx context.Context, body AccountNewParams, opts ...option.RequestOption) (res *Account, err error)
Create an Account
func (*AccountService) Update ¶
func (r *AccountService) Update(ctx context.Context, accountID string, body AccountUpdateParams, opts ...option.RequestOption) (res *Account, err error)
Update an Account
type AccountStatement ¶
type AccountStatement struct {
// The Account Statement identifier.
ID string `json:"id,required"`
// The identifier for the Account this Account Statement belongs to.
AccountID string `json:"account_id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account
// Statement was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The Account's balance at the start of its statement period.
EndingBalance int64 `json:"ending_balance,required"`
// The identifier of the File containing a PDF of the statement.
FileID string `json:"file_id,required"`
// The Account's balance at the start of its statement period.
StartingBalance int64 `json:"starting_balance,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
// of the period the Account Statement covers.
StatementPeriodEnd time.Time `json:"statement_period_end,required" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
// start of the period the Account Statement covers.
StatementPeriodStart time.Time `json:"statement_period_start,required" format:"date-time"`
// A constant representing the object's type. For this resource it will always be
// `account_statement`.
Type AccountStatementType `json:"type,required"`
JSON accountStatementJSON
}
Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
func (*AccountStatement) UnmarshalJSON ¶
func (r *AccountStatement) UnmarshalJSON(data []byte) (err error)
type AccountStatementListParams ¶
type AccountStatementListParams struct {
// Filter Account Statements to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
StatementPeriodStart param.Field[AccountStatementListParamsStatementPeriodStart] `query:"statement_period_start"`
}
func (AccountStatementListParams) URLQuery ¶
func (r AccountStatementListParams) URLQuery() (v url.Values)
URLQuery serializes AccountStatementListParams's query parameters as `url.Values`.
type AccountStatementListParamsStatementPeriodStart ¶
type AccountStatementListParamsStatementPeriodStart struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (AccountStatementListParamsStatementPeriodStart) URLQuery ¶
func (r AccountStatementListParamsStatementPeriodStart) URLQuery() (v url.Values)
URLQuery serializes AccountStatementListParamsStatementPeriodStart's query parameters as `url.Values`.
type AccountStatementService ¶
type AccountStatementService struct {
Options []option.RequestOption
}
AccountStatementService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountStatementService method instead.
func NewAccountStatementService ¶
func NewAccountStatementService(opts ...option.RequestOption) (r *AccountStatementService)
NewAccountStatementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AccountStatementService) Get ¶
func (r *AccountStatementService) Get(ctx context.Context, accountStatementID string, opts ...option.RequestOption) (res *AccountStatement, err error)
Retrieve an Account Statement
func (*AccountStatementService) List ¶
func (r *AccountStatementService) List(ctx context.Context, query AccountStatementListParams, opts ...option.RequestOption) (res *shared.Page[AccountStatement], err error)
List Account Statements
func (*AccountStatementService) ListAutoPaging ¶
func (r *AccountStatementService) ListAutoPaging(ctx context.Context, query AccountStatementListParams, opts ...option.RequestOption) *shared.PageAutoPager[AccountStatement]
List Account Statements
type AccountStatementType ¶
type AccountStatementType string
A constant representing the object's type. For this resource it will always be `account_statement`.
const (
AccountStatementTypeAccountStatement AccountStatementType = "account_statement"
)
type AccountStatus ¶
type AccountStatus string
The status of the Account.
const ( // Open Accounts that are ready to use. AccountStatusOpen AccountStatus = "open" // Closed Accounts on which no new activity can occur. AccountStatusClosed AccountStatus = "closed" )
type AccountTransfer ¶
type AccountTransfer struct {
// The account transfer's identifier.
ID string `json:"id,required"`
// The Account to which the transfer belongs.
AccountID string `json:"account_id,required"`
// The transfer amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// If your account requires approvals for transfers and the transfer was approved,
// this will contain details of the approval.
Approval AccountTransferApproval `json:"approval,required,nullable"`
// If your account requires approvals for transfers and the transfer was not
// approved, this will contain details of the cancellation.
Cancellation AccountTransferCancellation `json:"cancellation,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency AccountTransferCurrency `json:"currency,required"`
// The description that will show on the transactions.
Description string `json:"description,required"`
// The destination account's identifier.
DestinationAccountID string `json:"destination_account_id,required"`
// The ID for the transaction receiving the transfer.
DestinationTransactionID string `json:"destination_transaction_id,required,nullable"`
// The transfer's network.
Network AccountTransferNetwork `json:"network,required"`
// The ID for the pending transaction representing the transfer. A pending
// transaction is created when the transfer
// [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
// by someone else in your organization.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The lifecycle status of the transfer.
Status AccountTransferStatus `json:"status,required"`
// The ID for the transaction funding the transfer.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `account_transfer`.
Type AccountTransferType `json:"type,required"`
// The unique identifier you chose for this transfer.
UniqueIdentifier string `json:"unique_identifier,required,nullable"`
JSON accountTransferJSON
}
Account transfers move funds between your own accounts at Increase.
func (*AccountTransfer) UnmarshalJSON ¶
func (r *AccountTransfer) UnmarshalJSON(data []byte) (err error)
type AccountTransferApproval ¶
type AccountTransferApproval struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was approved.
ApprovedAt time.Time `json:"approved_at,required" format:"date-time"`
// If the Transfer was approved by a user in the dashboard, the email address of
// that user.
ApprovedBy string `json:"approved_by,required,nullable"`
JSON accountTransferApprovalJSON
}
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
func (*AccountTransferApproval) UnmarshalJSON ¶
func (r *AccountTransferApproval) UnmarshalJSON(data []byte) (err error)
type AccountTransferCancellation ¶
type AccountTransferCancellation struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Transfer was canceled.
CanceledAt time.Time `json:"canceled_at,required" format:"date-time"`
// If the Transfer was canceled by a user in the dashboard, the email address of
// that user.
CanceledBy string `json:"canceled_by,required,nullable"`
JSON accountTransferCancellationJSON
}
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
func (*AccountTransferCancellation) UnmarshalJSON ¶
func (r *AccountTransferCancellation) UnmarshalJSON(data []byte) (err error)
type AccountTransferCurrency ¶
type AccountTransferCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) AccountTransferCurrencyCad AccountTransferCurrency = "CAD" // Swiss Franc (CHF) AccountTransferCurrencyChf AccountTransferCurrency = "CHF" // Euro (EUR) AccountTransferCurrencyEur AccountTransferCurrency = "EUR" // British Pound (GBP) AccountTransferCurrencyGbp AccountTransferCurrency = "GBP" // Japanese Yen (JPY) AccountTransferCurrencyJpy AccountTransferCurrency = "JPY" // US Dollar (USD) AccountTransferCurrencyUsd AccountTransferCurrency = "USD" )
type AccountTransferListParams ¶
type AccountTransferListParams struct {
// Filter Account Transfers to those that originated from the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[AccountTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Account Transfers to the one with the specified unique identifier.
UniqueIdentifier param.Field[string] `query:"unique_identifier"`
}
func (AccountTransferListParams) URLQuery ¶
func (r AccountTransferListParams) URLQuery() (v url.Values)
URLQuery serializes AccountTransferListParams's query parameters as `url.Values`.
type AccountTransferListParamsCreatedAt ¶
type AccountTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (AccountTransferListParamsCreatedAt) URLQuery ¶
func (r AccountTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes AccountTransferListParamsCreatedAt's query parameters as `url.Values`.
type AccountTransferNetwork ¶
type AccountTransferNetwork string
The transfer's network.
const (
AccountTransferNetworkAccount AccountTransferNetwork = "account"
)
type AccountTransferNewParams ¶
type AccountTransferNewParams struct {
// The identifier for the account that will send the transfer.
AccountID param.Field[string] `json:"account_id,required"`
// The transfer amount in the minor unit of the account currency. For dollars, for
// example, this is cents.
Amount param.Field[int64] `json:"amount,required"`
// The description you choose to give the transfer.
Description param.Field[string] `json:"description,required"`
// The identifier for the account that will receive the transfer.
DestinationAccountID param.Field[string] `json:"destination_account_id,required"`
// Whether the transfer requires explicit approval via the dashboard or API.
RequireApproval param.Field[bool] `json:"require_approval"`
// A unique identifier you choose for the transfer. Reusing this identifier for
// another transfer will result in an error. You can query for the transfer
// associated with this identifier using the List endpoint.
UniqueIdentifier param.Field[string] `json:"unique_identifier"`
}
func (AccountTransferNewParams) MarshalJSON ¶
func (r AccountTransferNewParams) MarshalJSON() (data []byte, err error)
type AccountTransferService ¶
type AccountTransferService struct {
Options []option.RequestOption
}
AccountTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAccountTransferService method instead.
func NewAccountTransferService ¶
func NewAccountTransferService(opts ...option.RequestOption) (r *AccountTransferService)
NewAccountTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*AccountTransferService) Approve ¶
func (r *AccountTransferService) Approve(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
Approve an Account Transfer
func (*AccountTransferService) Cancel ¶
func (r *AccountTransferService) Cancel(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
Cancel an Account Transfer
func (*AccountTransferService) Get ¶
func (r *AccountTransferService) Get(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
Retrieve an Account Transfer
func (*AccountTransferService) List ¶
func (r *AccountTransferService) List(ctx context.Context, query AccountTransferListParams, opts ...option.RequestOption) (res *shared.Page[AccountTransfer], err error)
List Account Transfers
func (*AccountTransferService) ListAutoPaging ¶
func (r *AccountTransferService) ListAutoPaging(ctx context.Context, query AccountTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[AccountTransfer]
List Account Transfers
func (*AccountTransferService) New ¶
func (r *AccountTransferService) New(ctx context.Context, body AccountTransferNewParams, opts ...option.RequestOption) (res *AccountTransfer, err error)
Create an Account Transfer
type AccountTransferStatus ¶
type AccountTransferStatus string
The lifecycle status of the transfer.
const ( // The transfer is pending approval. AccountTransferStatusPendingApproval AccountTransferStatus = "pending_approval" // The transfer has been canceled. AccountTransferStatusCanceled AccountTransferStatus = "canceled" // The transfer has been completed. AccountTransferStatusComplete AccountTransferStatus = "complete" )
type AccountTransferType ¶
type AccountTransferType string
A constant representing the object's type. For this resource it will always be `account_transfer`.
const (
AccountTransferTypeAccountTransfer AccountTransferType = "account_transfer"
)
type AccountType ¶
type AccountType string
A constant representing the object's type. For this resource it will always be `account`.
const (
AccountTypeAccount AccountType = "account"
)
type AccountUpdateParams ¶
type AccountUpdateParams struct {
// The new name of the Account.
Name param.Field[string] `json:"name"`
}
func (AccountUpdateParams) MarshalJSON ¶
func (r AccountUpdateParams) MarshalJSON() (data []byte, err error)
type BalanceLookupLookupParams ¶
type BalanceLookupLookupParams struct {
// The Account to query the balance for.
AccountID param.Field[string] `json:"account_id,required"`
// The moment to query the balance at. If not set, returns the current balances.
AtTime param.Field[time.Time] `json:"at_time" format:"date-time"`
}
func (BalanceLookupLookupParams) MarshalJSON ¶
func (r BalanceLookupLookupParams) MarshalJSON() (data []byte, err error)
type BalanceLookupLookupResponse ¶
type BalanceLookupLookupResponse struct {
// The identifier for the account for which the balance was queried.
AccountID string `json:"account_id,required"`
// The Account's available balance, representing the current balance less any open
// Pending Transactions on the Account.
AvailableBalance int64 `json:"available_balance,required"`
// The Account's current balance, representing the sum of all posted Transactions
// on the Account.
CurrentBalance int64 `json:"current_balance,required"`
// A constant representing the object's type. For this resource it will always be
// `balance_lookup`.
Type BalanceLookupLookupResponseType `json:"type,required"`
JSON balanceLookupLookupResponseJSON
}
Represents a request to lookup the balance of an Account at a given point in time.
func (*BalanceLookupLookupResponse) UnmarshalJSON ¶
func (r *BalanceLookupLookupResponse) UnmarshalJSON(data []byte) (err error)
type BalanceLookupLookupResponseType ¶
type BalanceLookupLookupResponseType string
A constant representing the object's type. For this resource it will always be `balance_lookup`.
const (
BalanceLookupLookupResponseTypeBalanceLookup BalanceLookupLookupResponseType = "balance_lookup"
)
type BalanceLookupService ¶
type BalanceLookupService struct {
Options []option.RequestOption
}
BalanceLookupService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBalanceLookupService method instead.
func NewBalanceLookupService ¶
func NewBalanceLookupService(opts ...option.RequestOption) (r *BalanceLookupService)
NewBalanceLookupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*BalanceLookupService) Lookup ¶
func (r *BalanceLookupService) Lookup(ctx context.Context, body BalanceLookupLookupParams, opts ...option.RequestOption) (res *BalanceLookupLookupResponse, err error)
Look up the balance for an Account
type BookkeepingAccount ¶
type BookkeepingAccount struct {
// The account identifier.
ID string `json:"id,required"`
// The API Account associated with this bookkeeping account.
AccountID string `json:"account_id,required,nullable"`
// The compliance category of the account.
ComplianceCategory BookkeepingAccountComplianceCategory `json:"compliance_category,required,nullable"`
// The Entity associated with this bookkeeping account.
EntityID string `json:"entity_id,required,nullable"`
// The name you choose for the account.
Name string `json:"name,required"`
// A constant representing the object's type. For this resource it will always be
// `bookkeeping_account`.
Type BookkeepingAccountType `json:"type,required"`
JSON bookkeepingAccountJSON
}
Accounts are T-accounts. They can store accounting entries.
func (*BookkeepingAccount) UnmarshalJSON ¶
func (r *BookkeepingAccount) UnmarshalJSON(data []byte) (err error)
type BookkeepingAccountComplianceCategory ¶
type BookkeepingAccountComplianceCategory string
The compliance category of the account.
const ( // A cash in an commingled Increase Account. BookkeepingAccountComplianceCategoryCommingledCash BookkeepingAccountComplianceCategory = "commingled_cash" // A customer balance. BookkeepingAccountComplianceCategoryCustomerBalance BookkeepingAccountComplianceCategory = "customer_balance" )
type BookkeepingAccountListParams ¶
type BookkeepingAccountListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (BookkeepingAccountListParams) URLQuery ¶
func (r BookkeepingAccountListParams) URLQuery() (v url.Values)
URLQuery serializes BookkeepingAccountListParams's query parameters as `url.Values`.
type BookkeepingAccountNewParams ¶
type BookkeepingAccountNewParams struct {
// The name you choose for the account.
Name param.Field[string] `json:"name,required"`
// The entity, if `compliance_category` is `commingled_cash`.
AccountID param.Field[string] `json:"account_id"`
// The account compliance category.
ComplianceCategory param.Field[BookkeepingAccountNewParamsComplianceCategory] `json:"compliance_category"`
// The entity, if `compliance_category` is `customer_balance`.
EntityID param.Field[string] `json:"entity_id"`
}
func (BookkeepingAccountNewParams) MarshalJSON ¶
func (r BookkeepingAccountNewParams) MarshalJSON() (data []byte, err error)
type BookkeepingAccountNewParamsComplianceCategory ¶
type BookkeepingAccountNewParamsComplianceCategory string
The account compliance category.
const ( // A cash in an commingled Increase Account. BookkeepingAccountNewParamsComplianceCategoryCommingledCash BookkeepingAccountNewParamsComplianceCategory = "commingled_cash" // A customer balance. BookkeepingAccountNewParamsComplianceCategoryCustomerBalance BookkeepingAccountNewParamsComplianceCategory = "customer_balance" )
type BookkeepingAccountService ¶
type BookkeepingAccountService struct {
Options []option.RequestOption
}
BookkeepingAccountService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBookkeepingAccountService method instead.
func NewBookkeepingAccountService ¶
func NewBookkeepingAccountService(opts ...option.RequestOption) (r *BookkeepingAccountService)
NewBookkeepingAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*BookkeepingAccountService) List ¶
func (r *BookkeepingAccountService) List(ctx context.Context, query BookkeepingAccountListParams, opts ...option.RequestOption) (res *shared.Page[BookkeepingAccount], err error)
List Bookkeeping Accounts
func (*BookkeepingAccountService) ListAutoPaging ¶
func (r *BookkeepingAccountService) ListAutoPaging(ctx context.Context, query BookkeepingAccountListParams, opts ...option.RequestOption) *shared.PageAutoPager[BookkeepingAccount]
List Bookkeeping Accounts
func (*BookkeepingAccountService) New ¶
func (r *BookkeepingAccountService) New(ctx context.Context, body BookkeepingAccountNewParams, opts ...option.RequestOption) (res *BookkeepingAccount, err error)
Create a Bookkeeping Account
type BookkeepingAccountType ¶
type BookkeepingAccountType string
A constant representing the object's type. For this resource it will always be `bookkeeping_account`.
const (
BookkeepingAccountTypeBookkeepingAccount BookkeepingAccountType = "bookkeeping_account"
)
type BookkeepingEntry ¶
type BookkeepingEntry struct {
// The entry identifier.
ID string `json:"id,required"`
// The identifier for the Account the Entry belongs to.
AccountID string `json:"account_id,required"`
// The Entry amount in the minor unit of its currency. For dollars, for example,
// this is cents.
Amount int64 `json:"amount,required"`
// The identifier for the Account the Entry belongs to.
EntrySetID string `json:"entry_set_id,required"`
// A constant representing the object's type. For this resource it will always be
// `bookkeeping_entry`.
Type BookkeepingEntryType `json:"type,required"`
JSON bookkeepingEntryJSON
}
Entries are T-account entries recording debits and credits.
func (*BookkeepingEntry) UnmarshalJSON ¶
func (r *BookkeepingEntry) UnmarshalJSON(data []byte) (err error)
type BookkeepingEntryListParams ¶
type BookkeepingEntryListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (BookkeepingEntryListParams) URLQuery ¶
func (r BookkeepingEntryListParams) URLQuery() (v url.Values)
URLQuery serializes BookkeepingEntryListParams's query parameters as `url.Values`.
type BookkeepingEntryService ¶
type BookkeepingEntryService struct {
Options []option.RequestOption
}
BookkeepingEntryService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBookkeepingEntryService method instead.
func NewBookkeepingEntryService ¶
func NewBookkeepingEntryService(opts ...option.RequestOption) (r *BookkeepingEntryService)
NewBookkeepingEntryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*BookkeepingEntryService) List ¶
func (r *BookkeepingEntryService) List(ctx context.Context, query BookkeepingEntryListParams, opts ...option.RequestOption) (res *shared.Page[BookkeepingEntry], err error)
List Bookkeeping Entries
func (*BookkeepingEntryService) ListAutoPaging ¶
func (r *BookkeepingEntryService) ListAutoPaging(ctx context.Context, query BookkeepingEntryListParams, opts ...option.RequestOption) *shared.PageAutoPager[BookkeepingEntry]
List Bookkeeping Entries
type BookkeepingEntrySet ¶
type BookkeepingEntrySet struct {
// The entry set identifier.
ID string `json:"id,required"`
// The timestamp of the entry set.
Date time.Time `json:"date,required" format:"date-time"`
// The entries
Entries []BookkeepingEntrySetEntry `json:"entries,required"`
// The transaction identifier, if any.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `bookkeeping_entry_set`.
Type BookkeepingEntrySetType `json:"type,required"`
JSON bookkeepingEntrySetJSON
}
Entry Sets are accounting entries that are transactionally applied.
func (*BookkeepingEntrySet) UnmarshalJSON ¶
func (r *BookkeepingEntrySet) UnmarshalJSON(data []byte) (err error)
type BookkeepingEntrySetEntry ¶ added in v0.3.0
type BookkeepingEntrySetEntry struct {
// The entry identifier.
ID string `json:"id,required"`
// The bookkeeping account impacted by the entry.
AccountID string `json:"account_id,required"`
// The amount of the entry in minor units.
Amount int64 `json:"amount,required"`
JSON bookkeepingEntrySetEntryJSON
}
func (*BookkeepingEntrySetEntry) UnmarshalJSON ¶ added in v0.3.0
func (r *BookkeepingEntrySetEntry) UnmarshalJSON(data []byte) (err error)
type BookkeepingEntrySetNewParams ¶
type BookkeepingEntrySetNewParams struct {
// The bookkeeping entries.
Entries param.Field[[]BookkeepingEntrySetNewParamsEntry] `json:"entries,required"`
// The date of the transaction. Optional if `transaction_id` is provided, in which
// case we use the `date` of that transaction. Required otherwise.
Date param.Field[time.Time] `json:"date" format:"date-time"`
// The identifier of the Transaction related to this entry set, if any.
TransactionID param.Field[string] `json:"transaction_id"`
}
func (BookkeepingEntrySetNewParams) MarshalJSON ¶
func (r BookkeepingEntrySetNewParams) MarshalJSON() (data []byte, err error)
type BookkeepingEntrySetNewParamsEntry ¶ added in v0.3.0
type BookkeepingEntrySetNewParamsEntry struct {
// The identifier for the Bookkeeping Account impacted by this entry.
AccountID param.Field[string] `json:"account_id,required"`
// The entry amount in the minor unit of the account currency. For dollars, for
// example, this is cents. Debit entries have positive amounts; credit entries have
// negative amounts.
Amount param.Field[int64] `json:"amount,required"`
}
func (BookkeepingEntrySetNewParamsEntry) MarshalJSON ¶ added in v0.3.0
func (r BookkeepingEntrySetNewParamsEntry) MarshalJSON() (data []byte, err error)
type BookkeepingEntrySetService ¶
type BookkeepingEntrySetService struct {
Options []option.RequestOption
}
BookkeepingEntrySetService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBookkeepingEntrySetService method instead.
func NewBookkeepingEntrySetService ¶
func NewBookkeepingEntrySetService(opts ...option.RequestOption) (r *BookkeepingEntrySetService)
NewBookkeepingEntrySetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*BookkeepingEntrySetService) New ¶
func (r *BookkeepingEntrySetService) New(ctx context.Context, body BookkeepingEntrySetNewParams, opts ...option.RequestOption) (res *BookkeepingEntrySet, err error)
Create a Bookkeeping Entry Set
type BookkeepingEntrySetType ¶
type BookkeepingEntrySetType string
A constant representing the object's type. For this resource it will always be `bookkeeping_entry_set`.
const (
BookkeepingEntrySetTypeBookkeepingEntrySet BookkeepingEntrySetType = "bookkeeping_entry_set"
)
type BookkeepingEntryType ¶
type BookkeepingEntryType string
A constant representing the object's type. For this resource it will always be `bookkeeping_entry`.
const (
BookkeepingEntryTypeBookkeepingEntry BookkeepingEntryType = "bookkeeping_entry"
)
type Card ¶
type Card struct {
// The card identifier.
ID string `json:"id,required"`
// The identifier for the account this card belongs to.
AccountID string `json:"account_id,required"`
// The Card's billing address.
BillingAddress CardBillingAddress `json:"billing_address,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The card's description for display purposes.
Description string `json:"description,required,nullable"`
// The contact information used in the two-factor steps for digital wallet card
// creation. At least one field must be present to complete the digital wallet
// steps.
DigitalWallet CardDigitalWallet `json:"digital_wallet,required,nullable"`
// The month the card expires in M format (e.g., August is 8).
ExpirationMonth int64 `json:"expiration_month,required"`
// The year the card expires in YYYY format (e.g., 2025).
ExpirationYear int64 `json:"expiration_year,required"`
// The last 4 digits of the Card's Primary Account Number.
Last4 string `json:"last4,required"`
// This indicates if payments can be made with the card.
Status CardStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `card`.
Type CardType `json:"type,required"`
JSON cardJSON
}
Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
func (*Card) UnmarshalJSON ¶
type CardAuthorizationSimulation ¶
type CardAuthorizationSimulation struct {
// If the authorization attempt fails, this will contain the resulting
// [Declined Transaction](#declined-transactions) object. The Declined
// Transaction's `source` will be of `category: card_decline`.
DeclinedTransaction CardAuthorizationSimulationDeclinedTransaction `json:"declined_transaction,required,nullable"`
// If the authorization attempt succeeds, this will contain the resulting Pending
// Transaction object. The Pending Transaction's `source` will be of
// `category: card_authorization`.
PendingTransaction CardAuthorizationSimulationPendingTransaction `json:"pending_transaction,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `inbound_card_authorization_simulation_result`.
Type CardAuthorizationSimulationType `json:"type,required"`
JSON cardAuthorizationSimulationJSON
}
The results of a Card Authorization simulation.
func (*CardAuthorizationSimulation) UnmarshalJSON ¶
func (r *CardAuthorizationSimulation) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransaction ¶
type CardAuthorizationSimulationDeclinedTransaction struct {
// The Declined Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Declined Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Declined Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
// Transaction's currency. This will match the currency on the Declined
// Transaction's Account.
Currency CardAuthorizationSimulationDeclinedTransactionCurrency `json:"currency,required"`
// This is the description the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Declined Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Declined Transaction came through.
RouteType CardAuthorizationSimulationDeclinedTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Declined Transaction. For example, for a card transaction this lists the
// merchant's industry and location. Note that for backwards compatibility reasons,
// additional undocumented keys may appear in this object. These should be treated
// as deprecated and will be removed in the future.
Source CardAuthorizationSimulationDeclinedTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `declined_transaction`.
Type CardAuthorizationSimulationDeclinedTransactionType `json:"type,required"`
JSON cardAuthorizationSimulationDeclinedTransactionJSON
}
If the authorization attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: card_decline`.
func (*CardAuthorizationSimulationDeclinedTransaction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransaction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionCurrency ¶
type CardAuthorizationSimulationDeclinedTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationDeclinedTransactionCurrencyCad CardAuthorizationSimulationDeclinedTransactionCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationDeclinedTransactionCurrencyChf CardAuthorizationSimulationDeclinedTransactionCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationDeclinedTransactionCurrencyEur CardAuthorizationSimulationDeclinedTransactionCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationDeclinedTransactionCurrencyGbp CardAuthorizationSimulationDeclinedTransactionCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationDeclinedTransactionCurrencyJpy CardAuthorizationSimulationDeclinedTransactionCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationDeclinedTransactionCurrencyUsd CardAuthorizationSimulationDeclinedTransactionCurrency = "USD" )
type CardAuthorizationSimulationDeclinedTransactionRouteType ¶
type CardAuthorizationSimulationDeclinedTransactionRouteType string
The type of the route this Declined Transaction came through.
const ( // An Account Number. CardAuthorizationSimulationDeclinedTransactionRouteTypeAccountNumber CardAuthorizationSimulationDeclinedTransactionRouteType = "account_number" // A Card. CardAuthorizationSimulationDeclinedTransactionRouteTypeCard CardAuthorizationSimulationDeclinedTransactionRouteType = "card" )
type CardAuthorizationSimulationDeclinedTransactionSource ¶
type CardAuthorizationSimulationDeclinedTransactionSource struct {
// An ACH Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `ach_decline`.
ACHDecline CardAuthorizationSimulationDeclinedTransactionSourceACHDecline `json:"ach_decline,required,nullable"`
// A Card Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `card_decline`.
CardDecline CardAuthorizationSimulationDeclinedTransactionSourceCardDecline `json:"card_decline,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category CardAuthorizationSimulationDeclinedTransactionSourceCategory `json:"category,required"`
// A Check Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `check_decline`.
CheckDecline CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline `json:"check_decline,required,nullable"`
// An Inbound Real-Time Payments Transfer Decline object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_decline`.
InboundRealTimePaymentsTransferDecline CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline `json:"inbound_real_time_payments_transfer_decline,required,nullable"`
// An International ACH Decline object. This field will be present in the JSON
// response if and only if `category` is equal to `international_ach_decline`.
InternationalACHDecline CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline `json:"international_ach_decline,required,nullable"`
// A Wire Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `wire_decline`.
WireDecline CardAuthorizationSimulationDeclinedTransactionSourceWireDecline `json:"wire_decline,required,nullable"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*CardAuthorizationSimulationDeclinedTransactionSource) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSource) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceACHDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceACHDecline struct {
// The ACH Decline's identifier.
ID string `json:"id,required"`
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The descriptive date of the transfer.
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
// The additional information included with the transfer.
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
// The identifier of the company that initiated the transfer.
OriginatorCompanyID string `json:"originator_company_id,required"`
// The name of the company that initiated the transfer.
OriginatorCompanyName string `json:"originator_company_name,required"`
// Why the ACH transfer was declined.
Reason CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason `json:"reason,required"`
// The id of the receiver of the transfer.
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
// The name of the receiver of the transfer.
ReceiverName string `json:"receiver_name,required,nullable"`
// The trace number of the transfer.
TraceNumber string `json:"trace_number,required"`
// A constant representing the object's type. For this resource it will always be
// `ach_decline`.
Type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineType `json:"type,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceACHDeclineJSON
}
An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceACHDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceACHDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason ¶
type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason string
Why the ACH transfer was declined.
const ( // The account number is canceled. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonACHRouteCanceled CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "ach_route_canceled" // The account number is disabled. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonACHRouteDisabled CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonBreachesLimit CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "breaches_limit" // A credit was refused. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonCreditEntryRefusedByReceiver CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "credit_entry_refused_by_receiver" // Other. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonDuplicateReturn CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "duplicate_return" // The account's entity is not active. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonEntityNotActive CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "entity_not_active" // Your account is inactive. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonGroupLocked CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "group_locked" // Your account contains insufficient funds. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonInsufficientFunds CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "insufficient_funds" // Other. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonMisroutedReturn CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "misrouted_return" // Other. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonReturnOfErroneousOrReversingDebit CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "return_of_erroneous_or_reversing_debit" // The account number that was debited does not exist. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonNoACHRoute CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "no_ach_route" // Other. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonOriginatorRequest CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "originator_request" // The transaction is not allowed per Increase's terms. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonTransactionNotAllowed CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "transaction_not_allowed" // The user initiated the decline. CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReasonUserInitiated CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineReason = "user_initiated" )
type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineType ¶ added in v0.7.1
type CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineType string
A constant representing the object's type. For this resource it will always be `ach_decline`.
const (
CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineTypeACHDecline CardAuthorizationSimulationDeclinedTransactionSourceACHDeclineType = "ach_decline"
)
type CardAuthorizationSimulationDeclinedTransactionSourceCardDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Fields specific to the `network`
NetworkDetails CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails `json:"network_details,required"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// Why the transaction was declined.
Reason CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason `json:"reason,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceCardDeclineJSON
}
A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceCardDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceCardDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyCad CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyChf CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyEur CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyGbp CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyJpy CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrencyUsd CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineCurrency = "USD" )
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails struct {
// The payment network used to process this card authorization
Category CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa `json:"visa,required,nullable"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsJSON
}
Fields specific to the `network`
func (*CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory ¶ added in v0.6.0
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategoryVisa CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsCategory = "visa" )
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorRecurring CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorInstallment CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeUnknown CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeManual CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeOpticalCode CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactless CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason string
Why the transaction was declined.
const ( // The Card was not active. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonCardNotActive CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "card_not_active" // The Physical Card was not active. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonPhysicalCardNotActive CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "physical_card_not_active" // The account's entity was not active. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonEntityNotActive CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "entity_not_active" // The account was inactive. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonGroupLocked CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "group_locked" // The Card's Account did not have a sufficient available balance. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonInsufficientFunds CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "insufficient_funds" // The given CVV2 did not match the card's value. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonCvv2Mismatch CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "cvv2_mismatch" // The attempted card transaction is not allowed per Increase's terms. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonTransactionNotAllowed CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "transaction_not_allowed" // The transaction was blocked by a Limit. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonBreachesLimit CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "breaches_limit" // Your application declined the transaction via webhook. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonWebhookDeclined CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "webhook_declined" // Your application webhook did not respond without the required timeout. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonWebhookTimedOut CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "webhook_timed_out" // Declined by stand-in processing. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonDeclinedByStandInProcessing CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "declined_by_stand_in_processing" // The card read had an invalid CVV, dCVV, or authorization request cryptogram. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonInvalidPhysicalCard CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "invalid_physical_card" // The original card authorization for this incremental authorization does not // exist. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonMissingOriginalAuthorization CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "missing_original_authorization" // The transaction was suspected to be fraudulent. Please reach out to // support@increase.com for more information. CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReasonSuspectedFraud CardAuthorizationSimulationDeclinedTransactionSourceCardDeclineReason = "suspected_fraud" )
type CardAuthorizationSimulationDeclinedTransactionSourceCategory ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // ACH Decline: details will be under the `ach_decline` object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryACHDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "ach_decline" // Card Decline: details will be under the `card_decline` object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryCardDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "card_decline" // Check Decline: details will be under the `check_decline` object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryCheckDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "check_decline" // Inbound Real-Time Payments Transfer Decline: details will be under the // `inbound_real_time_payments_transfer_decline` object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryInboundRealTimePaymentsTransferDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "inbound_real_time_payments_transfer_decline" // International ACH Decline: details will be under the `international_ach_decline` // object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryInternationalACHDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "international_ach_decline" // Wire Decline: details will be under the `wire_decline` object. CardAuthorizationSimulationDeclinedTransactionSourceCategoryWireDecline CardAuthorizationSimulationDeclinedTransactionSourceCategory = "wire_decline" // The Declined Transaction was made for an undocumented or deprecated reason. CardAuthorizationSimulationDeclinedTransactionSourceCategoryOther CardAuthorizationSimulationDeclinedTransactionSourceCategory = "other" )
type CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// Why the check was declined.
Reason CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason `json:"reason,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineJSON
}
A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceCheckDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason ¶
type CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason string
Why the check was declined.
const ( // The account number is canceled. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonACHRouteCanceled CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "ach_route_canceled" // The account number is disabled. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonACHRouteDisabled CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonBreachesLimit CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "breaches_limit" // The account's entity is not active. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonEntityNotActive CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "entity_not_active" // Your account is inactive. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonGroupLocked CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "group_locked" // Your account contains insufficient funds. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonInsufficientFunds CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "insufficient_funds" // Unable to locate account. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonUnableToLocateAccount CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "unable_to_locate_account" // Routing number on the check is not ours. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonNotOurItem CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "not_our_item" // Unable to process. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonUnableToProcess CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "unable_to_process" // Refer to image. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonReferToImage CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "refer_to_image" // Stop payment requested for this check. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonStopPaymentRequested CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "stop_payment_requested" // Check was returned to sender. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonReturned CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "returned" // The check was a duplicate deposit. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonDuplicatePresentment CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "duplicate_presentment" // The transaction is not allowed. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonNotAuthorized CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "not_authorized" // The check was altered or fictitious. CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReasonAlteredOrFictitious CardAuthorizationSimulationDeclinedTransactionSourceCheckDeclineReason = "altered_or_fictitious" )
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
// transfer's currency. This will always be "USD" for a Real-Time Payments
// transfer.
Currency CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Why the transfer was declined.
Reason CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason `json:"reason,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the declined transfer.
TransactionIdentification string `json:"transaction_identification,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineJSON
}
An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency ¶
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyCad CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyChf CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyEur CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyGbp CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyJpy CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyUsd CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "USD" )
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason ¶
type CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason string
Why the transfer was declined.
const ( // The account number is canceled. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberCanceled CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_canceled" // The account number is disabled. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberDisabled CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_disabled" // Your account is restricted. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountRestricted CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_restricted" // Your account is inactive. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonGroupLocked CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "group_locked" // The account's entity is not active. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonEntityNotActive CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "entity_not_active" // Your account is not enabled to receive Real-Time Payments transfers. CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonRealTimePaymentsNotEnabled CardAuthorizationSimulationDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "real_time_payments_not_enabled" )
type CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDeclineJSON
}
An International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceWireDecline ¶
type CardAuthorizationSimulationDeclinedTransactionSourceWireDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
// Why the wire transfer was declined.
Reason CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason `json:"reason,required"`
JSON cardAuthorizationSimulationDeclinedTransactionSourceWireDeclineJSON
}
A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`.
func (*CardAuthorizationSimulationDeclinedTransactionSourceWireDecline) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationDeclinedTransactionSourceWireDecline) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason ¶
type CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason string
Why the wire transfer was declined.
const ( // The account number is canceled. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonAccountNumberCanceled CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "account_number_canceled" // The account number is disabled. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonAccountNumberDisabled CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "account_number_disabled" // The account's entity is not active. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonEntityNotActive CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "entity_not_active" // Your account is inactive. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonGroupLocked CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "group_locked" // The beneficiary account number does not exist. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonNoAccountNumber CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "no_account_number" // The transaction is not allowed per Increase's terms. CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReasonTransactionNotAllowed CardAuthorizationSimulationDeclinedTransactionSourceWireDeclineReason = "transaction_not_allowed" )
type CardAuthorizationSimulationDeclinedTransactionType ¶
type CardAuthorizationSimulationDeclinedTransactionType string
A constant representing the object's type. For this resource it will always be `declined_transaction`.
const (
CardAuthorizationSimulationDeclinedTransactionTypeDeclinedTransaction CardAuthorizationSimulationDeclinedTransactionType = "declined_transaction"
)
type CardAuthorizationSimulationPendingTransaction ¶
type CardAuthorizationSimulationPendingTransaction struct {
// The Pending Transaction identifier.
ID string `json:"id,required"`
// The identifier for the account this Pending Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Pending Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
// Transaction was completed.
CompletedAt time.Time `json:"completed_at,required,nullable" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
// Transaction's currency. This will match the currency on the Pending
// Transaction's Account.
Currency CardAuthorizationSimulationPendingTransactionCurrency `json:"currency,required"`
// For a Pending Transaction related to a transfer, this is the description you
// provide. For a Pending Transaction related to a payment, this is the description
// the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Pending Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Pending Transaction came through.
RouteType CardAuthorizationSimulationPendingTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Pending Transaction. For example, for a card transaction this lists the
// merchant's industry and location.
Source CardAuthorizationSimulationPendingTransactionSource `json:"source,required"`
// Whether the Pending Transaction has been confirmed and has an associated
// Transaction.
Status CardAuthorizationSimulationPendingTransactionStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `pending_transaction`.
Type CardAuthorizationSimulationPendingTransactionType `json:"type,required"`
JSON cardAuthorizationSimulationPendingTransactionJSON
}
If the authorization attempt succeeds, this will contain the resulting Pending Transaction object. The Pending Transaction's `source` will be of `category: card_authorization`.
func (*CardAuthorizationSimulationPendingTransaction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransaction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionCurrency ¶
type CardAuthorizationSimulationPendingTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionCurrencyCad CardAuthorizationSimulationPendingTransactionCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionCurrencyChf CardAuthorizationSimulationPendingTransactionCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionCurrencyEur CardAuthorizationSimulationPendingTransactionCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionCurrencyGbp CardAuthorizationSimulationPendingTransactionCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionCurrencyJpy CardAuthorizationSimulationPendingTransactionCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionCurrencyUsd CardAuthorizationSimulationPendingTransactionCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionRouteType ¶
type CardAuthorizationSimulationPendingTransactionRouteType string
The type of the route this Pending Transaction came through.
const ( // An Account Number. CardAuthorizationSimulationPendingTransactionRouteTypeAccountNumber CardAuthorizationSimulationPendingTransactionRouteType = "account_number" // A Card. CardAuthorizationSimulationPendingTransactionRouteTypeCard CardAuthorizationSimulationPendingTransactionRouteType = "card" )
type CardAuthorizationSimulationPendingTransactionSource ¶
type CardAuthorizationSimulationPendingTransactionSource struct {
// An Account Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_instruction`.
AccountTransferInstruction CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction `json:"account_transfer_instruction,required,nullable"`
// An ACH Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_instruction`.
ACHTransferInstruction CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction `json:"ach_transfer_instruction,required,nullable"`
// A Card Authorization object. This field will be present in the JSON response if
// and only if `category` is equal to `card_authorization`.
CardAuthorization CardAuthorizationSimulationPendingTransactionSourceCardAuthorization `json:"card_authorization,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category CardAuthorizationSimulationPendingTransactionSourceCategory `json:"category,required"`
// A Check Deposit Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_instruction`.
CheckDepositInstruction CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction `json:"check_deposit_instruction,required,nullable"`
// A Check Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_instruction`.
CheckTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction `json:"check_transfer_instruction,required,nullable"`
// An Inbound Funds Hold object. This field will be present in the JSON response if
// and only if `category` is equal to `inbound_funds_hold`.
InboundFundsHold CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold `json:"inbound_funds_hold,required,nullable"`
// A Real-Time Payments Transfer Instruction object. This field will be present in
// the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_instruction`.
RealTimePaymentsTransferInstruction CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction `json:"real_time_payments_transfer_instruction,required,nullable"`
// A Wire Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_instruction`.
WireTransferInstruction CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction `json:"wire_transfer_instruction,required,nullable"`
JSON cardAuthorizationSimulationPendingTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
func (*CardAuthorizationSimulationPendingTransactionSource) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSource) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the ACH Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceACHTransferInstructionJSON
}
An ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceACHTransferInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency `json:"currency,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionJSON
}
An Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency ¶
type CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyCad CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyChf CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyEur CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyGbp CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyJpy CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrencyUsd CardAuthorizationSimulationPendingTransactionSourceAccountTransferInstructionCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorization ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorization struct {
// The Card Authorization identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
// will expire and the pending transaction will be released.
ExpiresAt time.Time `json:"expires_at,required" format:"date-time"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// Fields specific to the `network`
NetworkDetails CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails `json:"network_details,required"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `card_authorization`.
Type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationType `json:"type,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceCardAuthorizationJSON
}
A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`.
func (*CardAuthorizationSimulationPendingTransactionSourceCardAuthorization) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceCardAuthorization) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyCad CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyChf CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyEur CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyGbp CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyJpy CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrencyUsd CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails struct {
// The payment network used to process this card authorization
Category CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa `json:"visa,required,nullable"`
JSON cardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsJSON
}
Fields specific to the `network`
func (*CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetails) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategory ¶ added in v0.6.0
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategoryVisa CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsCategory = "visa" )
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON cardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorRecurring CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorInstallment CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeUnknown CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeManual CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeOpticalCode CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactless CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationType ¶
type CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationType string
A constant representing the object's type. For this resource it will always be `card_authorization`.
const (
CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationTypeCardAuthorization CardAuthorizationSimulationPendingTransactionSourceCardAuthorizationType = "card_authorization"
)
type CardAuthorizationSimulationPendingTransactionSourceCategory ¶
type CardAuthorizationSimulationPendingTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Instruction: details will be under the // `account_transfer_instruction` object. CardAuthorizationSimulationPendingTransactionSourceCategoryAccountTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "account_transfer_instruction" // ACH Transfer Instruction: details will be under the `ach_transfer_instruction` // object. CardAuthorizationSimulationPendingTransactionSourceCategoryACHTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "ach_transfer_instruction" // Card Authorization: details will be under the `card_authorization` object. CardAuthorizationSimulationPendingTransactionSourceCategoryCardAuthorization CardAuthorizationSimulationPendingTransactionSourceCategory = "card_authorization" // Check Deposit Instruction: details will be under the `check_deposit_instruction` // object. CardAuthorizationSimulationPendingTransactionSourceCategoryCheckDepositInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "check_deposit_instruction" // Check Transfer Instruction: details will be under the // `check_transfer_instruction` object. CardAuthorizationSimulationPendingTransactionSourceCategoryCheckTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "check_transfer_instruction" // Inbound Funds Hold: details will be under the `inbound_funds_hold` object. CardAuthorizationSimulationPendingTransactionSourceCategoryInboundFundsHold CardAuthorizationSimulationPendingTransactionSourceCategory = "inbound_funds_hold" // Real-Time Payments Transfer Instruction: details will be under the // `real_time_payments_transfer_instruction` object. CardAuthorizationSimulationPendingTransactionSourceCategoryRealTimePaymentsTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "real_time_payments_transfer_instruction" // Wire Transfer Instruction: details will be under the `wire_transfer_instruction` // object. CardAuthorizationSimulationPendingTransactionSourceCategoryWireTransferInstruction CardAuthorizationSimulationPendingTransactionSourceCategory = "wire_transfer_instruction" // The Pending Transaction was made for an undocumented or deprecated reason. CardAuthorizationSimulationPendingTransactionSourceCategoryOther CardAuthorizationSimulationPendingTransactionSourceCategory = "other" )
type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the File containing the image of the back of the check that
// was deposited.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// The identifier of the Check Deposit.
CheckDepositID string `json:"check_deposit_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency `json:"currency,required"`
// The identifier of the File containing the image of the front of the check that
// was deposited.
FrontImageFileID string `json:"front_image_file_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionJSON
}
A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency ¶
type CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyCad CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyChf CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyEur CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyGbp CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyJpy CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrencyUsd CardAuthorizationSimulationPendingTransactionSourceCheckDepositInstructionCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency `json:"currency,required"`
// The identifier of the Check Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionJSON
}
A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency ¶
type CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyCad CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyChf CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyEur CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyGbp CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyJpy CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrencyUsd CardAuthorizationSimulationPendingTransactionSourceCheckTransferInstructionCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold ¶
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold struct {
// The Inbound Funds Hold identifier.
ID string `json:"id,required"`
// The held amount in the minor unit of the account's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// When the hold will be released automatically. Certain conditions may cause it to
// be released before this time.
AutomaticallyReleasesAt time.Time `json:"automatically_releases_at,required" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
// currency.
Currency CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency `json:"currency,required"`
// The ID of the Transaction for which funds were held.
HeldTransactionID string `json:"held_transaction_id,required,nullable"`
// The ID of the Pending Transaction representing the held funds.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// When the hold was released (if it has been released).
ReleasedAt time.Time `json:"released_at,required,nullable" format:"date-time"`
// The status of the hold.
Status CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `inbound_funds_hold`.
Type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldType `json:"type,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldJSON
}
An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`.
func (*CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceInboundFundsHold) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency ¶
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.
const ( // Canadian Dollar (CAD) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyCad CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "CAD" // Swiss Franc (CHF) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyChf CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "CHF" // Euro (EUR) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyEur CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "EUR" // British Pound (GBP) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyGbp CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "GBP" // Japanese Yen (JPY) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyJpy CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "JPY" // US Dollar (USD) CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrencyUsd CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldCurrency = "USD" )
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus ¶
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus string
The status of the hold.
const ( // Funds are still being held. CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatusHeld CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus = "held" // Funds have been released. CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatusComplete CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldStatus = "complete" )
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldType ¶ added in v0.5.0
type CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldType string
A constant representing the object's type. For this resource it will always be `inbound_funds_hold`.
const (
CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldTypeInboundFundsHold CardAuthorizationSimulationPendingTransactionSourceInboundFundsHoldType = "inbound_funds_hold"
)
type CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Real-Time Payments Transfer that led to this Pending
// Transaction.
TransferID string `json:"transfer_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstructionJSON
}
A Real-Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceRealTimePaymentsTransferInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction ¶
type CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction struct {
AccountNumber string `json:"account_number,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
MessageToRecipient string `json:"message_to_recipient,required"`
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON cardAuthorizationSimulationPendingTransactionSourceWireTransferInstructionJSON
}
A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.
func (*CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction) UnmarshalJSON ¶
func (r *CardAuthorizationSimulationPendingTransactionSourceWireTransferInstruction) UnmarshalJSON(data []byte) (err error)
type CardAuthorizationSimulationPendingTransactionStatus ¶
type CardAuthorizationSimulationPendingTransactionStatus string
Whether the Pending Transaction has been confirmed and has an associated Transaction.
const ( // The Pending Transaction is still awaiting confirmation. CardAuthorizationSimulationPendingTransactionStatusPending CardAuthorizationSimulationPendingTransactionStatus = "pending" // The Pending Transaction is confirmed. An associated Transaction exists for this // object. The Pending Transaction will no longer count against your balance and // can generally be hidden from UIs, etc. CardAuthorizationSimulationPendingTransactionStatusComplete CardAuthorizationSimulationPendingTransactionStatus = "complete" )
type CardAuthorizationSimulationPendingTransactionType ¶
type CardAuthorizationSimulationPendingTransactionType string
A constant representing the object's type. For this resource it will always be `pending_transaction`.
const (
CardAuthorizationSimulationPendingTransactionTypePendingTransaction CardAuthorizationSimulationPendingTransactionType = "pending_transaction"
)
type CardAuthorizationSimulationType ¶
type CardAuthorizationSimulationType string
A constant representing the object's type. For this resource it will always be `inbound_card_authorization_simulation_result`.
const (
CardAuthorizationSimulationTypeInboundCardAuthorizationSimulationResult CardAuthorizationSimulationType = "inbound_card_authorization_simulation_result"
)
type CardBillingAddress ¶
type CardBillingAddress struct {
// The city of the billing address.
City string `json:"city,required,nullable"`
// The first line of the billing address.
Line1 string `json:"line1,required,nullable"`
// The second line of the billing address.
Line2 string `json:"line2,required,nullable"`
// The postal code of the billing address.
PostalCode string `json:"postal_code,required,nullable"`
// The US state of the billing address.
State string `json:"state,required,nullable"`
JSON cardBillingAddressJSON
}
The Card's billing address.
func (*CardBillingAddress) UnmarshalJSON ¶
func (r *CardBillingAddress) UnmarshalJSON(data []byte) (err error)
type CardDetails ¶
type CardDetails struct {
// The identifier for the Card for which sensitive details have been returned.
CardID string `json:"card_id,required"`
// The month the card expires in M format (e.g., August is 8).
ExpirationMonth int64 `json:"expiration_month,required"`
// The year the card expires in YYYY format (e.g., 2025).
ExpirationYear int64 `json:"expiration_year,required"`
// The card number.
PrimaryAccountNumber string `json:"primary_account_number,required"`
// A constant representing the object's type. For this resource it will always be
// `card_details`.
Type CardDetailsType `json:"type,required"`
// The three-digit verification code for the card. It's also known as the Card
// Verification Code (CVC), the Card Verification Value (CVV), or the Card
// Identification (CID).
VerificationCode string `json:"verification_code,required"`
JSON cardDetailsJSON
}
An object containing the sensitive details (card number, cvc, etc) for a Card.
func (*CardDetails) UnmarshalJSON ¶
func (r *CardDetails) UnmarshalJSON(data []byte) (err error)
type CardDetailsType ¶
type CardDetailsType string
A constant representing the object's type. For this resource it will always be `card_details`.
const (
CardDetailsTypeCardDetails CardDetailsType = "card_details"
)
type CardDigitalWallet ¶
type CardDigitalWallet struct {
// The card profile assigned to this digital card. Card profiles may also be
// assigned at the program level.
CardProfileID string `json:"card_profile_id,required,nullable"`
// An email address that can be used to verify the cardholder via one-time passcode
// over email.
Email string `json:"email,required,nullable"`
// A phone number that can be used to verify the cardholder via one-time passcode
// over SMS.
Phone string `json:"phone,required,nullable"`
JSON cardDigitalWalletJSON
}
The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
func (*CardDigitalWallet) UnmarshalJSON ¶
func (r *CardDigitalWallet) UnmarshalJSON(data []byte) (err error)
type CardDispute ¶
type CardDispute struct {
// The Card Dispute identifier.
ID string `json:"id,required"`
// If the Card Dispute's status is `accepted`, this will contain details of the
// successful dispute.
Acceptance CardDisputeAcceptance `json:"acceptance,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The identifier of the Transaction that was disputed.
DisputedTransactionID string `json:"disputed_transaction_id,required"`
// Why you disputed the Transaction in question.
Explanation string `json:"explanation,required"`
// If the Card Dispute's status is `rejected`, this will contain details of the
// unsuccessful dispute.
Rejection CardDisputeRejection `json:"rejection,required,nullable"`
// The results of the Dispute investigation.
Status CardDisputeStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `card_dispute`.
Type CardDisputeType `json:"type,required"`
JSON cardDisputeJSON
}
If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.
func (*CardDispute) UnmarshalJSON ¶
func (r *CardDispute) UnmarshalJSON(data []byte) (err error)
type CardDisputeAcceptance ¶
type CardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON cardDisputeAcceptanceJSON
}
If the Card Dispute's status is `accepted`, this will contain details of the successful dispute.
func (*CardDisputeAcceptance) UnmarshalJSON ¶
func (r *CardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type CardDisputeListParams ¶
type CardDisputeListParams struct {
CreatedAt param.Field[CardDisputeListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
Status param.Field[CardDisputeListParamsStatus] `query:"status"`
}
func (CardDisputeListParams) URLQuery ¶
func (r CardDisputeListParams) URLQuery() (v url.Values)
URLQuery serializes CardDisputeListParams's query parameters as `url.Values`.
type CardDisputeListParamsCreatedAt ¶
type CardDisputeListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (CardDisputeListParamsCreatedAt) URLQuery ¶
func (r CardDisputeListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes CardDisputeListParamsCreatedAt's query parameters as `url.Values`.
type CardDisputeListParamsStatus ¶
type CardDisputeListParamsStatus struct {
// Filter Card Disputes for those with the specified status or statuses. For GET
// requests, this should be encoded as a comma-delimited string, such as
// `?in=one,two,three`.
In param.Field[[]CardDisputeListParamsStatusIn] `query:"in"`
}
func (CardDisputeListParamsStatus) URLQuery ¶
func (r CardDisputeListParamsStatus) URLQuery() (v url.Values)
URLQuery serializes CardDisputeListParamsStatus's query parameters as `url.Values`.
type CardDisputeListParamsStatusIn ¶
type CardDisputeListParamsStatusIn string
const ( // The Card Dispute is pending review. CardDisputeListParamsStatusInPendingReviewing CardDisputeListParamsStatusIn = "pending_reviewing" // The Card Dispute has been accepted and your funds have been returned. CardDisputeListParamsStatusInAccepted CardDisputeListParamsStatusIn = "accepted" // The Card Dispute has been rejected. CardDisputeListParamsStatusInRejected CardDisputeListParamsStatusIn = "rejected" )
type CardDisputeNewParams ¶
type CardDisputeNewParams struct {
// The Transaction you wish to dispute. This Transaction must have a `source_type`
// of `card_settlement`.
DisputedTransactionID param.Field[string] `json:"disputed_transaction_id,required"`
// Why you are disputing this Transaction.
Explanation param.Field[string] `json:"explanation,required"`
}
func (CardDisputeNewParams) MarshalJSON ¶
func (r CardDisputeNewParams) MarshalJSON() (data []byte, err error)
type CardDisputeRejection ¶
type CardDisputeRejection struct {
// The identifier of the Card Dispute that was rejected.
CardDisputeID string `json:"card_dispute_id,required"`
// Why the Card Dispute was rejected.
Explanation string `json:"explanation,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was rejected.
RejectedAt time.Time `json:"rejected_at,required" format:"date-time"`
JSON cardDisputeRejectionJSON
}
If the Card Dispute's status is `rejected`, this will contain details of the unsuccessful dispute.
func (*CardDisputeRejection) UnmarshalJSON ¶
func (r *CardDisputeRejection) UnmarshalJSON(data []byte) (err error)
type CardDisputeService ¶
type CardDisputeService struct {
Options []option.RequestOption
}
CardDisputeService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardDisputeService method instead.
func NewCardDisputeService ¶
func NewCardDisputeService(opts ...option.RequestOption) (r *CardDisputeService)
NewCardDisputeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CardDisputeService) Get ¶
func (r *CardDisputeService) Get(ctx context.Context, cardDisputeID string, opts ...option.RequestOption) (res *CardDispute, err error)
Retrieve a Card Dispute
func (*CardDisputeService) List ¶
func (r *CardDisputeService) List(ctx context.Context, query CardDisputeListParams, opts ...option.RequestOption) (res *shared.Page[CardDispute], err error)
List Card Disputes
func (*CardDisputeService) ListAutoPaging ¶
func (r *CardDisputeService) ListAutoPaging(ctx context.Context, query CardDisputeListParams, opts ...option.RequestOption) *shared.PageAutoPager[CardDispute]
List Card Disputes
func (*CardDisputeService) New ¶
func (r *CardDisputeService) New(ctx context.Context, body CardDisputeNewParams, opts ...option.RequestOption) (res *CardDispute, err error)
Create a Card Dispute
type CardDisputeStatus ¶
type CardDisputeStatus string
The results of the Dispute investigation.
const ( // The Card Dispute is pending review. CardDisputeStatusPendingReviewing CardDisputeStatus = "pending_reviewing" // The Card Dispute has been accepted and your funds have been returned. CardDisputeStatusAccepted CardDisputeStatus = "accepted" // The Card Dispute has been rejected. CardDisputeStatusRejected CardDisputeStatus = "rejected" )
type CardDisputeType ¶
type CardDisputeType string
A constant representing the object's type. For this resource it will always be `card_dispute`.
const (
CardDisputeTypeCardDispute CardDisputeType = "card_dispute"
)
type CardListParams ¶
type CardListParams struct {
// Filter Cards to ones belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[CardListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (CardListParams) URLQuery ¶
func (r CardListParams) URLQuery() (v url.Values)
URLQuery serializes CardListParams's query parameters as `url.Values`.
type CardListParamsCreatedAt ¶
type CardListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (CardListParamsCreatedAt) URLQuery ¶
func (r CardListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes CardListParamsCreatedAt's query parameters as `url.Values`.
type CardNewParams ¶
type CardNewParams struct {
// The Account the card should belong to.
AccountID param.Field[string] `json:"account_id,required"`
// The card's billing address.
BillingAddress param.Field[CardNewParamsBillingAddress] `json:"billing_address"`
// The description you choose to give the card.
Description param.Field[string] `json:"description"`
// The contact information used in the two-factor steps for digital wallet card
// creation. To add the card to a digital wallet, you may supply an email or phone
// number with this request. Otherwise, subscribe and then action a Real Time
// Decision with the category `digital_wallet_token_requested` or
// `digital_wallet_authentication_requested`.
DigitalWallet param.Field[CardNewParamsDigitalWallet] `json:"digital_wallet"`
}
func (CardNewParams) MarshalJSON ¶
func (r CardNewParams) MarshalJSON() (data []byte, err error)
type CardNewParamsBillingAddress ¶
type CardNewParamsBillingAddress struct {
// The city of the billing address.
City param.Field[string] `json:"city,required"`
// The first line of the billing address.
Line1 param.Field[string] `json:"line1,required"`
// The postal code of the billing address.
PostalCode param.Field[string] `json:"postal_code,required"`
// The US state of the billing address.
State param.Field[string] `json:"state,required"`
// The second line of the billing address.
Line2 param.Field[string] `json:"line2"`
}
The card's billing address.
func (CardNewParamsBillingAddress) MarshalJSON ¶ added in v0.1.1
func (r CardNewParamsBillingAddress) MarshalJSON() (data []byte, err error)
type CardNewParamsDigitalWallet ¶
type CardNewParamsDigitalWallet struct {
// The card profile assigned to this digital card. Card profiles may also be
// assigned at the program level.
CardProfileID param.Field[string] `json:"card_profile_id"`
// An email address that can be used to verify the cardholder via one-time passcode
// over email.
Email param.Field[string] `json:"email"`
// A phone number that can be used to verify the cardholder via one-time passcode
// over SMS.
Phone param.Field[string] `json:"phone"`
}
The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category `digital_wallet_token_requested` or `digital_wallet_authentication_requested`.
func (CardNewParamsDigitalWallet) MarshalJSON ¶ added in v0.1.1
func (r CardNewParamsDigitalWallet) MarshalJSON() (data []byte, err error)
type CardProfile ¶
type CardProfile struct {
// The Card Profile identifier.
ID string `json:"id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A description you can use to identify the Card Profile.
Description string `json:"description,required"`
// How Cards should appear in digital wallets such as Apple Pay. Different wallets
// will use these values to render card artwork appropriately for their app.
DigitalWallets CardProfileDigitalWallets `json:"digital_wallets,required"`
// Whether this Card Profile is the default for all cards in its Increase group.
IsDefault bool `json:"is_default,required"`
// How physical cards should be designed and shipped.
PhysicalCards CardProfilePhysicalCards `json:"physical_cards,required,nullable"`
// The status of the Card Profile.
Status CardProfileStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `card_profile`.
Type CardProfileType `json:"type,required"`
JSON cardProfileJSON
}
This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on [digital card artwork](https://increase.com/documentation/card-art)
func (*CardProfile) UnmarshalJSON ¶
func (r *CardProfile) UnmarshalJSON(data []byte) (err error)
type CardProfileDigitalWallets ¶
type CardProfileDigitalWallets struct {
// The identifier of the File containing the card's icon image.
AppIconFileID string `json:"app_icon_file_id,required"`
// The identifier of the File containing the card's front image.
BackgroundImageFileID string `json:"background_image_file_id,required"`
// A user-facing description for the card itself.
CardDescription string `json:"card_description,required"`
// An email address the user can contact to receive support for their card.
ContactEmail string `json:"contact_email,required,nullable"`
// A phone number the user can contact to receive support for their card.
ContactPhone string `json:"contact_phone,required,nullable"`
// A website the user can visit to view and receive support for their card.
ContactWebsite string `json:"contact_website,required,nullable"`
// A user-facing description for whoever is issuing the card.
IssuerName string `json:"issuer_name,required"`
// The Card's text color, specified as an RGB triple.
TextColor CardProfileDigitalWalletsTextColor `json:"text_color,required"`
JSON cardProfileDigitalWalletsJSON
}
How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
func (*CardProfileDigitalWallets) UnmarshalJSON ¶
func (r *CardProfileDigitalWallets) UnmarshalJSON(data []byte) (err error)
type CardProfileDigitalWalletsTextColor ¶
type CardProfileDigitalWalletsTextColor struct {
// The value of the blue channel in the RGB color.
Blue int64 `json:"blue,required"`
// The value of the green channel in the RGB color.
Green int64 `json:"green,required"`
// The value of the red channel in the RGB color.
Red int64 `json:"red,required"`
JSON cardProfileDigitalWalletsTextColorJSON
}
The Card's text color, specified as an RGB triple.
func (*CardProfileDigitalWalletsTextColor) UnmarshalJSON ¶
func (r *CardProfileDigitalWalletsTextColor) UnmarshalJSON(data []byte) (err error)
type CardProfileListParams ¶
type CardProfileListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
PhysicalCardsStatus param.Field[CardProfileListParamsPhysicalCardsStatus] `query:"physical_cards_status"`
Status param.Field[CardProfileListParamsStatus] `query:"status"`
}
func (CardProfileListParams) URLQuery ¶
func (r CardProfileListParams) URLQuery() (v url.Values)
URLQuery serializes CardProfileListParams's query parameters as `url.Values`.
type CardProfileListParamsPhysicalCardsStatus ¶ added in v0.7.0
type CardProfileListParamsPhysicalCardsStatus struct {
// Filter Card Profiles for those with the specified physical card status or
// statuses. For GET requests, this should be encoded as a comma-delimited string,
// such as `?in=one,two,three`.
In param.Field[[]CardProfileListParamsPhysicalCardsStatusIn] `query:"in"`
}
func (CardProfileListParamsPhysicalCardsStatus) URLQuery ¶ added in v0.7.0
func (r CardProfileListParamsPhysicalCardsStatus) URLQuery() (v url.Values)
URLQuery serializes CardProfileListParamsPhysicalCardsStatus's query parameters as `url.Values`.
type CardProfileListParamsPhysicalCardsStatusIn ¶ added in v0.7.0
type CardProfileListParamsPhysicalCardsStatusIn string
const ( // The Card Profile is not eligible for physical cards. CardProfileListParamsPhysicalCardsStatusInNotEligible CardProfileListParamsPhysicalCardsStatusIn = "not_eligible" // There is an issue with the Physical Card Profile preventing it from use. CardProfileListParamsPhysicalCardsStatusInRejected CardProfileListParamsPhysicalCardsStatusIn = "rejected" // The card profile is awaiting review by Increase. CardProfileListParamsPhysicalCardsStatusInPendingReviewing CardProfileListParamsPhysicalCardsStatusIn = "pending_reviewing" // The card profile is awaiting submission to the fulfillment provider. CardProfileListParamsPhysicalCardsStatusInPendingSubmitting CardProfileListParamsPhysicalCardsStatusIn = "pending_submitting" // The Physical Card Profile has been submitted to the fulfillment provider and is // ready to use. CardProfileListParamsPhysicalCardsStatusInActive CardProfileListParamsPhysicalCardsStatusIn = "active" )
type CardProfileListParamsStatus ¶
type CardProfileListParamsStatus struct {
// Filter Card Profiles for those with the specified digital wallet status or
// statuses. For GET requests, this should be encoded as a comma-delimited string,
// such as `?in=one,two,three`.
In param.Field[[]CardProfileListParamsStatusIn] `query:"in"`
}
func (CardProfileListParamsStatus) URLQuery ¶
func (r CardProfileListParamsStatus) URLQuery() (v url.Values)
URLQuery serializes CardProfileListParamsStatus's query parameters as `url.Values`.
type CardProfileListParamsStatusIn ¶
type CardProfileListParamsStatusIn string
const ( // The Card Profile is awaiting review from Increase and/or processing by card // networks. CardProfileListParamsStatusInPending CardProfileListParamsStatusIn = "pending" // There is an issue with the Card Profile preventing it from use. CardProfileListParamsStatusInRejected CardProfileListParamsStatusIn = "rejected" // The Card Profile can be assigned to Cards. CardProfileListParamsStatusInActive CardProfileListParamsStatusIn = "active" // The Card Profile is no longer in use. CardProfileListParamsStatusInArchived CardProfileListParamsStatusIn = "archived" )
type CardProfileNewParams ¶
type CardProfileNewParams struct {
// A description you can use to identify the Card Profile.
Description param.Field[string] `json:"description,required"`
// How Cards should appear in digital wallets such as Apple Pay. Different wallets
// will use these values to render card artwork appropriately for their app.
DigitalWallets param.Field[CardProfileNewParamsDigitalWallets] `json:"digital_wallets,required"`
// How physical cards should be designed and shipped.
PhysicalCards param.Field[CardProfileNewParamsPhysicalCards] `json:"physical_cards"`
}
func (CardProfileNewParams) MarshalJSON ¶
func (r CardProfileNewParams) MarshalJSON() (data []byte, err error)
type CardProfileNewParamsDigitalWallets ¶
type CardProfileNewParamsDigitalWallets struct {
// The identifier of the File containing the card's icon image.
AppIconFileID param.Field[string] `json:"app_icon_file_id,required"`
// The identifier of the File containing the card's front image.
BackgroundImageFileID param.Field[string] `json:"background_image_file_id,required"`
// A user-facing description for the card itself.
CardDescription param.Field[string] `json:"card_description,required"`
// A user-facing description for whoever is issuing the card.
IssuerName param.Field[string] `json:"issuer_name,required"`
// An email address the user can contact to receive support for their card.
ContactEmail param.Field[string] `json:"contact_email"`
// A phone number the user can contact to receive support for their card.
ContactPhone param.Field[string] `json:"contact_phone"`
// A website the user can visit to view and receive support for their card.
ContactWebsite param.Field[string] `json:"contact_website"`
// The Card's text color, specified as an RGB triple. The default is white.
TextColor param.Field[CardProfileNewParamsDigitalWalletsTextColor] `json:"text_color"`
}
How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
func (CardProfileNewParamsDigitalWallets) MarshalJSON ¶ added in v0.1.1
func (r CardProfileNewParamsDigitalWallets) MarshalJSON() (data []byte, err error)
type CardProfileNewParamsDigitalWalletsTextColor ¶
type CardProfileNewParamsDigitalWalletsTextColor struct {
// The value of the blue channel in the RGB color.
Blue param.Field[int64] `json:"blue,required"`
// The value of the green channel in the RGB color.
Green param.Field[int64] `json:"green,required"`
// The value of the red channel in the RGB color.
Red param.Field[int64] `json:"red,required"`
}
The Card's text color, specified as an RGB triple. The default is white.
func (CardProfileNewParamsDigitalWalletsTextColor) MarshalJSON ¶ added in v0.1.1
func (r CardProfileNewParamsDigitalWalletsTextColor) MarshalJSON() (data []byte, err error)
type CardProfileNewParamsPhysicalCards ¶ added in v0.5.0
type CardProfileNewParamsPhysicalCards struct {
// The identifier of the File containing the physical card's carrier image.
CarrierImageFileID param.Field[string] `json:"carrier_image_file_id,required"`
// A phone number the user can contact to receive support for their card.
ContactPhone param.Field[string] `json:"contact_phone,required"`
// The identifier of the File containing the physical card's front image.
FrontImageFileID param.Field[string] `json:"front_image_file_id,required"`
}
How physical cards should be designed and shipped.
func (CardProfileNewParamsPhysicalCards) MarshalJSON ¶ added in v0.5.0
func (r CardProfileNewParamsPhysicalCards) MarshalJSON() (data []byte, err error)
type CardProfilePhysicalCards ¶ added in v0.5.0
type CardProfilePhysicalCards struct {
// The identifier of the File containing the physical card's back image.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// The identifier of the File containing the physical card's carrier image.
CarrierImageFileID string `json:"carrier_image_file_id,required,nullable"`
// A phone number the user can contact to receive support for their card.
ContactPhone string `json:"contact_phone,required,nullable"`
// The identifier of the File containing the physical card's front image.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The status of the Physical Card Profile.
Status CardProfilePhysicalCardsStatus `json:"status,required"`
JSON cardProfilePhysicalCardsJSON
}
How physical cards should be designed and shipped.
func (*CardProfilePhysicalCards) UnmarshalJSON ¶ added in v0.5.0
func (r *CardProfilePhysicalCards) UnmarshalJSON(data []byte) (err error)
type CardProfilePhysicalCardsStatus ¶ added in v0.6.2
type CardProfilePhysicalCardsStatus string
The status of the Physical Card Profile.
const ( // The Card Profile is not eligible for physical cards. CardProfilePhysicalCardsStatusNotEligible CardProfilePhysicalCardsStatus = "not_eligible" // There is an issue with the Physical Card Profile preventing it from use. CardProfilePhysicalCardsStatusRejected CardProfilePhysicalCardsStatus = "rejected" // The card profile is awaiting review by Increase. CardProfilePhysicalCardsStatusPendingReviewing CardProfilePhysicalCardsStatus = "pending_reviewing" // The card profile is awaiting submission to the fulfillment provider. CardProfilePhysicalCardsStatusPendingSubmitting CardProfilePhysicalCardsStatus = "pending_submitting" // The Physical Card Profile has been submitted to the fulfillment provider and is // ready to use. CardProfilePhysicalCardsStatusActive CardProfilePhysicalCardsStatus = "active" )
type CardProfileService ¶
type CardProfileService struct {
Options []option.RequestOption
}
CardProfileService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardProfileService method instead.
func NewCardProfileService ¶
func NewCardProfileService(opts ...option.RequestOption) (r *CardProfileService)
NewCardProfileService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CardProfileService) Archive ¶ added in v0.6.3
func (r *CardProfileService) Archive(ctx context.Context, cardProfileID string, opts ...option.RequestOption) (res *CardProfile, err error)
Archive an Card Profile
func (*CardProfileService) Get ¶
func (r *CardProfileService) Get(ctx context.Context, cardProfileID string, opts ...option.RequestOption) (res *CardProfile, err error)
Retrieve a Card Profile
func (*CardProfileService) List ¶
func (r *CardProfileService) List(ctx context.Context, query CardProfileListParams, opts ...option.RequestOption) (res *shared.Page[CardProfile], err error)
List Card Profiles
func (*CardProfileService) ListAutoPaging ¶
func (r *CardProfileService) ListAutoPaging(ctx context.Context, query CardProfileListParams, opts ...option.RequestOption) *shared.PageAutoPager[CardProfile]
List Card Profiles
func (*CardProfileService) New ¶
func (r *CardProfileService) New(ctx context.Context, body CardProfileNewParams, opts ...option.RequestOption) (res *CardProfile, err error)
Create a Card Profile
type CardProfileStatus ¶
type CardProfileStatus string
The status of the Card Profile.
const ( // The Card Profile is awaiting review from Increase and/or processing by card // networks. CardProfileStatusPending CardProfileStatus = "pending" // There is an issue with the Card Profile preventing it from use. CardProfileStatusRejected CardProfileStatus = "rejected" // The Card Profile can be assigned to Cards. CardProfileStatusActive CardProfileStatus = "active" // The Card Profile is no longer in use. CardProfileStatusArchived CardProfileStatus = "archived" )
type CardProfileType ¶
type CardProfileType string
A constant representing the object's type. For this resource it will always be `card_profile`.
const (
CardProfileTypeCardProfile CardProfileType = "card_profile"
)
type CardPurchaseSupplement ¶ added in v0.6.2
type CardPurchaseSupplement struct {
// The Card Purchase Supplement identifier.
ID string `json:"id,required"`
// The ID of the Card Payment this transaction belongs to.
CardPaymentID string `json:"card_payment_id,required,nullable"`
// Invoice-level information about the payment.
Invoice CardPurchaseSupplementInvoice `json:"invoice,required,nullable"`
// Line item information, such as individual products purchased.
LineItems []CardPurchaseSupplementLineItem `json:"line_items,required,nullable"`
// The ID of the transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_purchase_supplement`.
Type CardPurchaseSupplementType `json:"type,required"`
JSON cardPurchaseSupplementJSON
}
Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.
func (*CardPurchaseSupplement) UnmarshalJSON ¶ added in v0.6.2
func (r *CardPurchaseSupplement) UnmarshalJSON(data []byte) (err error)
type CardPurchaseSupplementInvoice ¶ added in v0.6.2
type CardPurchaseSupplementInvoice struct {
// Discount given to cardholder.
DiscountAmount int64 `json:"discount_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
DiscountCurrency string `json:"discount_currency,required,nullable"`
// Indicates how the merchant applied the discount.
DiscountTreatmentCode CardPurchaseSupplementInvoiceDiscountTreatmentCode `json:"discount_treatment_code,required,nullable"`
// Amount of duty taxes.
DutyTaxAmount int64 `json:"duty_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax.
DutyTaxCurrency string `json:"duty_tax_currency,required,nullable"`
// Date the order was taken.
OrderDate time.Time `json:"order_date,required,nullable" format:"date"`
// The shipping cost.
ShippingAmount int64 `json:"shipping_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
// cost.
ShippingCurrency string `json:"shipping_currency,required,nullable"`
// Country code of the shipping destination.
ShippingDestinationCountryCode string `json:"shipping_destination_country_code,required,nullable"`
// Postal code of the shipping destination.
ShippingDestinationPostalCode string `json:"shipping_destination_postal_code,required,nullable"`
// Postal code of the location being shipped from.
ShippingSourcePostalCode string `json:"shipping_source_postal_code,required,nullable"`
// Taxes paid for freight and shipping.
ShippingTaxAmount int64 `json:"shipping_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping
// tax.
ShippingTaxCurrency string `json:"shipping_tax_currency,required,nullable"`
// Tax rate for freight and shipping.
ShippingTaxRate string `json:"shipping_tax_rate,required,nullable"`
// Indicates how the merchant applied taxes.
TaxTreatments CardPurchaseSupplementInvoiceTaxTreatments `json:"tax_treatments,required,nullable"`
// Value added tax invoice reference number.
UniqueValueAddedTaxInvoiceReference string `json:"unique_value_added_tax_invoice_reference,required,nullable"`
JSON cardPurchaseSupplementInvoiceJSON
}
Invoice-level information about the payment.
func (*CardPurchaseSupplementInvoice) UnmarshalJSON ¶ added in v0.6.2
func (r *CardPurchaseSupplementInvoice) UnmarshalJSON(data []byte) (err error)
type CardPurchaseSupplementInvoiceDiscountTreatmentCode ¶ added in v0.6.2
type CardPurchaseSupplementInvoiceDiscountTreatmentCode string
Indicates how the merchant applied the discount.
const ( // No invoice level discount provided CardPurchaseSupplementInvoiceDiscountTreatmentCodeNoInvoiceLevelDiscountProvided CardPurchaseSupplementInvoiceDiscountTreatmentCode = "no_invoice_level_discount_provided" // Tax calculated on post discount invoice total CardPurchaseSupplementInvoiceDiscountTreatmentCodeTaxCalculatedOnPostDiscountInvoiceTotal CardPurchaseSupplementInvoiceDiscountTreatmentCode = "tax_calculated_on_post_discount_invoice_total" // Tax calculated on pre discount invoice total CardPurchaseSupplementInvoiceDiscountTreatmentCodeTaxCalculatedOnPreDiscountInvoiceTotal CardPurchaseSupplementInvoiceDiscountTreatmentCode = "tax_calculated_on_pre_discount_invoice_total" )
type CardPurchaseSupplementInvoiceTaxTreatments ¶ added in v0.6.2
type CardPurchaseSupplementInvoiceTaxTreatments string
Indicates how the merchant applied taxes.
const ( // No tax applies CardPurchaseSupplementInvoiceTaxTreatmentsNoTaxApplies CardPurchaseSupplementInvoiceTaxTreatments = "no_tax_applies" // Net price line item level CardPurchaseSupplementInvoiceTaxTreatmentsNetPriceLineItemLevel CardPurchaseSupplementInvoiceTaxTreatments = "net_price_line_item_level" // Net price invoice level CardPurchaseSupplementInvoiceTaxTreatmentsNetPriceInvoiceLevel CardPurchaseSupplementInvoiceTaxTreatments = "net_price_invoice_level" // Gross price line item level CardPurchaseSupplementInvoiceTaxTreatmentsGrossPriceLineItemLevel CardPurchaseSupplementInvoiceTaxTreatments = "gross_price_line_item_level" // Gross price invoice level CardPurchaseSupplementInvoiceTaxTreatmentsGrossPriceInvoiceLevel CardPurchaseSupplementInvoiceTaxTreatments = "gross_price_invoice_level" )
type CardPurchaseSupplementLineItem ¶ added in v0.6.2
type CardPurchaseSupplementLineItem struct {
// Indicates the type of line item.
DetailIndicator CardPurchaseSupplementLineItemsDetailIndicator `json:"detail_indicator,required,nullable"`
// Discount amount for this specific line item.
DiscountAmount int64 `json:"discount_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount.
DiscountCurrency string `json:"discount_currency,required,nullable"`
// Indicates how the merchant applied the discount for this specific line item.
DiscountTreatmentCode CardPurchaseSupplementLineItemsDiscountTreatmentCode `json:"discount_treatment_code,required,nullable"`
// Code used to categorize the purchase item.
ItemCommodityCode string `json:"item_commodity_code,required,nullable"`
// Description of the purchase item.
ItemDescriptor string `json:"item_descriptor,required,nullable"`
// The number of units of the product being purchased.
ItemQuantity string `json:"item_quantity,required,nullable"`
// Code used to categorize the product being purchased.
ProductCode string `json:"product_code,required,nullable"`
// Sales tax amount for this line item.
SalesTaxAmount int64 `json:"sales_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax
// assessed.
SalesTaxCurrency string `json:"sales_tax_currency,required,nullable"`
// Sales tax rate for this line item.
SalesTaxRate string `json:"sales_tax_rate,required,nullable"`
// Total amount of all line items
TotalAmount int64 `json:"total_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total
// amount.
TotalAmountCurrency string `json:"total_amount_currency,required,nullable"`
// Cost of line item per unit of measure, in major units.
UnitCost string `json:"unit_cost,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost.
UnitCostCurrency string `json:"unit_cost_currency,required,nullable"`
// Code indicating unit of measure (gallons, etc.)
UnitOfMeasureCode string `json:"unit_of_measure_code,required,nullable"`
JSON cardPurchaseSupplementLineItemJSON
}
func (*CardPurchaseSupplementLineItem) UnmarshalJSON ¶ added in v0.6.2
func (r *CardPurchaseSupplementLineItem) UnmarshalJSON(data []byte) (err error)
type CardPurchaseSupplementLineItemsDetailIndicator ¶ added in v0.6.2
type CardPurchaseSupplementLineItemsDetailIndicator string
Indicates the type of line item.
const ( // Normal CardPurchaseSupplementLineItemsDetailIndicatorNormal CardPurchaseSupplementLineItemsDetailIndicator = "normal" // Credit CardPurchaseSupplementLineItemsDetailIndicatorCredit CardPurchaseSupplementLineItemsDetailIndicator = "credit" // Purchase CardPurchaseSupplementLineItemsDetailIndicatorPayment CardPurchaseSupplementLineItemsDetailIndicator = "payment" )
type CardPurchaseSupplementLineItemsDiscountTreatmentCode ¶ added in v0.6.2
type CardPurchaseSupplementLineItemsDiscountTreatmentCode string
Indicates how the merchant applied the discount for this specific line item.
const ( // No line item level discount provided CardPurchaseSupplementLineItemsDiscountTreatmentCodeNoLineItemLevelDiscountProvided CardPurchaseSupplementLineItemsDiscountTreatmentCode = "no_line_item_level_discount_provided" // Tax calculated on post discount line item total CardPurchaseSupplementLineItemsDiscountTreatmentCodeTaxCalculatedOnPostDiscountLineItemTotal CardPurchaseSupplementLineItemsDiscountTreatmentCode = "tax_calculated_on_post_discount_line_item_total" // Tax calculated on pre discount line item total CardPurchaseSupplementLineItemsDiscountTreatmentCodeTaxCalculatedOnPreDiscountLineItemTotal CardPurchaseSupplementLineItemsDiscountTreatmentCode = "tax_calculated_on_pre_discount_line_item_total" )
type CardPurchaseSupplementListParams ¶ added in v0.6.2
type CardPurchaseSupplementListParams struct {
// Filter Card Purchase Supplements to ones belonging to the specified Card
// Payment.
CardPaymentID param.Field[string] `query:"card_payment_id"`
CreatedAt param.Field[CardPurchaseSupplementListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (CardPurchaseSupplementListParams) URLQuery ¶ added in v0.6.2
func (r CardPurchaseSupplementListParams) URLQuery() (v url.Values)
URLQuery serializes CardPurchaseSupplementListParams's query parameters as `url.Values`.
type CardPurchaseSupplementListParamsCreatedAt ¶ added in v0.6.2
type CardPurchaseSupplementListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (CardPurchaseSupplementListParamsCreatedAt) URLQuery ¶ added in v0.6.2
func (r CardPurchaseSupplementListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes CardPurchaseSupplementListParamsCreatedAt's query parameters as `url.Values`.
type CardPurchaseSupplementService ¶ added in v0.6.2
type CardPurchaseSupplementService struct {
Options []option.RequestOption
}
CardPurchaseSupplementService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardPurchaseSupplementService method instead.
func NewCardPurchaseSupplementService ¶ added in v0.6.2
func NewCardPurchaseSupplementService(opts ...option.RequestOption) (r *CardPurchaseSupplementService)
NewCardPurchaseSupplementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CardPurchaseSupplementService) Get ¶ added in v0.6.2
func (r *CardPurchaseSupplementService) Get(ctx context.Context, cardPurchaseSupplementID string, opts ...option.RequestOption) (res *CardPurchaseSupplement, err error)
Retrieve a Card Purchase Supplement
func (*CardPurchaseSupplementService) List ¶ added in v0.6.2
func (r *CardPurchaseSupplementService) List(ctx context.Context, query CardPurchaseSupplementListParams, opts ...option.RequestOption) (res *shared.Page[CardPurchaseSupplement], err error)
List Card Purchase Supplements
func (*CardPurchaseSupplementService) ListAutoPaging ¶ added in v0.6.2
func (r *CardPurchaseSupplementService) ListAutoPaging(ctx context.Context, query CardPurchaseSupplementListParams, opts ...option.RequestOption) *shared.PageAutoPager[CardPurchaseSupplement]
List Card Purchase Supplements
type CardPurchaseSupplementType ¶ added in v0.6.2
type CardPurchaseSupplementType string
A constant representing the object's type. For this resource it will always be `card_purchase_supplement`.
const (
CardPurchaseSupplementTypeCardPurchaseSupplement CardPurchaseSupplementType = "card_purchase_supplement"
)
type CardService ¶
type CardService struct {
Options []option.RequestOption
}
CardService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCardService method instead.
func NewCardService ¶
func NewCardService(opts ...option.RequestOption) (r *CardService)
NewCardService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CardService) Get ¶
func (r *CardService) Get(ctx context.Context, cardID string, opts ...option.RequestOption) (res *Card, err error)
Retrieve a Card
func (*CardService) GetSensitiveDetails ¶
func (r *CardService) GetSensitiveDetails(ctx context.Context, cardID string, opts ...option.RequestOption) (res *CardDetails, err error)
Retrieve sensitive details for a Card
func (*CardService) List ¶
func (r *CardService) List(ctx context.Context, query CardListParams, opts ...option.RequestOption) (res *shared.Page[Card], err error)
List Cards
func (*CardService) ListAutoPaging ¶
func (r *CardService) ListAutoPaging(ctx context.Context, query CardListParams, opts ...option.RequestOption) *shared.PageAutoPager[Card]
List Cards
func (*CardService) New ¶
func (r *CardService) New(ctx context.Context, body CardNewParams, opts ...option.RequestOption) (res *Card, err error)
Create a Card
func (*CardService) Update ¶
func (r *CardService) Update(ctx context.Context, cardID string, body CardUpdateParams, opts ...option.RequestOption) (res *Card, err error)
Update a Card
type CardStatus ¶
type CardStatus string
This indicates if payments can be made with the card.
const ( // The card is active. CardStatusActive CardStatus = "active" // The card is temporarily disabled. CardStatusDisabled CardStatus = "disabled" // The card is permanently canceled. CardStatusCanceled CardStatus = "canceled" )
type CardType ¶
type CardType string
A constant representing the object's type. For this resource it will always be `card`.
const (
CardTypeCard CardType = "card"
)
type CardUpdateParams ¶
type CardUpdateParams struct {
// The card's updated billing address.
BillingAddress param.Field[CardUpdateParamsBillingAddress] `json:"billing_address"`
// The description you choose to give the card.
Description param.Field[string] `json:"description"`
// The contact information used in the two-factor steps for digital wallet card
// creation. At least one field must be present to complete the digital wallet
// steps.
DigitalWallet param.Field[CardUpdateParamsDigitalWallet] `json:"digital_wallet"`
// The status to update the Card with.
Status param.Field[CardUpdateParamsStatus] `json:"status"`
}
func (CardUpdateParams) MarshalJSON ¶
func (r CardUpdateParams) MarshalJSON() (data []byte, err error)
type CardUpdateParamsBillingAddress ¶
type CardUpdateParamsBillingAddress struct {
// The city of the billing address.
City param.Field[string] `json:"city,required"`
// The first line of the billing address.
Line1 param.Field[string] `json:"line1,required"`
// The postal code of the billing address.
PostalCode param.Field[string] `json:"postal_code,required"`
// The US state of the billing address.
State param.Field[string] `json:"state,required"`
// The second line of the billing address.
Line2 param.Field[string] `json:"line2"`
}
The card's updated billing address.
func (CardUpdateParamsBillingAddress) MarshalJSON ¶ added in v0.1.1
func (r CardUpdateParamsBillingAddress) MarshalJSON() (data []byte, err error)
type CardUpdateParamsDigitalWallet ¶
type CardUpdateParamsDigitalWallet struct {
// The card profile assigned to this card. Card profiles may also be assigned at
// the program level.
CardProfileID param.Field[string] `json:"card_profile_id"`
// An email address that can be used to verify the cardholder via one-time passcode
// over email.
Email param.Field[string] `json:"email"`
// A phone number that can be used to verify the cardholder via one-time passcode
// over SMS.
Phone param.Field[string] `json:"phone"`
}
The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
func (CardUpdateParamsDigitalWallet) MarshalJSON ¶ added in v0.1.1
func (r CardUpdateParamsDigitalWallet) MarshalJSON() (data []byte, err error)
type CardUpdateParamsStatus ¶
type CardUpdateParamsStatus string
The status to update the Card with.
const ( // The card is active. CardUpdateParamsStatusActive CardUpdateParamsStatus = "active" // The card is temporarily disabled. CardUpdateParamsStatusDisabled CardUpdateParamsStatus = "disabled" // The card is permanently canceled. CardUpdateParamsStatusCanceled CardUpdateParamsStatus = "canceled" )
type CheckDeposit ¶
type CheckDeposit struct {
// The deposit's identifier.
ID string `json:"id,required"`
// The Account the check was deposited into.
AccountID string `json:"account_id,required"`
// The deposited amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The ID for the File containing the image of the back of the check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
Currency CheckDepositCurrency `json:"currency,required"`
// If your deposit is successfully parsed and accepted by Increase, this will
// contain details of the parsed check.
DepositAcceptance CheckDepositDepositAcceptance `json:"deposit_acceptance,required,nullable"`
// If your deposit is rejected by Increase, this will contain details as to why it
// was rejected.
DepositRejection CheckDepositDepositRejection `json:"deposit_rejection,required,nullable"`
// If your deposit is returned, this will contain details as to why it was
// returned.
DepositReturn CheckDepositDepositReturn `json:"deposit_return,required,nullable"`
// The ID for the File containing the image of the front of the check.
FrontImageFileID string `json:"front_image_file_id,required"`
// The status of the Check Deposit.
Status CheckDepositStatus `json:"status,required"`
// The ID for the Transaction created by the deposit.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_deposit`.
Type CheckDepositType `json:"type,required"`
JSON checkDepositJSON
}
Check Deposits allow you to deposit images of paper checks into your account.
func (*CheckDeposit) UnmarshalJSON ¶
func (r *CheckDeposit) UnmarshalJSON(data []byte) (err error)
type CheckDepositCurrency ¶
type CheckDepositCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
const ( // Canadian Dollar (CAD) CheckDepositCurrencyCad CheckDepositCurrency = "CAD" // Swiss Franc (CHF) CheckDepositCurrencyChf CheckDepositCurrency = "CHF" // Euro (EUR) CheckDepositCurrencyEur CheckDepositCurrency = "EUR" // British Pound (GBP) CheckDepositCurrencyGbp CheckDepositCurrency = "GBP" // Japanese Yen (JPY) CheckDepositCurrencyJpy CheckDepositCurrency = "JPY" // US Dollar (USD) CheckDepositCurrencyUsd CheckDepositCurrency = "USD" )
type CheckDepositDepositAcceptance ¶
type CheckDepositDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency CheckDepositDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON checkDepositDepositAcceptanceJSON
}
If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
func (*CheckDepositDepositAcceptance) UnmarshalJSON ¶
func (r *CheckDepositDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type CheckDepositDepositAcceptanceCurrency ¶
type CheckDepositDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) CheckDepositDepositAcceptanceCurrencyCad CheckDepositDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) CheckDepositDepositAcceptanceCurrencyChf CheckDepositDepositAcceptanceCurrency = "CHF" // Euro (EUR) CheckDepositDepositAcceptanceCurrencyEur CheckDepositDepositAcceptanceCurrency = "EUR" // British Pound (GBP) CheckDepositDepositAcceptanceCurrencyGbp CheckDepositDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) CheckDepositDepositAcceptanceCurrencyJpy CheckDepositDepositAcceptanceCurrency = "JPY" // US Dollar (USD) CheckDepositDepositAcceptanceCurrencyUsd CheckDepositDepositAcceptanceCurrency = "USD" )
type CheckDepositDepositRejection ¶
type CheckDepositDepositRejection struct {
// The rejected amount in the minor unit of check's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency CheckDepositDepositRejectionCurrency `json:"currency,required"`
// Why the check deposit was rejected.
Reason CheckDepositDepositRejectionReason `json:"reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was rejected.
RejectedAt time.Time `json:"rejected_at,required" format:"date-time"`
JSON checkDepositDepositRejectionJSON
}
If your deposit is rejected by Increase, this will contain details as to why it was rejected.
func (*CheckDepositDepositRejection) UnmarshalJSON ¶
func (r *CheckDepositDepositRejection) UnmarshalJSON(data []byte) (err error)
type CheckDepositDepositRejectionCurrency ¶
type CheckDepositDepositRejectionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) CheckDepositDepositRejectionCurrencyCad CheckDepositDepositRejectionCurrency = "CAD" // Swiss Franc (CHF) CheckDepositDepositRejectionCurrencyChf CheckDepositDepositRejectionCurrency = "CHF" // Euro (EUR) CheckDepositDepositRejectionCurrencyEur CheckDepositDepositRejectionCurrency = "EUR" // British Pound (GBP) CheckDepositDepositRejectionCurrencyGbp CheckDepositDepositRejectionCurrency = "GBP" // Japanese Yen (JPY) CheckDepositDepositRejectionCurrencyJpy CheckDepositDepositRejectionCurrency = "JPY" // US Dollar (USD) CheckDepositDepositRejectionCurrencyUsd CheckDepositDepositRejectionCurrency = "USD" )
type CheckDepositDepositRejectionReason ¶
type CheckDepositDepositRejectionReason string
Why the check deposit was rejected.
const ( // The check's image is incomplete. CheckDepositDepositRejectionReasonIncompleteImage CheckDepositDepositRejectionReason = "incomplete_image" // This is a duplicate check submission. CheckDepositDepositRejectionReasonDuplicate CheckDepositDepositRejectionReason = "duplicate" // This check has poor image quality. CheckDepositDepositRejectionReasonPoorImageQuality CheckDepositDepositRejectionReason = "poor_image_quality" // The check was deposited with the incorrect amount. CheckDepositDepositRejectionReasonIncorrectAmount CheckDepositDepositRejectionReason = "incorrect_amount" // The check is made out to someone other than the account holder. CheckDepositDepositRejectionReasonIncorrectRecipient CheckDepositDepositRejectionReason = "incorrect_recipient" // This check was not eligible for mobile deposit. CheckDepositDepositRejectionReasonNotEligibleForMobileDeposit CheckDepositDepositRejectionReason = "not_eligible_for_mobile_deposit" // This check is missing at least one required field CheckDepositDepositRejectionReasonMissingRequiredDataElements CheckDepositDepositRejectionReason = "missing_required_data_elements" // The check was rejected for an unknown reason. CheckDepositDepositRejectionReasonUnknown CheckDepositDepositRejectionReason = "unknown" )
type CheckDepositDepositReturn ¶
type CheckDepositDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency CheckDepositDepositReturnCurrency `json:"currency,required"`
ReturnReason CheckDepositDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON checkDepositDepositReturnJSON
}
If your deposit is returned, this will contain details as to why it was returned.
func (*CheckDepositDepositReturn) UnmarshalJSON ¶
func (r *CheckDepositDepositReturn) UnmarshalJSON(data []byte) (err error)
type CheckDepositDepositReturnCurrency ¶
type CheckDepositDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) CheckDepositDepositReturnCurrencyCad CheckDepositDepositReturnCurrency = "CAD" // Swiss Franc (CHF) CheckDepositDepositReturnCurrencyChf CheckDepositDepositReturnCurrency = "CHF" // Euro (EUR) CheckDepositDepositReturnCurrencyEur CheckDepositDepositReturnCurrency = "EUR" // British Pound (GBP) CheckDepositDepositReturnCurrencyGbp CheckDepositDepositReturnCurrency = "GBP" // Japanese Yen (JPY) CheckDepositDepositReturnCurrencyJpy CheckDepositDepositReturnCurrency = "JPY" // US Dollar (USD) CheckDepositDepositReturnCurrencyUsd CheckDepositDepositReturnCurrency = "USD" )
type CheckDepositDepositReturnReturnReason ¶
type CheckDepositDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. CheckDepositDepositReturnReturnReasonACHConversionNotSupported CheckDepositDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. CheckDepositDepositReturnReturnReasonClosedAccount CheckDepositDepositReturnReturnReason = "closed_account" // The check has already been deposited. CheckDepositDepositReturnReturnReasonDuplicateSubmission CheckDepositDepositReturnReturnReason = "duplicate_submission" // Insufficient funds CheckDepositDepositReturnReturnReasonInsufficientFunds CheckDepositDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. CheckDepositDepositReturnReturnReasonNoAccount CheckDepositDepositReturnReturnReason = "no_account" // The check was not authorized. CheckDepositDepositReturnReturnReasonNotAuthorized CheckDepositDepositReturnReturnReason = "not_authorized" // The check is too old. CheckDepositDepositReturnReturnReasonStaleDated CheckDepositDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. CheckDepositDepositReturnReturnReasonStopPayment CheckDepositDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. CheckDepositDepositReturnReturnReasonUnknownReason CheckDepositDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. CheckDepositDepositReturnReturnReasonUnmatchedDetails CheckDepositDepositReturnReturnReason = "unmatched_details" // The image could not be read. CheckDepositDepositReturnReturnReasonUnreadableImage CheckDepositDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. CheckDepositDepositReturnReturnReasonEndorsementIrregular CheckDepositDepositReturnReturnReason = "endorsement_irregular" )
type CheckDepositListParams ¶
type CheckDepositListParams struct {
// Filter Check Deposits to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[CheckDepositListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (CheckDepositListParams) URLQuery ¶
func (r CheckDepositListParams) URLQuery() (v url.Values)
URLQuery serializes CheckDepositListParams's query parameters as `url.Values`.
type CheckDepositListParamsCreatedAt ¶
type CheckDepositListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (CheckDepositListParamsCreatedAt) URLQuery ¶
func (r CheckDepositListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes CheckDepositListParamsCreatedAt's query parameters as `url.Values`.
type CheckDepositNewParams ¶
type CheckDepositNewParams struct {
// The identifier for the Account to deposit the check in.
AccountID param.Field[string] `json:"account_id,required"`
// The deposit amount in the minor unit of the account currency. For dollars, for
// example, this is cents.
Amount param.Field[int64] `json:"amount,required"`
// The File containing the check's back image.
BackImageFileID param.Field[string] `json:"back_image_file_id,required"`
// The currency to use for the deposit.
Currency param.Field[string] `json:"currency,required"`
// The File containing the check's front image.
FrontImageFileID param.Field[string] `json:"front_image_file_id,required"`
}
func (CheckDepositNewParams) MarshalJSON ¶
func (r CheckDepositNewParams) MarshalJSON() (data []byte, err error)
type CheckDepositService ¶
type CheckDepositService struct {
Options []option.RequestOption
}
CheckDepositService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCheckDepositService method instead.
func NewCheckDepositService ¶
func NewCheckDepositService(opts ...option.RequestOption) (r *CheckDepositService)
NewCheckDepositService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CheckDepositService) Get ¶
func (r *CheckDepositService) Get(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
Retrieve a Check Deposit
func (*CheckDepositService) List ¶
func (r *CheckDepositService) List(ctx context.Context, query CheckDepositListParams, opts ...option.RequestOption) (res *shared.Page[CheckDeposit], err error)
List Check Deposits
func (*CheckDepositService) ListAutoPaging ¶
func (r *CheckDepositService) ListAutoPaging(ctx context.Context, query CheckDepositListParams, opts ...option.RequestOption) *shared.PageAutoPager[CheckDeposit]
List Check Deposits
func (*CheckDepositService) New ¶
func (r *CheckDepositService) New(ctx context.Context, body CheckDepositNewParams, opts ...option.RequestOption) (res *CheckDeposit, err error)
Create a Check Deposit
type CheckDepositStatus ¶
type CheckDepositStatus string
The status of the Check Deposit.
const ( // The Check Deposit is pending review. CheckDepositStatusPending CheckDepositStatus = "pending" // The Check Deposit has been deposited. CheckDepositStatusSubmitted CheckDepositStatus = "submitted" // The Check Deposit has been rejected. CheckDepositStatusRejected CheckDepositStatus = "rejected" // The Check Deposit has been returned. CheckDepositStatusReturned CheckDepositStatus = "returned" )
type CheckDepositType ¶
type CheckDepositType string
A constant representing the object's type. For this resource it will always be `check_deposit`.
const (
CheckDepositTypeCheckDeposit CheckDepositType = "check_deposit"
)
type CheckTransfer ¶
type CheckTransfer struct {
// The Check transfer's identifier.
ID string `json:"id,required"`
// The identifier of the Account from which funds will be transferred.
AccountID string `json:"account_id,required"`
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// If your account requires approvals for transfers and the transfer was approved,
// this will contain details of the approval.
Approval CheckTransferApproval `json:"approval,required,nullable"`
// If your account requires approvals for transfers and the transfer was not
// approved, this will contain details of the cancellation.
Cancellation CheckTransferCancellation `json:"cancellation,required,nullable"`
// The check number printed on the check.
CheckNumber string `json:"check_number,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency CheckTransferCurrency `json:"currency,required"`
// After a check transfer is deposited, this will contain supplemental details.
Deposit CheckTransferDeposit `json:"deposit,required,nullable"`
// Whether Increase will print and mail the check or if you will do it yourself.
FulfillmentMethod CheckTransferFulfillmentMethod `json:"fulfillment_method,required"`
// If the check has been mailed by Increase, this will contain details of the
// shipment.
Mailing CheckTransferMailing `json:"mailing,required,nullable"`
// The ID for the pending transaction representing the transfer. A pending
// transaction is created when the transfer
// [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
// by someone else in your organization.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// Details relating to the physical check that Increase will print and mail. Will
// be present if and only if `fulfillment_method` is equal to `physical_check`.
PhysicalCheck CheckTransferPhysicalCheck `json:"physical_check,required,nullable"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The identifier of the Account Number from which to send the transfer and print
// on the check.
SourceAccountNumberID string `json:"source_account_number_id,required,nullable"`
// The lifecycle status of the transfer.
Status CheckTransferStatus `json:"status,required"`
// After a stop-payment is requested on the check, this will contain supplemental
// details.
StopPaymentRequest CheckTransferStopPaymentRequest `json:"stop_payment_request,required,nullable"`
// After the transfer is submitted, this will contain supplemental details.
Submission CheckTransferSubmission `json:"submission,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer`.
Type CheckTransferType `json:"type,required"`
// The unique identifier you chose for this transfer.
UniqueIdentifier string `json:"unique_identifier,required,nullable"`
JSON checkTransferJSON
}
Check Transfers move funds from your Increase account by mailing a physical check.
func (*CheckTransfer) UnmarshalJSON ¶
func (r *CheckTransfer) UnmarshalJSON(data []byte) (err error)
type CheckTransferApproval ¶
type CheckTransferApproval struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was approved.
ApprovedAt time.Time `json:"approved_at,required" format:"date-time"`
// If the Transfer was approved by a user in the dashboard, the email address of
// that user.
ApprovedBy string `json:"approved_by,required,nullable"`
JSON checkTransferApprovalJSON
}
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
func (*CheckTransferApproval) UnmarshalJSON ¶
func (r *CheckTransferApproval) UnmarshalJSON(data []byte) (err error)
type CheckTransferCancellation ¶
type CheckTransferCancellation struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Transfer was canceled.
CanceledAt time.Time `json:"canceled_at,required" format:"date-time"`
// If the Transfer was canceled by a user in the dashboard, the email address of
// that user.
CanceledBy string `json:"canceled_by,required,nullable"`
JSON checkTransferCancellationJSON
}
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
func (*CheckTransferCancellation) UnmarshalJSON ¶
func (r *CheckTransferCancellation) UnmarshalJSON(data []byte) (err error)
type CheckTransferCurrency ¶
type CheckTransferCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) CheckTransferCurrencyCad CheckTransferCurrency = "CAD" // Swiss Franc (CHF) CheckTransferCurrencyChf CheckTransferCurrency = "CHF" // Euro (EUR) CheckTransferCurrencyEur CheckTransferCurrency = "EUR" // British Pound (GBP) CheckTransferCurrencyGbp CheckTransferCurrency = "GBP" // Japanese Yen (JPY) CheckTransferCurrencyJpy CheckTransferCurrency = "JPY" // US Dollar (USD) CheckTransferCurrencyUsd CheckTransferCurrency = "USD" )
type CheckTransferDeposit ¶
type CheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type CheckTransferDepositType `json:"type,required"`
JSON checkTransferDepositJSON
}
After a check transfer is deposited, this will contain supplemental details.
func (*CheckTransferDeposit) UnmarshalJSON ¶
func (r *CheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type CheckTransferDepositType ¶
type CheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
CheckTransferDepositTypeCheckTransferDeposit CheckTransferDepositType = "check_transfer_deposit"
)
type CheckTransferFulfillmentMethod ¶ added in v0.6.0
type CheckTransferFulfillmentMethod string
Whether Increase will print and mail the check or if you will do it yourself.
const ( // Increase will print and mail a physical check. CheckTransferFulfillmentMethodPhysicalCheck CheckTransferFulfillmentMethod = "physical_check" // Increase will not print a check; you are responsible for printing and mailing a // check with the provided account number, routing number, check number, and // amount. CheckTransferFulfillmentMethodThirdParty CheckTransferFulfillmentMethod = "third_party" )
type CheckTransferListParams ¶
type CheckTransferListParams struct {
// Filter Check Transfers to those that originated from the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[CheckTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Check Transfers to the one with the specified unique identifier.
UniqueIdentifier param.Field[string] `query:"unique_identifier"`
}
func (CheckTransferListParams) URLQuery ¶
func (r CheckTransferListParams) URLQuery() (v url.Values)
URLQuery serializes CheckTransferListParams's query parameters as `url.Values`.
type CheckTransferListParamsCreatedAt ¶
type CheckTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (CheckTransferListParamsCreatedAt) URLQuery ¶
func (r CheckTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes CheckTransferListParamsCreatedAt's query parameters as `url.Values`.
type CheckTransferMailing ¶ added in v0.6.0
type CheckTransferMailing struct {
// The ID of the file corresponding to an image of the check that was mailed, if
// available.
ImageID string `json:"image_id,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check was mailed.
MailedAt time.Time `json:"mailed_at,required" format:"date-time"`
JSON checkTransferMailingJSON
}
If the check has been mailed by Increase, this will contain details of the shipment.
func (*CheckTransferMailing) UnmarshalJSON ¶ added in v0.6.0
func (r *CheckTransferMailing) UnmarshalJSON(data []byte) (err error)
type CheckTransferNewParams ¶
type CheckTransferNewParams struct {
// The identifier for the account that will send the transfer.
AccountID param.Field[string] `json:"account_id,required"`
// The transfer amount in cents.
Amount param.Field[int64] `json:"amount,required"`
// Whether Increase will print and mail the check or if you will do it yourself.
FulfillmentMethod param.Field[CheckTransferNewParamsFulfillmentMethod] `json:"fulfillment_method"`
// Details relating to the physical check that Increase will print and mail. This
// is required if `fulfillment_method` is equal to `physical_check`. It must not be
// included if any other `fulfillment_method` is provided.
PhysicalCheck param.Field[CheckTransferNewParamsPhysicalCheck] `json:"physical_check"`
// Whether the transfer requires explicit approval via the dashboard or API.
RequireApproval param.Field[bool] `json:"require_approval"`
// The identifier of the Account Number from which to send the transfer and print
// on the check.
SourceAccountNumberID param.Field[string] `json:"source_account_number_id"`
// A unique identifier you choose for the transfer. Reusing this identifier for
// another transfer will result in an error. You can query for the transfer
// associated with this identifier using the List endpoint.
UniqueIdentifier param.Field[string] `json:"unique_identifier"`
}
func (CheckTransferNewParams) MarshalJSON ¶
func (r CheckTransferNewParams) MarshalJSON() (data []byte, err error)
type CheckTransferNewParamsFulfillmentMethod ¶ added in v0.6.0
type CheckTransferNewParamsFulfillmentMethod string
Whether Increase will print and mail the check or if you will do it yourself.
const ( // Increase will print and mail a physical check. CheckTransferNewParamsFulfillmentMethodPhysicalCheck CheckTransferNewParamsFulfillmentMethod = "physical_check" // Increase will not print a check; you are responsible for printing and mailing a // check with the provided account number, routing number, check number, and // amount. CheckTransferNewParamsFulfillmentMethodThirdParty CheckTransferNewParamsFulfillmentMethod = "third_party" )
type CheckTransferNewParamsPhysicalCheck ¶ added in v0.6.0
type CheckTransferNewParamsPhysicalCheck struct {
// Details for where Increase will mail the check.
MailingAddress param.Field[CheckTransferNewParamsPhysicalCheckMailingAddress] `json:"mailing_address,required"`
// The descriptor that will be printed on the memo field on the check.
Memo param.Field[string] `json:"memo,required"`
// The name that will be printed on the check in the 'To:' field.
RecipientName param.Field[string] `json:"recipient_name,required"`
// The descriptor that will be printed on the letter included with the check.
Note param.Field[string] `json:"note"`
// The return address to be printed on the check. If omitted this will default to
// the address of the Entity of the Account used to make the Check Transfer.
ReturnAddress param.Field[CheckTransferNewParamsPhysicalCheckReturnAddress] `json:"return_address"`
}
Details relating to the physical check that Increase will print and mail. This is required if `fulfillment_method` is equal to `physical_check`. It must not be included if any other `fulfillment_method` is provided.
func (CheckTransferNewParamsPhysicalCheck) MarshalJSON ¶ added in v0.6.0
func (r CheckTransferNewParamsPhysicalCheck) MarshalJSON() (data []byte, err error)
type CheckTransferNewParamsPhysicalCheckMailingAddress ¶ added in v0.6.0
type CheckTransferNewParamsPhysicalCheckMailingAddress struct {
// The city component of the check's destination address.
City param.Field[string] `json:"city,required"`
// The first line of the address component of the check's destination address.
Line1 param.Field[string] `json:"line1,required"`
// The postal code component of the check's destination address.
PostalCode param.Field[string] `json:"postal_code,required"`
// The US state component of the check's destination address.
State param.Field[string] `json:"state,required"`
// The second line of the address component of the check's destination address.
Line2 param.Field[string] `json:"line2"`
// The name component of the check's destination address. Defaults to the provided
// `recipient_name` parameter.
Name param.Field[string] `json:"name"`
}
Details for where Increase will mail the check.
func (CheckTransferNewParamsPhysicalCheckMailingAddress) MarshalJSON ¶ added in v0.6.0
func (r CheckTransferNewParamsPhysicalCheckMailingAddress) MarshalJSON() (data []byte, err error)
type CheckTransferNewParamsPhysicalCheckReturnAddress ¶ added in v0.6.0
type CheckTransferNewParamsPhysicalCheckReturnAddress struct {
// The city of the return address.
City param.Field[string] `json:"city,required"`
// The first line of the return address.
Line1 param.Field[string] `json:"line1,required"`
// The name of the return address.
Name param.Field[string] `json:"name,required"`
// The postal code of the return address.
PostalCode param.Field[string] `json:"postal_code,required"`
// The US state of the return address.
State param.Field[string] `json:"state,required"`
// The second line of the return address.
Line2 param.Field[string] `json:"line2"`
}
The return address to be printed on the check. If omitted this will default to the address of the Entity of the Account used to make the Check Transfer.
func (CheckTransferNewParamsPhysicalCheckReturnAddress) MarshalJSON ¶ added in v0.6.0
func (r CheckTransferNewParamsPhysicalCheckReturnAddress) MarshalJSON() (data []byte, err error)
type CheckTransferPhysicalCheck ¶ added in v0.6.0
type CheckTransferPhysicalCheck struct {
// Details for where Increase will mail the check.
MailingAddress CheckTransferPhysicalCheckMailingAddress `json:"mailing_address,required"`
// The descriptor that will be printed on the memo field on the check.
Memo string `json:"memo,required,nullable"`
// The descriptor that will be printed on the letter included with the check.
Note string `json:"note,required,nullable"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required"`
// The return address to be printed on the check.
ReturnAddress CheckTransferPhysicalCheckReturnAddress `json:"return_address,required,nullable"`
JSON checkTransferPhysicalCheckJSON
}
Details relating to the physical check that Increase will print and mail. Will be present if and only if `fulfillment_method` is equal to `physical_check`.
func (*CheckTransferPhysicalCheck) UnmarshalJSON ¶ added in v0.6.0
func (r *CheckTransferPhysicalCheck) UnmarshalJSON(data []byte) (err error)
type CheckTransferPhysicalCheckMailingAddress ¶ added in v0.6.0
type CheckTransferPhysicalCheckMailingAddress struct {
// The city of the check's destination.
City string `json:"city,required,nullable"`
// The street address of the check's destination.
Line1 string `json:"line1,required,nullable"`
// The second line of the address of the check's destination.
Line2 string `json:"line2,required,nullable"`
// The name component of the check's mailing address.
Name string `json:"name,required,nullable"`
// The postal code of the check's destination.
PostalCode string `json:"postal_code,required,nullable"`
// The state of the check's destination.
State string `json:"state,required,nullable"`
JSON checkTransferPhysicalCheckMailingAddressJSON
}
Details for where Increase will mail the check.
func (*CheckTransferPhysicalCheckMailingAddress) UnmarshalJSON ¶ added in v0.6.0
func (r *CheckTransferPhysicalCheckMailingAddress) UnmarshalJSON(data []byte) (err error)
type CheckTransferPhysicalCheckReturnAddress ¶ added in v0.6.0
type CheckTransferPhysicalCheckReturnAddress struct {
// The city of the check's destination.
City string `json:"city,required,nullable"`
// The street address of the check's destination.
Line1 string `json:"line1,required,nullable"`
// The second line of the address of the check's destination.
Line2 string `json:"line2,required,nullable"`
// The name component of the check's return address.
Name string `json:"name,required,nullable"`
// The postal code of the check's destination.
PostalCode string `json:"postal_code,required,nullable"`
// The state of the check's destination.
State string `json:"state,required,nullable"`
JSON checkTransferPhysicalCheckReturnAddressJSON
}
The return address to be printed on the check.
func (*CheckTransferPhysicalCheckReturnAddress) UnmarshalJSON ¶ added in v0.6.0
func (r *CheckTransferPhysicalCheckReturnAddress) UnmarshalJSON(data []byte) (err error)
type CheckTransferService ¶
type CheckTransferService struct {
Options []option.RequestOption
}
CheckTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewCheckTransferService method instead.
func NewCheckTransferService ¶
func NewCheckTransferService(opts ...option.RequestOption) (r *CheckTransferService)
NewCheckTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*CheckTransferService) Approve ¶
func (r *CheckTransferService) Approve(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
Approve a Check Transfer
func (*CheckTransferService) Cancel ¶
func (r *CheckTransferService) Cancel(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
Cancel a pending Check Transfer
func (*CheckTransferService) Get ¶
func (r *CheckTransferService) Get(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
Retrieve a Check Transfer
func (*CheckTransferService) List ¶
func (r *CheckTransferService) List(ctx context.Context, query CheckTransferListParams, opts ...option.RequestOption) (res *shared.Page[CheckTransfer], err error)
List Check Transfers
func (*CheckTransferService) ListAutoPaging ¶
func (r *CheckTransferService) ListAutoPaging(ctx context.Context, query CheckTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[CheckTransfer]
List Check Transfers
func (*CheckTransferService) New ¶
func (r *CheckTransferService) New(ctx context.Context, body CheckTransferNewParams, opts ...option.RequestOption) (res *CheckTransfer, err error)
Create a Check Transfer
func (*CheckTransferService) StopPayment ¶
func (r *CheckTransferService) StopPayment(ctx context.Context, checkTransferID string, body CheckTransferStopPaymentParams, opts ...option.RequestOption) (res *CheckTransfer, err error)
Request a stop payment on a Check Transfer
type CheckTransferStatus ¶
type CheckTransferStatus string
The lifecycle status of the transfer.
const ( // The transfer is awaiting approval. CheckTransferStatusPendingApproval CheckTransferStatus = "pending_approval" // The transfer is pending submission. CheckTransferStatusPendingSubmission CheckTransferStatus = "pending_submission" // The transfer is complete. CheckTransferStatusSubmitted CheckTransferStatus = "submitted" // The check is queued for mailing. CheckTransferStatusPendingMailing CheckTransferStatus = "pending_mailing" // The check has been mailed. CheckTransferStatusMailed CheckTransferStatus = "mailed" // The transfer has been canceled. CheckTransferStatusCanceled CheckTransferStatus = "canceled" // The check has been deposited. CheckTransferStatusDeposited CheckTransferStatus = "deposited" // A stop-payment was requested for this check. CheckTransferStatusStopped CheckTransferStatus = "stopped" // The transfer has been rejected. CheckTransferStatusRejected CheckTransferStatus = "rejected" // The transfer requires attention from an Increase operator. CheckTransferStatusRequiresAttention CheckTransferStatus = "requires_attention" )
type CheckTransferStopPaymentParams ¶ added in v0.4.0
type CheckTransferStopPaymentParams struct {
// The reason why this transfer should be stopped.
Reason param.Field[CheckTransferStopPaymentParamsReason] `json:"reason"`
}
func (CheckTransferStopPaymentParams) MarshalJSON ¶ added in v0.4.0
func (r CheckTransferStopPaymentParams) MarshalJSON() (data []byte, err error)
type CheckTransferStopPaymentParamsReason ¶ added in v0.4.0
type CheckTransferStopPaymentParamsReason string
The reason why this transfer should be stopped.
const ( // The check could not be delivered. CheckTransferStopPaymentParamsReasonMailDeliveryFailed CheckTransferStopPaymentParamsReason = "mail_delivery_failed" // The check was stopped for another reason. CheckTransferStopPaymentParamsReasonUnknown CheckTransferStopPaymentParamsReason = "unknown" )
type CheckTransferStopPaymentRequest ¶
type CheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason CheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type CheckTransferStopPaymentRequestType `json:"type,required"`
JSON checkTransferStopPaymentRequestJSON
}
After a stop-payment is requested on the check, this will contain supplemental details.
func (*CheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *CheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type CheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type CheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. CheckTransferStopPaymentRequestReasonMailDeliveryFailed CheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. CheckTransferStopPaymentRequestReasonRejectedByIncrease CheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. CheckTransferStopPaymentRequestReasonUnknown CheckTransferStopPaymentRequestReason = "unknown" )
type CheckTransferStopPaymentRequestType ¶
type CheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
CheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest CheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type CheckTransferSubmission ¶
type CheckTransferSubmission struct {
// When this check transfer was submitted to our check printer.
SubmittedAt time.Time `json:"submitted_at,required" format:"date-time"`
JSON checkTransferSubmissionJSON
}
After the transfer is submitted, this will contain supplemental details.
func (*CheckTransferSubmission) UnmarshalJSON ¶
func (r *CheckTransferSubmission) UnmarshalJSON(data []byte) (err error)
type CheckTransferType ¶
type CheckTransferType string
A constant representing the object's type. For this resource it will always be `check_transfer`.
const (
CheckTransferTypeCheckTransfer CheckTransferType = "check_transfer"
)
type Client ¶
type Client struct {
Options []option.RequestOption
Accounts *AccountService
AccountNumbers *AccountNumberService
BookkeepingAccounts *BookkeepingAccountService
BookkeepingEntrySets *BookkeepingEntrySetService
BookkeepingEntries *BookkeepingEntryService
RealTimeDecisions *RealTimeDecisionService
RealTimePaymentsTransfers *RealTimePaymentsTransferService
BalanceLookups *BalanceLookupService
Cards *CardService
CardDisputes *CardDisputeService
CardProfiles *CardProfileService
CardPurchaseSupplements *CardPurchaseSupplementService
ExternalAccounts *ExternalAccountService
Exports *ExportService
DigitalWalletTokens *DigitalWalletTokenService
Transactions *TransactionService
PendingTransactions *PendingTransactionService
Programs *ProgramService
DeclinedTransactions *DeclinedTransactionService
Limits *LimitService
AccountTransfers *AccountTransferService
ACHTransfers *ACHTransferService
ACHPrenotifications *ACHPrenotificationService
Documents *DocumentService
WireTransfers *WireTransferService
CheckTransfers *CheckTransferService
Entities *EntityService
InboundACHTransfers *InboundACHTransferService
InboundWireDrawdownRequests *InboundWireDrawdownRequestService
WireDrawdownRequests *WireDrawdownRequestService
Events *EventService
EventSubscriptions *EventSubscriptionService
Files *FileService
Groups *GroupService
OauthConnections *OauthConnectionService
CheckDeposits *CheckDepositService
RoutingNumbers *RoutingNumberService
AccountStatements *AccountStatementService
Simulations *SimulationService
}
Client creates a struct with services and top level methods that help with interacting with the increase API. You should not instantiate this client directly, and instead use the NewClient method instead.
func NewClient ¶
func NewClient(opts ...option.RequestOption) (r *Client)
NewClient generates a new client with the default option read from the environment (INCREASE_API_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.
type DeclinedTransaction ¶
type DeclinedTransaction struct {
// The Declined Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Declined Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Declined Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
// Transaction's currency. This will match the currency on the Declined
// Transaction's Account.
Currency DeclinedTransactionCurrency `json:"currency,required"`
// This is the description the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Declined Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Declined Transaction came through.
RouteType DeclinedTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Declined Transaction. For example, for a card transaction this lists the
// merchant's industry and location. Note that for backwards compatibility reasons,
// additional undocumented keys may appear in this object. These should be treated
// as deprecated and will be removed in the future.
Source DeclinedTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `declined_transaction`.
Type DeclinedTransactionType `json:"type,required"`
JSON declinedTransactionJSON
}
Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
func (*DeclinedTransaction) UnmarshalJSON ¶
func (r *DeclinedTransaction) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionCurrency ¶
type DeclinedTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
const ( // Canadian Dollar (CAD) DeclinedTransactionCurrencyCad DeclinedTransactionCurrency = "CAD" // Swiss Franc (CHF) DeclinedTransactionCurrencyChf DeclinedTransactionCurrency = "CHF" // Euro (EUR) DeclinedTransactionCurrencyEur DeclinedTransactionCurrency = "EUR" // British Pound (GBP) DeclinedTransactionCurrencyGbp DeclinedTransactionCurrency = "GBP" // Japanese Yen (JPY) DeclinedTransactionCurrencyJpy DeclinedTransactionCurrency = "JPY" // US Dollar (USD) DeclinedTransactionCurrencyUsd DeclinedTransactionCurrency = "USD" )
type DeclinedTransactionListParams ¶
type DeclinedTransactionListParams struct {
// Filter Declined Transactions to ones belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
Category param.Field[DeclinedTransactionListParamsCategory] `query:"category"`
CreatedAt param.Field[DeclinedTransactionListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Declined Transactions to those belonging to the specified route.
RouteID param.Field[string] `query:"route_id"`
}
func (DeclinedTransactionListParams) URLQuery ¶
func (r DeclinedTransactionListParams) URLQuery() (v url.Values)
URLQuery serializes DeclinedTransactionListParams's query parameters as `url.Values`.
type DeclinedTransactionListParamsCategory ¶ added in v0.7.1
type DeclinedTransactionListParamsCategory struct {
// Return results whose value is in the provided list. For GET requests, this
// should be encoded as a comma-delimited string, such as `?in=one,two,three`.
In param.Field[[]DeclinedTransactionListParamsCategoryIn] `query:"in"`
}
func (DeclinedTransactionListParamsCategory) URLQuery ¶ added in v0.7.1
func (r DeclinedTransactionListParamsCategory) URLQuery() (v url.Values)
URLQuery serializes DeclinedTransactionListParamsCategory's query parameters as `url.Values`.
type DeclinedTransactionListParamsCategoryIn ¶ added in v0.7.1
type DeclinedTransactionListParamsCategoryIn string
const ( // ACH Decline: details will be under the `ach_decline` object. DeclinedTransactionListParamsCategoryInACHDecline DeclinedTransactionListParamsCategoryIn = "ach_decline" // Card Decline: details will be under the `card_decline` object. DeclinedTransactionListParamsCategoryInCardDecline DeclinedTransactionListParamsCategoryIn = "card_decline" // Check Decline: details will be under the `check_decline` object. DeclinedTransactionListParamsCategoryInCheckDecline DeclinedTransactionListParamsCategoryIn = "check_decline" // Inbound Real-Time Payments Transfer Decline: details will be under the // `inbound_real_time_payments_transfer_decline` object. DeclinedTransactionListParamsCategoryInInboundRealTimePaymentsTransferDecline DeclinedTransactionListParamsCategoryIn = "inbound_real_time_payments_transfer_decline" // International ACH Decline: details will be under the `international_ach_decline` // object. DeclinedTransactionListParamsCategoryInInternationalACHDecline DeclinedTransactionListParamsCategoryIn = "international_ach_decline" // Wire Decline: details will be under the `wire_decline` object. DeclinedTransactionListParamsCategoryInWireDecline DeclinedTransactionListParamsCategoryIn = "wire_decline" // The Declined Transaction was made for an undocumented or deprecated reason. DeclinedTransactionListParamsCategoryInOther DeclinedTransactionListParamsCategoryIn = "other" )
type DeclinedTransactionListParamsCreatedAt ¶
type DeclinedTransactionListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (DeclinedTransactionListParamsCreatedAt) URLQuery ¶
func (r DeclinedTransactionListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes DeclinedTransactionListParamsCreatedAt's query parameters as `url.Values`.
type DeclinedTransactionRouteType ¶
type DeclinedTransactionRouteType string
The type of the route this Declined Transaction came through.
const ( // An Account Number. DeclinedTransactionRouteTypeAccountNumber DeclinedTransactionRouteType = "account_number" // A Card. DeclinedTransactionRouteTypeCard DeclinedTransactionRouteType = "card" )
type DeclinedTransactionService ¶
type DeclinedTransactionService struct {
Options []option.RequestOption
}
DeclinedTransactionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDeclinedTransactionService method instead.
func NewDeclinedTransactionService ¶
func NewDeclinedTransactionService(opts ...option.RequestOption) (r *DeclinedTransactionService)
NewDeclinedTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*DeclinedTransactionService) Get ¶
func (r *DeclinedTransactionService) Get(ctx context.Context, declinedTransactionID string, opts ...option.RequestOption) (res *DeclinedTransaction, err error)
Retrieve a Declined Transaction
func (*DeclinedTransactionService) List ¶
func (r *DeclinedTransactionService) List(ctx context.Context, query DeclinedTransactionListParams, opts ...option.RequestOption) (res *shared.Page[DeclinedTransaction], err error)
List Declined Transactions
func (*DeclinedTransactionService) ListAutoPaging ¶
func (r *DeclinedTransactionService) ListAutoPaging(ctx context.Context, query DeclinedTransactionListParams, opts ...option.RequestOption) *shared.PageAutoPager[DeclinedTransaction]
List Declined Transactions
type DeclinedTransactionSource ¶
type DeclinedTransactionSource struct {
// An ACH Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `ach_decline`.
ACHDecline DeclinedTransactionSourceACHDecline `json:"ach_decline,required,nullable"`
// A Card Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `card_decline`.
CardDecline DeclinedTransactionSourceCardDecline `json:"card_decline,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category DeclinedTransactionSourceCategory `json:"category,required"`
// A Check Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `check_decline`.
CheckDecline DeclinedTransactionSourceCheckDecline `json:"check_decline,required,nullable"`
// An Inbound Real-Time Payments Transfer Decline object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_decline`.
InboundRealTimePaymentsTransferDecline DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline `json:"inbound_real_time_payments_transfer_decline,required,nullable"`
// An International ACH Decline object. This field will be present in the JSON
// response if and only if `category` is equal to `international_ach_decline`.
InternationalACHDecline DeclinedTransactionSourceInternationalACHDecline `json:"international_ach_decline,required,nullable"`
// A Wire Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `wire_decline`.
WireDecline DeclinedTransactionSourceWireDecline `json:"wire_decline,required,nullable"`
JSON declinedTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*DeclinedTransactionSource) UnmarshalJSON ¶
func (r *DeclinedTransactionSource) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceACHDecline ¶
type DeclinedTransactionSourceACHDecline struct {
// The ACH Decline's identifier.
ID string `json:"id,required"`
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The descriptive date of the transfer.
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
// The additional information included with the transfer.
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
// The identifier of the company that initiated the transfer.
OriginatorCompanyID string `json:"originator_company_id,required"`
// The name of the company that initiated the transfer.
OriginatorCompanyName string `json:"originator_company_name,required"`
// Why the ACH transfer was declined.
Reason DeclinedTransactionSourceACHDeclineReason `json:"reason,required"`
// The id of the receiver of the transfer.
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
// The name of the receiver of the transfer.
ReceiverName string `json:"receiver_name,required,nullable"`
// The trace number of the transfer.
TraceNumber string `json:"trace_number,required"`
// A constant representing the object's type. For this resource it will always be
// `ach_decline`.
Type DeclinedTransactionSourceACHDeclineType `json:"type,required"`
JSON declinedTransactionSourceACHDeclineJSON
}
An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
func (*DeclinedTransactionSourceACHDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceACHDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceACHDeclineReason ¶
type DeclinedTransactionSourceACHDeclineReason string
Why the ACH transfer was declined.
const ( // The account number is canceled. DeclinedTransactionSourceACHDeclineReasonACHRouteCanceled DeclinedTransactionSourceACHDeclineReason = "ach_route_canceled" // The account number is disabled. DeclinedTransactionSourceACHDeclineReasonACHRouteDisabled DeclinedTransactionSourceACHDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. DeclinedTransactionSourceACHDeclineReasonBreachesLimit DeclinedTransactionSourceACHDeclineReason = "breaches_limit" // A credit was refused. DeclinedTransactionSourceACHDeclineReasonCreditEntryRefusedByReceiver DeclinedTransactionSourceACHDeclineReason = "credit_entry_refused_by_receiver" // Other. DeclinedTransactionSourceACHDeclineReasonDuplicateReturn DeclinedTransactionSourceACHDeclineReason = "duplicate_return" // The account's entity is not active. DeclinedTransactionSourceACHDeclineReasonEntityNotActive DeclinedTransactionSourceACHDeclineReason = "entity_not_active" // Your account is inactive. DeclinedTransactionSourceACHDeclineReasonGroupLocked DeclinedTransactionSourceACHDeclineReason = "group_locked" // Your account contains insufficient funds. DeclinedTransactionSourceACHDeclineReasonInsufficientFunds DeclinedTransactionSourceACHDeclineReason = "insufficient_funds" // Other. DeclinedTransactionSourceACHDeclineReasonMisroutedReturn DeclinedTransactionSourceACHDeclineReason = "misrouted_return" // Other. DeclinedTransactionSourceACHDeclineReasonReturnOfErroneousOrReversingDebit DeclinedTransactionSourceACHDeclineReason = "return_of_erroneous_or_reversing_debit" // The account number that was debited does not exist. DeclinedTransactionSourceACHDeclineReasonNoACHRoute DeclinedTransactionSourceACHDeclineReason = "no_ach_route" // Other. DeclinedTransactionSourceACHDeclineReasonOriginatorRequest DeclinedTransactionSourceACHDeclineReason = "originator_request" // The transaction is not allowed per Increase's terms. DeclinedTransactionSourceACHDeclineReasonTransactionNotAllowed DeclinedTransactionSourceACHDeclineReason = "transaction_not_allowed" // The user initiated the decline. DeclinedTransactionSourceACHDeclineReasonUserInitiated DeclinedTransactionSourceACHDeclineReason = "user_initiated" )
type DeclinedTransactionSourceACHDeclineType ¶ added in v0.7.1
type DeclinedTransactionSourceACHDeclineType string
A constant representing the object's type. For this resource it will always be `ach_decline`.
const (
DeclinedTransactionSourceACHDeclineTypeACHDecline DeclinedTransactionSourceACHDeclineType = "ach_decline"
)
type DeclinedTransactionSourceCardDecline ¶
type DeclinedTransactionSourceCardDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency DeclinedTransactionSourceCardDeclineCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Fields specific to the `network`
NetworkDetails DeclinedTransactionSourceCardDeclineNetworkDetails `json:"network_details,required"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// Why the transaction was declined.
Reason DeclinedTransactionSourceCardDeclineReason `json:"reason,required"`
JSON declinedTransactionSourceCardDeclineJSON
}
A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
func (*DeclinedTransactionSourceCardDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceCardDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceCardDeclineCurrency ¶
type DeclinedTransactionSourceCardDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) DeclinedTransactionSourceCardDeclineCurrencyCad DeclinedTransactionSourceCardDeclineCurrency = "CAD" // Swiss Franc (CHF) DeclinedTransactionSourceCardDeclineCurrencyChf DeclinedTransactionSourceCardDeclineCurrency = "CHF" // Euro (EUR) DeclinedTransactionSourceCardDeclineCurrencyEur DeclinedTransactionSourceCardDeclineCurrency = "EUR" // British Pound (GBP) DeclinedTransactionSourceCardDeclineCurrencyGbp DeclinedTransactionSourceCardDeclineCurrency = "GBP" // Japanese Yen (JPY) DeclinedTransactionSourceCardDeclineCurrencyJpy DeclinedTransactionSourceCardDeclineCurrency = "JPY" // US Dollar (USD) DeclinedTransactionSourceCardDeclineCurrencyUsd DeclinedTransactionSourceCardDeclineCurrency = "USD" )
type DeclinedTransactionSourceCardDeclineNetworkDetails ¶
type DeclinedTransactionSourceCardDeclineNetworkDetails struct {
// The payment network used to process this card authorization
Category DeclinedTransactionSourceCardDeclineNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa DeclinedTransactionSourceCardDeclineNetworkDetailsVisa `json:"visa,required,nullable"`
JSON declinedTransactionSourceCardDeclineNetworkDetailsJSON
}
Fields specific to the `network`
func (*DeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceCardDeclineNetworkDetailsCategory ¶ added in v0.6.0
type DeclinedTransactionSourceCardDeclineNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa DeclinedTransactionSourceCardDeclineNetworkDetailsCategoryVisa DeclinedTransactionSourceCardDeclineNetworkDetailsCategory = "visa" )
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisa ¶
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON declinedTransactionSourceCardDeclineNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*DeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator ¶
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorRecurring DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorInstallment DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction DeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeUnknown DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeManual DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeOpticalCode DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactless DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv DeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type DeclinedTransactionSourceCardDeclineReason ¶
type DeclinedTransactionSourceCardDeclineReason string
Why the transaction was declined.
const ( // The Card was not active. DeclinedTransactionSourceCardDeclineReasonCardNotActive DeclinedTransactionSourceCardDeclineReason = "card_not_active" // The Physical Card was not active. DeclinedTransactionSourceCardDeclineReasonPhysicalCardNotActive DeclinedTransactionSourceCardDeclineReason = "physical_card_not_active" // The account's entity was not active. DeclinedTransactionSourceCardDeclineReasonEntityNotActive DeclinedTransactionSourceCardDeclineReason = "entity_not_active" // The account was inactive. DeclinedTransactionSourceCardDeclineReasonGroupLocked DeclinedTransactionSourceCardDeclineReason = "group_locked" // The Card's Account did not have a sufficient available balance. DeclinedTransactionSourceCardDeclineReasonInsufficientFunds DeclinedTransactionSourceCardDeclineReason = "insufficient_funds" // The given CVV2 did not match the card's value. DeclinedTransactionSourceCardDeclineReasonCvv2Mismatch DeclinedTransactionSourceCardDeclineReason = "cvv2_mismatch" // The attempted card transaction is not allowed per Increase's terms. DeclinedTransactionSourceCardDeclineReasonTransactionNotAllowed DeclinedTransactionSourceCardDeclineReason = "transaction_not_allowed" // The transaction was blocked by a Limit. DeclinedTransactionSourceCardDeclineReasonBreachesLimit DeclinedTransactionSourceCardDeclineReason = "breaches_limit" // Your application declined the transaction via webhook. DeclinedTransactionSourceCardDeclineReasonWebhookDeclined DeclinedTransactionSourceCardDeclineReason = "webhook_declined" // Your application webhook did not respond without the required timeout. DeclinedTransactionSourceCardDeclineReasonWebhookTimedOut DeclinedTransactionSourceCardDeclineReason = "webhook_timed_out" // Declined by stand-in processing. DeclinedTransactionSourceCardDeclineReasonDeclinedByStandInProcessing DeclinedTransactionSourceCardDeclineReason = "declined_by_stand_in_processing" // The card read had an invalid CVV, dCVV, or authorization request cryptogram. DeclinedTransactionSourceCardDeclineReasonInvalidPhysicalCard DeclinedTransactionSourceCardDeclineReason = "invalid_physical_card" // The original card authorization for this incremental authorization does not // exist. DeclinedTransactionSourceCardDeclineReasonMissingOriginalAuthorization DeclinedTransactionSourceCardDeclineReason = "missing_original_authorization" // The transaction was suspected to be fraudulent. Please reach out to // support@increase.com for more information. DeclinedTransactionSourceCardDeclineReasonSuspectedFraud DeclinedTransactionSourceCardDeclineReason = "suspected_fraud" )
type DeclinedTransactionSourceCategory ¶
type DeclinedTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // ACH Decline: details will be under the `ach_decline` object. DeclinedTransactionSourceCategoryACHDecline DeclinedTransactionSourceCategory = "ach_decline" // Card Decline: details will be under the `card_decline` object. DeclinedTransactionSourceCategoryCardDecline DeclinedTransactionSourceCategory = "card_decline" // Check Decline: details will be under the `check_decline` object. DeclinedTransactionSourceCategoryCheckDecline DeclinedTransactionSourceCategory = "check_decline" // Inbound Real-Time Payments Transfer Decline: details will be under the // `inbound_real_time_payments_transfer_decline` object. DeclinedTransactionSourceCategoryInboundRealTimePaymentsTransferDecline DeclinedTransactionSourceCategory = "inbound_real_time_payments_transfer_decline" // International ACH Decline: details will be under the `international_ach_decline` // object. DeclinedTransactionSourceCategoryInternationalACHDecline DeclinedTransactionSourceCategory = "international_ach_decline" // Wire Decline: details will be under the `wire_decline` object. DeclinedTransactionSourceCategoryWireDecline DeclinedTransactionSourceCategory = "wire_decline" // The Declined Transaction was made for an undocumented or deprecated reason. DeclinedTransactionSourceCategoryOther DeclinedTransactionSourceCategory = "other" )
type DeclinedTransactionSourceCheckDecline ¶
type DeclinedTransactionSourceCheckDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// Why the check was declined.
Reason DeclinedTransactionSourceCheckDeclineReason `json:"reason,required"`
JSON declinedTransactionSourceCheckDeclineJSON
}
A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
func (*DeclinedTransactionSourceCheckDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceCheckDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceCheckDeclineReason ¶
type DeclinedTransactionSourceCheckDeclineReason string
Why the check was declined.
const ( // The account number is canceled. DeclinedTransactionSourceCheckDeclineReasonACHRouteCanceled DeclinedTransactionSourceCheckDeclineReason = "ach_route_canceled" // The account number is disabled. DeclinedTransactionSourceCheckDeclineReasonACHRouteDisabled DeclinedTransactionSourceCheckDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. DeclinedTransactionSourceCheckDeclineReasonBreachesLimit DeclinedTransactionSourceCheckDeclineReason = "breaches_limit" // The account's entity is not active. DeclinedTransactionSourceCheckDeclineReasonEntityNotActive DeclinedTransactionSourceCheckDeclineReason = "entity_not_active" // Your account is inactive. DeclinedTransactionSourceCheckDeclineReasonGroupLocked DeclinedTransactionSourceCheckDeclineReason = "group_locked" // Your account contains insufficient funds. DeclinedTransactionSourceCheckDeclineReasonInsufficientFunds DeclinedTransactionSourceCheckDeclineReason = "insufficient_funds" // Unable to locate account. DeclinedTransactionSourceCheckDeclineReasonUnableToLocateAccount DeclinedTransactionSourceCheckDeclineReason = "unable_to_locate_account" // Routing number on the check is not ours. DeclinedTransactionSourceCheckDeclineReasonNotOurItem DeclinedTransactionSourceCheckDeclineReason = "not_our_item" // Unable to process. DeclinedTransactionSourceCheckDeclineReasonUnableToProcess DeclinedTransactionSourceCheckDeclineReason = "unable_to_process" // Refer to image. DeclinedTransactionSourceCheckDeclineReasonReferToImage DeclinedTransactionSourceCheckDeclineReason = "refer_to_image" // Stop payment requested for this check. DeclinedTransactionSourceCheckDeclineReasonStopPaymentRequested DeclinedTransactionSourceCheckDeclineReason = "stop_payment_requested" // Check was returned to sender. DeclinedTransactionSourceCheckDeclineReasonReturned DeclinedTransactionSourceCheckDeclineReason = "returned" // The check was a duplicate deposit. DeclinedTransactionSourceCheckDeclineReasonDuplicatePresentment DeclinedTransactionSourceCheckDeclineReason = "duplicate_presentment" // The transaction is not allowed. DeclinedTransactionSourceCheckDeclineReasonNotAuthorized DeclinedTransactionSourceCheckDeclineReason = "not_authorized" // The check was altered or fictitious. DeclinedTransactionSourceCheckDeclineReasonAlteredOrFictitious DeclinedTransactionSourceCheckDeclineReason = "altered_or_fictitious" )
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline ¶
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
// transfer's currency. This will always be "USD" for a Real-Time Payments
// transfer.
Currency DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Why the transfer was declined.
Reason DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason `json:"reason,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the declined transfer.
TransactionIdentification string `json:"transaction_identification,required"`
JSON declinedTransactionSourceInboundRealTimePaymentsTransferDeclineJSON
}
An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
func (*DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency ¶
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyCad DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CAD" // Swiss Franc (CHF) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyChf DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CHF" // Euro (EUR) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyEur DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "EUR" // British Pound (GBP) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyGbp DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "GBP" // Japanese Yen (JPY) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyJpy DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "JPY" // US Dollar (USD) DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyUsd DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "USD" )
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason ¶
type DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason string
Why the transfer was declined.
const ( // The account number is canceled. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberCanceled DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_canceled" // The account number is disabled. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberDisabled DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_disabled" // Your account is restricted. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountRestricted DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_restricted" // Your account is inactive. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonGroupLocked DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "group_locked" // The account's entity is not active. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonEntityNotActive DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "entity_not_active" // Your account is not enabled to receive Real-Time Payments transfers. DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonRealTimePaymentsNotEnabled DeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "real_time_payments_not_enabled" )
type DeclinedTransactionSourceInternationalACHDecline ¶
type DeclinedTransactionSourceInternationalACHDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON declinedTransactionSourceInternationalACHDeclineJSON
}
An International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
func (*DeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceWireDecline ¶
type DeclinedTransactionSourceWireDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
// Why the wire transfer was declined.
Reason DeclinedTransactionSourceWireDeclineReason `json:"reason,required"`
JSON declinedTransactionSourceWireDeclineJSON
}
A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`.
func (*DeclinedTransactionSourceWireDecline) UnmarshalJSON ¶
func (r *DeclinedTransactionSourceWireDecline) UnmarshalJSON(data []byte) (err error)
type DeclinedTransactionSourceWireDeclineReason ¶
type DeclinedTransactionSourceWireDeclineReason string
Why the wire transfer was declined.
const ( // The account number is canceled. DeclinedTransactionSourceWireDeclineReasonAccountNumberCanceled DeclinedTransactionSourceWireDeclineReason = "account_number_canceled" // The account number is disabled. DeclinedTransactionSourceWireDeclineReasonAccountNumberDisabled DeclinedTransactionSourceWireDeclineReason = "account_number_disabled" // The account's entity is not active. DeclinedTransactionSourceWireDeclineReasonEntityNotActive DeclinedTransactionSourceWireDeclineReason = "entity_not_active" // Your account is inactive. DeclinedTransactionSourceWireDeclineReasonGroupLocked DeclinedTransactionSourceWireDeclineReason = "group_locked" // The beneficiary account number does not exist. DeclinedTransactionSourceWireDeclineReasonNoAccountNumber DeclinedTransactionSourceWireDeclineReason = "no_account_number" // The transaction is not allowed per Increase's terms. DeclinedTransactionSourceWireDeclineReasonTransactionNotAllowed DeclinedTransactionSourceWireDeclineReason = "transaction_not_allowed" )
type DeclinedTransactionType ¶
type DeclinedTransactionType string
A constant representing the object's type. For this resource it will always be `declined_transaction`.
const (
DeclinedTransactionTypeDeclinedTransaction DeclinedTransactionType = "declined_transaction"
)
type DigitalWalletToken ¶
type DigitalWalletToken struct {
// The Digital Wallet Token identifier.
ID string `json:"id,required"`
// The identifier for the Card this Digital Wallet Token belongs to.
CardID string `json:"card_id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// This indicates if payments can be made with the Digital Wallet Token.
Status DigitalWalletTokenStatus `json:"status,required"`
// The digital wallet app being used.
TokenRequestor DigitalWalletTokenTokenRequestor `json:"token_requestor,required"`
// A constant representing the object's type. For this resource it will always be
// `digital_wallet_token`.
Type DigitalWalletTokenType `json:"type,required"`
JSON digitalWalletTokenJSON
}
A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
func (*DigitalWalletToken) UnmarshalJSON ¶
func (r *DigitalWalletToken) UnmarshalJSON(data []byte) (err error)
type DigitalWalletTokenListParams ¶
type DigitalWalletTokenListParams struct {
// Filter Digital Wallet Tokens to ones belonging to the specified Card.
CardID param.Field[string] `query:"card_id"`
CreatedAt param.Field[DigitalWalletTokenListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (DigitalWalletTokenListParams) URLQuery ¶
func (r DigitalWalletTokenListParams) URLQuery() (v url.Values)
URLQuery serializes DigitalWalletTokenListParams's query parameters as `url.Values`.
type DigitalWalletTokenListParamsCreatedAt ¶
type DigitalWalletTokenListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (DigitalWalletTokenListParamsCreatedAt) URLQuery ¶
func (r DigitalWalletTokenListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes DigitalWalletTokenListParamsCreatedAt's query parameters as `url.Values`.
type DigitalWalletTokenService ¶
type DigitalWalletTokenService struct {
Options []option.RequestOption
}
DigitalWalletTokenService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDigitalWalletTokenService method instead.
func NewDigitalWalletTokenService ¶
func NewDigitalWalletTokenService(opts ...option.RequestOption) (r *DigitalWalletTokenService)
NewDigitalWalletTokenService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*DigitalWalletTokenService) Get ¶
func (r *DigitalWalletTokenService) Get(ctx context.Context, digitalWalletTokenID string, opts ...option.RequestOption) (res *DigitalWalletToken, err error)
Retrieve a Digital Wallet Token
func (*DigitalWalletTokenService) List ¶
func (r *DigitalWalletTokenService) List(ctx context.Context, query DigitalWalletTokenListParams, opts ...option.RequestOption) (res *shared.Page[DigitalWalletToken], err error)
List Digital Wallet Tokens
func (*DigitalWalletTokenService) ListAutoPaging ¶
func (r *DigitalWalletTokenService) ListAutoPaging(ctx context.Context, query DigitalWalletTokenListParams, opts ...option.RequestOption) *shared.PageAutoPager[DigitalWalletToken]
List Digital Wallet Tokens
type DigitalWalletTokenStatus ¶
type DigitalWalletTokenStatus string
This indicates if payments can be made with the Digital Wallet Token.
const ( // The digital wallet token is active. DigitalWalletTokenStatusActive DigitalWalletTokenStatus = "active" // The digital wallet token has been created but not successfully activated via // two-factor authentication yet. DigitalWalletTokenStatusInactive DigitalWalletTokenStatus = "inactive" // The digital wallet token has been temporarily paused. DigitalWalletTokenStatusSuspended DigitalWalletTokenStatus = "suspended" // The digital wallet token has been permanently canceled. DigitalWalletTokenStatusDeactivated DigitalWalletTokenStatus = "deactivated" )
type DigitalWalletTokenTokenRequestor ¶
type DigitalWalletTokenTokenRequestor string
The digital wallet app being used.
const ( // Apple Pay DigitalWalletTokenTokenRequestorApplePay DigitalWalletTokenTokenRequestor = "apple_pay" // Google Pay DigitalWalletTokenTokenRequestorGooglePay DigitalWalletTokenTokenRequestor = "google_pay" )
type DigitalWalletTokenType ¶
type DigitalWalletTokenType string
A constant representing the object's type. For this resource it will always be `digital_wallet_token`.
const (
DigitalWalletTokenTypeDigitalWalletToken DigitalWalletTokenType = "digital_wallet_token"
)
type Document ¶
type Document struct {
// The Document identifier.
ID string `json:"id,required"`
// The type of document.
Category DocumentCategory `json:"category,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
// Document was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The identifier of the Entity the document was generated for.
EntityID string `json:"entity_id,required,nullable"`
// The identifier of the File containing the Document's contents.
FileID string `json:"file_id,required"`
// A constant representing the object's type. For this resource it will always be
// `document`.
Type DocumentType `json:"type,required"`
JSON documentJSON
}
Increase generates certain documents / forms automatically for your application; they can be listed here. Currently the only supported document type is IRS Form 1099-INT.
func (*Document) UnmarshalJSON ¶
type DocumentCategory ¶
type DocumentCategory string
The type of document.
const ( // Internal Revenue Service Form 1099-INT. DocumentCategoryForm1099Int DocumentCategory = "form_1099_int" // A document submitted in response to a proof of authorization request for an ACH // transfer. DocumentCategoryProofOfAuthorization DocumentCategory = "proof_of_authorization" // Company information, such a policies or procedures, typically submitted during // our due diligence process. DocumentCategoryCompanyInformation DocumentCategory = "company_information" )
type DocumentListParams ¶
type DocumentListParams struct {
Category param.Field[DocumentListParamsCategory] `query:"category"`
CreatedAt param.Field[DocumentListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Filter Documents to ones belonging to the specified Entity.
EntityID param.Field[string] `query:"entity_id"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (DocumentListParams) URLQuery ¶
func (r DocumentListParams) URLQuery() (v url.Values)
URLQuery serializes DocumentListParams's query parameters as `url.Values`.
type DocumentListParamsCategory ¶
type DocumentListParamsCategory struct {
// Filter Documents for those with the specified category or categories. For GET
// requests, this should be encoded as a comma-delimited string, such as
// `?in=one,two,three`.
In param.Field[[]DocumentListParamsCategoryIn] `query:"in"`
}
func (DocumentListParamsCategory) URLQuery ¶
func (r DocumentListParamsCategory) URLQuery() (v url.Values)
URLQuery serializes DocumentListParamsCategory's query parameters as `url.Values`.
type DocumentListParamsCategoryIn ¶
type DocumentListParamsCategoryIn string
const ( // Internal Revenue Service Form 1099-INT. DocumentListParamsCategoryInForm1099Int DocumentListParamsCategoryIn = "form_1099_int" // A document submitted in response to a proof of authorization request for an ACH // transfer. DocumentListParamsCategoryInProofOfAuthorization DocumentListParamsCategoryIn = "proof_of_authorization" // Company information, such a policies or procedures, typically submitted during // our due diligence process. DocumentListParamsCategoryInCompanyInformation DocumentListParamsCategoryIn = "company_information" )
type DocumentListParamsCreatedAt ¶
type DocumentListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (DocumentListParamsCreatedAt) URLQuery ¶
func (r DocumentListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes DocumentListParamsCreatedAt's query parameters as `url.Values`.
type DocumentService ¶
type DocumentService struct {
Options []option.RequestOption
}
DocumentService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDocumentService method instead.
func NewDocumentService ¶
func NewDocumentService(opts ...option.RequestOption) (r *DocumentService)
NewDocumentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*DocumentService) Get ¶
func (r *DocumentService) Get(ctx context.Context, documentID string, opts ...option.RequestOption) (res *Document, err error)
Retrieve a Document
func (*DocumentService) List ¶
func (r *DocumentService) List(ctx context.Context, query DocumentListParams, opts ...option.RequestOption) (res *shared.Page[Document], err error)
List Documents
func (*DocumentService) ListAutoPaging ¶
func (r *DocumentService) ListAutoPaging(ctx context.Context, query DocumentListParams, opts ...option.RequestOption) *shared.PageAutoPager[Document]
List Documents
type DocumentType ¶
type DocumentType string
A constant representing the object's type. For this resource it will always be `document`.
const (
DocumentTypeDocument DocumentType = "document"
)
type Entity ¶
type Entity struct {
// The entity's identifier.
ID string `json:"id,required"`
// Details of the corporation entity. Will be present if `structure` is equal to
// `corporation`.
Corporation EntityCorporation `json:"corporation,required,nullable"`
// The entity's description for display purposes.
Description string `json:"description,required,nullable"`
// Details of the joint entity. Will be present if `structure` is equal to `joint`.
Joint EntityJoint `json:"joint,required,nullable"`
// Details of the natural person entity. Will be present if `structure` is equal to
// `natural_person`.
NaturalPerson EntityNaturalPerson `json:"natural_person,required,nullable"`
// The relationship between your group and the entity.
Relationship EntityRelationship `json:"relationship,required"`
// The entity's legal structure.
Structure EntityStructure `json:"structure,required"`
// Additional documentation associated with the entity. This is limited to the
// first 10 documents for an entity. If an entity has more than 10 documents, use
// the GET /entity_supplemental_documents list endpoint to retrieve them.
SupplementalDocuments []EntitySupplementalDocument `json:"supplemental_documents,required"`
// Details of the trust entity. Will be present if `structure` is equal to `trust`.
Trust EntityTrust `json:"trust,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `entity`.
Type EntityType `json:"type,required"`
JSON entityJSON
}
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, or trusts.
func (*Entity) UnmarshalJSON ¶
type EntityBeneficialOwnerArchiveParams ¶ added in v0.7.1
type EntityBeneficialOwnerArchiveParams struct {
// The identifying details of anyone controlling or owning 25% or more of the
// corporation.
BeneficialOwnerID param.Field[string] `json:"beneficial_owner_id,required"`
// The identifier of the Entity to retrieve.
EntityID param.Field[string] `json:"entity_id,required"`
}
func (EntityBeneficialOwnerArchiveParams) MarshalJSON ¶ added in v0.7.1
func (r EntityBeneficialOwnerArchiveParams) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParams ¶ added in v0.6.2
type EntityBeneficialOwnerNewParams struct {
// The identifying details of anyone controlling or owning 25% or more of the
// corporation.
BeneficialOwner param.Field[EntityBeneficialOwnerNewParamsBeneficialOwner] `json:"beneficial_owner,required"`
// The identifier of the Entity to associate with the new Beneficial Owner.
EntityID param.Field[string] `json:"entity_id,required"`
}
func (EntityBeneficialOwnerNewParams) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParams) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwner ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwner struct {
// Personal details for the beneficial owner.
Individual param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual] `json:"individual,required"`
// Why this person is considered a beneficial owner of the entity. At least one
// option is required.
Prongs param.Field[[]EntityBeneficialOwnerNewParamsBeneficialOwnerProng] `json:"prongs,required"`
// This person's role or title within the entity.
CompanyTitle param.Field[string] `json:"company_title"`
}
The identifying details of anyone controlling or owning 25% or more of the corporation.
func (EntityBeneficialOwnerNewParamsBeneficialOwner) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwner) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
Personal details for the beneficial owner.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividual) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualAddress) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentification) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethodSocialSecurityNumber EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethodIndividualTaxpayerIdentificationNumber EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethodPassport EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod = "passport" // A driver's license number. EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethodDriversLicense EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod = "drivers_license" // Another identifying document. EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethodOther EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationMethod = "other" )
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport) MarshalJSON ¶ added in v0.6.2
func (r EntityBeneficialOwnerNewParamsBeneficialOwnerIndividualIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityBeneficialOwnerNewParamsBeneficialOwnerProng ¶ added in v0.6.2
type EntityBeneficialOwnerNewParamsBeneficialOwnerProng string
const ( // A person with 25% or greater direct or indirect ownership of the entity. EntityBeneficialOwnerNewParamsBeneficialOwnerProngOwnership EntityBeneficialOwnerNewParamsBeneficialOwnerProng = "ownership" // A person who manages, directs, or has significant control of the entity. EntityBeneficialOwnerNewParamsBeneficialOwnerProngControl EntityBeneficialOwnerNewParamsBeneficialOwnerProng = "control" )
type EntityBeneficialOwnerService ¶ added in v0.6.2
type EntityBeneficialOwnerService struct {
Options []option.RequestOption
}
EntityBeneficialOwnerService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntityBeneficialOwnerService method instead.
func NewEntityBeneficialOwnerService ¶ added in v0.6.2
func NewEntityBeneficialOwnerService(opts ...option.RequestOption) (r *EntityBeneficialOwnerService)
NewEntityBeneficialOwnerService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*EntityBeneficialOwnerService) Archive ¶ added in v0.7.1
func (r *EntityBeneficialOwnerService) Archive(ctx context.Context, body EntityBeneficialOwnerArchiveParams, opts ...option.RequestOption) (res *Entity, err error)
Archive a beneficial owner belonging to a corporate Entity
func (*EntityBeneficialOwnerService) New ¶ added in v0.6.2
func (r *EntityBeneficialOwnerService) New(ctx context.Context, body EntityBeneficialOwnerNewParams, opts ...option.RequestOption) (res *Entity, err error)
Create a beneficial owner for a corporate Entity
type EntityCorporation ¶
type EntityCorporation struct {
// The corporation's address.
Address EntityCorporationAddress `json:"address,required"`
// The identifying details of anyone controlling or owning 25% or more of the
// corporation.
BeneficialOwners []EntityCorporationBeneficialOwner `json:"beneficial_owners,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the
// corporation's state of incorporation.
IncorporationState string `json:"incorporation_state,required,nullable"`
// The legal name of the corporation.
Name string `json:"name,required"`
// The Employer Identification Number (EIN) for the corporation.
TaxIdentifier string `json:"tax_identifier,required,nullable"`
// The website of the corporation.
Website string `json:"website,required,nullable"`
JSON entityCorporationJSON
}
Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
func (*EntityCorporation) UnmarshalJSON ¶
func (r *EntityCorporation) UnmarshalJSON(data []byte) (err error)
type EntityCorporationAddress ¶
type EntityCorporationAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityCorporationAddressJSON
}
The corporation's address.
func (*EntityCorporationAddress) UnmarshalJSON ¶
func (r *EntityCorporationAddress) UnmarshalJSON(data []byte) (err error)
type EntityCorporationBeneficialOwner ¶ added in v0.3.0
type EntityCorporationBeneficialOwner struct {
// The identifier of this beneficial owner.
BeneficialOwnerID string `json:"beneficial_owner_id,required"`
// This person's role or title within the entity.
CompanyTitle string `json:"company_title,required,nullable"`
// Personal details for the beneficial owner.
Individual EntityCorporationBeneficialOwnersIndividual `json:"individual,required"`
// Why this person is considered a beneficial owner of the entity.
Prong EntityCorporationBeneficialOwnersProng `json:"prong,required"`
JSON entityCorporationBeneficialOwnerJSON
}
func (*EntityCorporationBeneficialOwner) UnmarshalJSON ¶ added in v0.3.0
func (r *EntityCorporationBeneficialOwner) UnmarshalJSON(data []byte) (err error)
type EntityCorporationBeneficialOwnersIndividual ¶
type EntityCorporationBeneficialOwnersIndividual struct {
// The person's address.
Address EntityCorporationBeneficialOwnersIndividualAddress `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth time.Time `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification EntityCorporationBeneficialOwnersIndividualIdentification `json:"identification,required"`
// The person's legal name.
Name string `json:"name,required"`
JSON entityCorporationBeneficialOwnersIndividualJSON
}
Personal details for the beneficial owner.
func (*EntityCorporationBeneficialOwnersIndividual) UnmarshalJSON ¶
func (r *EntityCorporationBeneficialOwnersIndividual) UnmarshalJSON(data []byte) (err error)
type EntityCorporationBeneficialOwnersIndividualAddress ¶
type EntityCorporationBeneficialOwnersIndividualAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityCorporationBeneficialOwnersIndividualAddressJSON
}
The person's address.
func (*EntityCorporationBeneficialOwnersIndividualAddress) UnmarshalJSON ¶
func (r *EntityCorporationBeneficialOwnersIndividualAddress) UnmarshalJSON(data []byte) (err error)
type EntityCorporationBeneficialOwnersIndividualIdentification ¶
type EntityCorporationBeneficialOwnersIndividualIdentification struct {
// A method that can be used to verify the individual's identity.
Method EntityCorporationBeneficialOwnersIndividualIdentificationMethod `json:"method,required"`
// The last 4 digits of the identification number that can be used to verify the
// individual's identity.
NumberLast4 string `json:"number_last4,required"`
JSON entityCorporationBeneficialOwnersIndividualIdentificationJSON
}
A means of verifying the person's identity.
func (*EntityCorporationBeneficialOwnersIndividualIdentification) UnmarshalJSON ¶
func (r *EntityCorporationBeneficialOwnersIndividualIdentification) UnmarshalJSON(data []byte) (err error)
type EntityCorporationBeneficialOwnersIndividualIdentificationMethod ¶
type EntityCorporationBeneficialOwnersIndividualIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityCorporationBeneficialOwnersIndividualIdentificationMethodSocialSecurityNumber EntityCorporationBeneficialOwnersIndividualIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityCorporationBeneficialOwnersIndividualIdentificationMethodIndividualTaxpayerIdentificationNumber EntityCorporationBeneficialOwnersIndividualIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityCorporationBeneficialOwnersIndividualIdentificationMethodPassport EntityCorporationBeneficialOwnersIndividualIdentificationMethod = "passport" // A driver's license number. EntityCorporationBeneficialOwnersIndividualIdentificationMethodDriversLicense EntityCorporationBeneficialOwnersIndividualIdentificationMethod = "drivers_license" // Another identifying document. EntityCorporationBeneficialOwnersIndividualIdentificationMethodOther EntityCorporationBeneficialOwnersIndividualIdentificationMethod = "other" )
type EntityCorporationBeneficialOwnersProng ¶
type EntityCorporationBeneficialOwnersProng string
Why this person is considered a beneficial owner of the entity.
const ( // A person with 25% or greater direct or indirect ownership of the entity. EntityCorporationBeneficialOwnersProngOwnership EntityCorporationBeneficialOwnersProng = "ownership" // A person who manages, directs, or has significant control of the entity. EntityCorporationBeneficialOwnersProngControl EntityCorporationBeneficialOwnersProng = "control" )
type EntityJoint ¶
type EntityJoint struct {
// The two individuals that share control of the entity.
Individuals []EntityJointIndividual `json:"individuals,required"`
// The entity's name.
Name string `json:"name,required"`
JSON entityJointJSON
}
Details of the joint entity. Will be present if `structure` is equal to `joint`.
func (*EntityJoint) UnmarshalJSON ¶
func (r *EntityJoint) UnmarshalJSON(data []byte) (err error)
type EntityJointIndividual ¶ added in v0.3.0
type EntityJointIndividual struct {
// The person's address.
Address EntityJointIndividualsAddress `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth time.Time `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification EntityJointIndividualsIdentification `json:"identification,required"`
// The person's legal name.
Name string `json:"name,required"`
JSON entityJointIndividualJSON
}
func (*EntityJointIndividual) UnmarshalJSON ¶ added in v0.3.0
func (r *EntityJointIndividual) UnmarshalJSON(data []byte) (err error)
type EntityJointIndividualsAddress ¶
type EntityJointIndividualsAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityJointIndividualsAddressJSON
}
The person's address.
func (*EntityJointIndividualsAddress) UnmarshalJSON ¶
func (r *EntityJointIndividualsAddress) UnmarshalJSON(data []byte) (err error)
type EntityJointIndividualsIdentification ¶
type EntityJointIndividualsIdentification struct {
// A method that can be used to verify the individual's identity.
Method EntityJointIndividualsIdentificationMethod `json:"method,required"`
// The last 4 digits of the identification number that can be used to verify the
// individual's identity.
NumberLast4 string `json:"number_last4,required"`
JSON entityJointIndividualsIdentificationJSON
}
A means of verifying the person's identity.
func (*EntityJointIndividualsIdentification) UnmarshalJSON ¶
func (r *EntityJointIndividualsIdentification) UnmarshalJSON(data []byte) (err error)
type EntityJointIndividualsIdentificationMethod ¶
type EntityJointIndividualsIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityJointIndividualsIdentificationMethodSocialSecurityNumber EntityJointIndividualsIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityJointIndividualsIdentificationMethodIndividualTaxpayerIdentificationNumber EntityJointIndividualsIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityJointIndividualsIdentificationMethodPassport EntityJointIndividualsIdentificationMethod = "passport" // A driver's license number. EntityJointIndividualsIdentificationMethodDriversLicense EntityJointIndividualsIdentificationMethod = "drivers_license" // Another identifying document. EntityJointIndividualsIdentificationMethodOther EntityJointIndividualsIdentificationMethod = "other" )
type EntityListParams ¶
type EntityListParams struct {
CreatedAt param.Field[EntityListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (EntityListParams) URLQuery ¶
func (r EntityListParams) URLQuery() (v url.Values)
URLQuery serializes EntityListParams's query parameters as `url.Values`.
type EntityListParamsCreatedAt ¶
type EntityListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (EntityListParamsCreatedAt) URLQuery ¶
func (r EntityListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes EntityListParamsCreatedAt's query parameters as `url.Values`.
type EntityNaturalPerson ¶
type EntityNaturalPerson struct {
// The person's address.
Address EntityNaturalPersonAddress `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth time.Time `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification EntityNaturalPersonIdentification `json:"identification,required"`
// The person's legal name.
Name string `json:"name,required"`
JSON entityNaturalPersonJSON
}
Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.
func (*EntityNaturalPerson) UnmarshalJSON ¶
func (r *EntityNaturalPerson) UnmarshalJSON(data []byte) (err error)
type EntityNaturalPersonAddress ¶
type EntityNaturalPersonAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityNaturalPersonAddressJSON
}
The person's address.
func (*EntityNaturalPersonAddress) UnmarshalJSON ¶
func (r *EntityNaturalPersonAddress) UnmarshalJSON(data []byte) (err error)
type EntityNaturalPersonIdentification ¶
type EntityNaturalPersonIdentification struct {
// A method that can be used to verify the individual's identity.
Method EntityNaturalPersonIdentificationMethod `json:"method,required"`
// The last 4 digits of the identification number that can be used to verify the
// individual's identity.
NumberLast4 string `json:"number_last4,required"`
JSON entityNaturalPersonIdentificationJSON
}
A means of verifying the person's identity.
func (*EntityNaturalPersonIdentification) UnmarshalJSON ¶
func (r *EntityNaturalPersonIdentification) UnmarshalJSON(data []byte) (err error)
type EntityNaturalPersonIdentificationMethod ¶
type EntityNaturalPersonIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNaturalPersonIdentificationMethodSocialSecurityNumber EntityNaturalPersonIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNaturalPersonIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNaturalPersonIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNaturalPersonIdentificationMethodPassport EntityNaturalPersonIdentificationMethod = "passport" // A driver's license number. EntityNaturalPersonIdentificationMethodDriversLicense EntityNaturalPersonIdentificationMethod = "drivers_license" // Another identifying document. EntityNaturalPersonIdentificationMethodOther EntityNaturalPersonIdentificationMethod = "other" )
type EntityNewParams ¶
type EntityNewParams struct {
// The relationship between your group and the entity.
Relationship param.Field[EntityNewParamsRelationship] `json:"relationship,required"`
// The type of Entity to create.
Structure param.Field[EntityNewParamsStructure] `json:"structure,required"`
// Details of the corporation entity to create. Required if `structure` is equal to
// `corporation`.
Corporation param.Field[EntityNewParamsCorporation] `json:"corporation"`
// The description you choose to give the entity.
Description param.Field[string] `json:"description"`
// Details of the joint entity to create. Required if `structure` is equal to
// `joint`.
Joint param.Field[EntityNewParamsJoint] `json:"joint"`
// Details of the natural person entity to create. Required if `structure` is equal
// to `natural_person`. Natural people entities should be submitted with
// `social_security_number` or `individual_taxpayer_identification_number`
// identification methods.
NaturalPerson param.Field[EntityNewParamsNaturalPerson] `json:"natural_person"`
// Additional documentation associated with the entity.
SupplementalDocuments param.Field[[]EntityNewParamsSupplementalDocument] `json:"supplemental_documents"`
// Details of the trust entity to create. Required if `structure` is equal to
// `trust`.
Trust param.Field[EntityNewParamsTrust] `json:"trust"`
}
func (EntityNewParams) MarshalJSON ¶
func (r EntityNewParams) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporation ¶
type EntityNewParamsCorporation struct {
// The corporation's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsCorporationAddress] `json:"address,required"`
// The identifying details of anyone controlling or owning 25% or more of the
// corporation.
BeneficialOwners param.Field[[]EntityNewParamsCorporationBeneficialOwner] `json:"beneficial_owners,required"`
// The legal name of the corporation.
Name param.Field[string] `json:"name,required"`
// The Employer Identification Number (EIN) for the corporation.
TaxIdentifier param.Field[string] `json:"tax_identifier,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the
// corporation's state of incorporation.
IncorporationState param.Field[string] `json:"incorporation_state"`
// The website of the corporation.
Website param.Field[string] `json:"website"`
}
Details of the corporation entity to create. Required if `structure` is equal to `corporation`.
func (EntityNewParamsCorporation) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporation) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationAddress ¶
type EntityNewParamsCorporationAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The corporation's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsCorporationAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwner ¶ added in v0.3.0
type EntityNewParamsCorporationBeneficialOwner struct {
// Personal details for the beneficial owner.
Individual param.Field[EntityNewParamsCorporationBeneficialOwnersIndividual] `json:"individual,required"`
// Why this person is considered a beneficial owner of the entity. At least one
// option is required.
Prongs param.Field[[]EntityNewParamsCorporationBeneficialOwnersProng] `json:"prongs,required"`
// This person's role or title within the entity.
CompanyTitle param.Field[string] `json:"company_title"`
}
func (EntityNewParamsCorporationBeneficialOwner) MarshalJSON ¶ added in v0.3.0
func (r EntityNewParamsCorporationBeneficialOwner) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividual ¶
type EntityNewParamsCorporationBeneficialOwnersIndividual struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
Personal details for the beneficial owner.
func (EntityNewParamsCorporationBeneficialOwnersIndividual) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividual) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividualAddress ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsCorporationBeneficialOwnersIndividualAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividualAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentification ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityNewParamsCorporationBeneficialOwnersIndividualIdentification) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividualIdentification) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethodSocialSecurityNumber EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethodPassport EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod = "passport" // A driver's license number. EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethodDriversLicense EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod = "drivers_license" // Another identifying document. EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethodOther EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationMethod = "other" )
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport ¶
type EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsCorporationBeneficialOwnersIndividualIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityNewParamsCorporationBeneficialOwnersProng ¶
type EntityNewParamsCorporationBeneficialOwnersProng string
const ( // A person with 25% or greater direct or indirect ownership of the entity. EntityNewParamsCorporationBeneficialOwnersProngOwnership EntityNewParamsCorporationBeneficialOwnersProng = "ownership" // A person who manages, directs, or has significant control of the entity. EntityNewParamsCorporationBeneficialOwnersProngControl EntityNewParamsCorporationBeneficialOwnersProng = "control" )
type EntityNewParamsJoint ¶
type EntityNewParamsJoint struct {
// The two individuals that share control of the entity.
Individuals param.Field[[]EntityNewParamsJointIndividual] `json:"individuals,required"`
// The name of the joint entity.
Name param.Field[string] `json:"name"`
}
Details of the joint entity to create. Required if `structure` is equal to `joint`.
func (EntityNewParamsJoint) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJoint) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividual ¶ added in v0.3.0
type EntityNewParamsJointIndividual struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsJointIndividualsAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityNewParamsJointIndividualsIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
func (EntityNewParamsJointIndividual) MarshalJSON ¶ added in v0.3.0
func (r EntityNewParamsJointIndividual) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividualsAddress ¶
type EntityNewParamsJointIndividualsAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsJointIndividualsAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJointIndividualsAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividualsIdentification ¶
type EntityNewParamsJointIndividualsIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityNewParamsJointIndividualsIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityNewParamsJointIndividualsIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityNewParamsJointIndividualsIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityNewParamsJointIndividualsIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityNewParamsJointIndividualsIdentification) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJointIndividualsIdentification) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividualsIdentificationDriversLicense ¶
type EntityNewParamsJointIndividualsIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityNewParamsJointIndividualsIdentificationDriversLicense) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJointIndividualsIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividualsIdentificationMethod ¶
type EntityNewParamsJointIndividualsIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNewParamsJointIndividualsIdentificationMethodSocialSecurityNumber EntityNewParamsJointIndividualsIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNewParamsJointIndividualsIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNewParamsJointIndividualsIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNewParamsJointIndividualsIdentificationMethodPassport EntityNewParamsJointIndividualsIdentificationMethod = "passport" // A driver's license number. EntityNewParamsJointIndividualsIdentificationMethodDriversLicense EntityNewParamsJointIndividualsIdentificationMethod = "drivers_license" // Another identifying document. EntityNewParamsJointIndividualsIdentificationMethodOther EntityNewParamsJointIndividualsIdentificationMethod = "other" )
type EntityNewParamsJointIndividualsIdentificationOther ¶
type EntityNewParamsJointIndividualsIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityNewParamsJointIndividualsIdentificationOther) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJointIndividualsIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityNewParamsJointIndividualsIdentificationPassport ¶
type EntityNewParamsJointIndividualsIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityNewParamsJointIndividualsIdentificationPassport) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsJointIndividualsIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPerson ¶
type EntityNewParamsNaturalPerson struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsNaturalPersonAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityNewParamsNaturalPersonIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods.
func (EntityNewParamsNaturalPerson) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPerson) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPersonAddress ¶
type EntityNewParamsNaturalPersonAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsNaturalPersonAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPersonAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPersonIdentification ¶
type EntityNewParamsNaturalPersonIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityNewParamsNaturalPersonIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityNewParamsNaturalPersonIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityNewParamsNaturalPersonIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityNewParamsNaturalPersonIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityNewParamsNaturalPersonIdentification) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPersonIdentification) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPersonIdentificationDriversLicense ¶
type EntityNewParamsNaturalPersonIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityNewParamsNaturalPersonIdentificationDriversLicense) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPersonIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPersonIdentificationMethod ¶
type EntityNewParamsNaturalPersonIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNewParamsNaturalPersonIdentificationMethodSocialSecurityNumber EntityNewParamsNaturalPersonIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNewParamsNaturalPersonIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNewParamsNaturalPersonIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNewParamsNaturalPersonIdentificationMethodPassport EntityNewParamsNaturalPersonIdentificationMethod = "passport" // A driver's license number. EntityNewParamsNaturalPersonIdentificationMethodDriversLicense EntityNewParamsNaturalPersonIdentificationMethod = "drivers_license" // Another identifying document. EntityNewParamsNaturalPersonIdentificationMethodOther EntityNewParamsNaturalPersonIdentificationMethod = "other" )
type EntityNewParamsNaturalPersonIdentificationOther ¶
type EntityNewParamsNaturalPersonIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityNewParamsNaturalPersonIdentificationOther) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPersonIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityNewParamsNaturalPersonIdentificationPassport ¶
type EntityNewParamsNaturalPersonIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityNewParamsNaturalPersonIdentificationPassport) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsNaturalPersonIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityNewParamsRelationship ¶
type EntityNewParamsRelationship string
The relationship between your group and the entity.
const ( // The entity is controlled by your group. EntityNewParamsRelationshipAffiliated EntityNewParamsRelationship = "affiliated" // The entity is for informational purposes only. EntityNewParamsRelationshipInformational EntityNewParamsRelationship = "informational" // The entity is not controlled by your group, but can still directly open // accounts. EntityNewParamsRelationshipUnaffiliated EntityNewParamsRelationship = "unaffiliated" )
type EntityNewParamsStructure ¶
type EntityNewParamsStructure string
The type of Entity to create.
const ( // A corporation. EntityNewParamsStructureCorporation EntityNewParamsStructure = "corporation" // An individual person. EntityNewParamsStructureNaturalPerson EntityNewParamsStructure = "natural_person" // Multiple individual people. EntityNewParamsStructureJoint EntityNewParamsStructure = "joint" // A trust. EntityNewParamsStructureTrust EntityNewParamsStructure = "trust" )
type EntityNewParamsSupplementalDocument ¶ added in v0.3.0
type EntityNewParamsSupplementalDocument struct {
// The identifier of the File containing the document.
FileID param.Field[string] `json:"file_id,required"`
}
func (EntityNewParamsSupplementalDocument) MarshalJSON ¶ added in v0.3.0
func (r EntityNewParamsSupplementalDocument) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrust ¶
type EntityNewParamsTrust struct {
// The trust's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsTrustAddress] `json:"address,required"`
// Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require
// their own Employer Identification Number. Revocable trusts require information
// about the individual `grantor` who created the trust.
Category param.Field[EntityNewParamsTrustCategory] `json:"category,required"`
// The legal name of the trust.
Name param.Field[string] `json:"name,required"`
// The trustees of the trust.
Trustees param.Field[[]EntityNewParamsTrustTrustee] `json:"trustees,required"`
// The identifier of the File containing the formation document of the trust.
FormationDocumentFileID param.Field[string] `json:"formation_document_file_id"`
// The two-letter United States Postal Service (USPS) abbreviation for the state in
// which the trust was formed.
FormationState param.Field[string] `json:"formation_state"`
// The grantor of the trust. Required if `category` is equal to `revocable`.
Grantor param.Field[EntityNewParamsTrustGrantor] `json:"grantor"`
// The Employer Identification Number (EIN) for the trust. Required if `category`
// is equal to `irrevocable`.
TaxIdentifier param.Field[string] `json:"tax_identifier"`
}
Details of the trust entity to create. Required if `structure` is equal to `trust`.
func (EntityNewParamsTrust) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrust) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustAddress ¶
type EntityNewParamsTrustAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The trust's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsTrustAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustCategory ¶
type EntityNewParamsTrustCategory string
Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their own Employer Identification Number. Revocable trusts require information about the individual `grantor` who created the trust.
const ( // The trust is revocable by the grantor. EntityNewParamsTrustCategoryRevocable EntityNewParamsTrustCategory = "revocable" // The trust cannot be revoked. EntityNewParamsTrustCategoryIrrevocable EntityNewParamsTrustCategory = "irrevocable" )
type EntityNewParamsTrustGrantor ¶
type EntityNewParamsTrustGrantor struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsTrustGrantorAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityNewParamsTrustGrantorIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
The grantor of the trust. Required if `category` is equal to `revocable`.
func (EntityNewParamsTrustGrantor) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantor) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustGrantorAddress ¶
type EntityNewParamsTrustGrantorAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsTrustGrantorAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantorAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustGrantorIdentification ¶
type EntityNewParamsTrustGrantorIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityNewParamsTrustGrantorIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityNewParamsTrustGrantorIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityNewParamsTrustGrantorIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityNewParamsTrustGrantorIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityNewParamsTrustGrantorIdentification) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantorIdentification) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustGrantorIdentificationDriversLicense ¶
type EntityNewParamsTrustGrantorIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityNewParamsTrustGrantorIdentificationDriversLicense) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantorIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustGrantorIdentificationMethod ¶
type EntityNewParamsTrustGrantorIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNewParamsTrustGrantorIdentificationMethodSocialSecurityNumber EntityNewParamsTrustGrantorIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNewParamsTrustGrantorIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNewParamsTrustGrantorIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNewParamsTrustGrantorIdentificationMethodPassport EntityNewParamsTrustGrantorIdentificationMethod = "passport" // A driver's license number. EntityNewParamsTrustGrantorIdentificationMethodDriversLicense EntityNewParamsTrustGrantorIdentificationMethod = "drivers_license" // Another identifying document. EntityNewParamsTrustGrantorIdentificationMethodOther EntityNewParamsTrustGrantorIdentificationMethod = "other" )
type EntityNewParamsTrustGrantorIdentificationOther ¶
type EntityNewParamsTrustGrantorIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityNewParamsTrustGrantorIdentificationOther) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantorIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustGrantorIdentificationPassport ¶
type EntityNewParamsTrustGrantorIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityNewParamsTrustGrantorIdentificationPassport) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustGrantorIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrustee ¶ added in v0.3.0
type EntityNewParamsTrustTrustee struct {
// The structure of the trustee.
Structure param.Field[EntityNewParamsTrustTrusteesStructure] `json:"structure,required"`
// Details of the individual trustee. Required when the trustee `structure` is
// equal to `individual`.
Individual param.Field[EntityNewParamsTrustTrusteesIndividual] `json:"individual"`
}
func (EntityNewParamsTrustTrustee) MarshalJSON ¶ added in v0.3.0
func (r EntityNewParamsTrustTrustee) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividual ¶
type EntityNewParamsTrustTrusteesIndividual struct {
// The individual's physical address. Post Office Boxes are disallowed.
Address param.Field[EntityNewParamsTrustTrusteesIndividualAddress] `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth param.Field[time.Time] `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification param.Field[EntityNewParamsTrustTrusteesIndividualIdentification] `json:"identification,required"`
// The person's legal name.
Name param.Field[string] `json:"name,required"`
// The identification method for an individual can only be a passport, driver's
// license, or other document if you've confirmed the individual does not have a US
// tax id (either a Social Security Number or Individual Taxpayer Identification
// Number).
ConfirmedNoUsTaxID param.Field[bool] `json:"confirmed_no_us_tax_id"`
}
Details of the individual trustee. Required when the trustee `structure` is equal to `individual`.
func (EntityNewParamsTrustTrusteesIndividual) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividual) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividualAddress ¶
type EntityNewParamsTrustTrusteesIndividualAddress struct {
// The city of the address.
City param.Field[string] `json:"city,required"`
// The first line of the address. This is usually the street number and street.
Line1 param.Field[string] `json:"line1,required"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State param.Field[string] `json:"state,required"`
// The ZIP code of the address.
Zip param.Field[string] `json:"zip,required"`
// The second line of the address. This might be the floor or room number.
Line2 param.Field[string] `json:"line2"`
}
The individual's physical address. Post Office Boxes are disallowed.
func (EntityNewParamsTrustTrusteesIndividualAddress) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividualAddress) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividualIdentification ¶
type EntityNewParamsTrustTrusteesIndividualIdentification struct {
// A method that can be used to verify the individual's identity.
Method param.Field[EntityNewParamsTrustTrusteesIndividualIdentificationMethod] `json:"method,required"`
// An identification number that can be used to verify the individual's identity,
// such as a social security number.
Number param.Field[string] `json:"number,required"`
// Information about the United States driver's license used for identification.
// Required if `method` is equal to `drivers_license`.
DriversLicense param.Field[EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense] `json:"drivers_license"`
// Information about the identification document provided. Required if `method` is
// equal to `other`.
Other param.Field[EntityNewParamsTrustTrusteesIndividualIdentificationOther] `json:"other"`
// Information about the passport used for identification. Required if `method` is
// equal to `passport`.
Passport param.Field[EntityNewParamsTrustTrusteesIndividualIdentificationPassport] `json:"passport"`
}
A means of verifying the person's identity.
func (EntityNewParamsTrustTrusteesIndividualIdentification) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividualIdentification) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense ¶
type EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense struct {
// The driver's license's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the front of the driver's license.
FileID param.Field[string] `json:"file_id,required"`
// The state that issued the provided driver's license.
State param.Field[string] `json:"state,required"`
// The identifier of the File containing the back of the driver's license.
BackFileID param.Field[string] `json:"back_file_id"`
}
Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
func (EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividualIdentificationDriversLicense) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividualIdentificationMethod ¶
type EntityNewParamsTrustTrusteesIndividualIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityNewParamsTrustTrusteesIndividualIdentificationMethodSocialSecurityNumber EntityNewParamsTrustTrusteesIndividualIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityNewParamsTrustTrusteesIndividualIdentificationMethodIndividualTaxpayerIdentificationNumber EntityNewParamsTrustTrusteesIndividualIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityNewParamsTrustTrusteesIndividualIdentificationMethodPassport EntityNewParamsTrustTrusteesIndividualIdentificationMethod = "passport" // A driver's license number. EntityNewParamsTrustTrusteesIndividualIdentificationMethodDriversLicense EntityNewParamsTrustTrusteesIndividualIdentificationMethod = "drivers_license" // Another identifying document. EntityNewParamsTrustTrusteesIndividualIdentificationMethodOther EntityNewParamsTrustTrusteesIndividualIdentificationMethod = "other" )
type EntityNewParamsTrustTrusteesIndividualIdentificationOther ¶
type EntityNewParamsTrustTrusteesIndividualIdentificationOther struct {
// The two-character ISO 3166-1 code representing the country that issued the
// document.
Country param.Field[string] `json:"country,required"`
// A description of the document submitted.
Description param.Field[string] `json:"description,required"`
// The identifier of the File containing the front of the document.
FileID param.Field[string] `json:"file_id,required"`
// The identifier of the File containing the back of the document. Not every
// document has a reverse side.
BackFileID param.Field[string] `json:"back_file_id"`
// The document's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date" format:"date"`
}
Information about the identification document provided. Required if `method` is equal to `other`.
func (EntityNewParamsTrustTrusteesIndividualIdentificationOther) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividualIdentificationOther) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesIndividualIdentificationPassport ¶
type EntityNewParamsTrustTrusteesIndividualIdentificationPassport struct {
// The country that issued the passport.
Country param.Field[string] `json:"country,required"`
// The passport's expiration date in YYYY-MM-DD format.
ExpirationDate param.Field[time.Time] `json:"expiration_date,required" format:"date"`
// The identifier of the File containing the passport.
FileID param.Field[string] `json:"file_id,required"`
}
Information about the passport used for identification. Required if `method` is equal to `passport`.
func (EntityNewParamsTrustTrusteesIndividualIdentificationPassport) MarshalJSON ¶ added in v0.1.1
func (r EntityNewParamsTrustTrusteesIndividualIdentificationPassport) MarshalJSON() (data []byte, err error)
type EntityNewParamsTrustTrusteesStructure ¶
type EntityNewParamsTrustTrusteesStructure string
The structure of the trustee.
const ( // The trustee is an individual. EntityNewParamsTrustTrusteesStructureIndividual EntityNewParamsTrustTrusteesStructure = "individual" )
type EntityRelationship ¶
type EntityRelationship string
The relationship between your group and the entity.
const ( // The entity is controlled by your group. EntityRelationshipAffiliated EntityRelationship = "affiliated" // The entity is for informational purposes only. EntityRelationshipInformational EntityRelationship = "informational" // The entity is not controlled by your group, but can still directly open // accounts. EntityRelationshipUnaffiliated EntityRelationship = "unaffiliated" )
type EntityService ¶
type EntityService struct {
Options []option.RequestOption
BeneficialOwners *EntityBeneficialOwnerService
SupplementalDocuments *EntitySupplementalDocumentService
}
EntityService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntityService method instead.
func NewEntityService ¶
func NewEntityService(opts ...option.RequestOption) (r *EntityService)
NewEntityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*EntityService) Archive ¶ added in v0.6.3
func (r *EntityService) Archive(ctx context.Context, entityID string, opts ...option.RequestOption) (res *Entity, err error)
Archive an Entity
func (*EntityService) Get ¶
func (r *EntityService) Get(ctx context.Context, entityID string, opts ...option.RequestOption) (res *Entity, err error)
Retrieve an Entity
func (*EntityService) List ¶
func (r *EntityService) List(ctx context.Context, query EntityListParams, opts ...option.RequestOption) (res *shared.Page[Entity], err error)
List Entities
func (*EntityService) ListAutoPaging ¶
func (r *EntityService) ListAutoPaging(ctx context.Context, query EntityListParams, opts ...option.RequestOption) *shared.PageAutoPager[Entity]
List Entities
func (*EntityService) New ¶
func (r *EntityService) New(ctx context.Context, body EntityNewParams, opts ...option.RequestOption) (res *Entity, err error)
Create an Entity
type EntityStructure ¶
type EntityStructure string
The entity's legal structure.
const ( // A corporation. EntityStructureCorporation EntityStructure = "corporation" // An individual person. EntityStructureNaturalPerson EntityStructure = "natural_person" // Multiple individual people. EntityStructureJoint EntityStructure = "joint" // A trust. EntityStructureTrust EntityStructure = "trust" )
type EntitySupplementalDocument ¶ added in v0.3.0
type EntitySupplementalDocument struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
// Supplemental Document was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The File containing the document.
FileID string `json:"file_id,required"`
// A constant representing the object's type. For this resource it will always be
// `entity_supplemental_document`.
Type EntitySupplementalDocumentsType `json:"type,required"`
JSON entitySupplementalDocumentJSON
}
Supplemental Documents are uploaded files connected to an Entity during onboarding.
func (*EntitySupplementalDocument) UnmarshalJSON ¶ added in v0.3.0
func (r *EntitySupplementalDocument) UnmarshalJSON(data []byte) (err error)
type EntitySupplementalDocumentListParams ¶ added in v0.1.1
type EntitySupplementalDocumentListParams struct {
// The identifier of the Entity to list supplemental documents for.
EntityID param.Field[string] `query:"entity_id,required"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (EntitySupplementalDocumentListParams) URLQuery ¶ added in v0.1.1
func (r EntitySupplementalDocumentListParams) URLQuery() (v url.Values)
URLQuery serializes EntitySupplementalDocumentListParams's query parameters as `url.Values`.
type EntitySupplementalDocumentNewParams ¶
type EntitySupplementalDocumentNewParams struct {
// The identifier of the File containing the document.
FileID param.Field[string] `json:"file_id,required"`
}
func (EntitySupplementalDocumentNewParams) MarshalJSON ¶
func (r EntitySupplementalDocumentNewParams) MarshalJSON() (data []byte, err error)
type EntitySupplementalDocumentService ¶
type EntitySupplementalDocumentService struct {
Options []option.RequestOption
}
EntitySupplementalDocumentService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEntitySupplementalDocumentService method instead.
func NewEntitySupplementalDocumentService ¶
func NewEntitySupplementalDocumentService(opts ...option.RequestOption) (r *EntitySupplementalDocumentService)
NewEntitySupplementalDocumentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*EntitySupplementalDocumentService) List ¶ added in v0.1.1
func (r *EntitySupplementalDocumentService) List(ctx context.Context, query EntitySupplementalDocumentListParams, opts ...option.RequestOption) (res *shared.Page[SupplementalDocument], err error)
List Entity Supplemental Document Submissions
func (*EntitySupplementalDocumentService) ListAutoPaging ¶ added in v0.1.1
func (r *EntitySupplementalDocumentService) ListAutoPaging(ctx context.Context, query EntitySupplementalDocumentListParams, opts ...option.RequestOption) *shared.PageAutoPager[SupplementalDocument]
List Entity Supplemental Document Submissions
func (*EntitySupplementalDocumentService) New ¶
func (r *EntitySupplementalDocumentService) New(ctx context.Context, entityID string, body EntitySupplementalDocumentNewParams, opts ...option.RequestOption) (res *Entity, err error)
Create a supplemental document for an Entity
type EntitySupplementalDocumentsType ¶ added in v0.1.1
type EntitySupplementalDocumentsType string
A constant representing the object's type. For this resource it will always be `entity_supplemental_document`.
const (
EntitySupplementalDocumentsTypeEntitySupplementalDocument EntitySupplementalDocumentsType = "entity_supplemental_document"
)
type EntityTrust ¶
type EntityTrust struct {
// The trust's address.
Address EntityTrustAddress `json:"address,required"`
// Whether the trust is `revocable` or `irrevocable`.
Category EntityTrustCategory `json:"category,required"`
// The ID for the File containing the formation document of the trust.
FormationDocumentFileID string `json:"formation_document_file_id,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state in
// which the trust was formed.
FormationState string `json:"formation_state,required,nullable"`
// The grantor of the trust. Will be present if the `category` is `revocable`.
Grantor EntityTrustGrantor `json:"grantor,required,nullable"`
// The trust's name
Name string `json:"name,required"`
// The Employer Identification Number (EIN) of the trust itself.
TaxIdentifier string `json:"tax_identifier,required,nullable"`
// The trustees of the trust.
Trustees []EntityTrustTrustee `json:"trustees,required"`
JSON entityTrustJSON
}
Details of the trust entity. Will be present if `structure` is equal to `trust`.
func (*EntityTrust) UnmarshalJSON ¶
func (r *EntityTrust) UnmarshalJSON(data []byte) (err error)
type EntityTrustAddress ¶
type EntityTrustAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityTrustAddressJSON
}
The trust's address.
func (*EntityTrustAddress) UnmarshalJSON ¶
func (r *EntityTrustAddress) UnmarshalJSON(data []byte) (err error)
type EntityTrustCategory ¶
type EntityTrustCategory string
Whether the trust is `revocable` or `irrevocable`.
const ( // The trust is revocable by the grantor. EntityTrustCategoryRevocable EntityTrustCategory = "revocable" // The trust cannot be revoked. EntityTrustCategoryIrrevocable EntityTrustCategory = "irrevocable" )
type EntityTrustGrantor ¶
type EntityTrustGrantor struct {
// The person's address.
Address EntityTrustGrantorAddress `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth time.Time `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification EntityTrustGrantorIdentification `json:"identification,required"`
// The person's legal name.
Name string `json:"name,required"`
JSON entityTrustGrantorJSON
}
The grantor of the trust. Will be present if the `category` is `revocable`.
func (*EntityTrustGrantor) UnmarshalJSON ¶
func (r *EntityTrustGrantor) UnmarshalJSON(data []byte) (err error)
type EntityTrustGrantorAddress ¶
type EntityTrustGrantorAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityTrustGrantorAddressJSON
}
The person's address.
func (*EntityTrustGrantorAddress) UnmarshalJSON ¶
func (r *EntityTrustGrantorAddress) UnmarshalJSON(data []byte) (err error)
type EntityTrustGrantorIdentification ¶
type EntityTrustGrantorIdentification struct {
// A method that can be used to verify the individual's identity.
Method EntityTrustGrantorIdentificationMethod `json:"method,required"`
// The last 4 digits of the identification number that can be used to verify the
// individual's identity.
NumberLast4 string `json:"number_last4,required"`
JSON entityTrustGrantorIdentificationJSON
}
A means of verifying the person's identity.
func (*EntityTrustGrantorIdentification) UnmarshalJSON ¶
func (r *EntityTrustGrantorIdentification) UnmarshalJSON(data []byte) (err error)
type EntityTrustGrantorIdentificationMethod ¶
type EntityTrustGrantorIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityTrustGrantorIdentificationMethodSocialSecurityNumber EntityTrustGrantorIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityTrustGrantorIdentificationMethodIndividualTaxpayerIdentificationNumber EntityTrustGrantorIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityTrustGrantorIdentificationMethodPassport EntityTrustGrantorIdentificationMethod = "passport" // A driver's license number. EntityTrustGrantorIdentificationMethodDriversLicense EntityTrustGrantorIdentificationMethod = "drivers_license" // Another identifying document. EntityTrustGrantorIdentificationMethodOther EntityTrustGrantorIdentificationMethod = "other" )
type EntityTrustTrustee ¶ added in v0.3.0
type EntityTrustTrustee struct {
// The individual trustee of the trust. Will be present if the trustee's
// `structure` is equal to `individual`.
Individual EntityTrustTrusteesIndividual `json:"individual,required,nullable"`
// The structure of the trustee. Will always be equal to `individual`.
Structure EntityTrustTrusteesStructure `json:"structure,required"`
JSON entityTrustTrusteeJSON
}
func (*EntityTrustTrustee) UnmarshalJSON ¶ added in v0.3.0
func (r *EntityTrustTrustee) UnmarshalJSON(data []byte) (err error)
type EntityTrustTrusteesIndividual ¶
type EntityTrustTrusteesIndividual struct {
// The person's address.
Address EntityTrustTrusteesIndividualAddress `json:"address,required"`
// The person's date of birth in YYYY-MM-DD format.
DateOfBirth time.Time `json:"date_of_birth,required" format:"date"`
// A means of verifying the person's identity.
Identification EntityTrustTrusteesIndividualIdentification `json:"identification,required"`
// The person's legal name.
Name string `json:"name,required"`
JSON entityTrustTrusteesIndividualJSON
}
The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`.
func (*EntityTrustTrusteesIndividual) UnmarshalJSON ¶
func (r *EntityTrustTrusteesIndividual) UnmarshalJSON(data []byte) (err error)
type EntityTrustTrusteesIndividualAddress ¶
type EntityTrustTrusteesIndividualAddress struct {
// The city of the address.
City string `json:"city,required"`
// The first line of the address.
Line1 string `json:"line1,required"`
// The second line of the address.
Line2 string `json:"line2,required,nullable"`
// The two-letter United States Postal Service (USPS) abbreviation for the state of
// the address.
State string `json:"state,required"`
// The ZIP code of the address.
Zip string `json:"zip,required"`
JSON entityTrustTrusteesIndividualAddressJSON
}
The person's address.
func (*EntityTrustTrusteesIndividualAddress) UnmarshalJSON ¶
func (r *EntityTrustTrusteesIndividualAddress) UnmarshalJSON(data []byte) (err error)
type EntityTrustTrusteesIndividualIdentification ¶
type EntityTrustTrusteesIndividualIdentification struct {
// A method that can be used to verify the individual's identity.
Method EntityTrustTrusteesIndividualIdentificationMethod `json:"method,required"`
// The last 4 digits of the identification number that can be used to verify the
// individual's identity.
NumberLast4 string `json:"number_last4,required"`
JSON entityTrustTrusteesIndividualIdentificationJSON
}
A means of verifying the person's identity.
func (*EntityTrustTrusteesIndividualIdentification) UnmarshalJSON ¶
func (r *EntityTrustTrusteesIndividualIdentification) UnmarshalJSON(data []byte) (err error)
type EntityTrustTrusteesIndividualIdentificationMethod ¶
type EntityTrustTrusteesIndividualIdentificationMethod string
A method that can be used to verify the individual's identity.
const ( // A social security number. EntityTrustTrusteesIndividualIdentificationMethodSocialSecurityNumber EntityTrustTrusteesIndividualIdentificationMethod = "social_security_number" // An individual taxpayer identification number (ITIN). EntityTrustTrusteesIndividualIdentificationMethodIndividualTaxpayerIdentificationNumber EntityTrustTrusteesIndividualIdentificationMethod = "individual_taxpayer_identification_number" // A passport number. EntityTrustTrusteesIndividualIdentificationMethodPassport EntityTrustTrusteesIndividualIdentificationMethod = "passport" // A driver's license number. EntityTrustTrusteesIndividualIdentificationMethodDriversLicense EntityTrustTrusteesIndividualIdentificationMethod = "drivers_license" // Another identifying document. EntityTrustTrusteesIndividualIdentificationMethodOther EntityTrustTrusteesIndividualIdentificationMethod = "other" )
type EntityTrustTrusteesStructure ¶
type EntityTrustTrusteesStructure string
The structure of the trustee. Will always be equal to `individual`.
const ( // The trustee is an individual. EntityTrustTrusteesStructureIndividual EntityTrustTrusteesStructure = "individual" )
type EntityType ¶
type EntityType string
A constant representing the object's type. For this resource it will always be `entity`.
const (
EntityTypeEntity EntityType = "entity"
)
type Event ¶
type Event struct {
// The Event identifier.
ID string `json:"id,required"`
// The identifier of the object that generated this Event.
AssociatedObjectID string `json:"associated_object_id,required"`
// The type of the object that generated this Event.
AssociatedObjectType string `json:"associated_object_type,required"`
// The category of the Event. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category EventCategory `json:"category,required"`
// The time the Event was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A constant representing the object's type. For this resource it will always be
// `event`.
Type EventType `json:"type,required"`
JSON eventJSON
}
Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
func (*Event) UnmarshalJSON ¶
type EventCategory ¶
type EventCategory string
The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Occurs whenever an Account is created. EventCategoryAccountCreated EventCategory = "account.created" // Occurs whenever an Account is updated. EventCategoryAccountUpdated EventCategory = "account.updated" // Occurs whenever an Account Number is created. EventCategoryAccountNumberCreated EventCategory = "account_number.created" // Occurs whenever an Account Number is updated. EventCategoryAccountNumberUpdated EventCategory = "account_number.updated" // Occurs whenever an Account Statement is created. EventCategoryAccountStatementCreated EventCategory = "account_statement.created" // Occurs whenever an Account Transfer is created. EventCategoryAccountTransferCreated EventCategory = "account_transfer.created" // Occurs whenever an Account Transfer is updated. EventCategoryAccountTransferUpdated EventCategory = "account_transfer.updated" // Occurs whenever an ACH Prenotification is created. EventCategoryACHPrenotificationCreated EventCategory = "ach_prenotification.created" // Occurs whenever an ACH Prenotification is updated. EventCategoryACHPrenotificationUpdated EventCategory = "ach_prenotification.updated" // Occurs whenever an ACH Transfer is created. EventCategoryACHTransferCreated EventCategory = "ach_transfer.created" // Occurs whenever an ACH Transfer is updated. EventCategoryACHTransferUpdated EventCategory = "ach_transfer.updated" // Occurs whenever a Card is created. EventCategoryCardCreated EventCategory = "card.created" // Occurs whenever a Card is updated. EventCategoryCardUpdated EventCategory = "card.updated" // Occurs whenever a Card Payment is created. EventCategoryCardPaymentCreated EventCategory = "card_payment.created" // Occurs whenever a Card Payment is updated. EventCategoryCardPaymentUpdated EventCategory = "card_payment.updated" // Occurs whenever a Card Dispute is created. EventCategoryCardDisputeCreated EventCategory = "card_dispute.created" // Occurs whenever a Card Dispute is updated. EventCategoryCardDisputeUpdated EventCategory = "card_dispute.updated" // Occurs whenever a Check Deposit is created. EventCategoryCheckDepositCreated EventCategory = "check_deposit.created" // Occurs whenever a Check Deposit is updated. EventCategoryCheckDepositUpdated EventCategory = "check_deposit.updated" // Occurs whenever a Check Transfer is created. EventCategoryCheckTransferCreated EventCategory = "check_transfer.created" // Occurs whenever a Check Transfer is updated. EventCategoryCheckTransferUpdated EventCategory = "check_transfer.updated" // Occurs whenever a Declined Transaction is created. EventCategoryDeclinedTransactionCreated EventCategory = "declined_transaction.created" // Occurs whenever a Digital Wallet Token is created. EventCategoryDigitalWalletTokenCreated EventCategory = "digital_wallet_token.created" // Occurs whenever a Digital Wallet Token is updated. EventCategoryDigitalWalletTokenUpdated EventCategory = "digital_wallet_token.updated" // Occurs whenever a Document is created. EventCategoryDocumentCreated EventCategory = "document.created" // Occurs whenever an Entity is created. EventCategoryEntityCreated EventCategory = "entity.created" // Occurs whenever an Entity is updated. EventCategoryEntityUpdated EventCategory = "entity.updated" // Occurs whenever an External Account is created. EventCategoryExternalAccountCreated EventCategory = "external_account.created" // Occurs whenever a File is created. EventCategoryFileCreated EventCategory = "file.created" // Occurs whenever a Group is updated. EventCategoryGroupUpdated EventCategory = "group.updated" // Increase may send webhooks with this category to see if a webhook endpoint is // working properly. EventCategoryGroupHeartbeat EventCategory = "group.heartbeat" // Occurs whenever an Inbound ACH Transfer is created. EventCategoryInboundACHTransferCreated EventCategory = "inbound_ach_transfer.created" // Occurs whenever an Inbound ACH Transfer is updated. EventCategoryInboundACHTransferUpdated EventCategory = "inbound_ach_transfer.updated" // Occurs whenever an Inbound ACH Transfer Return is created. EventCategoryInboundACHTransferReturnCreated EventCategory = "inbound_ach_transfer_return.created" // Occurs whenever an Inbound ACH Transfer Return is updated. EventCategoryInboundACHTransferReturnUpdated EventCategory = "inbound_ach_transfer_return.updated" // Occurs whenever an Inbound Wire Drawdown Request is created. EventCategoryInboundWireDrawdownRequestCreated EventCategory = "inbound_wire_drawdown_request.created" // Occurs whenever an OAuth Connection is created. EventCategoryOauthConnectionCreated EventCategory = "oauth_connection.created" // Occurs whenever an OAuth Connection is deactivated. EventCategoryOauthConnectionDeactivated EventCategory = "oauth_connection.deactivated" // Occurs whenever a Pending Transaction is created. EventCategoryPendingTransactionCreated EventCategory = "pending_transaction.created" // Occurs whenever a Pending Transaction is updated. EventCategoryPendingTransactionUpdated EventCategory = "pending_transaction.updated" // Occurs whenever a Real-Time Decision is created in response to a card // authorization. EventCategoryRealTimeDecisionCardAuthorizationRequested EventCategory = "real_time_decision.card_authorization_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // provisioning attempt. EventCategoryRealTimeDecisionDigitalWalletTokenRequested EventCategory = "real_time_decision.digital_wallet_token_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // requiring two-factor authentication. EventCategoryRealTimeDecisionDigitalWalletAuthenticationRequested EventCategory = "real_time_decision.digital_wallet_authentication_requested" // Occurs whenever a Real-Time Payments Transfer is created. EventCategoryRealTimePaymentsTransferCreated EventCategory = "real_time_payments_transfer.created" // Occurs whenever a Real-Time Payments Transfer is updated. EventCategoryRealTimePaymentsTransferUpdated EventCategory = "real_time_payments_transfer.updated" // Occurs whenever a Real-Time Payments Request for Payment is created. EventCategoryRealTimePaymentsRequestForPaymentCreated EventCategory = "real_time_payments_request_for_payment.created" // Occurs whenever a Real-Time Payments Request for Payment is updated. EventCategoryRealTimePaymentsRequestForPaymentUpdated EventCategory = "real_time_payments_request_for_payment.updated" // Occurs whenever a Transaction is created. EventCategoryTransactionCreated EventCategory = "transaction.created" // Occurs whenever a Wire Drawdown Request is created. EventCategoryWireDrawdownRequestCreated EventCategory = "wire_drawdown_request.created" // Occurs whenever a Wire Drawdown Request is updated. EventCategoryWireDrawdownRequestUpdated EventCategory = "wire_drawdown_request.updated" // Occurs whenever a Wire Transfer is created. EventCategoryWireTransferCreated EventCategory = "wire_transfer.created" // Occurs whenever a Wire Transfer is updated. EventCategoryWireTransferUpdated EventCategory = "wire_transfer.updated" )
type EventListParams ¶
type EventListParams struct {
// Filter Events to those belonging to the object with the provided identifier.
AssociatedObjectID param.Field[string] `query:"associated_object_id"`
Category param.Field[EventListParamsCategory] `query:"category"`
CreatedAt param.Field[EventListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (EventListParams) URLQuery ¶
func (r EventListParams) URLQuery() (v url.Values)
URLQuery serializes EventListParams's query parameters as `url.Values`.
type EventListParamsCategory ¶
type EventListParamsCategory struct {
// Filter Events for those with the specified category or categories. For GET
// requests, this should be encoded as a comma-delimited string, such as
// `?in=one,two,three`.
In param.Field[[]EventListParamsCategoryIn] `query:"in"`
}
func (EventListParamsCategory) URLQuery ¶
func (r EventListParamsCategory) URLQuery() (v url.Values)
URLQuery serializes EventListParamsCategory's query parameters as `url.Values`.
type EventListParamsCategoryIn ¶
type EventListParamsCategoryIn string
const ( // Occurs whenever an Account is created. EventListParamsCategoryInAccountCreated EventListParamsCategoryIn = "account.created" // Occurs whenever an Account is updated. EventListParamsCategoryInAccountUpdated EventListParamsCategoryIn = "account.updated" // Occurs whenever an Account Number is created. EventListParamsCategoryInAccountNumberCreated EventListParamsCategoryIn = "account_number.created" // Occurs whenever an Account Number is updated. EventListParamsCategoryInAccountNumberUpdated EventListParamsCategoryIn = "account_number.updated" // Occurs whenever an Account Statement is created. EventListParamsCategoryInAccountStatementCreated EventListParamsCategoryIn = "account_statement.created" // Occurs whenever an Account Transfer is created. EventListParamsCategoryInAccountTransferCreated EventListParamsCategoryIn = "account_transfer.created" // Occurs whenever an Account Transfer is updated. EventListParamsCategoryInAccountTransferUpdated EventListParamsCategoryIn = "account_transfer.updated" // Occurs whenever an ACH Prenotification is created. EventListParamsCategoryInACHPrenotificationCreated EventListParamsCategoryIn = "ach_prenotification.created" // Occurs whenever an ACH Prenotification is updated. EventListParamsCategoryInACHPrenotificationUpdated EventListParamsCategoryIn = "ach_prenotification.updated" // Occurs whenever an ACH Transfer is created. EventListParamsCategoryInACHTransferCreated EventListParamsCategoryIn = "ach_transfer.created" // Occurs whenever an ACH Transfer is updated. EventListParamsCategoryInACHTransferUpdated EventListParamsCategoryIn = "ach_transfer.updated" // Occurs whenever a Card is created. EventListParamsCategoryInCardCreated EventListParamsCategoryIn = "card.created" // Occurs whenever a Card is updated. EventListParamsCategoryInCardUpdated EventListParamsCategoryIn = "card.updated" // Occurs whenever a Card Payment is created. EventListParamsCategoryInCardPaymentCreated EventListParamsCategoryIn = "card_payment.created" // Occurs whenever a Card Payment is updated. EventListParamsCategoryInCardPaymentUpdated EventListParamsCategoryIn = "card_payment.updated" // Occurs whenever a Card Dispute is created. EventListParamsCategoryInCardDisputeCreated EventListParamsCategoryIn = "card_dispute.created" // Occurs whenever a Card Dispute is updated. EventListParamsCategoryInCardDisputeUpdated EventListParamsCategoryIn = "card_dispute.updated" // Occurs whenever a Check Deposit is created. EventListParamsCategoryInCheckDepositCreated EventListParamsCategoryIn = "check_deposit.created" // Occurs whenever a Check Deposit is updated. EventListParamsCategoryInCheckDepositUpdated EventListParamsCategoryIn = "check_deposit.updated" // Occurs whenever a Check Transfer is created. EventListParamsCategoryInCheckTransferCreated EventListParamsCategoryIn = "check_transfer.created" // Occurs whenever a Check Transfer is updated. EventListParamsCategoryInCheckTransferUpdated EventListParamsCategoryIn = "check_transfer.updated" // Occurs whenever a Declined Transaction is created. EventListParamsCategoryInDeclinedTransactionCreated EventListParamsCategoryIn = "declined_transaction.created" // Occurs whenever a Digital Wallet Token is created. EventListParamsCategoryInDigitalWalletTokenCreated EventListParamsCategoryIn = "digital_wallet_token.created" // Occurs whenever a Digital Wallet Token is updated. EventListParamsCategoryInDigitalWalletTokenUpdated EventListParamsCategoryIn = "digital_wallet_token.updated" // Occurs whenever a Document is created. EventListParamsCategoryInDocumentCreated EventListParamsCategoryIn = "document.created" // Occurs whenever an Entity is created. EventListParamsCategoryInEntityCreated EventListParamsCategoryIn = "entity.created" // Occurs whenever an Entity is updated. EventListParamsCategoryInEntityUpdated EventListParamsCategoryIn = "entity.updated" // Occurs whenever an External Account is created. EventListParamsCategoryInExternalAccountCreated EventListParamsCategoryIn = "external_account.created" // Occurs whenever a File is created. EventListParamsCategoryInFileCreated EventListParamsCategoryIn = "file.created" // Occurs whenever a Group is updated. EventListParamsCategoryInGroupUpdated EventListParamsCategoryIn = "group.updated" // Increase may send webhooks with this category to see if a webhook endpoint is // working properly. EventListParamsCategoryInGroupHeartbeat EventListParamsCategoryIn = "group.heartbeat" // Occurs whenever an Inbound ACH Transfer is created. EventListParamsCategoryInInboundACHTransferCreated EventListParamsCategoryIn = "inbound_ach_transfer.created" // Occurs whenever an Inbound ACH Transfer is updated. EventListParamsCategoryInInboundACHTransferUpdated EventListParamsCategoryIn = "inbound_ach_transfer.updated" // Occurs whenever an Inbound ACH Transfer Return is created. EventListParamsCategoryInInboundACHTransferReturnCreated EventListParamsCategoryIn = "inbound_ach_transfer_return.created" // Occurs whenever an Inbound ACH Transfer Return is updated. EventListParamsCategoryInInboundACHTransferReturnUpdated EventListParamsCategoryIn = "inbound_ach_transfer_return.updated" // Occurs whenever an Inbound Wire Drawdown Request is created. EventListParamsCategoryInInboundWireDrawdownRequestCreated EventListParamsCategoryIn = "inbound_wire_drawdown_request.created" // Occurs whenever an OAuth Connection is created. EventListParamsCategoryInOauthConnectionCreated EventListParamsCategoryIn = "oauth_connection.created" // Occurs whenever an OAuth Connection is deactivated. EventListParamsCategoryInOauthConnectionDeactivated EventListParamsCategoryIn = "oauth_connection.deactivated" // Occurs whenever a Pending Transaction is created. EventListParamsCategoryInPendingTransactionCreated EventListParamsCategoryIn = "pending_transaction.created" // Occurs whenever a Pending Transaction is updated. EventListParamsCategoryInPendingTransactionUpdated EventListParamsCategoryIn = "pending_transaction.updated" // Occurs whenever a Real-Time Decision is created in response to a card // authorization. EventListParamsCategoryInRealTimeDecisionCardAuthorizationRequested EventListParamsCategoryIn = "real_time_decision.card_authorization_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // provisioning attempt. EventListParamsCategoryInRealTimeDecisionDigitalWalletTokenRequested EventListParamsCategoryIn = "real_time_decision.digital_wallet_token_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // requiring two-factor authentication. EventListParamsCategoryInRealTimeDecisionDigitalWalletAuthenticationRequested EventListParamsCategoryIn = "real_time_decision.digital_wallet_authentication_requested" // Occurs whenever a Real-Time Payments Transfer is created. EventListParamsCategoryInRealTimePaymentsTransferCreated EventListParamsCategoryIn = "real_time_payments_transfer.created" // Occurs whenever a Real-Time Payments Transfer is updated. EventListParamsCategoryInRealTimePaymentsTransferUpdated EventListParamsCategoryIn = "real_time_payments_transfer.updated" // Occurs whenever a Real-Time Payments Request for Payment is created. EventListParamsCategoryInRealTimePaymentsRequestForPaymentCreated EventListParamsCategoryIn = "real_time_payments_request_for_payment.created" // Occurs whenever a Real-Time Payments Request for Payment is updated. EventListParamsCategoryInRealTimePaymentsRequestForPaymentUpdated EventListParamsCategoryIn = "real_time_payments_request_for_payment.updated" // Occurs whenever a Transaction is created. EventListParamsCategoryInTransactionCreated EventListParamsCategoryIn = "transaction.created" // Occurs whenever a Wire Drawdown Request is created. EventListParamsCategoryInWireDrawdownRequestCreated EventListParamsCategoryIn = "wire_drawdown_request.created" // Occurs whenever a Wire Drawdown Request is updated. EventListParamsCategoryInWireDrawdownRequestUpdated EventListParamsCategoryIn = "wire_drawdown_request.updated" // Occurs whenever a Wire Transfer is created. EventListParamsCategoryInWireTransferCreated EventListParamsCategoryIn = "wire_transfer.created" // Occurs whenever a Wire Transfer is updated. EventListParamsCategoryInWireTransferUpdated EventListParamsCategoryIn = "wire_transfer.updated" )
type EventListParamsCreatedAt ¶
type EventListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (EventListParamsCreatedAt) URLQuery ¶
func (r EventListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes EventListParamsCreatedAt's query parameters as `url.Values`.
type EventService ¶
type EventService struct {
Options []option.RequestOption
}
EventService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEventService method instead.
func NewEventService ¶
func NewEventService(opts ...option.RequestOption) (r *EventService)
NewEventService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*EventService) Get ¶
func (r *EventService) Get(ctx context.Context, eventID string, opts ...option.RequestOption) (res *Event, err error)
Retrieve an Event
func (*EventService) List ¶
func (r *EventService) List(ctx context.Context, query EventListParams, opts ...option.RequestOption) (res *shared.Page[Event], err error)
List Events
func (*EventService) ListAutoPaging ¶
func (r *EventService) ListAutoPaging(ctx context.Context, query EventListParams, opts ...option.RequestOption) *shared.PageAutoPager[Event]
List Events
type EventSubscription ¶
type EventSubscription struct {
// The event subscription identifier.
ID string `json:"id,required"`
// The time the event subscription was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// If specified, this subscription will only receive webhooks for Events with the
// specified `category`.
SelectedEventCategory EventSubscriptionSelectedEventCategory `json:"selected_event_category,required,nullable"`
// This indicates if we'll send notifications to this subscription.
Status EventSubscriptionStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `event_subscription`.
Type EventSubscriptionType `json:"type,required"`
// The webhook url where we'll send notifications.
URL string `json:"url,required"`
JSON eventSubscriptionJSON
}
Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
func (*EventSubscription) UnmarshalJSON ¶
func (r *EventSubscription) UnmarshalJSON(data []byte) (err error)
type EventSubscriptionListParams ¶
type EventSubscriptionListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (EventSubscriptionListParams) URLQuery ¶
func (r EventSubscriptionListParams) URLQuery() (v url.Values)
URLQuery serializes EventSubscriptionListParams's query parameters as `url.Values`.
type EventSubscriptionNewParams ¶
type EventSubscriptionNewParams struct {
// The URL you'd like us to send webhooks to.
URL param.Field[string] `json:"url,required"`
// If specified, this subscription will only receive webhooks for Events with the
// specified `category`.
SelectedEventCategory param.Field[EventSubscriptionNewParamsSelectedEventCategory] `json:"selected_event_category"`
// string will be used as default.
SharedSecret param.Field[string] `json:"shared_secret"`
}
func (EventSubscriptionNewParams) MarshalJSON ¶
func (r EventSubscriptionNewParams) MarshalJSON() (data []byte, err error)
type EventSubscriptionNewParamsSelectedEventCategory ¶
type EventSubscriptionNewParamsSelectedEventCategory string
If specified, this subscription will only receive webhooks for Events with the specified `category`.
const ( // Occurs whenever an Account is created. EventSubscriptionNewParamsSelectedEventCategoryAccountCreated EventSubscriptionNewParamsSelectedEventCategory = "account.created" // Occurs whenever an Account is updated. EventSubscriptionNewParamsSelectedEventCategoryAccountUpdated EventSubscriptionNewParamsSelectedEventCategory = "account.updated" // Occurs whenever an Account Number is created. EventSubscriptionNewParamsSelectedEventCategoryAccountNumberCreated EventSubscriptionNewParamsSelectedEventCategory = "account_number.created" // Occurs whenever an Account Number is updated. EventSubscriptionNewParamsSelectedEventCategoryAccountNumberUpdated EventSubscriptionNewParamsSelectedEventCategory = "account_number.updated" // Occurs whenever an Account Statement is created. EventSubscriptionNewParamsSelectedEventCategoryAccountStatementCreated EventSubscriptionNewParamsSelectedEventCategory = "account_statement.created" // Occurs whenever an Account Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryAccountTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "account_transfer.created" // Occurs whenever an Account Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryAccountTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "account_transfer.updated" // Occurs whenever an ACH Prenotification is created. EventSubscriptionNewParamsSelectedEventCategoryACHPrenotificationCreated EventSubscriptionNewParamsSelectedEventCategory = "ach_prenotification.created" // Occurs whenever an ACH Prenotification is updated. EventSubscriptionNewParamsSelectedEventCategoryACHPrenotificationUpdated EventSubscriptionNewParamsSelectedEventCategory = "ach_prenotification.updated" // Occurs whenever an ACH Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryACHTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "ach_transfer.created" // Occurs whenever an ACH Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryACHTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "ach_transfer.updated" // Occurs whenever a Card is created. EventSubscriptionNewParamsSelectedEventCategoryCardCreated EventSubscriptionNewParamsSelectedEventCategory = "card.created" // Occurs whenever a Card is updated. EventSubscriptionNewParamsSelectedEventCategoryCardUpdated EventSubscriptionNewParamsSelectedEventCategory = "card.updated" // Occurs whenever a Card Payment is created. EventSubscriptionNewParamsSelectedEventCategoryCardPaymentCreated EventSubscriptionNewParamsSelectedEventCategory = "card_payment.created" // Occurs whenever a Card Payment is updated. EventSubscriptionNewParamsSelectedEventCategoryCardPaymentUpdated EventSubscriptionNewParamsSelectedEventCategory = "card_payment.updated" // Occurs whenever a Card Dispute is created. EventSubscriptionNewParamsSelectedEventCategoryCardDisputeCreated EventSubscriptionNewParamsSelectedEventCategory = "card_dispute.created" // Occurs whenever a Card Dispute is updated. EventSubscriptionNewParamsSelectedEventCategoryCardDisputeUpdated EventSubscriptionNewParamsSelectedEventCategory = "card_dispute.updated" // Occurs whenever a Check Deposit is created. EventSubscriptionNewParamsSelectedEventCategoryCheckDepositCreated EventSubscriptionNewParamsSelectedEventCategory = "check_deposit.created" // Occurs whenever a Check Deposit is updated. EventSubscriptionNewParamsSelectedEventCategoryCheckDepositUpdated EventSubscriptionNewParamsSelectedEventCategory = "check_deposit.updated" // Occurs whenever a Check Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryCheckTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "check_transfer.created" // Occurs whenever a Check Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryCheckTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "check_transfer.updated" // Occurs whenever a Declined Transaction is created. EventSubscriptionNewParamsSelectedEventCategoryDeclinedTransactionCreated EventSubscriptionNewParamsSelectedEventCategory = "declined_transaction.created" // Occurs whenever a Digital Wallet Token is created. EventSubscriptionNewParamsSelectedEventCategoryDigitalWalletTokenCreated EventSubscriptionNewParamsSelectedEventCategory = "digital_wallet_token.created" // Occurs whenever a Digital Wallet Token is updated. EventSubscriptionNewParamsSelectedEventCategoryDigitalWalletTokenUpdated EventSubscriptionNewParamsSelectedEventCategory = "digital_wallet_token.updated" // Occurs whenever a Document is created. EventSubscriptionNewParamsSelectedEventCategoryDocumentCreated EventSubscriptionNewParamsSelectedEventCategory = "document.created" // Occurs whenever an Entity is created. EventSubscriptionNewParamsSelectedEventCategoryEntityCreated EventSubscriptionNewParamsSelectedEventCategory = "entity.created" // Occurs whenever an Entity is updated. EventSubscriptionNewParamsSelectedEventCategoryEntityUpdated EventSubscriptionNewParamsSelectedEventCategory = "entity.updated" // Occurs whenever an External Account is created. EventSubscriptionNewParamsSelectedEventCategoryExternalAccountCreated EventSubscriptionNewParamsSelectedEventCategory = "external_account.created" // Occurs whenever a File is created. EventSubscriptionNewParamsSelectedEventCategoryFileCreated EventSubscriptionNewParamsSelectedEventCategory = "file.created" // Occurs whenever a Group is updated. EventSubscriptionNewParamsSelectedEventCategoryGroupUpdated EventSubscriptionNewParamsSelectedEventCategory = "group.updated" // Increase may send webhooks with this category to see if a webhook endpoint is // working properly. EventSubscriptionNewParamsSelectedEventCategoryGroupHeartbeat EventSubscriptionNewParamsSelectedEventCategory = "group.heartbeat" // Occurs whenever an Inbound ACH Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryInboundACHTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "inbound_ach_transfer.created" // Occurs whenever an Inbound ACH Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryInboundACHTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "inbound_ach_transfer.updated" // Occurs whenever an Inbound ACH Transfer Return is created. EventSubscriptionNewParamsSelectedEventCategoryInboundACHTransferReturnCreated EventSubscriptionNewParamsSelectedEventCategory = "inbound_ach_transfer_return.created" // Occurs whenever an Inbound ACH Transfer Return is updated. EventSubscriptionNewParamsSelectedEventCategoryInboundACHTransferReturnUpdated EventSubscriptionNewParamsSelectedEventCategory = "inbound_ach_transfer_return.updated" // Occurs whenever an Inbound Wire Drawdown Request is created. EventSubscriptionNewParamsSelectedEventCategoryInboundWireDrawdownRequestCreated EventSubscriptionNewParamsSelectedEventCategory = "inbound_wire_drawdown_request.created" // Occurs whenever an OAuth Connection is created. EventSubscriptionNewParamsSelectedEventCategoryOauthConnectionCreated EventSubscriptionNewParamsSelectedEventCategory = "oauth_connection.created" // Occurs whenever an OAuth Connection is deactivated. EventSubscriptionNewParamsSelectedEventCategoryOauthConnectionDeactivated EventSubscriptionNewParamsSelectedEventCategory = "oauth_connection.deactivated" // Occurs whenever a Pending Transaction is created. EventSubscriptionNewParamsSelectedEventCategoryPendingTransactionCreated EventSubscriptionNewParamsSelectedEventCategory = "pending_transaction.created" // Occurs whenever a Pending Transaction is updated. EventSubscriptionNewParamsSelectedEventCategoryPendingTransactionUpdated EventSubscriptionNewParamsSelectedEventCategory = "pending_transaction.updated" // Occurs whenever a Real-Time Decision is created in response to a card // authorization. EventSubscriptionNewParamsSelectedEventCategoryRealTimeDecisionCardAuthorizationRequested EventSubscriptionNewParamsSelectedEventCategory = "real_time_decision.card_authorization_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // provisioning attempt. EventSubscriptionNewParamsSelectedEventCategoryRealTimeDecisionDigitalWalletTokenRequested EventSubscriptionNewParamsSelectedEventCategory = "real_time_decision.digital_wallet_token_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // requiring two-factor authentication. EventSubscriptionNewParamsSelectedEventCategoryRealTimeDecisionDigitalWalletAuthenticationRequested EventSubscriptionNewParamsSelectedEventCategory = "real_time_decision.digital_wallet_authentication_requested" // Occurs whenever a Real-Time Payments Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryRealTimePaymentsTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "real_time_payments_transfer.created" // Occurs whenever a Real-Time Payments Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryRealTimePaymentsTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "real_time_payments_transfer.updated" // Occurs whenever a Real-Time Payments Request for Payment is created. EventSubscriptionNewParamsSelectedEventCategoryRealTimePaymentsRequestForPaymentCreated EventSubscriptionNewParamsSelectedEventCategory = "real_time_payments_request_for_payment.created" // Occurs whenever a Real-Time Payments Request for Payment is updated. EventSubscriptionNewParamsSelectedEventCategoryRealTimePaymentsRequestForPaymentUpdated EventSubscriptionNewParamsSelectedEventCategory = "real_time_payments_request_for_payment.updated" // Occurs whenever a Transaction is created. EventSubscriptionNewParamsSelectedEventCategoryTransactionCreated EventSubscriptionNewParamsSelectedEventCategory = "transaction.created" // Occurs whenever a Wire Drawdown Request is created. EventSubscriptionNewParamsSelectedEventCategoryWireDrawdownRequestCreated EventSubscriptionNewParamsSelectedEventCategory = "wire_drawdown_request.created" // Occurs whenever a Wire Drawdown Request is updated. EventSubscriptionNewParamsSelectedEventCategoryWireDrawdownRequestUpdated EventSubscriptionNewParamsSelectedEventCategory = "wire_drawdown_request.updated" // Occurs whenever a Wire Transfer is created. EventSubscriptionNewParamsSelectedEventCategoryWireTransferCreated EventSubscriptionNewParamsSelectedEventCategory = "wire_transfer.created" // Occurs whenever a Wire Transfer is updated. EventSubscriptionNewParamsSelectedEventCategoryWireTransferUpdated EventSubscriptionNewParamsSelectedEventCategory = "wire_transfer.updated" )
type EventSubscriptionSelectedEventCategory ¶
type EventSubscriptionSelectedEventCategory string
If specified, this subscription will only receive webhooks for Events with the specified `category`.
const ( // Occurs whenever an Account is created. EventSubscriptionSelectedEventCategoryAccountCreated EventSubscriptionSelectedEventCategory = "account.created" // Occurs whenever an Account is updated. EventSubscriptionSelectedEventCategoryAccountUpdated EventSubscriptionSelectedEventCategory = "account.updated" // Occurs whenever an Account Number is created. EventSubscriptionSelectedEventCategoryAccountNumberCreated EventSubscriptionSelectedEventCategory = "account_number.created" // Occurs whenever an Account Number is updated. EventSubscriptionSelectedEventCategoryAccountNumberUpdated EventSubscriptionSelectedEventCategory = "account_number.updated" // Occurs whenever an Account Statement is created. EventSubscriptionSelectedEventCategoryAccountStatementCreated EventSubscriptionSelectedEventCategory = "account_statement.created" // Occurs whenever an Account Transfer is created. EventSubscriptionSelectedEventCategoryAccountTransferCreated EventSubscriptionSelectedEventCategory = "account_transfer.created" // Occurs whenever an Account Transfer is updated. EventSubscriptionSelectedEventCategoryAccountTransferUpdated EventSubscriptionSelectedEventCategory = "account_transfer.updated" // Occurs whenever an ACH Prenotification is created. EventSubscriptionSelectedEventCategoryACHPrenotificationCreated EventSubscriptionSelectedEventCategory = "ach_prenotification.created" // Occurs whenever an ACH Prenotification is updated. EventSubscriptionSelectedEventCategoryACHPrenotificationUpdated EventSubscriptionSelectedEventCategory = "ach_prenotification.updated" // Occurs whenever an ACH Transfer is created. EventSubscriptionSelectedEventCategoryACHTransferCreated EventSubscriptionSelectedEventCategory = "ach_transfer.created" // Occurs whenever an ACH Transfer is updated. EventSubscriptionSelectedEventCategoryACHTransferUpdated EventSubscriptionSelectedEventCategory = "ach_transfer.updated" // Occurs whenever a Card is created. EventSubscriptionSelectedEventCategoryCardCreated EventSubscriptionSelectedEventCategory = "card.created" // Occurs whenever a Card is updated. EventSubscriptionSelectedEventCategoryCardUpdated EventSubscriptionSelectedEventCategory = "card.updated" // Occurs whenever a Card Payment is created. EventSubscriptionSelectedEventCategoryCardPaymentCreated EventSubscriptionSelectedEventCategory = "card_payment.created" // Occurs whenever a Card Payment is updated. EventSubscriptionSelectedEventCategoryCardPaymentUpdated EventSubscriptionSelectedEventCategory = "card_payment.updated" // Occurs whenever a Card Dispute is created. EventSubscriptionSelectedEventCategoryCardDisputeCreated EventSubscriptionSelectedEventCategory = "card_dispute.created" // Occurs whenever a Card Dispute is updated. EventSubscriptionSelectedEventCategoryCardDisputeUpdated EventSubscriptionSelectedEventCategory = "card_dispute.updated" // Occurs whenever a Check Deposit is created. EventSubscriptionSelectedEventCategoryCheckDepositCreated EventSubscriptionSelectedEventCategory = "check_deposit.created" // Occurs whenever a Check Deposit is updated. EventSubscriptionSelectedEventCategoryCheckDepositUpdated EventSubscriptionSelectedEventCategory = "check_deposit.updated" // Occurs whenever a Check Transfer is created. EventSubscriptionSelectedEventCategoryCheckTransferCreated EventSubscriptionSelectedEventCategory = "check_transfer.created" // Occurs whenever a Check Transfer is updated. EventSubscriptionSelectedEventCategoryCheckTransferUpdated EventSubscriptionSelectedEventCategory = "check_transfer.updated" // Occurs whenever a Declined Transaction is created. EventSubscriptionSelectedEventCategoryDeclinedTransactionCreated EventSubscriptionSelectedEventCategory = "declined_transaction.created" // Occurs whenever a Digital Wallet Token is created. EventSubscriptionSelectedEventCategoryDigitalWalletTokenCreated EventSubscriptionSelectedEventCategory = "digital_wallet_token.created" // Occurs whenever a Digital Wallet Token is updated. EventSubscriptionSelectedEventCategoryDigitalWalletTokenUpdated EventSubscriptionSelectedEventCategory = "digital_wallet_token.updated" // Occurs whenever a Document is created. EventSubscriptionSelectedEventCategoryDocumentCreated EventSubscriptionSelectedEventCategory = "document.created" // Occurs whenever an Entity is created. EventSubscriptionSelectedEventCategoryEntityCreated EventSubscriptionSelectedEventCategory = "entity.created" // Occurs whenever an Entity is updated. EventSubscriptionSelectedEventCategoryEntityUpdated EventSubscriptionSelectedEventCategory = "entity.updated" // Occurs whenever an External Account is created. EventSubscriptionSelectedEventCategoryExternalAccountCreated EventSubscriptionSelectedEventCategory = "external_account.created" // Occurs whenever a File is created. EventSubscriptionSelectedEventCategoryFileCreated EventSubscriptionSelectedEventCategory = "file.created" // Occurs whenever a Group is updated. EventSubscriptionSelectedEventCategoryGroupUpdated EventSubscriptionSelectedEventCategory = "group.updated" // Increase may send webhooks with this category to see if a webhook endpoint is // working properly. EventSubscriptionSelectedEventCategoryGroupHeartbeat EventSubscriptionSelectedEventCategory = "group.heartbeat" // Occurs whenever an Inbound ACH Transfer is created. EventSubscriptionSelectedEventCategoryInboundACHTransferCreated EventSubscriptionSelectedEventCategory = "inbound_ach_transfer.created" // Occurs whenever an Inbound ACH Transfer is updated. EventSubscriptionSelectedEventCategoryInboundACHTransferUpdated EventSubscriptionSelectedEventCategory = "inbound_ach_transfer.updated" // Occurs whenever an Inbound ACH Transfer Return is created. EventSubscriptionSelectedEventCategoryInboundACHTransferReturnCreated EventSubscriptionSelectedEventCategory = "inbound_ach_transfer_return.created" // Occurs whenever an Inbound ACH Transfer Return is updated. EventSubscriptionSelectedEventCategoryInboundACHTransferReturnUpdated EventSubscriptionSelectedEventCategory = "inbound_ach_transfer_return.updated" // Occurs whenever an Inbound Wire Drawdown Request is created. EventSubscriptionSelectedEventCategoryInboundWireDrawdownRequestCreated EventSubscriptionSelectedEventCategory = "inbound_wire_drawdown_request.created" // Occurs whenever an OAuth Connection is created. EventSubscriptionSelectedEventCategoryOauthConnectionCreated EventSubscriptionSelectedEventCategory = "oauth_connection.created" // Occurs whenever an OAuth Connection is deactivated. EventSubscriptionSelectedEventCategoryOauthConnectionDeactivated EventSubscriptionSelectedEventCategory = "oauth_connection.deactivated" // Occurs whenever a Pending Transaction is created. EventSubscriptionSelectedEventCategoryPendingTransactionCreated EventSubscriptionSelectedEventCategory = "pending_transaction.created" // Occurs whenever a Pending Transaction is updated. EventSubscriptionSelectedEventCategoryPendingTransactionUpdated EventSubscriptionSelectedEventCategory = "pending_transaction.updated" // Occurs whenever a Real-Time Decision is created in response to a card // authorization. EventSubscriptionSelectedEventCategoryRealTimeDecisionCardAuthorizationRequested EventSubscriptionSelectedEventCategory = "real_time_decision.card_authorization_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // provisioning attempt. EventSubscriptionSelectedEventCategoryRealTimeDecisionDigitalWalletTokenRequested EventSubscriptionSelectedEventCategory = "real_time_decision.digital_wallet_token_requested" // Occurs whenever a Real-Time Decision is created in response to a digital wallet // requiring two-factor authentication. EventSubscriptionSelectedEventCategoryRealTimeDecisionDigitalWalletAuthenticationRequested EventSubscriptionSelectedEventCategory = "real_time_decision.digital_wallet_authentication_requested" // Occurs whenever a Real-Time Payments Transfer is created. EventSubscriptionSelectedEventCategoryRealTimePaymentsTransferCreated EventSubscriptionSelectedEventCategory = "real_time_payments_transfer.created" // Occurs whenever a Real-Time Payments Transfer is updated. EventSubscriptionSelectedEventCategoryRealTimePaymentsTransferUpdated EventSubscriptionSelectedEventCategory = "real_time_payments_transfer.updated" // Occurs whenever a Real-Time Payments Request for Payment is created. EventSubscriptionSelectedEventCategoryRealTimePaymentsRequestForPaymentCreated EventSubscriptionSelectedEventCategory = "real_time_payments_request_for_payment.created" // Occurs whenever a Real-Time Payments Request for Payment is updated. EventSubscriptionSelectedEventCategoryRealTimePaymentsRequestForPaymentUpdated EventSubscriptionSelectedEventCategory = "real_time_payments_request_for_payment.updated" // Occurs whenever a Transaction is created. EventSubscriptionSelectedEventCategoryTransactionCreated EventSubscriptionSelectedEventCategory = "transaction.created" // Occurs whenever a Wire Drawdown Request is created. EventSubscriptionSelectedEventCategoryWireDrawdownRequestCreated EventSubscriptionSelectedEventCategory = "wire_drawdown_request.created" // Occurs whenever a Wire Drawdown Request is updated. EventSubscriptionSelectedEventCategoryWireDrawdownRequestUpdated EventSubscriptionSelectedEventCategory = "wire_drawdown_request.updated" // Occurs whenever a Wire Transfer is created. EventSubscriptionSelectedEventCategoryWireTransferCreated EventSubscriptionSelectedEventCategory = "wire_transfer.created" // Occurs whenever a Wire Transfer is updated. EventSubscriptionSelectedEventCategoryWireTransferUpdated EventSubscriptionSelectedEventCategory = "wire_transfer.updated" )
type EventSubscriptionService ¶
type EventSubscriptionService struct {
Options []option.RequestOption
}
EventSubscriptionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEventSubscriptionService method instead.
func NewEventSubscriptionService ¶
func NewEventSubscriptionService(opts ...option.RequestOption) (r *EventSubscriptionService)
NewEventSubscriptionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*EventSubscriptionService) Get ¶
func (r *EventSubscriptionService) Get(ctx context.Context, eventSubscriptionID string, opts ...option.RequestOption) (res *EventSubscription, err error)
Retrieve an Event Subscription
func (*EventSubscriptionService) List ¶
func (r *EventSubscriptionService) List(ctx context.Context, query EventSubscriptionListParams, opts ...option.RequestOption) (res *shared.Page[EventSubscription], err error)
List Event Subscriptions
func (*EventSubscriptionService) ListAutoPaging ¶
func (r *EventSubscriptionService) ListAutoPaging(ctx context.Context, query EventSubscriptionListParams, opts ...option.RequestOption) *shared.PageAutoPager[EventSubscription]
List Event Subscriptions
func (*EventSubscriptionService) New ¶
func (r *EventSubscriptionService) New(ctx context.Context, body EventSubscriptionNewParams, opts ...option.RequestOption) (res *EventSubscription, err error)
Create an Event Subscription
func (*EventSubscriptionService) Update ¶
func (r *EventSubscriptionService) Update(ctx context.Context, eventSubscriptionID string, body EventSubscriptionUpdateParams, opts ...option.RequestOption) (res *EventSubscription, err error)
Update an Event Subscription
type EventSubscriptionStatus ¶
type EventSubscriptionStatus string
This indicates if we'll send notifications to this subscription.
const ( // The subscription is active and Events will be delivered normally. EventSubscriptionStatusActive EventSubscriptionStatus = "active" // The subscription is temporarily disabled and Events will not be delivered. EventSubscriptionStatusDisabled EventSubscriptionStatus = "disabled" // The subscription is permanently disabled and Events will not be delivered. EventSubscriptionStatusDeleted EventSubscriptionStatus = "deleted" // The subscription is temporarily disabled due to delivery errors and Events will // not be delivered. EventSubscriptionStatusRequiresAttention EventSubscriptionStatus = "requires_attention" )
type EventSubscriptionType ¶
type EventSubscriptionType string
A constant representing the object's type. For this resource it will always be `event_subscription`.
const (
EventSubscriptionTypeEventSubscription EventSubscriptionType = "event_subscription"
)
type EventSubscriptionUpdateParams ¶
type EventSubscriptionUpdateParams struct {
// The status to update the Event Subscription with.
Status param.Field[EventSubscriptionUpdateParamsStatus] `json:"status"`
}
func (EventSubscriptionUpdateParams) MarshalJSON ¶
func (r EventSubscriptionUpdateParams) MarshalJSON() (data []byte, err error)
type EventSubscriptionUpdateParamsStatus ¶
type EventSubscriptionUpdateParamsStatus string
The status to update the Event Subscription with.
const ( // The subscription is active and Events will be delivered normally. EventSubscriptionUpdateParamsStatusActive EventSubscriptionUpdateParamsStatus = "active" // The subscription is temporarily disabled and Events will not be delivered. EventSubscriptionUpdateParamsStatusDisabled EventSubscriptionUpdateParamsStatus = "disabled" // The subscription is permanently disabled and Events will not be delivered. EventSubscriptionUpdateParamsStatusDeleted EventSubscriptionUpdateParamsStatus = "deleted" )
type EventType ¶
type EventType string
A constant representing the object's type. For this resource it will always be `event`.
const (
EventTypeEvent EventType = "event"
)
type Export ¶
type Export struct {
// The Export identifier.
ID string `json:"id,required"`
// The category of the Export. We may add additional possible values for this enum
// over time; your application should be able to handle that gracefully.
Category ExportCategory `json:"category,required"`
// The time the Export was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A URL at which the Export's file can be downloaded. This will be present when
// the Export's status transitions to `complete`.
FileDownloadURL string `json:"file_download_url,required,nullable"`
// The File containing the contents of the Export. This will be present when the
// Export's status transitions to `complete`.
FileID string `json:"file_id,required,nullable"`
// The status of the Export.
Status ExportStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `export`.
Type ExportType `json:"type,required"`
JSON exportJSON
}
Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).
func (*Export) UnmarshalJSON ¶
type ExportCategory ¶
type ExportCategory string
The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.
const ( // Export a CSV of all transactions for a given time range. ExportCategoryTransactionCsv ExportCategory = "transaction_csv" // Export a CSV of account balances for the dates in a given range. ExportCategoryBalanceCsv ExportCategory = "balance_csv" )
type ExportListParams ¶
type ExportListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (ExportListParams) URLQuery ¶
func (r ExportListParams) URLQuery() (v url.Values)
URLQuery serializes ExportListParams's query parameters as `url.Values`.
type ExportNewParams ¶
type ExportNewParams struct {
// The type of Export to create.
Category param.Field[ExportNewParamsCategory] `json:"category,required"`
// Options for the created export. Required if `category` is equal to
// `balance_csv`.
BalanceCsv param.Field[ExportNewParamsBalanceCsv] `json:"balance_csv"`
// Options for the created export. Required if `category` is equal to
// `transaction_csv`.
TransactionCsv param.Field[ExportNewParamsTransactionCsv] `json:"transaction_csv"`
}
func (ExportNewParams) MarshalJSON ¶
func (r ExportNewParams) MarshalJSON() (data []byte, err error)
type ExportNewParamsBalanceCsv ¶
type ExportNewParamsBalanceCsv struct {
// Filter exported Transactions to the specified Account.
AccountID param.Field[string] `json:"account_id"`
// Filter results by time range on the `created_at` attribute.
CreatedAt param.Field[ExportNewParamsBalanceCsvCreatedAt] `json:"created_at"`
}
Options for the created export. Required if `category` is equal to `balance_csv`.
func (ExportNewParamsBalanceCsv) MarshalJSON ¶ added in v0.1.1
func (r ExportNewParamsBalanceCsv) MarshalJSON() (data []byte, err error)
type ExportNewParamsBalanceCsvCreatedAt ¶
type ExportNewParamsBalanceCsvCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `json:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `json:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `json:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `json:"on_or_before" format:"date-time"`
}
Filter results by time range on the `created_at` attribute.
func (ExportNewParamsBalanceCsvCreatedAt) MarshalJSON ¶ added in v0.1.1
func (r ExportNewParamsBalanceCsvCreatedAt) MarshalJSON() (data []byte, err error)
type ExportNewParamsCategory ¶
type ExportNewParamsCategory string
The type of Export to create.
const ( // Export a CSV of all transactions for a given time range. ExportNewParamsCategoryTransactionCsv ExportNewParamsCategory = "transaction_csv" // Export a CSV of account balances for the dates in a given range. ExportNewParamsCategoryBalanceCsv ExportNewParamsCategory = "balance_csv" )
type ExportNewParamsTransactionCsv ¶
type ExportNewParamsTransactionCsv struct {
// Filter exported Transactions to the specified Account.
AccountID param.Field[string] `json:"account_id"`
// Filter results by time range on the `created_at` attribute.
CreatedAt param.Field[ExportNewParamsTransactionCsvCreatedAt] `json:"created_at"`
}
Options for the created export. Required if `category` is equal to `transaction_csv`.
func (ExportNewParamsTransactionCsv) MarshalJSON ¶ added in v0.1.1
func (r ExportNewParamsTransactionCsv) MarshalJSON() (data []byte, err error)
type ExportNewParamsTransactionCsvCreatedAt ¶
type ExportNewParamsTransactionCsvCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `json:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `json:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `json:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `json:"on_or_before" format:"date-time"`
}
Filter results by time range on the `created_at` attribute.
func (ExportNewParamsTransactionCsvCreatedAt) MarshalJSON ¶ added in v0.1.1
func (r ExportNewParamsTransactionCsvCreatedAt) MarshalJSON() (data []byte, err error)
type ExportService ¶
type ExportService struct {
Options []option.RequestOption
}
ExportService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewExportService method instead.
func NewExportService ¶
func NewExportService(opts ...option.RequestOption) (r *ExportService)
NewExportService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ExportService) Get ¶
func (r *ExportService) Get(ctx context.Context, exportID string, opts ...option.RequestOption) (res *Export, err error)
Retrieve an Export
func (*ExportService) List ¶
func (r *ExportService) List(ctx context.Context, query ExportListParams, opts ...option.RequestOption) (res *shared.Page[Export], err error)
List Exports
func (*ExportService) ListAutoPaging ¶
func (r *ExportService) ListAutoPaging(ctx context.Context, query ExportListParams, opts ...option.RequestOption) *shared.PageAutoPager[Export]
List Exports
func (*ExportService) New ¶
func (r *ExportService) New(ctx context.Context, body ExportNewParams, opts ...option.RequestOption) (res *Export, err error)
Create an Export
type ExportStatus ¶
type ExportStatus string
The status of the Export.
const ( // Increase is generating the export. ExportStatusPending ExportStatus = "pending" // The export has been successfully generated. ExportStatusComplete ExportStatus = "complete" )
type ExportType ¶
type ExportType string
A constant representing the object's type. For this resource it will always be `export`.
const (
ExportTypeExport ExportType = "export"
)
type ExternalAccount ¶
type ExternalAccount struct {
// The External Account's identifier.
ID string `json:"id,required"`
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the External Account was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The External Account's description for display purposes.
Description string `json:"description,required"`
// The type of the account to which the transfer will be sent.
Funding ExternalAccountFunding `json:"funding,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
// The External Account's status.
Status ExternalAccountStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `external_account`.
Type ExternalAccountType `json:"type,required"`
// If you have verified ownership of the External Account.
VerificationStatus ExternalAccountVerificationStatus `json:"verification_status,required"`
JSON externalAccountJSON
}
External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
func (*ExternalAccount) UnmarshalJSON ¶
func (r *ExternalAccount) UnmarshalJSON(data []byte) (err error)
type ExternalAccountFunding ¶
type ExternalAccountFunding string
The type of the account to which the transfer will be sent.
const ( // A checking account. ExternalAccountFundingChecking ExternalAccountFunding = "checking" // A savings account. ExternalAccountFundingSavings ExternalAccountFunding = "savings" // A different type of account. ExternalAccountFundingOther ExternalAccountFunding = "other" )
type ExternalAccountListParams ¶
type ExternalAccountListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
Status param.Field[ExternalAccountListParamsStatus] `query:"status"`
}
func (ExternalAccountListParams) URLQuery ¶
func (r ExternalAccountListParams) URLQuery() (v url.Values)
URLQuery serializes ExternalAccountListParams's query parameters as `url.Values`.
type ExternalAccountListParamsStatus ¶
type ExternalAccountListParamsStatus struct {
// Filter External Accounts for those with the specified status or statuses. For
// GET requests, this should be encoded as a comma-delimited string, such as
// `?in=one,two,three`.
In param.Field[[]ExternalAccountListParamsStatusIn] `query:"in"`
}
func (ExternalAccountListParamsStatus) URLQuery ¶
func (r ExternalAccountListParamsStatus) URLQuery() (v url.Values)
URLQuery serializes ExternalAccountListParamsStatus's query parameters as `url.Values`.
type ExternalAccountListParamsStatusIn ¶
type ExternalAccountListParamsStatusIn string
const ( // The External Account is active. ExternalAccountListParamsStatusInActive ExternalAccountListParamsStatusIn = "active" // The External Account is archived and won't appear in the dashboard. ExternalAccountListParamsStatusInArchived ExternalAccountListParamsStatusIn = "archived" )
type ExternalAccountNewParams ¶
type ExternalAccountNewParams struct {
// The account number for the destination account.
AccountNumber param.Field[string] `json:"account_number,required"`
// The name you choose for the Account.
Description param.Field[string] `json:"description,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
// destination account.
RoutingNumber param.Field[string] `json:"routing_number,required"`
// The type of the destination account. Defaults to `checking`.
Funding param.Field[ExternalAccountNewParamsFunding] `json:"funding"`
}
func (ExternalAccountNewParams) MarshalJSON ¶
func (r ExternalAccountNewParams) MarshalJSON() (data []byte, err error)
type ExternalAccountNewParamsFunding ¶
type ExternalAccountNewParamsFunding string
The type of the destination account. Defaults to `checking`.
const ( // A checking account. ExternalAccountNewParamsFundingChecking ExternalAccountNewParamsFunding = "checking" // A savings account. ExternalAccountNewParamsFundingSavings ExternalAccountNewParamsFunding = "savings" // A different type of account. ExternalAccountNewParamsFundingOther ExternalAccountNewParamsFunding = "other" )
type ExternalAccountService ¶
type ExternalAccountService struct {
Options []option.RequestOption
}
ExternalAccountService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewExternalAccountService method instead.
func NewExternalAccountService ¶
func NewExternalAccountService(opts ...option.RequestOption) (r *ExternalAccountService)
NewExternalAccountService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ExternalAccountService) Get ¶
func (r *ExternalAccountService) Get(ctx context.Context, externalAccountID string, opts ...option.RequestOption) (res *ExternalAccount, err error)
Retrieve an External Account
func (*ExternalAccountService) List ¶
func (r *ExternalAccountService) List(ctx context.Context, query ExternalAccountListParams, opts ...option.RequestOption) (res *shared.Page[ExternalAccount], err error)
List External Accounts
func (*ExternalAccountService) ListAutoPaging ¶
func (r *ExternalAccountService) ListAutoPaging(ctx context.Context, query ExternalAccountListParams, opts ...option.RequestOption) *shared.PageAutoPager[ExternalAccount]
List External Accounts
func (*ExternalAccountService) New ¶
func (r *ExternalAccountService) New(ctx context.Context, body ExternalAccountNewParams, opts ...option.RequestOption) (res *ExternalAccount, err error)
Create an External Account
func (*ExternalAccountService) Update ¶
func (r *ExternalAccountService) Update(ctx context.Context, externalAccountID string, body ExternalAccountUpdateParams, opts ...option.RequestOption) (res *ExternalAccount, err error)
Update an External Account
type ExternalAccountStatus ¶
type ExternalAccountStatus string
The External Account's status.
const ( // The External Account is active. ExternalAccountStatusActive ExternalAccountStatus = "active" // The External Account is archived and won't appear in the dashboard. ExternalAccountStatusArchived ExternalAccountStatus = "archived" )
type ExternalAccountType ¶
type ExternalAccountType string
A constant representing the object's type. For this resource it will always be `external_account`.
const (
ExternalAccountTypeExternalAccount ExternalAccountType = "external_account"
)
type ExternalAccountUpdateParams ¶
type ExternalAccountUpdateParams struct {
// The description you choose to give the external account.
Description param.Field[string] `json:"description"`
// The status of the External Account.
Status param.Field[ExternalAccountUpdateParamsStatus] `json:"status"`
}
func (ExternalAccountUpdateParams) MarshalJSON ¶
func (r ExternalAccountUpdateParams) MarshalJSON() (data []byte, err error)
type ExternalAccountUpdateParamsStatus ¶
type ExternalAccountUpdateParamsStatus string
The status of the External Account.
const ( // The External Account is active. ExternalAccountUpdateParamsStatusActive ExternalAccountUpdateParamsStatus = "active" // The External Account is archived and won't appear in the dashboard. ExternalAccountUpdateParamsStatusArchived ExternalAccountUpdateParamsStatus = "archived" )
type ExternalAccountVerificationStatus ¶
type ExternalAccountVerificationStatus string
If you have verified ownership of the External Account.
const ( // The External Account has not been verified. ExternalAccountVerificationStatusUnverified ExternalAccountVerificationStatus = "unverified" // The External Account is in the process of being verified. ExternalAccountVerificationStatusPending ExternalAccountVerificationStatus = "pending" // The External Account is verified. ExternalAccountVerificationStatusVerified ExternalAccountVerificationStatus = "verified" )
type File ¶
type File struct {
// The File's identifier.
ID string `json:"id,required"`
// The time the File was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A description of the File.
Description string `json:"description,required,nullable"`
// Whether the File was generated by Increase or by you and sent to Increase.
Direction FileDirection `json:"direction,required"`
// A URL from where the File can be downloaded at this point in time. The location
// of this URL may change over time.
DownloadURL string `json:"download_url,required,nullable"`
// The filename that was provided upon upload or generated by Increase.
Filename string `json:"filename,required,nullable"`
// What the File will be used for. We may add additional possible values for this
// enum over time; your application should be able to handle such additions
// gracefully.
Purpose FilePurpose `json:"purpose,required"`
// A constant representing the object's type. For this resource it will always be
// `file`.
Type FileType `json:"type,required"`
JSON fileJSON
}
Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF).
func (*File) UnmarshalJSON ¶
type FileDirection ¶
type FileDirection string
Whether the File was generated by Increase or by you and sent to Increase.
const ( // This File was sent by you to Increase. FileDirectionToIncrease FileDirection = "to_increase" // This File was generated by Increase. FileDirectionFromIncrease FileDirection = "from_increase" )
type FileListParams ¶
type FileListParams struct {
CreatedAt param.Field[FileListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
Purpose param.Field[FileListParamsPurpose] `query:"purpose"`
}
func (FileListParams) URLQuery ¶
func (r FileListParams) URLQuery() (v url.Values)
URLQuery serializes FileListParams's query parameters as `url.Values`.
type FileListParamsCreatedAt ¶
type FileListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (FileListParamsCreatedAt) URLQuery ¶
func (r FileListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes FileListParamsCreatedAt's query parameters as `url.Values`.
type FileListParamsPurpose ¶
type FileListParamsPurpose struct {
// Filter Files for those with the specified purpose or purposes. For GET requests,
// this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
In param.Field[[]FileListParamsPurposeIn] `query:"in"`
}
func (FileListParamsPurpose) URLQuery ¶
func (r FileListParamsPurpose) URLQuery() (v url.Values)
URLQuery serializes FileListParamsPurpose's query parameters as `url.Values`.
type FileListParamsPurposeIn ¶
type FileListParamsPurposeIn string
const ( // An image of the front of a check, used for check deposits. FileListParamsPurposeInCheckImageFront FileListParamsPurposeIn = "check_image_front" // An image of the back of a check, used for check deposits. FileListParamsPurposeInCheckImageBack FileListParamsPurposeIn = "check_image_back" // An image of a check that was mailed to a recipient. FileListParamsPurposeInMailedCheckImage FileListParamsPurposeIn = "mailed_check_image" // IRS Form 1099-INT. FileListParamsPurposeInForm1099Int FileListParamsPurposeIn = "form_1099_int" // IRS Form SS-4. FileListParamsPurposeInFormSS4 FileListParamsPurposeIn = "form_ss_4" // An image of a government-issued ID. FileListParamsPurposeInIdentityDocument FileListParamsPurposeIn = "identity_document" // A statement generated by Increase. FileListParamsPurposeInIncreaseStatement FileListParamsPurposeIn = "increase_statement" // A file purpose not covered by any of the other cases. FileListParamsPurposeInOther FileListParamsPurposeIn = "other" // A legal document forming a trust. FileListParamsPurposeInTrustFormationDocument FileListParamsPurposeIn = "trust_formation_document" // A card image to be rendered inside digital wallet apps. This must be a 1536x969 // pixel PNG. FileListParamsPurposeInDigitalWalletArtwork FileListParamsPurposeIn = "digital_wallet_artwork" // An icon for you app to be rendered inside digital wallet apps. This must be a // 100x100 pixel PNG. FileListParamsPurposeInDigitalWalletAppIcon FileListParamsPurposeIn = "digital_wallet_app_icon" // A card image to be printed on the front of a physical card. This must be a // 2100x1340 pixel PNG with no other color but black. FileListParamsPurposeInPhysicalCardFront FileListParamsPurposeIn = "physical_card_front" // The image to be printed on the back of a physical card. FileListParamsPurposeInPhysicalCardBack FileListParamsPurposeIn = "physical_card_back" // An image representing the entirety of the carrier used for a physical card. This // must be a 2550x3300 pixel PNG with no other color but black. FileListParamsPurposeInPhysicalCardCarrier FileListParamsPurposeIn = "physical_card_carrier" // A document requested by Increase. FileListParamsPurposeInDocumentRequest FileListParamsPurposeIn = "document_request" // A supplemental document associated an an Entity. FileListParamsPurposeInEntitySupplementalDocument FileListParamsPurposeIn = "entity_supplemental_document" // The results of an Export you requested via the dashboard or API. FileListParamsPurposeInExport FileListParamsPurposeIn = "export" )
type FileNewParams ¶
type FileNewParams struct {
// The file contents. This should follow the specifications of
// [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file
// transfers for the multipart/form-data protocol.
File param.Field[io.Reader] `json:"file,required" format:"binary"`
// What the File will be used for in Increase's systems.
Purpose param.Field[FileNewParamsPurpose] `json:"purpose,required"`
// The description you choose to give the File.
Description param.Field[string] `json:"description"`
}
func (FileNewParams) MarshalMultipart ¶
func (r FileNewParams) MarshalMultipart() (data []byte, contentType string, err error)
type FileNewParamsPurpose ¶
type FileNewParamsPurpose string
What the File will be used for in Increase's systems.
const ( // An image of the front of a check, used for check deposits. FileNewParamsPurposeCheckImageFront FileNewParamsPurpose = "check_image_front" // An image of the back of a check, used for check deposits. FileNewParamsPurposeCheckImageBack FileNewParamsPurpose = "check_image_back" // An image of a check that was mailed to a recipient. FileNewParamsPurposeMailedCheckImage FileNewParamsPurpose = "mailed_check_image" // IRS Form SS-4. FileNewParamsPurposeFormSS4 FileNewParamsPurpose = "form_ss_4" // An image of a government-issued ID. FileNewParamsPurposeIdentityDocument FileNewParamsPurpose = "identity_document" // A file purpose not covered by any of the other cases. FileNewParamsPurposeOther FileNewParamsPurpose = "other" // A legal document forming a trust. FileNewParamsPurposeTrustFormationDocument FileNewParamsPurpose = "trust_formation_document" // A card image to be rendered inside digital wallet apps. This must be a 1536x969 // pixel PNG. FileNewParamsPurposeDigitalWalletArtwork FileNewParamsPurpose = "digital_wallet_artwork" // An icon for you app to be rendered inside digital wallet apps. This must be a // 100x100 pixel PNG. FileNewParamsPurposeDigitalWalletAppIcon FileNewParamsPurpose = "digital_wallet_app_icon" // A card image to be printed on the front of a physical card. This must be a // 2100x1340 pixel PNG with no other color but black. FileNewParamsPurposePhysicalCardFront FileNewParamsPurpose = "physical_card_front" // An image representing the entirety of the carrier used for a physical card. This // must be a 2550x3300 pixel PNG with no other color but black. FileNewParamsPurposePhysicalCardCarrier FileNewParamsPurpose = "physical_card_carrier" // A document requested by Increase. FileNewParamsPurposeDocumentRequest FileNewParamsPurpose = "document_request" // A supplemental document associated an an Entity. FileNewParamsPurposeEntitySupplementalDocument FileNewParamsPurpose = "entity_supplemental_document" )
type FilePurpose ¶
type FilePurpose string
What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // An image of the front of a check, used for check deposits. FilePurposeCheckImageFront FilePurpose = "check_image_front" // An image of the back of a check, used for check deposits. FilePurposeCheckImageBack FilePurpose = "check_image_back" // An image of a check that was mailed to a recipient. FilePurposeMailedCheckImage FilePurpose = "mailed_check_image" // IRS Form 1099-INT. FilePurposeForm1099Int FilePurpose = "form_1099_int" // IRS Form SS-4. FilePurposeFormSS4 FilePurpose = "form_ss_4" // An image of a government-issued ID. FilePurposeIdentityDocument FilePurpose = "identity_document" // A statement generated by Increase. FilePurposeIncreaseStatement FilePurpose = "increase_statement" // A file purpose not covered by any of the other cases. FilePurposeOther FilePurpose = "other" // A legal document forming a trust. FilePurposeTrustFormationDocument FilePurpose = "trust_formation_document" // A card image to be rendered inside digital wallet apps. This must be a 1536x969 // pixel PNG. FilePurposeDigitalWalletArtwork FilePurpose = "digital_wallet_artwork" // An icon for you app to be rendered inside digital wallet apps. This must be a // 100x100 pixel PNG. FilePurposeDigitalWalletAppIcon FilePurpose = "digital_wallet_app_icon" // A card image to be printed on the front of a physical card. This must be a // 2100x1340 pixel PNG with no other color but black. FilePurposePhysicalCardFront FilePurpose = "physical_card_front" // The image to be printed on the back of a physical card. FilePurposePhysicalCardBack FilePurpose = "physical_card_back" // An image representing the entirety of the carrier used for a physical card. This // must be a 2550x3300 pixel PNG with no other color but black. FilePurposePhysicalCardCarrier FilePurpose = "physical_card_carrier" // A document requested by Increase. FilePurposeDocumentRequest FilePurpose = "document_request" // A supplemental document associated an an Entity. FilePurposeEntitySupplementalDocument FilePurpose = "entity_supplemental_document" // The results of an Export you requested via the dashboard or API. FilePurposeExport FilePurpose = "export" )
type FileService ¶
type FileService struct {
Options []option.RequestOption
}
FileService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewFileService method instead.
func NewFileService ¶
func NewFileService(opts ...option.RequestOption) (r *FileService)
NewFileService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*FileService) Get ¶
func (r *FileService) Get(ctx context.Context, fileID string, opts ...option.RequestOption) (res *File, err error)
Retrieve a File
func (*FileService) List ¶
func (r *FileService) List(ctx context.Context, query FileListParams, opts ...option.RequestOption) (res *shared.Page[File], err error)
List Files
func (*FileService) ListAutoPaging ¶
func (r *FileService) ListAutoPaging(ctx context.Context, query FileListParams, opts ...option.RequestOption) *shared.PageAutoPager[File]
List Files
func (*FileService) New ¶
func (r *FileService) New(ctx context.Context, body FileNewParams, opts ...option.RequestOption) (res *File, err error)
To upload a file to Increase, you'll need to send a request of Content-Type `multipart/form-data`. The request should contain the file you would like to upload, as well as the parameters for creating a file.
type FileType ¶
type FileType string
A constant representing the object's type. For this resource it will always be `file`.
const (
FileTypeFile FileType = "file"
)
type Group ¶
type Group struct {
// The Group identifier.
ID string `json:"id,required"`
// If the Group is allowed to create ACH debits.
ACHDebitStatus GroupACHDebitStatus `json:"ach_debit_status,required"`
// If the Group is activated or not.
ActivationStatus GroupActivationStatus `json:"activation_status,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// A constant representing the object's type. For this resource it will always be
// `group`.
Type GroupType `json:"type,required"`
JSON groupJSON
}
Groups represent organizations using Increase. You can retrieve information about your own organization via the API, or (more commonly) OAuth platforms can retrieve information about the organizations that have granted them access.
func (*Group) UnmarshalJSON ¶
type GroupACHDebitStatus ¶
type GroupACHDebitStatus string
If the Group is allowed to create ACH debits.
const ( // The Group cannot make ACH debits. GroupACHDebitStatusDisabled GroupACHDebitStatus = "disabled" // The Group can make ACH debits. GroupACHDebitStatusEnabled GroupACHDebitStatus = "enabled" )
type GroupActivationStatus ¶
type GroupActivationStatus string
If the Group is activated or not.
const ( // The Group is not activated. GroupActivationStatusUnactivated GroupActivationStatus = "unactivated" // The Group is activated. GroupActivationStatusActivated GroupActivationStatus = "activated" )
type GroupService ¶
type GroupService struct {
Options []option.RequestOption
}
GroupService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewGroupService method instead.
func NewGroupService ¶
func NewGroupService(opts ...option.RequestOption) (r *GroupService)
NewGroupService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*GroupService) GetDetails ¶
func (r *GroupService) GetDetails(ctx context.Context, opts ...option.RequestOption) (res *Group, err error)
Returns details for the currently authenticated Group.
type GroupType ¶
type GroupType string
A constant representing the object's type. For this resource it will always be `group`.
const (
GroupTypeGroup GroupType = "group"
)
type InboundACHTransfer ¶ added in v0.7.1
type InboundACHTransfer struct {
// The inbound ach transfer's identifier.
ID string `json:"id,required"`
// If your transfer is accepted, this will contain details of the acceptance.
Acceptance InboundACHTransferAcceptance `json:"acceptance,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The time at which the transfer will be automatically resolved.
AutomaticallyResolvesAt time.Time `json:"automatically_resolves_at,required" format:"date-time"`
// If your transfer is declined, this will contain details of the decline.
Decline InboundACHTransferDecline `json:"decline,required,nullable"`
// The direction of the transfer.
Direction InboundACHTransferDirection `json:"direction,required"`
// The descriptive date of the transfer.
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
// The additional information included with the transfer.
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
// The description of the transfer.
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
// The id of the company that initiated the transfer.
OriginatorCompanyID string `json:"originator_company_id,required"`
// The name of the company that initiated the transfer.
OriginatorCompanyName string `json:"originator_company_name,required"`
// The id of the receiver of the transfer.
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
// The name of the receiver of the transfer.
ReceiverName string `json:"receiver_name,required,nullable"`
// The status of the transfer.
Status InboundACHTransferStatus `json:"status,required"`
// The trace number of the transfer.
TraceNumber string `json:"trace_number,required"`
// If your transfer is returned, this will contain details of the return.
TransferReturn InboundACHTransferTransferReturn `json:"transfer_return,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `inbound_ach_transfer`.
Type InboundACHTransferType `json:"type,required"`
JSON inboundACHTransferJSON
}
An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.
func (*InboundACHTransfer) UnmarshalJSON ¶ added in v0.7.1
func (r *InboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type InboundACHTransferAcceptance ¶ added in v0.7.1
type InboundACHTransferAcceptance struct {
// The time at which the transfer was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The id of the transaction for the accepted transfer.
TransactionID string `json:"transaction_id,required"`
JSON inboundACHTransferAcceptanceJSON
}
If your transfer is accepted, this will contain details of the acceptance.
func (*InboundACHTransferAcceptance) UnmarshalJSON ¶ added in v0.7.1
func (r *InboundACHTransferAcceptance) UnmarshalJSON(data []byte) (err error)
type InboundACHTransferDecline ¶ added in v0.7.1
type InboundACHTransferDecline struct {
// The time at which the transfer was declined.
DeclinedAt time.Time `json:"declined_at,required" format:"date-time"`
// The id of the transaction for the declined transfer.
DeclinedTransactionID string `json:"declined_transaction_id,required"`
// The reason for the transfer decline
Reason InboundACHTransferDeclineReason `json:"reason,required"`
JSON inboundACHTransferDeclineJSON
}
If your transfer is declined, this will contain details of the decline.
func (*InboundACHTransferDecline) UnmarshalJSON ¶ added in v0.7.1
func (r *InboundACHTransferDecline) UnmarshalJSON(data []byte) (err error)
type InboundACHTransferDeclineReason ¶ added in v0.7.1
type InboundACHTransferDeclineReason string
The reason for the transfer decline
const ( // The account number is canceled. InboundACHTransferDeclineReasonACHRouteCanceled InboundACHTransferDeclineReason = "ach_route_canceled" // The account number is disabled. InboundACHTransferDeclineReasonACHRouteDisabled InboundACHTransferDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. InboundACHTransferDeclineReasonBreachesLimit InboundACHTransferDeclineReason = "breaches_limit" // A credit was refused. InboundACHTransferDeclineReasonCreditEntryRefusedByReceiver InboundACHTransferDeclineReason = "credit_entry_refused_by_receiver" // Other. InboundACHTransferDeclineReasonDuplicateReturn InboundACHTransferDeclineReason = "duplicate_return" // The account's entity is not active. InboundACHTransferDeclineReasonEntityNotActive InboundACHTransferDeclineReason = "entity_not_active" // Your account is inactive. InboundACHTransferDeclineReasonGroupLocked InboundACHTransferDeclineReason = "group_locked" // Your account contains insufficient funds. InboundACHTransferDeclineReasonInsufficientFunds InboundACHTransferDeclineReason = "insufficient_funds" // Other. InboundACHTransferDeclineReasonMisroutedReturn InboundACHTransferDeclineReason = "misrouted_return" // Other. InboundACHTransferDeclineReasonReturnOfErroneousOrReversingDebit InboundACHTransferDeclineReason = "return_of_erroneous_or_reversing_debit" // The account number that was debited does not exist. InboundACHTransferDeclineReasonNoACHRoute InboundACHTransferDeclineReason = "no_ach_route" // Other. InboundACHTransferDeclineReasonOriginatorRequest InboundACHTransferDeclineReason = "originator_request" // The transaction is not allowed per Increase's terms. InboundACHTransferDeclineReasonTransactionNotAllowed InboundACHTransferDeclineReason = "transaction_not_allowed" // The user initiated the decline. InboundACHTransferDeclineReasonUserInitiated InboundACHTransferDeclineReason = "user_initiated" )
type InboundACHTransferDirection ¶ added in v0.7.1
type InboundACHTransferDirection string
The direction of the transfer.
const ( // Credit InboundACHTransferDirectionCredit InboundACHTransferDirection = "credit" // Debit InboundACHTransferDirectionDebit InboundACHTransferDirection = "debit" )
type InboundACHTransferListParams ¶ added in v0.7.1
type InboundACHTransferListParams struct {
// Filter Inbound ACH Tranfers to ones belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[InboundACHTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Inbound ACH Transfers to those with the specified status.
Status param.Field[InboundACHTransferListParamsStatus] `query:"status"`
}
func (InboundACHTransferListParams) URLQuery ¶ added in v0.7.1
func (r InboundACHTransferListParams) URLQuery() (v url.Values)
URLQuery serializes InboundACHTransferListParams's query parameters as `url.Values`.
type InboundACHTransferListParamsCreatedAt ¶ added in v0.7.1
type InboundACHTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (InboundACHTransferListParamsCreatedAt) URLQuery ¶ added in v0.7.1
func (r InboundACHTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes InboundACHTransferListParamsCreatedAt's query parameters as `url.Values`.
type InboundACHTransferListParamsStatus ¶ added in v0.7.1
type InboundACHTransferListParamsStatus string
Filter Inbound ACH Transfers to those with the specified status.
const ( // The Inbound ACH Transfer is awaiting action, will transition automatically if no // action is taken. InboundACHTransferListParamsStatusPending InboundACHTransferListParamsStatus = "pending" // The Inbound ACH Transfer has been declined. InboundACHTransferListParamsStatusDeclined InboundACHTransferListParamsStatus = "declined" // The Inbound ACH Transfer is accepted. InboundACHTransferListParamsStatusAccepted InboundACHTransferListParamsStatus = "accepted" // The Inbound ACH Transfer has been returned. InboundACHTransferListParamsStatusReturned InboundACHTransferListParamsStatus = "returned" )
type InboundACHTransferService ¶ added in v0.7.1
type InboundACHTransferService struct {
Options []option.RequestOption
}
InboundACHTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInboundACHTransferService method instead.
func NewInboundACHTransferService ¶ added in v0.7.1
func NewInboundACHTransferService(opts ...option.RequestOption) (r *InboundACHTransferService)
NewInboundACHTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*InboundACHTransferService) Decline ¶ added in v0.7.1
func (r *InboundACHTransferService) Decline(ctx context.Context, inboundACHTransferID string, opts ...option.RequestOption) (res *InboundACHTransfer, err error)
Decline an Inbound ACH Transfer
func (*InboundACHTransferService) Get ¶ added in v0.7.1
func (r *InboundACHTransferService) Get(ctx context.Context, inboundACHTransferID string, opts ...option.RequestOption) (res *InboundACHTransfer, err error)
Retrieve an Inbound ACH Transfer
func (*InboundACHTransferService) List ¶ added in v0.7.1
func (r *InboundACHTransferService) List(ctx context.Context, query InboundACHTransferListParams, opts ...option.RequestOption) (res *shared.Page[InboundACHTransfer], err error)
List Inbound ACH Transfers
func (*InboundACHTransferService) ListAutoPaging ¶ added in v0.7.1
func (r *InboundACHTransferService) ListAutoPaging(ctx context.Context, query InboundACHTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[InboundACHTransfer]
List Inbound ACH Transfers
func (*InboundACHTransferService) TransferReturn ¶ added in v0.7.1
func (r *InboundACHTransferService) TransferReturn(ctx context.Context, inboundACHTransferID string, body InboundACHTransferTransferReturnParams, opts ...option.RequestOption) (res *InboundACHTransfer, err error)
Return an Inbound ACH Transfer
type InboundACHTransferStatus ¶ added in v0.7.1
type InboundACHTransferStatus string
The status of the transfer.
const ( // The Inbound ACH Transfer is awaiting action, will transition automatically if no // action is taken. InboundACHTransferStatusPending InboundACHTransferStatus = "pending" // The Inbound ACH Transfer has been declined. InboundACHTransferStatusDeclined InboundACHTransferStatus = "declined" // The Inbound ACH Transfer is accepted. InboundACHTransferStatusAccepted InboundACHTransferStatus = "accepted" // The Inbound ACH Transfer has been returned. InboundACHTransferStatusReturned InboundACHTransferStatus = "returned" )
type InboundACHTransferTransferReturn ¶ added in v0.7.1
type InboundACHTransferTransferReturn struct {
// The reason for the transfer return
Reason InboundACHTransferTransferReturnReason `json:"reason,required"`
// The time at which the transfer was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The id of the transaction for the returned transfer.
TransactionID string `json:"transaction_id,required"`
JSON inboundACHTransferTransferReturnJSON
}
If your transfer is returned, this will contain details of the return.
func (*InboundACHTransferTransferReturn) UnmarshalJSON ¶ added in v0.7.1
func (r *InboundACHTransferTransferReturn) UnmarshalJSON(data []byte) (err error)
type InboundACHTransferTransferReturnParams ¶ added in v0.7.1
type InboundACHTransferTransferReturnParams struct {
// The reason why this transfer will be returned. The most usual return codes are
// `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
Reason param.Field[InboundACHTransferTransferReturnParamsReason] `json:"reason,required"`
}
func (InboundACHTransferTransferReturnParams) MarshalJSON ¶ added in v0.7.1
func (r InboundACHTransferTransferReturnParams) MarshalJSON() (data []byte, err error)
type InboundACHTransferTransferReturnParamsReason ¶ added in v0.7.1
type InboundACHTransferTransferReturnParamsReason string
The reason why this transfer will be returned. The most usual return codes are `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
const ( // The customer no longer authorizes this transaction. The Nacha return code is // R07. InboundACHTransferTransferReturnParamsReasonAuthorizationRevokedByCustomer InboundACHTransferTransferReturnParamsReason = "authorization_revoked_by_customer" // The customer asked for the payment to be stopped. This reason is only allowed // for debits. The Nacha return code is R08. InboundACHTransferTransferReturnParamsReasonPaymentStopped InboundACHTransferTransferReturnParamsReason = "payment_stopped" // R10. InboundACHTransferTransferReturnParamsReasonCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete InboundACHTransferTransferReturnParamsReason = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // The payee is deceased. The Nacha return code is R14. InboundACHTransferTransferReturnParamsReasonRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity InboundACHTransferTransferReturnParamsReason = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // The account holder is deceased. The Nacha return code is R15. InboundACHTransferTransferReturnParamsReasonBeneficiaryOrAccountHolderDeceased InboundACHTransferTransferReturnParamsReason = "beneficiary_or_account_holder_deceased" // The customer refused a credit entry. This reason is only allowed for credits. // The Nacha return code is R23. InboundACHTransferTransferReturnParamsReasonCreditEntryRefusedByReceiver InboundACHTransferTransferReturnParamsReason = "credit_entry_refused_by_receiver" // The account holder identified this transaction as a duplicate. The Nacha return // code is R24. InboundACHTransferTransferReturnParamsReasonDuplicateEntry InboundACHTransferTransferReturnParamsReason = "duplicate_entry" // The corporate customer no longer authorizes this transaction. The Nacha return // code is R29. InboundACHTransferTransferReturnParamsReasonCorporateCustomerAdvisedNotAuthorized InboundACHTransferTransferReturnParamsReason = "corporate_customer_advised_not_authorized" )
type InboundACHTransferTransferReturnReason ¶ added in v0.7.1
type InboundACHTransferTransferReturnReason string
The reason for the transfer return
const ( // The customer no longer authorizes this transaction. The Nacha return code is // R07. InboundACHTransferTransferReturnReasonAuthorizationRevokedByCustomer InboundACHTransferTransferReturnReason = "authorization_revoked_by_customer" // The customer asked for the payment to be stopped. This reason is only allowed // for debits. The Nacha return code is R08. InboundACHTransferTransferReturnReasonPaymentStopped InboundACHTransferTransferReturnReason = "payment_stopped" // R10. InboundACHTransferTransferReturnReasonCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete InboundACHTransferTransferReturnReason = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // The payee is deceased. The Nacha return code is R14. InboundACHTransferTransferReturnReasonRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity InboundACHTransferTransferReturnReason = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // The account holder is deceased. The Nacha return code is R15. InboundACHTransferTransferReturnReasonBeneficiaryOrAccountHolderDeceased InboundACHTransferTransferReturnReason = "beneficiary_or_account_holder_deceased" // The customer refused a credit entry. This reason is only allowed for credits. // The Nacha return code is R23. InboundACHTransferTransferReturnReasonCreditEntryRefusedByReceiver InboundACHTransferTransferReturnReason = "credit_entry_refused_by_receiver" // The account holder identified this transaction as a duplicate. The Nacha return // code is R24. InboundACHTransferTransferReturnReasonDuplicateEntry InboundACHTransferTransferReturnReason = "duplicate_entry" // The corporate customer no longer authorizes this transaction. The Nacha return // code is R29. InboundACHTransferTransferReturnReasonCorporateCustomerAdvisedNotAuthorized InboundACHTransferTransferReturnReason = "corporate_customer_advised_not_authorized" )
type InboundACHTransferType ¶ added in v0.7.1
type InboundACHTransferType string
A constant representing the object's type. For this resource it will always be `inbound_ach_transfer`.
const (
InboundACHTransferTypeInboundACHTransfer InboundACHTransferType = "inbound_ach_transfer"
)
type InboundRealTimePaymentsTransferSimulationResult ¶
type InboundRealTimePaymentsTransferSimulationResult struct {
// If the Real-Time Payments Transfer attempt fails, this will contain the
// resulting [Declined Transaction](#declined-transactions) object. The Declined
// Transaction's `source` will be of
// `category: inbound_real_time_payments_transfer_decline`.
DeclinedTransaction InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction `json:"declined_transaction,required,nullable"`
// If the Real-Time Payments Transfer attempt succeeds, this will contain the
// resulting [Transaction](#transactions) object. The Transaction's `source` will
// be of `category: inbound_real_time_payments_transfer_confirmation`.
Transaction InboundRealTimePaymentsTransferSimulationResultTransaction `json:"transaction,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `inbound_real_time_payments_transfer_simulation_result`.
Type InboundRealTimePaymentsTransferSimulationResultType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultJSON
}
The results of an inbound Real-Time Payments Transfer simulation.
func (*InboundRealTimePaymentsTransferSimulationResult) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResult) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction struct {
// The Declined Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Declined Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Declined Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined
// Transaction's currency. This will match the currency on the Declined
// Transaction's Account.
Currency InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency `json:"currency,required"`
// This is the description the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Declined Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Declined Transaction came through.
RouteType InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Declined Transaction. For example, for a card transaction this lists the
// merchant's industry and location. Note that for backwards compatibility reasons,
// additional undocumented keys may appear in this object. These should be treated
// as deprecated and will be removed in the future.
Source InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `declined_transaction`.
Type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionJSON
}
If the Real-Time Payments Transfer attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: inbound_real_time_payments_transfer_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransaction) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyCad InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyChf InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyEur InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyGbp InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyJpy InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrencyUsd InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType string
The type of the route this Declined Transaction came through.
const ( // An Account Number. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteTypeAccountNumber InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType = "account_number" // A Card. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteTypeCard InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionRouteType = "card" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource struct {
// An ACH Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `ach_decline`.
ACHDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline `json:"ach_decline,required,nullable"`
// A Card Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `card_decline`.
CardDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline `json:"card_decline,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory `json:"category,required"`
// A Check Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `check_decline`.
CheckDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline `json:"check_decline,required,nullable"`
// An Inbound Real-Time Payments Transfer Decline object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_decline`.
InboundRealTimePaymentsTransferDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline `json:"inbound_real_time_payments_transfer_decline,required,nullable"`
// An International ACH Decline object. This field will be present in the JSON
// response if and only if `category` is equal to `international_ach_decline`.
InternationalACHDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline `json:"international_ach_decline,required,nullable"`
// A Wire Decline object. This field will be present in the JSON response if and
// only if `category` is equal to `wire_decline`.
WireDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline `json:"wire_decline,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSource) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline struct {
// The ACH Decline's identifier.
ID string `json:"id,required"`
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The descriptive date of the transfer.
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
// The additional information included with the transfer.
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
// The identifier of the company that initiated the transfer.
OriginatorCompanyID string `json:"originator_company_id,required"`
// The name of the company that initiated the transfer.
OriginatorCompanyName string `json:"originator_company_name,required"`
// Why the ACH transfer was declined.
Reason InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason `json:"reason,required"`
// The id of the receiver of the transfer.
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
// The name of the receiver of the transfer.
ReceiverName string `json:"receiver_name,required,nullable"`
// The trace number of the transfer.
TraceNumber string `json:"trace_number,required"`
// A constant representing the object's type. For this resource it will always be
// `ach_decline`.
Type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineJSON
}
An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason string
Why the ACH transfer was declined.
const ( // The account number is canceled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonACHRouteCanceled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "ach_route_canceled" // The account number is disabled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonACHRouteDisabled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonBreachesLimit InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "breaches_limit" // A credit was refused. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonCreditEntryRefusedByReceiver InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "credit_entry_refused_by_receiver" // Other. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonDuplicateReturn InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "duplicate_return" // The account's entity is not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonEntityNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "entity_not_active" // Your account is inactive. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonGroupLocked InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "group_locked" // Your account contains insufficient funds. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonInsufficientFunds InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "insufficient_funds" // Other. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonMisroutedReturn InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "misrouted_return" // Other. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonReturnOfErroneousOrReversingDebit InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "return_of_erroneous_or_reversing_debit" // The account number that was debited does not exist. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonNoACHRoute InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "no_ach_route" // Other. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonOriginatorRequest InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "originator_request" // The transaction is not allowed per Increase's terms. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonTransactionNotAllowed InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "transaction_not_allowed" // The user initiated the decline. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReasonUserInitiated InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineReason = "user_initiated" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineType ¶ added in v0.7.1
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineType string
A constant representing the object's type. For this resource it will always be `ach_decline`.
const (
InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineTypeACHDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceACHDeclineType = "ach_decline"
)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Fields specific to the `network`
NetworkDetails InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails `json:"network_details,required"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// Why the transaction was declined.
Reason InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason `json:"reason,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineJSON
}
A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyCad InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyChf InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyEur InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyGbp InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyJpy InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrencyUsd InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails struct {
// The payment network used to process this card authorization
Category InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa `json:"visa,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsJSON
}
Fields specific to the `network`
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetails) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategory ¶ added in v0.6.0
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategoryVisa InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsCategory = "visa" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorRecurring InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorInstallment InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeUnknown InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeManual InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeOpticalCode InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactless InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason string
Why the transaction was declined.
const ( // The Card was not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonCardNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "card_not_active" // The Physical Card was not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonPhysicalCardNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "physical_card_not_active" // The account's entity was not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonEntityNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "entity_not_active" // The account was inactive. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonGroupLocked InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "group_locked" // The Card's Account did not have a sufficient available balance. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonInsufficientFunds InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "insufficient_funds" // The given CVV2 did not match the card's value. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonCvv2Mismatch InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "cvv2_mismatch" // The attempted card transaction is not allowed per Increase's terms. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonTransactionNotAllowed InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "transaction_not_allowed" // The transaction was blocked by a Limit. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonBreachesLimit InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "breaches_limit" // Your application declined the transaction via webhook. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonWebhookDeclined InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "webhook_declined" // Your application webhook did not respond without the required timeout. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonWebhookTimedOut InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "webhook_timed_out" // Declined by stand-in processing. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonDeclinedByStandInProcessing InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "declined_by_stand_in_processing" // The card read had an invalid CVV, dCVV, or authorization request cryptogram. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonInvalidPhysicalCard InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "invalid_physical_card" // The original card authorization for this incremental authorization does not // exist. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonMissingOriginalAuthorization InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "missing_original_authorization" // The transaction was suspected to be fraudulent. Please reach out to // support@increase.com for more information. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReasonSuspectedFraud InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCardDeclineReason = "suspected_fraud" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // ACH Decline: details will be under the `ach_decline` object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryACHDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "ach_decline" // Card Decline: details will be under the `card_decline` object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryCardDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "card_decline" // Check Decline: details will be under the `check_decline` object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryCheckDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "check_decline" // Inbound Real-Time Payments Transfer Decline: details will be under the // `inbound_real_time_payments_transfer_decline` object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryInboundRealTimePaymentsTransferDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "inbound_real_time_payments_transfer_decline" // International ACH Decline: details will be under the `international_ach_decline` // object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryInternationalACHDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "international_ach_decline" // Wire Decline: details will be under the `wire_decline` object. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryWireDecline InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "wire_decline" // The Declined Transaction was made for an undocumented or deprecated reason. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategoryOther InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCategory = "other" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// Why the check was declined.
Reason InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason `json:"reason,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineJSON
}
A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason string
Why the check was declined.
const ( // The account number is canceled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonACHRouteCanceled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "ach_route_canceled" // The account number is disabled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonACHRouteDisabled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "ach_route_disabled" // The transaction would cause a limit to be exceeded. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonBreachesLimit InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "breaches_limit" // The account's entity is not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonEntityNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "entity_not_active" // Your account is inactive. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonGroupLocked InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "group_locked" // Your account contains insufficient funds. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonInsufficientFunds InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "insufficient_funds" // Unable to locate account. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonUnableToLocateAccount InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "unable_to_locate_account" // Routing number on the check is not ours. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonNotOurItem InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "not_our_item" // Unable to process. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonUnableToProcess InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "unable_to_process" // Refer to image. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonReferToImage InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "refer_to_image" // Stop payment requested for this check. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonStopPaymentRequested InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "stop_payment_requested" // Check was returned to sender. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonReturned InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "returned" // The check was a duplicate deposit. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonDuplicatePresentment InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "duplicate_presentment" // The transaction is not allowed. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonNotAuthorized InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "not_authorized" // The check was altered or fictitious. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReasonAlteredOrFictitious InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceCheckDeclineReason = "altered_or_fictitious" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined
// transfer's currency. This will always be "USD" for a Real-Time Payments
// transfer.
Currency InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Why the transfer was declined.
Reason InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason `json:"reason,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the declined transfer.
TransactionIdentification string `json:"transaction_identification,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineJSON
}
An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyCad InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyChf InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyEur InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyGbp InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyJpy InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrencyUsd InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason string
Why the transfer was declined.
const ( // The account number is canceled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberCanceled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_canceled" // The account number is disabled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountNumberDisabled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_number_disabled" // Your account is restricted. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonAccountRestricted InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "account_restricted" // Your account is inactive. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonGroupLocked InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "group_locked" // The account's entity is not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonEntityNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "entity_not_active" // Your account is not enabled to receive Real-Time Payments transfers. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReasonRealTimePaymentsNotEnabled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInboundRealTimePaymentsTransferDeclineReason = "real_time_payments_not_enabled" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDeclineJSON
}
An International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceInternationalACHDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline struct {
// The declined amount in the minor unit of the destination account currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
// Why the wire transfer was declined.
Reason InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason `json:"reason,required"`
JSON inboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineJSON
}
A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`.
func (*InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDecline) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason string
Why the wire transfer was declined.
const ( // The account number is canceled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonAccountNumberCanceled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "account_number_canceled" // The account number is disabled. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonAccountNumberDisabled InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "account_number_disabled" // The account's entity is not active. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonEntityNotActive InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "entity_not_active" // Your account is inactive. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonGroupLocked InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "group_locked" // The beneficiary account number does not exist. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonNoAccountNumber InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "no_account_number" // The transaction is not allowed per Increase's terms. InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReasonTransactionNotAllowed InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionSourceWireDeclineReason = "transaction_not_allowed" )
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionType ¶
type InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionType string
A constant representing the object's type. For this resource it will always be `declined_transaction`.
const (
InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionTypeDeclinedTransaction InboundRealTimePaymentsTransferSimulationResultDeclinedTransactionType = "declined_transaction"
)
type InboundRealTimePaymentsTransferSimulationResultTransaction ¶
type InboundRealTimePaymentsTransferSimulationResultTransaction struct {
// The Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Transaction amount in the minor unit of its currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// Transaction's currency. This will match the currency on the Transaction's
// Account.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionCurrency `json:"currency,required"`
// An informational message describing this transaction. Use the fields in `source`
// to get more detailed information. This field appears as the line-item on the
// statement.
Description string `json:"description,required"`
// The identifier for the route this Transaction came through. Routes are things
// like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Transaction came through.
RouteType InboundRealTimePaymentsTransferSimulationResultTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Transaction. Note that for backwards compatibility reasons, additional
// undocumented keys may appear in this object. These should be treated as
// deprecated and will be removed in the future.
Source InboundRealTimePaymentsTransferSimulationResultTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `transaction`.
Type InboundRealTimePaymentsTransferSimulationResultTransactionType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionJSON
}
If the Real-Time Payments Transfer attempt succeeds, this will contain the resulting Transaction(#transactions) object. The Transaction's `source` will be of `category: inbound_real_time_payments_transfer_confirmation`.
func (*InboundRealTimePaymentsTransferSimulationResultTransaction) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransaction) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionRouteType ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionRouteType string
The type of the route this Transaction came through.
const ( // An Account Number. InboundRealTimePaymentsTransferSimulationResultTransactionRouteTypeAccountNumber InboundRealTimePaymentsTransferSimulationResultTransactionRouteType = "account_number" // A Card. InboundRealTimePaymentsTransferSimulationResultTransactionRouteTypeCard InboundRealTimePaymentsTransferSimulationResultTransactionRouteType = "card" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSource ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSource struct {
// An Account Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_intention`.
AccountTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention `json:"account_transfer_intention,required,nullable"`
// An ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_intention`.
ACHTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention `json:"ach_transfer_intention,required,nullable"`
// An ACH Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_rejection`.
ACHTransferRejection InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection `json:"ach_transfer_rejection,required,nullable"`
// An ACH Transfer Return object. This field will be present in the JSON response
// if and only if `category` is equal to `ach_transfer_return`.
ACHTransferReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn `json:"ach_transfer_return,required,nullable"`
// A Card Dispute Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `card_dispute_acceptance`.
CardDisputeAcceptance InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance `json:"card_dispute_acceptance,required,nullable"`
// A Card Refund object. This field will be present in the JSON response if and
// only if `category` is equal to `card_refund`.
CardRefund InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund `json:"card_refund,required,nullable"`
// A Card Revenue Payment object. This field will be present in the JSON response
// if and only if `category` is equal to `card_revenue_payment`.
CardRevenuePayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment `json:"card_revenue_payment,required,nullable"`
// A Card Settlement object. This field will be present in the JSON response if and
// only if `category` is equal to `card_settlement`.
CardSettlement InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement `json:"card_settlement,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory `json:"category,required"`
// A Check Deposit Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_acceptance`.
CheckDepositAcceptance InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance `json:"check_deposit_acceptance,required,nullable"`
// A Check Deposit Return object. This field will be present in the JSON response
// if and only if `category` is equal to `check_deposit_return`.
CheckDepositReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn `json:"check_deposit_return,required,nullable"`
// A Check Transfer Deposit object. This field will be present in the JSON response
// if and only if `category` is equal to `check_transfer_deposit`.
CheckTransferDeposit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit `json:"check_transfer_deposit,required,nullable"`
// A Check Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_intention`.
CheckTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention `json:"check_transfer_intention,required,nullable"`
// A Check Transfer Stop Payment Request object. This field will be present in the
// JSON response if and only if `category` is equal to
// `check_transfer_stop_payment_request`.
CheckTransferStopPaymentRequest InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest `json:"check_transfer_stop_payment_request,required,nullable"`
// A Fee Payment object. This field will be present in the JSON response if and
// only if `category` is equal to `fee_payment`.
FeePayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment `json:"fee_payment,required,nullable"`
// An Inbound ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_ach_transfer`.
InboundACHTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer `json:"inbound_ach_transfer,required,nullable"`
// An Inbound Check object. This field will be present in the JSON response if and
// only if `category` is equal to `inbound_check`.
InboundCheck InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck `json:"inbound_check,required,nullable"`
// An Inbound International ACH Transfer object. This field will be present in the
// JSON response if and only if `category` is equal to
// `inbound_international_ach_transfer`.
InboundInternationalACHTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer `json:"inbound_international_ach_transfer,required,nullable"`
// An Inbound Real-Time Payments Transfer Confirmation object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_confirmation`.
InboundRealTimePaymentsTransferConfirmation InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation `json:"inbound_real_time_payments_transfer_confirmation,required,nullable"`
// An Inbound Wire Drawdown Payment object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
InboundWireDrawdownPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment `json:"inbound_wire_drawdown_payment,required,nullable"`
// An Inbound Wire Drawdown Payment Reversal object. This field will be present in
// the JSON response if and only if `category` is equal to
// `inbound_wire_drawdown_payment_reversal`.
InboundWireDrawdownPaymentReversal InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal `json:"inbound_wire_drawdown_payment_reversal,required,nullable"`
// An Inbound Wire Reversal object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_reversal`.
InboundWireReversal InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal `json:"inbound_wire_reversal,required,nullable"`
// An Inbound Wire Transfer object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_transfer`.
InboundWireTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer `json:"inbound_wire_transfer,required,nullable"`
// An Interest Payment object. This field will be present in the JSON response if
// and only if `category` is equal to `interest_payment`.
InterestPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment `json:"interest_payment,required,nullable"`
// An Internal Source object. This field will be present in the JSON response if
// and only if `category` is equal to `internal_source`.
InternalSource InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource `json:"internal_source,required,nullable"`
// A Real-Time Payments Transfer Acknowledgement object. This field will be present
// in the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_acknowledgement`.
RealTimePaymentsTransferAcknowledgement InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement `json:"real_time_payments_transfer_acknowledgement,required,nullable"`
// A Sample Funds object. This field will be present in the JSON response if and
// only if `category` is equal to `sample_funds`.
SampleFunds InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds `json:"sample_funds,required,nullable"`
// A Wire Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_intention`.
WireTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention `json:"wire_transfer_intention,required,nullable"`
// A Wire Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_rejection`.
WireTransferRejection InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection `json:"wire_transfer_rejection,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSource) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSource) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention struct {
AccountNumber string `json:"account_number,required"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
RoutingNumber string `json:"routing_number,required"`
StatementDescriptor string `json:"statement_descriptor,required"`
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntentionJSON
}
An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferIntention) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection struct {
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejectionJSON
}
An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferRejection) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnJSON
}
An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInsufficientFund InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNoAccount InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountClosed InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePaymentStopped InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonTransactionAccount InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUncollectedFunds InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAmountFieldError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeFileRecordEditCriteria InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualName InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeLimitedParticipationDfi InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAddendaError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCorrectedReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeDuplicateEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeDuplicateReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeFieldError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeIatEntryCodingError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidCompanyID InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMandatoryFieldError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMisroutedReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNoErrorsFound InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonParticipantInIatProgram InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRdfiNonSettlement InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnNotADuplicate InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfXckEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeTimelyOriginalReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeTraceNumberError InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUntimelyReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "untimely_return" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency `json:"currency,required"`
// The description you chose to give the transfer.
Description string `json:"description,required"`
// The identifier of the Account to where the Account Transfer was sent.
DestinationAccountID string `json:"destination_account_id,required"`
// The identifier of the Account from where the Account Transfer was sent.
SourceAccountID string `json:"source_account_id,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionJSON
}
An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntention) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceAccountTransferIntentionCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptanceJSON
}
A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund struct {
// The Card Refund identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_refund`.
Type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundJSON
}
A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefund) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails struct {
// Fields specific to car rentals.
CarRental InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesNoExtraCharge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesGas InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesExtraMileage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesLateReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesOneWayServiceFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesParkingViolation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNotApplicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesNoExtraCharge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesRestaurant InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesGiftShop InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesMiniBar InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesTelephone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "telephone" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "other" // Laundry InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesLaundry InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "laundry" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNotApplicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNoShow InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatFreeText InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatOrderNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServiceJSON
}
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBundledService InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryChangeFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCargo InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGiftCard InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryLounge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMedical InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPets InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategorySeatFees InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStandby InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryServiceFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStore InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryTravelService InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUpgrades InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryWifi InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorNoCredit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNewTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegJSON
}
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundType ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundType string
A constant representing the object's type. For this resource it will always be `card_refund`.
const (
InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundTypeCardRefund InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRefundType = "card_refund"
)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
// The account the card belonged to.
TransactedOnAccountID string `json:"transacted_on_account_id,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentJSON
}
A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePayment) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardRevenuePaymentCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement struct {
// The Card Settlement identifier.
ID string `json:"id,required"`
// The amount in the minor unit of the transaction's settlement currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The Card Authorization that was created prior to this Card Settlement, if on
// exists.
CardAuthorization string `json:"card_authorization,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's settlement currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The amount in the minor unit of the transaction's presentment currency.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's presentment currency.
PresentmentCurrency string `json:"presentment_currency,required"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_settlement`.
Type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementJSON
}
A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlement) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails struct {
// Fields specific to car rentals.
CarRental InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesNoExtraCharge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesGas InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesExtraMileage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesLateReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesOneWayServiceFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesParkingViolation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNotApplicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesNoExtraCharge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesRestaurant InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesGiftShop InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesMiniBar InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesTelephone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "telephone" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "other" // Laundry InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesLaundry InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "laundry" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNotApplicable InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNoShow InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatFreeText InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatOrderNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServiceJSON
}
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBundledService InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryChangeFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCargo InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGiftCard InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryLounge InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMedical InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPets InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategorySeatFees InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStandby InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryServiceFee InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStore InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryTravelService InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUpgrades InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryWifi InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorNoCredit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNewTicket InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegJSON
}
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeNone InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementType ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementType string
A constant representing the object's type. For this resource it will always be `card_settlement`.
const (
InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementTypeCardSettlement InboundRealTimePaymentsTransferSimulationResultTransactionSourceCardSettlementType = "card_settlement"
)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryAccountTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryACHTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryACHTransferRejection InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryACHTransferReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCardDisputeAcceptance InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCardRefund InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCardRevenuePayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCardSettlement InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCheckDepositAcceptance InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCheckDepositReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCheckTransferDeposit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCheckTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryCheckTransferStopPaymentRequest InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryFeePayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundACHTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundACHTransferReturnIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundCheck InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundInternationalACHTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundRealTimePaymentsTransferConfirmation InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundWireDrawdownPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundWireDrawdownPaymentReversal InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundWireReversal InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInboundWireTransfer InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInterestPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "interest_payment" // Internal Source: details will be under the `internal_source` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryInternalSource InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryRealTimePaymentsTransferAcknowledgement InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategorySampleFunds InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryWireTransferIntention InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryWireTransferRejection InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategoryOther InboundRealTimePaymentsTransferSimulationResultTransactionSourceCategory = "other" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceJSON
}
A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency `json:"currency,required"`
ReturnReason InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnJSON
}
A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturn) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonACHConversionNotSupported InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonClosedAccount InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "closed_account" // The check has already been deposited. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonDuplicateSubmission InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "duplicate_submission" // Insufficient funds InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonInsufficientFunds InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonNoAccount InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "no_account" // The check was not authorized. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonNotAuthorized InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "not_authorized" // The check is too old. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonStaleDated InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonStopPayment InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnknownReason InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnmatchedDetails InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unmatched_details" // The image could not be read. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnreadableImage InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReasonEndorsementIrregular InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckDepositReturnReturnReason = "endorsement_irregular" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit ¶ added in v0.3.0
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositJSON
}
A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit) UnmarshalJSON ¶ added in v0.3.0
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositType ¶ added in v0.3.0
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositTypeCheckTransferDeposit InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferDepositType = "check_transfer_deposit"
)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention struct {
// The city of the check's destination.
AddressCity string `json:"address_city,required,nullable"`
// The street address of the check's destination.
AddressLine1 string `json:"address_line1,required,nullable"`
// The second line of the address of the check's destination.
AddressLine2 string `json:"address_line2,required,nullable"`
// The state of the check's destination.
AddressState string `json:"address_state,required,nullable"`
// The postal code of the check's destination.
AddressZip string `json:"address_zip,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency `json:"currency,required"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required,nullable"`
// The identifier of the Check Transfer with which this is associated.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionJSON
}
A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntention) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferIntentionCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestType `json:"type,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestJSON
}
A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonMailDeliveryFailed InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonRejectedByIncrease InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonUnknown InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "unknown" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestType ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest InboundRealTimePaymentsTransferSimulationResultTransactionSourceCheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency `json:"currency,required"`
// The start of this payment's fee period, usually the first day of a month.
FeePeriodStart time.Time `json:"fee_period_start,required" format:"date"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentJSON
}
A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePayment) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceFeePaymentCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCompanyID string `json:"originator_company_id,required"`
OriginatorCompanyName string `json:"originator_company_name,required"`
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
ReceiverName string `json:"receiver_name,required,nullable"`
TraceNumber string `json:"trace_number,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransferJSON
}
An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
CheckFrontImageFileID string `json:"check_front_image_file_id,required,nullable"`
CheckNumber string `json:"check_number,required,nullable"`
CheckRearImageFileID string `json:"check_rear_image_file_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency `json:"currency,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckJSON
}
An Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheck) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundCheckCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransferJSON
}
An Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation struct {
// The amount in the minor unit of the transfer's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
// currency. This will always be "USD" for a Real-Time Payments transfer.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the transfer
TransactionIdentification string `json:"transaction_identification,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationJSON
}
An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentJSON
}
An Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversalJSON
}
An Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversalJSON
}
An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireReversal) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransferJSON
}
An Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInboundWireTransfer) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment struct {
// The account on which the interest was accrued.
AccruedOnAccountID string `json:"accrued_on_account_id,required,nullable"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentJSON
}
An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPayment) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceInterestPaymentCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency `json:"currency,required"`
Reason InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason `json:"reason,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceJSON
}
An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSource) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyCad InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "CAD" // Swiss Franc (CHF) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyChf InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "CHF" // Euro (EUR) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyEur InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "EUR" // British Pound (GBP) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyGbp InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "GBP" // Japanese Yen (JPY) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyJpy InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "JPY" // US Dollar (USD) InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrencyUsd InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceCurrency = "USD" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason string
const ( // Account closure InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonAccountClosure InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "account_closure" // Bank migration InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonBankMigration InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "bank_migration" // Cashback InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonCashback InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "cashback" // Check adjustment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonCheckAdjustment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "check_adjustment" // Collection receivable InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonCollectionReceivable InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "collection_receivable" // Empyreal adjustment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonEmpyrealAdjustment InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "empyreal_adjustment" // Error InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonError InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "error" // Error correction InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonErrorCorrection InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "error_correction" // Fees InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonFees InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "fees" // Interest InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonInterest InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "interest" // Negative balance forgiveness InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonNegativeBalanceForgiveness InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "negative_balance_forgiveness" // Sample funds InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonSampleFunds InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "sample_funds" // Sample funds return InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReasonSampleFundsReturn InboundRealTimePaymentsTransferSimulationResultTransactionSourceInternalSourceReason = "sample_funds_return" )
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement struct {
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The identifier of the Real-Time Payments Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgementJSON
}
A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds struct {
// Where the sample funds came from.
Originator string `json:"originator,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFundsJSON
}
A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceSampleFunds) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention struct {
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntentionJSON
}
A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferIntention) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection struct {
TransferID string `json:"transfer_id,required"`
JSON inboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejectionJSON
}
A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
func (*InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection) UnmarshalJSON ¶
func (r *InboundRealTimePaymentsTransferSimulationResultTransactionSourceWireTransferRejection) UnmarshalJSON(data []byte) (err error)
type InboundRealTimePaymentsTransferSimulationResultTransactionType ¶
type InboundRealTimePaymentsTransferSimulationResultTransactionType string
A constant representing the object's type. For this resource it will always be `transaction`.
const (
InboundRealTimePaymentsTransferSimulationResultTransactionTypeTransaction InboundRealTimePaymentsTransferSimulationResultTransactionType = "transaction"
)
type InboundRealTimePaymentsTransferSimulationResultType ¶
type InboundRealTimePaymentsTransferSimulationResultType string
A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer_simulation_result`.
const (
InboundRealTimePaymentsTransferSimulationResultTypeInboundRealTimePaymentsTransferSimulationResult InboundRealTimePaymentsTransferSimulationResultType = "inbound_real_time_payments_transfer_simulation_result"
)
type InboundWireDrawdownRequest ¶
type InboundWireDrawdownRequest struct {
// The Wire drawdown request identifier.
ID string `json:"id,required"`
// The amount being requested in cents.
Amount int64 `json:"amount,required"`
// The drawdown request's beneficiary's account number.
BeneficiaryAccountNumber string `json:"beneficiary_account_number,required"`
// Line 1 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
// Line 2 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
// Line 3 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
// The drawdown request's beneficiary's name.
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
// The drawdown request's beneficiary's routing number.
BeneficiaryRoutingNumber string `json:"beneficiary_routing_number,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
// requested. Will always be "USD".
Currency string `json:"currency,required"`
// A message from the drawdown request's originator.
MessageToRecipient string `json:"message_to_recipient,required,nullable"`
// The drawdown request's originator's account number.
OriginatorAccountNumber string `json:"originator_account_number,required"`
// Line 1 of the drawdown request's originator's address.
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
// Line 2 of the drawdown request's originator's address.
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
// Line 3 of the drawdown request's originator's address.
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
// The drawdown request's originator's name.
OriginatorName string `json:"originator_name,required,nullable"`
// The drawdown request's originator's routing number.
OriginatorRoutingNumber string `json:"originator_routing_number,required"`
// Line 1 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
// Line 2 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
// Line 3 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
// Line 4 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
// The Account Number from which the recipient of this request is being requested
// to send funds.
RecipientAccountNumberID string `json:"recipient_account_number_id,required"`
// A constant representing the object's type. For this resource it will always be
// `inbound_wire_drawdown_request`.
Type InboundWireDrawdownRequestType `json:"type,required"`
JSON inboundWireDrawdownRequestJSON
}
Inbound wire drawdown requests are requests from someone else to send them a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
func (*InboundWireDrawdownRequest) UnmarshalJSON ¶
func (r *InboundWireDrawdownRequest) UnmarshalJSON(data []byte) (err error)
type InboundWireDrawdownRequestListParams ¶
type InboundWireDrawdownRequestListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (InboundWireDrawdownRequestListParams) URLQuery ¶
func (r InboundWireDrawdownRequestListParams) URLQuery() (v url.Values)
URLQuery serializes InboundWireDrawdownRequestListParams's query parameters as `url.Values`.
type InboundWireDrawdownRequestService ¶
type InboundWireDrawdownRequestService struct {
Options []option.RequestOption
}
InboundWireDrawdownRequestService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInboundWireDrawdownRequestService method instead.
func NewInboundWireDrawdownRequestService ¶
func NewInboundWireDrawdownRequestService(opts ...option.RequestOption) (r *InboundWireDrawdownRequestService)
NewInboundWireDrawdownRequestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*InboundWireDrawdownRequestService) Get ¶
func (r *InboundWireDrawdownRequestService) Get(ctx context.Context, inboundWireDrawdownRequestID string, opts ...option.RequestOption) (res *InboundWireDrawdownRequest, err error)
Retrieve an Inbound Wire Drawdown Request
func (*InboundWireDrawdownRequestService) List ¶
func (r *InboundWireDrawdownRequestService) List(ctx context.Context, query InboundWireDrawdownRequestListParams, opts ...option.RequestOption) (res *shared.Page[InboundWireDrawdownRequest], err error)
List Inbound Wire Drawdown Requests
func (*InboundWireDrawdownRequestService) ListAutoPaging ¶
func (r *InboundWireDrawdownRequestService) ListAutoPaging(ctx context.Context, query InboundWireDrawdownRequestListParams, opts ...option.RequestOption) *shared.PageAutoPager[InboundWireDrawdownRequest]
List Inbound Wire Drawdown Requests
type InboundWireDrawdownRequestType ¶
type InboundWireDrawdownRequestType string
A constant representing the object's type. For this resource it will always be `inbound_wire_drawdown_request`.
const (
InboundWireDrawdownRequestTypeInboundWireDrawdownRequest InboundWireDrawdownRequestType = "inbound_wire_drawdown_request"
)
type InterestPaymentSimulationResult ¶
type InterestPaymentSimulationResult struct {
// This will contain the resulting [Transaction](#transactions) object. The
// Transaction's `source` will be of `category: interest_payment`.
Transaction InterestPaymentSimulationResultTransaction `json:"transaction,required"`
// A constant representing the object's type. For this resource it will always be
// `interest_payment_simulation_result`.
Type InterestPaymentSimulationResultType `json:"type,required"`
JSON interestPaymentSimulationResultJSON
}
The results of an Interest Payment simulation.
func (*InterestPaymentSimulationResult) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResult) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransaction ¶
type InterestPaymentSimulationResultTransaction struct {
// The Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Transaction amount in the minor unit of its currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// Transaction's currency. This will match the currency on the Transaction's
// Account.
Currency InterestPaymentSimulationResultTransactionCurrency `json:"currency,required"`
// An informational message describing this transaction. Use the fields in `source`
// to get more detailed information. This field appears as the line-item on the
// statement.
Description string `json:"description,required"`
// The identifier for the route this Transaction came through. Routes are things
// like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Transaction came through.
RouteType InterestPaymentSimulationResultTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Transaction. Note that for backwards compatibility reasons, additional
// undocumented keys may appear in this object. These should be treated as
// deprecated and will be removed in the future.
Source InterestPaymentSimulationResultTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `transaction`.
Type InterestPaymentSimulationResultTransactionType `json:"type,required"`
JSON interestPaymentSimulationResultTransactionJSON
}
This will contain the resulting Transaction(#transactions) object. The Transaction's `source` will be of `category: interest_payment`.
func (*InterestPaymentSimulationResultTransaction) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransaction) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionCurrency ¶
type InterestPaymentSimulationResultTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionCurrencyCad InterestPaymentSimulationResultTransactionCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionCurrencyChf InterestPaymentSimulationResultTransactionCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionCurrencyEur InterestPaymentSimulationResultTransactionCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionCurrencyGbp InterestPaymentSimulationResultTransactionCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionCurrencyJpy InterestPaymentSimulationResultTransactionCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionCurrencyUsd InterestPaymentSimulationResultTransactionCurrency = "USD" )
type InterestPaymentSimulationResultTransactionRouteType ¶
type InterestPaymentSimulationResultTransactionRouteType string
The type of the route this Transaction came through.
const ( // An Account Number. InterestPaymentSimulationResultTransactionRouteTypeAccountNumber InterestPaymentSimulationResultTransactionRouteType = "account_number" // A Card. InterestPaymentSimulationResultTransactionRouteTypeCard InterestPaymentSimulationResultTransactionRouteType = "card" )
type InterestPaymentSimulationResultTransactionSource ¶
type InterestPaymentSimulationResultTransactionSource struct {
// An Account Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_intention`.
AccountTransferIntention InterestPaymentSimulationResultTransactionSourceAccountTransferIntention `json:"account_transfer_intention,required,nullable"`
// An ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_intention`.
ACHTransferIntention InterestPaymentSimulationResultTransactionSourceACHTransferIntention `json:"ach_transfer_intention,required,nullable"`
// An ACH Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_rejection`.
ACHTransferRejection InterestPaymentSimulationResultTransactionSourceACHTransferRejection `json:"ach_transfer_rejection,required,nullable"`
// An ACH Transfer Return object. This field will be present in the JSON response
// if and only if `category` is equal to `ach_transfer_return`.
ACHTransferReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturn `json:"ach_transfer_return,required,nullable"`
// A Card Dispute Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `card_dispute_acceptance`.
CardDisputeAcceptance InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance `json:"card_dispute_acceptance,required,nullable"`
// A Card Refund object. This field will be present in the JSON response if and
// only if `category` is equal to `card_refund`.
CardRefund InterestPaymentSimulationResultTransactionSourceCardRefund `json:"card_refund,required,nullable"`
// A Card Revenue Payment object. This field will be present in the JSON response
// if and only if `category` is equal to `card_revenue_payment`.
CardRevenuePayment InterestPaymentSimulationResultTransactionSourceCardRevenuePayment `json:"card_revenue_payment,required,nullable"`
// A Card Settlement object. This field will be present in the JSON response if and
// only if `category` is equal to `card_settlement`.
CardSettlement InterestPaymentSimulationResultTransactionSourceCardSettlement `json:"card_settlement,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category InterestPaymentSimulationResultTransactionSourceCategory `json:"category,required"`
// A Check Deposit Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_acceptance`.
CheckDepositAcceptance InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance `json:"check_deposit_acceptance,required,nullable"`
// A Check Deposit Return object. This field will be present in the JSON response
// if and only if `category` is equal to `check_deposit_return`.
CheckDepositReturn InterestPaymentSimulationResultTransactionSourceCheckDepositReturn `json:"check_deposit_return,required,nullable"`
// A Check Transfer Deposit object. This field will be present in the JSON response
// if and only if `category` is equal to `check_transfer_deposit`.
CheckTransferDeposit InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit `json:"check_transfer_deposit,required,nullable"`
// A Check Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_intention`.
CheckTransferIntention InterestPaymentSimulationResultTransactionSourceCheckTransferIntention `json:"check_transfer_intention,required,nullable"`
// A Check Transfer Stop Payment Request object. This field will be present in the
// JSON response if and only if `category` is equal to
// `check_transfer_stop_payment_request`.
CheckTransferStopPaymentRequest InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest `json:"check_transfer_stop_payment_request,required,nullable"`
// A Fee Payment object. This field will be present in the JSON response if and
// only if `category` is equal to `fee_payment`.
FeePayment InterestPaymentSimulationResultTransactionSourceFeePayment `json:"fee_payment,required,nullable"`
// An Inbound ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_ach_transfer`.
InboundACHTransfer InterestPaymentSimulationResultTransactionSourceInboundACHTransfer `json:"inbound_ach_transfer,required,nullable"`
// An Inbound Check object. This field will be present in the JSON response if and
// only if `category` is equal to `inbound_check`.
InboundCheck InterestPaymentSimulationResultTransactionSourceInboundCheck `json:"inbound_check,required,nullable"`
// An Inbound International ACH Transfer object. This field will be present in the
// JSON response if and only if `category` is equal to
// `inbound_international_ach_transfer`.
InboundInternationalACHTransfer InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer `json:"inbound_international_ach_transfer,required,nullable"`
// An Inbound Real-Time Payments Transfer Confirmation object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_confirmation`.
InboundRealTimePaymentsTransferConfirmation InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation `json:"inbound_real_time_payments_transfer_confirmation,required,nullable"`
// An Inbound Wire Drawdown Payment object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
InboundWireDrawdownPayment InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment `json:"inbound_wire_drawdown_payment,required,nullable"`
// An Inbound Wire Drawdown Payment Reversal object. This field will be present in
// the JSON response if and only if `category` is equal to
// `inbound_wire_drawdown_payment_reversal`.
InboundWireDrawdownPaymentReversal InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal `json:"inbound_wire_drawdown_payment_reversal,required,nullable"`
// An Inbound Wire Reversal object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_reversal`.
InboundWireReversal InterestPaymentSimulationResultTransactionSourceInboundWireReversal `json:"inbound_wire_reversal,required,nullable"`
// An Inbound Wire Transfer object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_transfer`.
InboundWireTransfer InterestPaymentSimulationResultTransactionSourceInboundWireTransfer `json:"inbound_wire_transfer,required,nullable"`
// An Interest Payment object. This field will be present in the JSON response if
// and only if `category` is equal to `interest_payment`.
InterestPayment InterestPaymentSimulationResultTransactionSourceInterestPayment `json:"interest_payment,required,nullable"`
// An Internal Source object. This field will be present in the JSON response if
// and only if `category` is equal to `internal_source`.
InternalSource InterestPaymentSimulationResultTransactionSourceInternalSource `json:"internal_source,required,nullable"`
// A Real-Time Payments Transfer Acknowledgement object. This field will be present
// in the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_acknowledgement`.
RealTimePaymentsTransferAcknowledgement InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement `json:"real_time_payments_transfer_acknowledgement,required,nullable"`
// A Sample Funds object. This field will be present in the JSON response if and
// only if `category` is equal to `sample_funds`.
SampleFunds InterestPaymentSimulationResultTransactionSourceSampleFunds `json:"sample_funds,required,nullable"`
// A Wire Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_intention`.
WireTransferIntention InterestPaymentSimulationResultTransactionSourceWireTransferIntention `json:"wire_transfer_intention,required,nullable"`
// A Wire Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_rejection`.
WireTransferRejection InterestPaymentSimulationResultTransactionSourceWireTransferRejection `json:"wire_transfer_rejection,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*InterestPaymentSimulationResultTransactionSource) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSource) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceACHTransferIntention ¶
type InterestPaymentSimulationResultTransactionSourceACHTransferIntention struct {
AccountNumber string `json:"account_number,required"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
RoutingNumber string `json:"routing_number,required"`
StatementDescriptor string `json:"statement_descriptor,required"`
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceACHTransferIntentionJSON
}
An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
func (*InterestPaymentSimulationResultTransactionSourceACHTransferIntention) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceACHTransferIntention) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceACHTransferRejection ¶
type InterestPaymentSimulationResultTransactionSourceACHTransferRejection struct {
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceACHTransferRejectionJSON
}
An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
func (*InterestPaymentSimulationResultTransactionSourceACHTransferRejection) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceACHTransferRejection) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceACHTransferReturn ¶
type InterestPaymentSimulationResultTransactionSourceACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceACHTransferReturnJSON
}
An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
func (*InterestPaymentSimulationResultTransactionSourceACHTransferReturn) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode ¶
type InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInsufficientFund InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNoAccount InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountClosed InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePaymentStopped InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonTransactionAccount InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUncollectedFunds InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAmountFieldError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeFileRecordEditCriteria InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualName InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeLimitedParticipationDfi InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeAddendaError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeCorrectedReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeDuplicateEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeDuplicateReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeFieldError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeIatEntryCodingError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidCompanyID InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMandatoryFieldError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeMisroutedReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNoErrorsFound InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeNonParticipantInIatProgram InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRdfiNonSettlement InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnNotADuplicate InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeReturnOfXckEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeTimelyOriginalReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeTraceNumberError InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCodeUntimelyReturn InterestPaymentSimulationResultTransactionSourceACHTransferReturnReturnReasonCode = "untimely_return" )
type InterestPaymentSimulationResultTransactionSourceAccountTransferIntention ¶
type InterestPaymentSimulationResultTransactionSourceAccountTransferIntention struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency `json:"currency,required"`
// The description you chose to give the transfer.
Description string `json:"description,required"`
// The identifier of the Account to where the Account Transfer was sent.
DestinationAccountID string `json:"destination_account_id,required"`
// The identifier of the Account from where the Account Transfer was sent.
SourceAccountID string `json:"source_account_id,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceAccountTransferIntentionJSON
}
An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
func (*InterestPaymentSimulationResultTransactionSourceAccountTransferIntention) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceAccountTransferIntention) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency ¶
type InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyCad InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyChf InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyEur InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyGbp InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyJpy InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrencyUsd InterestPaymentSimulationResultTransactionSourceAccountTransferIntentionCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance ¶
type InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON interestPaymentSimulationResultTransactionSourceCardDisputeAcceptanceJSON
}
A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
func (*InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefund ¶
type InterestPaymentSimulationResultTransactionSourceCardRefund struct {
// The Card Refund identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InterestPaymentSimulationResultTransactionSourceCardRefundCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_refund`.
Type InterestPaymentSimulationResultTransactionSourceCardRefundType `json:"type,required"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundJSON
}
A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
func (*InterestPaymentSimulationResultTransactionSourceCardRefund) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCardRefund) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCardRefundCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyCad InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyChf InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyEur InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyGbp InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyJpy InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCardRefundCurrencyUsd InterestPaymentSimulationResultTransactionSourceCardRefundCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails struct {
// Fields specific to car rentals.
CarRental InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesNoExtraCharge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesGas InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesExtraMileage InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesLateReturn InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesOneWayServiceFee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesParkingViolation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNotApplicable InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesNoExtraCharge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesRestaurant InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesGiftShop InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesMiniBar InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesTelephone InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "telephone" // Other InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesOther InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "other" // Laundry InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesLaundry InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "laundry" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNotApplicable InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNoShow InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatFreeText InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatOrderNumber InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServiceJSON
}
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryNone InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBundledService InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryChangeFee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCargo InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGiftCard InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryLounge InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMedical InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryOther InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPets InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategorySeatFees InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStandby InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryServiceFee InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStore InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryTravelService InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUpgrades InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryWifi InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorNoCredit InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorOther InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNone InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNewTicket InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegJSON
}
func (*InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeNone InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed InterestPaymentSimulationResultTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type InterestPaymentSimulationResultTransactionSourceCardRefundType ¶
type InterestPaymentSimulationResultTransactionSourceCardRefundType string
A constant representing the object's type. For this resource it will always be `card_refund`.
const (
InterestPaymentSimulationResultTransactionSourceCardRefundTypeCardRefund InterestPaymentSimulationResultTransactionSourceCardRefundType = "card_refund"
)
type InterestPaymentSimulationResultTransactionSourceCardRevenuePayment ¶
type InterestPaymentSimulationResultTransactionSourceCardRevenuePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
// The account the card belonged to.
TransactedOnAccountID string `json:"transacted_on_account_id,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardRevenuePaymentJSON
}
A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
func (*InterestPaymentSimulationResultTransactionSourceCardRevenuePayment) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCardRevenuePayment) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyCad InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyChf InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyEur InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyGbp InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyJpy InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrencyUsd InterestPaymentSimulationResultTransactionSourceCardRevenuePaymentCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCardSettlement ¶
type InterestPaymentSimulationResultTransactionSourceCardSettlement struct {
// The Card Settlement identifier.
ID string `json:"id,required"`
// The amount in the minor unit of the transaction's settlement currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The Card Authorization that was created prior to this Card Settlement, if on
// exists.
CardAuthorization string `json:"card_authorization,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's settlement currency.
Currency InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The amount in the minor unit of the transaction's presentment currency.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's presentment currency.
PresentmentCurrency string `json:"presentment_currency,required"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_settlement`.
Type InterestPaymentSimulationResultTransactionSourceCardSettlementType `json:"type,required"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementJSON
}
A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlement) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlement) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyCad InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyChf InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyEur InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyGbp InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyJpy InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCardSettlementCurrencyUsd InterestPaymentSimulationResultTransactionSourceCardSettlementCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails struct {
// Fields specific to car rentals.
CarRental InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesNoExtraCharge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesGas InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesExtraMileage InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesLateReturn InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesOneWayServiceFee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesParkingViolation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNotApplicable InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesNoExtraCharge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesRestaurant InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesGiftShop InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesMiniBar InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesTelephone InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "telephone" // Other InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesOther InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "other" // Laundry InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesLaundry InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "laundry" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNotApplicable InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNoShow InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatFreeText InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatOrderNumber InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServiceJSON
}
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryNone InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBundledService InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryChangeFee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCargo InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGiftCard InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryLounge InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMedical InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryOther InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPets InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategorySeatFees InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStandby InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryServiceFee InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStore InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryTravelService InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUpgrades InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryWifi InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorNoCredit InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorOther InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNone InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNewTicket InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegJSON
}
func (*InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeNone InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed InterestPaymentSimulationResultTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type InterestPaymentSimulationResultTransactionSourceCardSettlementType ¶
type InterestPaymentSimulationResultTransactionSourceCardSettlementType string
A constant representing the object's type. For this resource it will always be `card_settlement`.
const (
InterestPaymentSimulationResultTransactionSourceCardSettlementTypeCardSettlement InterestPaymentSimulationResultTransactionSourceCardSettlementType = "card_settlement"
)
type InterestPaymentSimulationResultTransactionSourceCategory ¶
type InterestPaymentSimulationResultTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. InterestPaymentSimulationResultTransactionSourceCategoryAccountTransferIntention InterestPaymentSimulationResultTransactionSourceCategory = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. InterestPaymentSimulationResultTransactionSourceCategoryACHTransferIntention InterestPaymentSimulationResultTransactionSourceCategory = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. InterestPaymentSimulationResultTransactionSourceCategoryACHTransferRejection InterestPaymentSimulationResultTransactionSourceCategory = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. InterestPaymentSimulationResultTransactionSourceCategoryACHTransferReturn InterestPaymentSimulationResultTransactionSourceCategory = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. InterestPaymentSimulationResultTransactionSourceCategoryCardDisputeAcceptance InterestPaymentSimulationResultTransactionSourceCategory = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. InterestPaymentSimulationResultTransactionSourceCategoryCardRefund InterestPaymentSimulationResultTransactionSourceCategory = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. InterestPaymentSimulationResultTransactionSourceCategoryCardRevenuePayment InterestPaymentSimulationResultTransactionSourceCategory = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. InterestPaymentSimulationResultTransactionSourceCategoryCardSettlement InterestPaymentSimulationResultTransactionSourceCategory = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. InterestPaymentSimulationResultTransactionSourceCategoryCheckDepositAcceptance InterestPaymentSimulationResultTransactionSourceCategory = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. InterestPaymentSimulationResultTransactionSourceCategoryCheckDepositReturn InterestPaymentSimulationResultTransactionSourceCategory = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. InterestPaymentSimulationResultTransactionSourceCategoryCheckTransferDeposit InterestPaymentSimulationResultTransactionSourceCategory = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. InterestPaymentSimulationResultTransactionSourceCategoryCheckTransferIntention InterestPaymentSimulationResultTransactionSourceCategory = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. InterestPaymentSimulationResultTransactionSourceCategoryCheckTransferStopPaymentRequest InterestPaymentSimulationResultTransactionSourceCategory = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. InterestPaymentSimulationResultTransactionSourceCategoryFeePayment InterestPaymentSimulationResultTransactionSourceCategory = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. InterestPaymentSimulationResultTransactionSourceCategoryInboundACHTransfer InterestPaymentSimulationResultTransactionSourceCategory = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundACHTransferReturnIntention InterestPaymentSimulationResultTransactionSourceCategory = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundCheck InterestPaymentSimulationResultTransactionSourceCategory = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundInternationalACHTransfer InterestPaymentSimulationResultTransactionSourceCategory = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundRealTimePaymentsTransferConfirmation InterestPaymentSimulationResultTransactionSourceCategory = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundWireDrawdownPayment InterestPaymentSimulationResultTransactionSourceCategory = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundWireDrawdownPaymentReversal InterestPaymentSimulationResultTransactionSourceCategory = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundWireReversal InterestPaymentSimulationResultTransactionSourceCategory = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. InterestPaymentSimulationResultTransactionSourceCategoryInboundWireTransfer InterestPaymentSimulationResultTransactionSourceCategory = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. InterestPaymentSimulationResultTransactionSourceCategoryInterestPayment InterestPaymentSimulationResultTransactionSourceCategory = "interest_payment" // Internal Source: details will be under the `internal_source` object. InterestPaymentSimulationResultTransactionSourceCategoryInternalSource InterestPaymentSimulationResultTransactionSourceCategory = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. InterestPaymentSimulationResultTransactionSourceCategoryRealTimePaymentsTransferAcknowledgement InterestPaymentSimulationResultTransactionSourceCategory = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. InterestPaymentSimulationResultTransactionSourceCategorySampleFunds InterestPaymentSimulationResultTransactionSourceCategory = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. InterestPaymentSimulationResultTransactionSourceCategoryWireTransferIntention InterestPaymentSimulationResultTransactionSourceCategory = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. InterestPaymentSimulationResultTransactionSourceCategoryWireTransferRejection InterestPaymentSimulationResultTransactionSourceCategory = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. InterestPaymentSimulationResultTransactionSourceCategoryOther InterestPaymentSimulationResultTransactionSourceCategory = "other" )
type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance ¶
type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceJSON
}
A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
func (*InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyCad InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyChf InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyEur InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyGbp InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyJpy InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrencyUsd InterestPaymentSimulationResultTransactionSourceCheckDepositAcceptanceCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturn ¶
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency `json:"currency,required"`
ReturnReason InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON interestPaymentSimulationResultTransactionSourceCheckDepositReturnJSON
}
A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
func (*InterestPaymentSimulationResultTransactionSourceCheckDepositReturn) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCheckDepositReturn) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyCad InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyChf InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyEur InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyGbp InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyJpy InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrencyUsd InterestPaymentSimulationResultTransactionSourceCheckDepositReturnCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason ¶
type InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonACHConversionNotSupported InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonClosedAccount InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "closed_account" // The check has already been deposited. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonDuplicateSubmission InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "duplicate_submission" // Insufficient funds InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonInsufficientFunds InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonNoAccount InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "no_account" // The check was not authorized. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonNotAuthorized InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "not_authorized" // The check is too old. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonStaleDated InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonStopPayment InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnknownReason InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnmatchedDetails InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unmatched_details" // The image could not be read. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonUnreadableImage InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReasonEndorsementIrregular InterestPaymentSimulationResultTransactionSourceCheckDepositReturnReturnReason = "endorsement_irregular" )
type InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit ¶ added in v0.3.0
type InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type InterestPaymentSimulationResultTransactionSourceCheckTransferDepositType `json:"type,required"`
JSON interestPaymentSimulationResultTransactionSourceCheckTransferDepositJSON
}
A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`.
func (*InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit) UnmarshalJSON ¶ added in v0.3.0
func (r *InterestPaymentSimulationResultTransactionSourceCheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCheckTransferDepositType ¶ added in v0.3.0
type InterestPaymentSimulationResultTransactionSourceCheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
InterestPaymentSimulationResultTransactionSourceCheckTransferDepositTypeCheckTransferDeposit InterestPaymentSimulationResultTransactionSourceCheckTransferDepositType = "check_transfer_deposit"
)
type InterestPaymentSimulationResultTransactionSourceCheckTransferIntention ¶
type InterestPaymentSimulationResultTransactionSourceCheckTransferIntention struct {
// The city of the check's destination.
AddressCity string `json:"address_city,required,nullable"`
// The street address of the check's destination.
AddressLine1 string `json:"address_line1,required,nullable"`
// The second line of the address of the check's destination.
AddressLine2 string `json:"address_line2,required,nullable"`
// The state of the check's destination.
AddressState string `json:"address_state,required,nullable"`
// The postal code of the check's destination.
AddressZip string `json:"address_zip,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency `json:"currency,required"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required,nullable"`
// The identifier of the Check Transfer with which this is associated.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceCheckTransferIntentionJSON
}
A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
func (*InterestPaymentSimulationResultTransactionSourceCheckTransferIntention) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCheckTransferIntention) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency ¶
type InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyCad InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyChf InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyEur InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyGbp InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyJpy InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrencyUsd InterestPaymentSimulationResultTransactionSourceCheckTransferIntentionCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest ¶
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestType `json:"type,required"`
JSON interestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestJSON
}
A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
func (*InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonMailDeliveryFailed InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonRejectedByIncrease InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReasonUnknown InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestReason = "unknown" )
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestType ¶
type InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest InterestPaymentSimulationResultTransactionSourceCheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type InterestPaymentSimulationResultTransactionSourceFeePayment ¶
type InterestPaymentSimulationResultTransactionSourceFeePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency `json:"currency,required"`
// The start of this payment's fee period, usually the first day of a month.
FeePeriodStart time.Time `json:"fee_period_start,required" format:"date"`
JSON interestPaymentSimulationResultTransactionSourceFeePaymentJSON
}
A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
func (*InterestPaymentSimulationResultTransactionSourceFeePayment) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceFeePayment) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency ¶
type InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyCad InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyChf InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyEur InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyGbp InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyJpy InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceFeePaymentCurrencyUsd InterestPaymentSimulationResultTransactionSourceFeePaymentCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceInboundACHTransfer ¶
type InterestPaymentSimulationResultTransactionSourceInboundACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCompanyID string `json:"originator_company_id,required"`
OriginatorCompanyName string `json:"originator_company_name,required"`
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
ReceiverName string `json:"receiver_name,required,nullable"`
TraceNumber string `json:"trace_number,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundACHTransferJSON
}
An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
func (*InterestPaymentSimulationResultTransactionSourceInboundACHTransfer) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundCheck ¶
type InterestPaymentSimulationResultTransactionSourceInboundCheck struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
CheckFrontImageFileID string `json:"check_front_image_file_id,required,nullable"`
CheckNumber string `json:"check_number,required,nullable"`
CheckRearImageFileID string `json:"check_rear_image_file_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency `json:"currency,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundCheckJSON
}
An Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
func (*InterestPaymentSimulationResultTransactionSourceInboundCheck) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundCheck) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency ¶
type InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyCad InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyChf InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyEur InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyGbp InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyJpy InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceInboundCheckCurrencyUsd InterestPaymentSimulationResultTransactionSourceInboundCheckCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer ¶
type InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundInternationalACHTransferJSON
}
An Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
func (*InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation ¶
type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation struct {
// The amount in the minor unit of the transfer's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
// currency. This will always be "USD" for a Real-Time Payments transfer.
Currency InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the transfer
TransactionIdentification string `json:"transaction_identification,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationJSON
}
An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
func (*InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency ¶
type InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyCad InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyChf InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyEur InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyGbp InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyJpy InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyUsd InterestPaymentSimulationResultTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment ¶
type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentJSON
}
An Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
func (*InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal ¶
type InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversalJSON
}
An Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
func (*InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundWireReversal ¶
type InterestPaymentSimulationResultTransactionSourceInboundWireReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceInboundWireReversalJSON
}
An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
func (*InterestPaymentSimulationResultTransactionSourceInboundWireReversal) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundWireReversal) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInboundWireTransfer ¶
type InterestPaymentSimulationResultTransactionSourceInboundWireTransfer struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
JSON interestPaymentSimulationResultTransactionSourceInboundWireTransferJSON
}
An Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
func (*InterestPaymentSimulationResultTransactionSourceInboundWireTransfer) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInboundWireTransfer) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInterestPayment ¶
type InterestPaymentSimulationResultTransactionSourceInterestPayment struct {
// The account on which the interest was accrued.
AccruedOnAccountID string `json:"accrued_on_account_id,required,nullable"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
JSON interestPaymentSimulationResultTransactionSourceInterestPaymentJSON
}
An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
func (*InterestPaymentSimulationResultTransactionSourceInterestPayment) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInterestPayment) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency ¶
type InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyCad InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyChf InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyEur InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyGbp InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyJpy InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrencyUsd InterestPaymentSimulationResultTransactionSourceInterestPaymentCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceInternalSource ¶
type InterestPaymentSimulationResultTransactionSourceInternalSource struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency `json:"currency,required"`
Reason InterestPaymentSimulationResultTransactionSourceInternalSourceReason `json:"reason,required"`
JSON interestPaymentSimulationResultTransactionSourceInternalSourceJSON
}
An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
func (*InterestPaymentSimulationResultTransactionSourceInternalSource) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceInternalSource) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency ¶
type InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyCad InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "CAD" // Swiss Franc (CHF) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyChf InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "CHF" // Euro (EUR) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyEur InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "EUR" // British Pound (GBP) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyGbp InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "GBP" // Japanese Yen (JPY) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyJpy InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "JPY" // US Dollar (USD) InterestPaymentSimulationResultTransactionSourceInternalSourceCurrencyUsd InterestPaymentSimulationResultTransactionSourceInternalSourceCurrency = "USD" )
type InterestPaymentSimulationResultTransactionSourceInternalSourceReason ¶
type InterestPaymentSimulationResultTransactionSourceInternalSourceReason string
const ( // Account closure InterestPaymentSimulationResultTransactionSourceInternalSourceReasonAccountClosure InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "account_closure" // Bank migration InterestPaymentSimulationResultTransactionSourceInternalSourceReasonBankMigration InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "bank_migration" // Cashback InterestPaymentSimulationResultTransactionSourceInternalSourceReasonCashback InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "cashback" // Check adjustment InterestPaymentSimulationResultTransactionSourceInternalSourceReasonCheckAdjustment InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "check_adjustment" // Collection receivable InterestPaymentSimulationResultTransactionSourceInternalSourceReasonCollectionReceivable InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "collection_receivable" // Empyreal adjustment InterestPaymentSimulationResultTransactionSourceInternalSourceReasonEmpyrealAdjustment InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "empyreal_adjustment" // Error InterestPaymentSimulationResultTransactionSourceInternalSourceReasonError InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "error" // Error correction InterestPaymentSimulationResultTransactionSourceInternalSourceReasonErrorCorrection InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "error_correction" // Fees InterestPaymentSimulationResultTransactionSourceInternalSourceReasonFees InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "fees" // Interest InterestPaymentSimulationResultTransactionSourceInternalSourceReasonInterest InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "interest" // Negative balance forgiveness InterestPaymentSimulationResultTransactionSourceInternalSourceReasonNegativeBalanceForgiveness InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "negative_balance_forgiveness" // Sample funds InterestPaymentSimulationResultTransactionSourceInternalSourceReasonSampleFunds InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "sample_funds" // Sample funds return InterestPaymentSimulationResultTransactionSourceInternalSourceReasonSampleFundsReturn InterestPaymentSimulationResultTransactionSourceInternalSourceReason = "sample_funds_return" )
type InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement ¶
type InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement struct {
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The identifier of the Real-Time Payments Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgementJSON
}
A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
func (*InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceSampleFunds ¶
type InterestPaymentSimulationResultTransactionSourceSampleFunds struct {
// Where the sample funds came from.
Originator string `json:"originator,required"`
JSON interestPaymentSimulationResultTransactionSourceSampleFundsJSON
}
A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
func (*InterestPaymentSimulationResultTransactionSourceSampleFunds) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceSampleFunds) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceWireTransferIntention ¶
type InterestPaymentSimulationResultTransactionSourceWireTransferIntention struct {
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceWireTransferIntentionJSON
}
A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
func (*InterestPaymentSimulationResultTransactionSourceWireTransferIntention) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceWireTransferIntention) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionSourceWireTransferRejection ¶
type InterestPaymentSimulationResultTransactionSourceWireTransferRejection struct {
TransferID string `json:"transfer_id,required"`
JSON interestPaymentSimulationResultTransactionSourceWireTransferRejectionJSON
}
A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
func (*InterestPaymentSimulationResultTransactionSourceWireTransferRejection) UnmarshalJSON ¶
func (r *InterestPaymentSimulationResultTransactionSourceWireTransferRejection) UnmarshalJSON(data []byte) (err error)
type InterestPaymentSimulationResultTransactionType ¶
type InterestPaymentSimulationResultTransactionType string
A constant representing the object's type. For this resource it will always be `transaction`.
const (
InterestPaymentSimulationResultTransactionTypeTransaction InterestPaymentSimulationResultTransactionType = "transaction"
)
type InterestPaymentSimulationResultType ¶
type InterestPaymentSimulationResultType string
A constant representing the object's type. For this resource it will always be `interest_payment_simulation_result`.
const (
InterestPaymentSimulationResultTypeInterestPaymentSimulationResult InterestPaymentSimulationResultType = "interest_payment_simulation_result"
)
type Limit ¶
type Limit struct {
// The Limit identifier.
ID string `json:"id,required"`
// The interval for the metric. This is required if `metric` is `count` or
// `volume`.
Interval LimitInterval `json:"interval,required,nullable"`
// The metric for the Limit.
Metric LimitMetric `json:"metric,required"`
// The identifier of the Account Number, Account, or Card the Limit applies to.
ModelID string `json:"model_id,required"`
// The type of the model you wish to associate the Limit with.
ModelType LimitModelType `json:"model_type,required"`
// The current status of the Limit.
Status LimitStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `limit`.
Type LimitType `json:"type,required"`
// The value to evaluate the Limit against.
Value int64 `json:"value,required"`
JSON limitJSON
}
You can set limits at the Account, Account Number, or Card level. Limits applied to Accounts will apply to all Account Numbers and Cards in the Account. You can specify any number of Limits and they will all be applied to inbound debits and card authorizations. Volume and count Limits are designed to prevent unauthorized debits.
func (*Limit) UnmarshalJSON ¶
type LimitInterval ¶
type LimitInterval string
The interval for the metric. This is required if `metric` is `count` or `volume`.
const ( // Enforce the Limit per-transaction. LimitIntervalTransaction LimitInterval = "transaction" // Enforce the Limit based on the trailing 24 hour period. LimitIntervalDay LimitInterval = "day" // Enforce the Limit based on the trailing seven days. LimitIntervalWeek LimitInterval = "week" // Enforce the Limit based on the trailing month, going back to the current day in // the previous month, or as close as possible given month length differences. LimitIntervalMonth LimitInterval = "month" // Enforce the Limit based on the trailing 365 days. LimitIntervalYear LimitInterval = "year" // Enforce the Limit for all time. LimitIntervalAllTime LimitInterval = "all_time" )
type LimitListParams ¶
type LimitListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// The model to retrieve limits for.
ModelID param.Field[string] `query:"model_id"`
// The status to retrieve limits for.
Status param.Field[string] `query:"status"`
}
func (LimitListParams) URLQuery ¶
func (r LimitListParams) URLQuery() (v url.Values)
URLQuery serializes LimitListParams's query parameters as `url.Values`.
type LimitMetric ¶
type LimitMetric string
The metric for the Limit.
const ( // The maximum number of debits allowed. LimitMetricCount LimitMetric = "count" // The maximum volume of debits allowed in the minor unit of the model's currency. LimitMetricVolume LimitMetric = "volume" )
type LimitModelType ¶
type LimitModelType string
The type of the model you wish to associate the Limit with.
const ( // Enforce the Limit for the entire account. LimitModelTypeAccount LimitModelType = "account" // Enforce the Limit for this specific route. LimitModelTypeAccountNumber LimitModelType = "account_number" // Enforce the Limit for this specific card. LimitModelTypeCard LimitModelType = "card" )
type LimitNewParams ¶
type LimitNewParams struct {
// The metric for the limit.
Metric param.Field[LimitNewParamsMetric] `json:"metric,required"`
// The identifier of the Account, Account Number, or Card you wish to associate the
// limit with.
ModelID param.Field[string] `json:"model_id,required"`
// The value to test the limit against.
Value param.Field[int64] `json:"value,required"`
// The interval for the metric. Required if `metric` is `count` or `volume`.
Interval param.Field[LimitNewParamsInterval] `json:"interval"`
}
func (LimitNewParams) MarshalJSON ¶
func (r LimitNewParams) MarshalJSON() (data []byte, err error)
type LimitNewParamsInterval ¶
type LimitNewParamsInterval string
The interval for the metric. Required if `metric` is `count` or `volume`.
const ( // Enforce the limit per-transaction. LimitNewParamsIntervalTransaction LimitNewParamsInterval = "transaction" // Enforce the limit based on the previous 24 hour period. LimitNewParamsIntervalDay LimitNewParamsInterval = "day" // Enforce the limit based on the previous seven days. LimitNewParamsIntervalWeek LimitNewParamsInterval = "week" // Enforce the limit based on the previous month, going back to the current day in // the previous month, or as close as possible given month length differences. LimitNewParamsIntervalMonth LimitNewParamsInterval = "month" // Enforce the limit based on the previous year. LimitNewParamsIntervalYear LimitNewParamsInterval = "year" // Enforce the limit for all time. LimitNewParamsIntervalAllTime LimitNewParamsInterval = "all_time" )
type LimitNewParamsMetric ¶
type LimitNewParamsMetric string
The metric for the limit.
const ( // The maximum number of debits allowed. LimitNewParamsMetricCount LimitNewParamsMetric = "count" // The maximum volume of debits allowed in the minor unit of the model's currency. LimitNewParamsMetricVolume LimitNewParamsMetric = "volume" )
type LimitService ¶
type LimitService struct {
Options []option.RequestOption
}
LimitService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewLimitService method instead.
func NewLimitService ¶
func NewLimitService(opts ...option.RequestOption) (r *LimitService)
NewLimitService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*LimitService) Get ¶
func (r *LimitService) Get(ctx context.Context, limitID string, opts ...option.RequestOption) (res *Limit, err error)
Retrieve a Limit
func (*LimitService) List ¶
func (r *LimitService) List(ctx context.Context, query LimitListParams, opts ...option.RequestOption) (res *shared.Page[Limit], err error)
List Limits
func (*LimitService) ListAutoPaging ¶
func (r *LimitService) ListAutoPaging(ctx context.Context, query LimitListParams, opts ...option.RequestOption) *shared.PageAutoPager[Limit]
List Limits
func (*LimitService) New ¶
func (r *LimitService) New(ctx context.Context, body LimitNewParams, opts ...option.RequestOption) (res *Limit, err error)
Create a Limit
func (*LimitService) Update ¶
func (r *LimitService) Update(ctx context.Context, limitID string, body LimitUpdateParams, opts ...option.RequestOption) (res *Limit, err error)
Update a Limit
type LimitStatus ¶
type LimitStatus string
The current status of the Limit.
const ( // The Limit is active. LimitStatusActive LimitStatus = "active" // The Limit is temporarily disabled. LimitStatusInactive LimitStatus = "inactive" )
type LimitType ¶
type LimitType string
A constant representing the object's type. For this resource it will always be `limit`.
const (
LimitTypeLimit LimitType = "limit"
)
type LimitUpdateParams ¶
type LimitUpdateParams struct {
// The status to update the limit with.
Status param.Field[LimitUpdateParamsStatus] `json:"status,required"`
}
func (LimitUpdateParams) MarshalJSON ¶
func (r LimitUpdateParams) MarshalJSON() (data []byte, err error)
type LimitUpdateParamsStatus ¶
type LimitUpdateParamsStatus string
The status to update the limit with.
const ( // Disable the limit temporarily. LimitUpdateParamsStatusInactive LimitUpdateParamsStatus = "inactive" // Activate the limit. LimitUpdateParamsStatusActive LimitUpdateParamsStatus = "active" )
type OauthConnection ¶
type OauthConnection struct {
// The OAuth Connection's identifier.
ID string `json:"id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
// Connection was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The identifier of the Group that has authorized your OAuth application.
GroupID string `json:"group_id,required"`
// Whether the connection is active.
Status OauthConnectionStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `oauth_connection`.
Type OauthConnectionType `json:"type,required"`
JSON oauthConnectionJSON
}
When a user authorizes your OAuth application, an OAuth Connection object is created.
func (*OauthConnection) UnmarshalJSON ¶
func (r *OauthConnection) UnmarshalJSON(data []byte) (err error)
type OauthConnectionListParams ¶
type OauthConnectionListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (OauthConnectionListParams) URLQuery ¶
func (r OauthConnectionListParams) URLQuery() (v url.Values)
URLQuery serializes OauthConnectionListParams's query parameters as `url.Values`.
type OauthConnectionService ¶
type OauthConnectionService struct {
Options []option.RequestOption
}
OauthConnectionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOauthConnectionService method instead.
func NewOauthConnectionService ¶
func NewOauthConnectionService(opts ...option.RequestOption) (r *OauthConnectionService)
NewOauthConnectionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*OauthConnectionService) Get ¶
func (r *OauthConnectionService) Get(ctx context.Context, oauthConnectionID string, opts ...option.RequestOption) (res *OauthConnection, err error)
Retrieve an OAuth Connection
func (*OauthConnectionService) List ¶
func (r *OauthConnectionService) List(ctx context.Context, query OauthConnectionListParams, opts ...option.RequestOption) (res *shared.Page[OauthConnection], err error)
List OAuth Connections
func (*OauthConnectionService) ListAutoPaging ¶
func (r *OauthConnectionService) ListAutoPaging(ctx context.Context, query OauthConnectionListParams, opts ...option.RequestOption) *shared.PageAutoPager[OauthConnection]
List OAuth Connections
type OauthConnectionStatus ¶
type OauthConnectionStatus string
Whether the connection is active.
const ( // The OAuth connection is active. OauthConnectionStatusActive OauthConnectionStatus = "active" // The OAuth connection is permanently deactivated. OauthConnectionStatusInactive OauthConnectionStatus = "inactive" )
type OauthConnectionType ¶
type OauthConnectionType string
A constant representing the object's type. For this resource it will always be `oauth_connection`.
const (
OauthConnectionTypeOauthConnection OauthConnectionType = "oauth_connection"
)
type PendingTransaction ¶
type PendingTransaction struct {
// The Pending Transaction identifier.
ID string `json:"id,required"`
// The identifier for the account this Pending Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Pending Transaction amount in the minor unit of its currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
// Transaction was completed.
CompletedAt time.Time `json:"completed_at,required,nullable" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending
// Transaction's currency. This will match the currency on the Pending
// Transaction's Account.
Currency PendingTransactionCurrency `json:"currency,required"`
// For a Pending Transaction related to a transfer, this is the description you
// provide. For a Pending Transaction related to a payment, this is the description
// the vendor provides.
Description string `json:"description,required"`
// The identifier for the route this Pending Transaction came through. Routes are
// things like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Pending Transaction came through.
RouteType PendingTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Pending Transaction. For example, for a card transaction this lists the
// merchant's industry and location.
Source PendingTransactionSource `json:"source,required"`
// Whether the Pending Transaction has been confirmed and has an associated
// Transaction.
Status PendingTransactionStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `pending_transaction`.
Type PendingTransactionType `json:"type,required"`
JSON pendingTransactionJSON
}
Pending Transactions are potential future additions and removals of money from your bank account.
func (*PendingTransaction) UnmarshalJSON ¶
func (r *PendingTransaction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionCurrency ¶
type PendingTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.
const ( // Canadian Dollar (CAD) PendingTransactionCurrencyCad PendingTransactionCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionCurrencyChf PendingTransactionCurrency = "CHF" // Euro (EUR) PendingTransactionCurrencyEur PendingTransactionCurrency = "EUR" // British Pound (GBP) PendingTransactionCurrencyGbp PendingTransactionCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionCurrencyJpy PendingTransactionCurrency = "JPY" // US Dollar (USD) PendingTransactionCurrencyUsd PendingTransactionCurrency = "USD" )
type PendingTransactionListParams ¶
type PendingTransactionListParams struct {
// Filter pending transactions to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
Category param.Field[PendingTransactionListParamsCategory] `query:"category"`
CreatedAt param.Field[PendingTransactionListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter pending transactions to those belonging to the specified Route.
RouteID param.Field[string] `query:"route_id"`
// Filter pending transactions to those caused by the specified source.
SourceID param.Field[string] `query:"source_id"`
Status param.Field[PendingTransactionListParamsStatus] `query:"status"`
}
func (PendingTransactionListParams) URLQuery ¶
func (r PendingTransactionListParams) URLQuery() (v url.Values)
URLQuery serializes PendingTransactionListParams's query parameters as `url.Values`.
type PendingTransactionListParamsCategory ¶ added in v0.7.1
type PendingTransactionListParamsCategory struct {
// Return results whose value is in the provided list. For GET requests, this
// should be encoded as a comma-delimited string, such as `?in=one,two,three`.
In param.Field[[]PendingTransactionListParamsCategoryIn] `query:"in"`
}
func (PendingTransactionListParamsCategory) URLQuery ¶ added in v0.7.1
func (r PendingTransactionListParamsCategory) URLQuery() (v url.Values)
URLQuery serializes PendingTransactionListParamsCategory's query parameters as `url.Values`.
type PendingTransactionListParamsCategoryIn ¶ added in v0.7.1
type PendingTransactionListParamsCategoryIn string
const ( // Account Transfer Instruction: details will be under the // `account_transfer_instruction` object. PendingTransactionListParamsCategoryInAccountTransferInstruction PendingTransactionListParamsCategoryIn = "account_transfer_instruction" // ACH Transfer Instruction: details will be under the `ach_transfer_instruction` // object. PendingTransactionListParamsCategoryInACHTransferInstruction PendingTransactionListParamsCategoryIn = "ach_transfer_instruction" // Card Authorization: details will be under the `card_authorization` object. PendingTransactionListParamsCategoryInCardAuthorization PendingTransactionListParamsCategoryIn = "card_authorization" // Check Deposit Instruction: details will be under the `check_deposit_instruction` // object. PendingTransactionListParamsCategoryInCheckDepositInstruction PendingTransactionListParamsCategoryIn = "check_deposit_instruction" // Check Transfer Instruction: details will be under the // `check_transfer_instruction` object. PendingTransactionListParamsCategoryInCheckTransferInstruction PendingTransactionListParamsCategoryIn = "check_transfer_instruction" // Inbound Funds Hold: details will be under the `inbound_funds_hold` object. PendingTransactionListParamsCategoryInInboundFundsHold PendingTransactionListParamsCategoryIn = "inbound_funds_hold" // Real-Time Payments Transfer Instruction: details will be under the // `real_time_payments_transfer_instruction` object. PendingTransactionListParamsCategoryInRealTimePaymentsTransferInstruction PendingTransactionListParamsCategoryIn = "real_time_payments_transfer_instruction" // Wire Transfer Instruction: details will be under the `wire_transfer_instruction` // object. PendingTransactionListParamsCategoryInWireTransferInstruction PendingTransactionListParamsCategoryIn = "wire_transfer_instruction" // The Pending Transaction was made for an undocumented or deprecated reason. PendingTransactionListParamsCategoryInOther PendingTransactionListParamsCategoryIn = "other" )
type PendingTransactionListParamsCreatedAt ¶
type PendingTransactionListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (PendingTransactionListParamsCreatedAt) URLQuery ¶
func (r PendingTransactionListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes PendingTransactionListParamsCreatedAt's query parameters as `url.Values`.
type PendingTransactionListParamsStatus ¶
type PendingTransactionListParamsStatus struct {
// Filter Pending Transactions for those with the specified status. By default only
// Pending Transactions in with status `pending` will be returned. For GET
// requests, this should be encoded as a comma-delimited string, such as
// `?in=one,two,three`.
In param.Field[[]PendingTransactionListParamsStatusIn] `query:"in"`
}
func (PendingTransactionListParamsStatus) URLQuery ¶
func (r PendingTransactionListParamsStatus) URLQuery() (v url.Values)
URLQuery serializes PendingTransactionListParamsStatus's query parameters as `url.Values`.
type PendingTransactionListParamsStatusIn ¶
type PendingTransactionListParamsStatusIn string
const ( // The Pending Transaction is still awaiting confirmation. PendingTransactionListParamsStatusInPending PendingTransactionListParamsStatusIn = "pending" // The Pending Transaction is confirmed. An associated Transaction exists for this // object. The Pending Transaction will no longer count against your balance and // can generally be hidden from UIs, etc. PendingTransactionListParamsStatusInComplete PendingTransactionListParamsStatusIn = "complete" )
type PendingTransactionRouteType ¶
type PendingTransactionRouteType string
The type of the route this Pending Transaction came through.
const ( // An Account Number. PendingTransactionRouteTypeAccountNumber PendingTransactionRouteType = "account_number" // A Card. PendingTransactionRouteTypeCard PendingTransactionRouteType = "card" )
type PendingTransactionService ¶
type PendingTransactionService struct {
Options []option.RequestOption
}
PendingTransactionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPendingTransactionService method instead.
func NewPendingTransactionService ¶
func NewPendingTransactionService(opts ...option.RequestOption) (r *PendingTransactionService)
NewPendingTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PendingTransactionService) Get ¶
func (r *PendingTransactionService) Get(ctx context.Context, pendingTransactionID string, opts ...option.RequestOption) (res *PendingTransaction, err error)
Retrieve a Pending Transaction
func (*PendingTransactionService) List ¶
func (r *PendingTransactionService) List(ctx context.Context, query PendingTransactionListParams, opts ...option.RequestOption) (res *shared.Page[PendingTransaction], err error)
List Pending Transactions
func (*PendingTransactionService) ListAutoPaging ¶
func (r *PendingTransactionService) ListAutoPaging(ctx context.Context, query PendingTransactionListParams, opts ...option.RequestOption) *shared.PageAutoPager[PendingTransaction]
List Pending Transactions
type PendingTransactionSource ¶
type PendingTransactionSource struct {
// An Account Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_instruction`.
AccountTransferInstruction PendingTransactionSourceAccountTransferInstruction `json:"account_transfer_instruction,required,nullable"`
// An ACH Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_instruction`.
ACHTransferInstruction PendingTransactionSourceACHTransferInstruction `json:"ach_transfer_instruction,required,nullable"`
// A Card Authorization object. This field will be present in the JSON response if
// and only if `category` is equal to `card_authorization`.
CardAuthorization PendingTransactionSourceCardAuthorization `json:"card_authorization,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category PendingTransactionSourceCategory `json:"category,required"`
// A Check Deposit Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_instruction`.
CheckDepositInstruction PendingTransactionSourceCheckDepositInstruction `json:"check_deposit_instruction,required,nullable"`
// A Check Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_instruction`.
CheckTransferInstruction PendingTransactionSourceCheckTransferInstruction `json:"check_transfer_instruction,required,nullable"`
// An Inbound Funds Hold object. This field will be present in the JSON response if
// and only if `category` is equal to `inbound_funds_hold`.
InboundFundsHold PendingTransactionSourceInboundFundsHold `json:"inbound_funds_hold,required,nullable"`
// A Real-Time Payments Transfer Instruction object. This field will be present in
// the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_instruction`.
RealTimePaymentsTransferInstruction PendingTransactionSourceRealTimePaymentsTransferInstruction `json:"real_time_payments_transfer_instruction,required,nullable"`
// A Wire Transfer Instruction object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_instruction`.
WireTransferInstruction PendingTransactionSourceWireTransferInstruction `json:"wire_transfer_instruction,required,nullable"`
JSON pendingTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
func (*PendingTransactionSource) UnmarshalJSON ¶
func (r *PendingTransactionSource) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceACHTransferInstruction ¶
type PendingTransactionSourceACHTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the ACH Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON pendingTransactionSourceACHTransferInstructionJSON
}
An ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.
func (*PendingTransactionSourceACHTransferInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceACHTransferInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceAccountTransferInstruction ¶
type PendingTransactionSourceAccountTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency PendingTransactionSourceAccountTransferInstructionCurrency `json:"currency,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON pendingTransactionSourceAccountTransferInstructionJSON
}
An Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.
func (*PendingTransactionSourceAccountTransferInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceAccountTransferInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceAccountTransferInstructionCurrency ¶
type PendingTransactionSourceAccountTransferInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) PendingTransactionSourceAccountTransferInstructionCurrencyCad PendingTransactionSourceAccountTransferInstructionCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionSourceAccountTransferInstructionCurrencyChf PendingTransactionSourceAccountTransferInstructionCurrency = "CHF" // Euro (EUR) PendingTransactionSourceAccountTransferInstructionCurrencyEur PendingTransactionSourceAccountTransferInstructionCurrency = "EUR" // British Pound (GBP) PendingTransactionSourceAccountTransferInstructionCurrencyGbp PendingTransactionSourceAccountTransferInstructionCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionSourceAccountTransferInstructionCurrencyJpy PendingTransactionSourceAccountTransferInstructionCurrency = "JPY" // US Dollar (USD) PendingTransactionSourceAccountTransferInstructionCurrencyUsd PendingTransactionSourceAccountTransferInstructionCurrency = "USD" )
type PendingTransactionSourceCardAuthorization ¶
type PendingTransactionSourceCardAuthorization struct {
// The Card Authorization identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency PendingTransactionSourceCardAuthorizationCurrency `json:"currency,required"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
// will expire and the pending transaction will be released.
ExpiresAt time.Time `json:"expires_at,required" format:"date-time"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// Fields specific to the `network`
NetworkDetails PendingTransactionSourceCardAuthorizationNetworkDetails `json:"network_details,required"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The identifier of the Real-Time Decision sent to approve or decline this
// transaction.
RealTimeDecisionID string `json:"real_time_decision_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `card_authorization`.
Type PendingTransactionSourceCardAuthorizationType `json:"type,required"`
JSON pendingTransactionSourceCardAuthorizationJSON
}
A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`.
func (*PendingTransactionSourceCardAuthorization) UnmarshalJSON ¶
func (r *PendingTransactionSourceCardAuthorization) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceCardAuthorizationCurrency ¶
type PendingTransactionSourceCardAuthorizationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) PendingTransactionSourceCardAuthorizationCurrencyCad PendingTransactionSourceCardAuthorizationCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionSourceCardAuthorizationCurrencyChf PendingTransactionSourceCardAuthorizationCurrency = "CHF" // Euro (EUR) PendingTransactionSourceCardAuthorizationCurrencyEur PendingTransactionSourceCardAuthorizationCurrency = "EUR" // British Pound (GBP) PendingTransactionSourceCardAuthorizationCurrencyGbp PendingTransactionSourceCardAuthorizationCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionSourceCardAuthorizationCurrencyJpy PendingTransactionSourceCardAuthorizationCurrency = "JPY" // US Dollar (USD) PendingTransactionSourceCardAuthorizationCurrencyUsd PendingTransactionSourceCardAuthorizationCurrency = "USD" )
type PendingTransactionSourceCardAuthorizationNetworkDetails ¶
type PendingTransactionSourceCardAuthorizationNetworkDetails struct {
// The payment network used to process this card authorization
Category PendingTransactionSourceCardAuthorizationNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa PendingTransactionSourceCardAuthorizationNetworkDetailsVisa `json:"visa,required,nullable"`
JSON pendingTransactionSourceCardAuthorizationNetworkDetailsJSON
}
Fields specific to the `network`
func (*PendingTransactionSourceCardAuthorizationNetworkDetails) UnmarshalJSON ¶
func (r *PendingTransactionSourceCardAuthorizationNetworkDetails) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceCardAuthorizationNetworkDetailsCategory ¶ added in v0.6.0
type PendingTransactionSourceCardAuthorizationNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa PendingTransactionSourceCardAuthorizationNetworkDetailsCategoryVisa PendingTransactionSourceCardAuthorizationNetworkDetailsCategory = "visa" )
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisa ¶
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON pendingTransactionSourceCardAuthorizationNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*PendingTransactionSourceCardAuthorizationNetworkDetailsVisa) UnmarshalJSON ¶
func (r *PendingTransactionSourceCardAuthorizationNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator ¶
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorRecurring PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorInstallment PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction PendingTransactionSourceCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeUnknown PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeManual PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeOpticalCode PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactless PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv PendingTransactionSourceCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type PendingTransactionSourceCardAuthorizationType ¶
type PendingTransactionSourceCardAuthorizationType string
A constant representing the object's type. For this resource it will always be `card_authorization`.
const (
PendingTransactionSourceCardAuthorizationTypeCardAuthorization PendingTransactionSourceCardAuthorizationType = "card_authorization"
)
type PendingTransactionSourceCategory ¶
type PendingTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Instruction: details will be under the // `account_transfer_instruction` object. PendingTransactionSourceCategoryAccountTransferInstruction PendingTransactionSourceCategory = "account_transfer_instruction" // ACH Transfer Instruction: details will be under the `ach_transfer_instruction` // object. PendingTransactionSourceCategoryACHTransferInstruction PendingTransactionSourceCategory = "ach_transfer_instruction" // Card Authorization: details will be under the `card_authorization` object. PendingTransactionSourceCategoryCardAuthorization PendingTransactionSourceCategory = "card_authorization" // Check Deposit Instruction: details will be under the `check_deposit_instruction` // object. PendingTransactionSourceCategoryCheckDepositInstruction PendingTransactionSourceCategory = "check_deposit_instruction" // Check Transfer Instruction: details will be under the // `check_transfer_instruction` object. PendingTransactionSourceCategoryCheckTransferInstruction PendingTransactionSourceCategory = "check_transfer_instruction" // Inbound Funds Hold: details will be under the `inbound_funds_hold` object. PendingTransactionSourceCategoryInboundFundsHold PendingTransactionSourceCategory = "inbound_funds_hold" // Real-Time Payments Transfer Instruction: details will be under the // `real_time_payments_transfer_instruction` object. PendingTransactionSourceCategoryRealTimePaymentsTransferInstruction PendingTransactionSourceCategory = "real_time_payments_transfer_instruction" // Wire Transfer Instruction: details will be under the `wire_transfer_instruction` // object. PendingTransactionSourceCategoryWireTransferInstruction PendingTransactionSourceCategory = "wire_transfer_instruction" // The Pending Transaction was made for an undocumented or deprecated reason. PendingTransactionSourceCategoryOther PendingTransactionSourceCategory = "other" )
type PendingTransactionSourceCheckDepositInstruction ¶
type PendingTransactionSourceCheckDepositInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the File containing the image of the back of the check that
// was deposited.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// The identifier of the Check Deposit.
CheckDepositID string `json:"check_deposit_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency PendingTransactionSourceCheckDepositInstructionCurrency `json:"currency,required"`
// The identifier of the File containing the image of the front of the check that
// was deposited.
FrontImageFileID string `json:"front_image_file_id,required"`
JSON pendingTransactionSourceCheckDepositInstructionJSON
}
A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.
func (*PendingTransactionSourceCheckDepositInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceCheckDepositInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceCheckDepositInstructionCurrency ¶
type PendingTransactionSourceCheckDepositInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) PendingTransactionSourceCheckDepositInstructionCurrencyCad PendingTransactionSourceCheckDepositInstructionCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionSourceCheckDepositInstructionCurrencyChf PendingTransactionSourceCheckDepositInstructionCurrency = "CHF" // Euro (EUR) PendingTransactionSourceCheckDepositInstructionCurrencyEur PendingTransactionSourceCheckDepositInstructionCurrency = "EUR" // British Pound (GBP) PendingTransactionSourceCheckDepositInstructionCurrencyGbp PendingTransactionSourceCheckDepositInstructionCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionSourceCheckDepositInstructionCurrencyJpy PendingTransactionSourceCheckDepositInstructionCurrency = "JPY" // US Dollar (USD) PendingTransactionSourceCheckDepositInstructionCurrencyUsd PendingTransactionSourceCheckDepositInstructionCurrency = "USD" )
type PendingTransactionSourceCheckTransferInstruction ¶
type PendingTransactionSourceCheckTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency PendingTransactionSourceCheckTransferInstructionCurrency `json:"currency,required"`
// The identifier of the Check Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON pendingTransactionSourceCheckTransferInstructionJSON
}
A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.
func (*PendingTransactionSourceCheckTransferInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceCheckTransferInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceCheckTransferInstructionCurrency ¶
type PendingTransactionSourceCheckTransferInstructionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) PendingTransactionSourceCheckTransferInstructionCurrencyCad PendingTransactionSourceCheckTransferInstructionCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionSourceCheckTransferInstructionCurrencyChf PendingTransactionSourceCheckTransferInstructionCurrency = "CHF" // Euro (EUR) PendingTransactionSourceCheckTransferInstructionCurrencyEur PendingTransactionSourceCheckTransferInstructionCurrency = "EUR" // British Pound (GBP) PendingTransactionSourceCheckTransferInstructionCurrencyGbp PendingTransactionSourceCheckTransferInstructionCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionSourceCheckTransferInstructionCurrencyJpy PendingTransactionSourceCheckTransferInstructionCurrency = "JPY" // US Dollar (USD) PendingTransactionSourceCheckTransferInstructionCurrencyUsd PendingTransactionSourceCheckTransferInstructionCurrency = "USD" )
type PendingTransactionSourceInboundFundsHold ¶
type PendingTransactionSourceInboundFundsHold struct {
// The Inbound Funds Hold identifier.
ID string `json:"id,required"`
// The held amount in the minor unit of the account's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// When the hold will be released automatically. Certain conditions may cause it to
// be released before this time.
AutomaticallyReleasesAt time.Time `json:"automatically_releases_at,required" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
// currency.
Currency PendingTransactionSourceInboundFundsHoldCurrency `json:"currency,required"`
// The ID of the Transaction for which funds were held.
HeldTransactionID string `json:"held_transaction_id,required,nullable"`
// The ID of the Pending Transaction representing the held funds.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// When the hold was released (if it has been released).
ReleasedAt time.Time `json:"released_at,required,nullable" format:"date-time"`
// The status of the hold.
Status PendingTransactionSourceInboundFundsHoldStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `inbound_funds_hold`.
Type PendingTransactionSourceInboundFundsHoldType `json:"type,required"`
JSON pendingTransactionSourceInboundFundsHoldJSON
}
An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`.
func (*PendingTransactionSourceInboundFundsHold) UnmarshalJSON ¶
func (r *PendingTransactionSourceInboundFundsHold) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceInboundFundsHoldCurrency ¶
type PendingTransactionSourceInboundFundsHoldCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.
const ( // Canadian Dollar (CAD) PendingTransactionSourceInboundFundsHoldCurrencyCad PendingTransactionSourceInboundFundsHoldCurrency = "CAD" // Swiss Franc (CHF) PendingTransactionSourceInboundFundsHoldCurrencyChf PendingTransactionSourceInboundFundsHoldCurrency = "CHF" // Euro (EUR) PendingTransactionSourceInboundFundsHoldCurrencyEur PendingTransactionSourceInboundFundsHoldCurrency = "EUR" // British Pound (GBP) PendingTransactionSourceInboundFundsHoldCurrencyGbp PendingTransactionSourceInboundFundsHoldCurrency = "GBP" // Japanese Yen (JPY) PendingTransactionSourceInboundFundsHoldCurrencyJpy PendingTransactionSourceInboundFundsHoldCurrency = "JPY" // US Dollar (USD) PendingTransactionSourceInboundFundsHoldCurrencyUsd PendingTransactionSourceInboundFundsHoldCurrency = "USD" )
type PendingTransactionSourceInboundFundsHoldStatus ¶
type PendingTransactionSourceInboundFundsHoldStatus string
The status of the hold.
const ( // Funds are still being held. PendingTransactionSourceInboundFundsHoldStatusHeld PendingTransactionSourceInboundFundsHoldStatus = "held" // Funds have been released. PendingTransactionSourceInboundFundsHoldStatusComplete PendingTransactionSourceInboundFundsHoldStatus = "complete" )
type PendingTransactionSourceInboundFundsHoldType ¶ added in v0.5.0
type PendingTransactionSourceInboundFundsHoldType string
A constant representing the object's type. For this resource it will always be `inbound_funds_hold`.
const (
PendingTransactionSourceInboundFundsHoldTypeInboundFundsHold PendingTransactionSourceInboundFundsHoldType = "inbound_funds_hold"
)
type PendingTransactionSourceRealTimePaymentsTransferInstruction ¶
type PendingTransactionSourceRealTimePaymentsTransferInstruction struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Real-Time Payments Transfer that led to this Pending
// Transaction.
TransferID string `json:"transfer_id,required"`
JSON pendingTransactionSourceRealTimePaymentsTransferInstructionJSON
}
A Real-Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`.
func (*PendingTransactionSourceRealTimePaymentsTransferInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceRealTimePaymentsTransferInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionSourceWireTransferInstruction ¶
type PendingTransactionSourceWireTransferInstruction struct {
AccountNumber string `json:"account_number,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
MessageToRecipient string `json:"message_to_recipient,required"`
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON pendingTransactionSourceWireTransferInstructionJSON
}
A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.
func (*PendingTransactionSourceWireTransferInstruction) UnmarshalJSON ¶
func (r *PendingTransactionSourceWireTransferInstruction) UnmarshalJSON(data []byte) (err error)
type PendingTransactionStatus ¶
type PendingTransactionStatus string
Whether the Pending Transaction has been confirmed and has an associated Transaction.
const ( // The Pending Transaction is still awaiting confirmation. PendingTransactionStatusPending PendingTransactionStatus = "pending" // The Pending Transaction is confirmed. An associated Transaction exists for this // object. The Pending Transaction will no longer count against your balance and // can generally be hidden from UIs, etc. PendingTransactionStatusComplete PendingTransactionStatus = "complete" )
type PendingTransactionType ¶
type PendingTransactionType string
A constant representing the object's type. For this resource it will always be `pending_transaction`.
const (
PendingTransactionTypePendingTransaction PendingTransactionType = "pending_transaction"
)
type Program ¶
type Program struct {
// The Program identifier.
ID string `json:"id,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The name of the Program.
Name string `json:"name,required"`
// A constant representing the object's type. For this resource it will always be
// `program`.
Type ProgramType `json:"type,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program
// was last updated.
UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
JSON programJSON
}
Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
func (*Program) UnmarshalJSON ¶
type ProgramListParams ¶
type ProgramListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (ProgramListParams) URLQuery ¶
func (r ProgramListParams) URLQuery() (v url.Values)
URLQuery serializes ProgramListParams's query parameters as `url.Values`.
type ProgramService ¶
type ProgramService struct {
Options []option.RequestOption
}
ProgramService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProgramService method instead.
func NewProgramService ¶
func NewProgramService(opts ...option.RequestOption) (r *ProgramService)
NewProgramService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ProgramService) Get ¶
func (r *ProgramService) Get(ctx context.Context, programID string, opts ...option.RequestOption) (res *Program, err error)
Retrieve a Program
func (*ProgramService) List ¶
func (r *ProgramService) List(ctx context.Context, query ProgramListParams, opts ...option.RequestOption) (res *shared.Page[Program], err error)
List Programs
func (*ProgramService) ListAutoPaging ¶
func (r *ProgramService) ListAutoPaging(ctx context.Context, query ProgramListParams, opts ...option.RequestOption) *shared.PageAutoPager[Program]
List Programs
type ProgramType ¶
type ProgramType string
A constant representing the object's type. For this resource it will always be `program`.
const (
ProgramTypeProgram ProgramType = "program"
)
type RealTimeDecision ¶
type RealTimeDecision struct {
// The Real-Time Decision identifier.
ID string `json:"id,required"`
// Fields related to a card authorization.
CardAuthorization RealTimeDecisionCardAuthorization `json:"card_authorization,required,nullable"`
// The category of the Real-Time Decision.
Category RealTimeDecisionCategory `json:"category,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Real-Time Decision was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// Fields related to a digital wallet authentication attempt.
DigitalWalletAuthentication RealTimeDecisionDigitalWalletAuthentication `json:"digital_wallet_authentication,required,nullable"`
// Fields related to a digital wallet token provisioning attempt.
DigitalWalletToken RealTimeDecisionDigitalWalletToken `json:"digital_wallet_token,required,nullable"`
// The status of the Real-Time Decision.
Status RealTimeDecisionStatus `json:"status,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// your application can no longer respond to the Real-Time Decision.
TimeoutAt time.Time `json:"timeout_at,required" format:"date-time"`
// A constant representing the object's type. For this resource it will always be
// `real_time_decision`.
Type RealTimeDecisionType `json:"type,required"`
JSON realTimeDecisionJSON
}
Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. Real time decisions are currently in beta; please contact support@increase.com if you're interested in trying them out!
func (*RealTimeDecision) UnmarshalJSON ¶
func (r *RealTimeDecision) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionActionParams ¶
type RealTimeDecisionActionParams struct {
// If the Real-Time Decision relates to a card authorization attempt, this object
// contains your response to the authorization.
CardAuthorization param.Field[RealTimeDecisionActionParamsCardAuthorization] `json:"card_authorization"`
// If the Real-Time Decision relates to a digital wallet authentication attempt,
// this object contains your response to the authentication.
DigitalWalletAuthentication param.Field[RealTimeDecisionActionParamsDigitalWalletAuthentication] `json:"digital_wallet_authentication"`
// If the Real-Time Decision relates to a digital wallet token provisioning
// attempt, this object contains your response to the attempt.
DigitalWalletToken param.Field[RealTimeDecisionActionParamsDigitalWalletToken] `json:"digital_wallet_token"`
}
func (RealTimeDecisionActionParams) MarshalJSON ¶
func (r RealTimeDecisionActionParams) MarshalJSON() (data []byte, err error)
type RealTimeDecisionActionParamsCardAuthorization ¶
type RealTimeDecisionActionParamsCardAuthorization struct {
// Whether the card authorization should be approved or declined.
Decision param.Field[RealTimeDecisionActionParamsCardAuthorizationDecision] `json:"decision,required"`
}
If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.
func (RealTimeDecisionActionParamsCardAuthorization) MarshalJSON ¶ added in v0.1.1
func (r RealTimeDecisionActionParamsCardAuthorization) MarshalJSON() (data []byte, err error)
type RealTimeDecisionActionParamsCardAuthorizationDecision ¶
type RealTimeDecisionActionParamsCardAuthorizationDecision string
Whether the card authorization should be approved or declined.
const ( // Approve the authorization. RealTimeDecisionActionParamsCardAuthorizationDecisionApprove RealTimeDecisionActionParamsCardAuthorizationDecision = "approve" // Decline the authorization. RealTimeDecisionActionParamsCardAuthorizationDecisionDecline RealTimeDecisionActionParamsCardAuthorizationDecision = "decline" )
type RealTimeDecisionActionParamsDigitalWalletAuthentication ¶
type RealTimeDecisionActionParamsDigitalWalletAuthentication struct {
// Whether your application was able to deliver the one-time passcode.
Result param.Field[RealTimeDecisionActionParamsDigitalWalletAuthenticationResult] `json:"result,required"`
}
If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.
func (RealTimeDecisionActionParamsDigitalWalletAuthentication) MarshalJSON ¶ added in v0.1.1
func (r RealTimeDecisionActionParamsDigitalWalletAuthentication) MarshalJSON() (data []byte, err error)
type RealTimeDecisionActionParamsDigitalWalletAuthenticationResult ¶
type RealTimeDecisionActionParamsDigitalWalletAuthenticationResult string
Whether your application was able to deliver the one-time passcode.
const ( // Your application successfully delivered the one-time passcode to the cardholder. RealTimeDecisionActionParamsDigitalWalletAuthenticationResultSuccess RealTimeDecisionActionParamsDigitalWalletAuthenticationResult = "success" // Your application failed to deliver the one-time passcode to the cardholder. RealTimeDecisionActionParamsDigitalWalletAuthenticationResultFailure RealTimeDecisionActionParamsDigitalWalletAuthenticationResult = "failure" )
type RealTimeDecisionActionParamsDigitalWalletToken ¶
type RealTimeDecisionActionParamsDigitalWalletToken struct {
// If your application approves the provisioning attempt, this contains metadata
// about the digital wallet token that will be generated.
Approval param.Field[RealTimeDecisionActionParamsDigitalWalletTokenApproval] `json:"approval"`
// If your application declines the provisioning attempt, this contains details
// about the decline.
Decline param.Field[RealTimeDecisionActionParamsDigitalWalletTokenDecline] `json:"decline"`
}
If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.
func (RealTimeDecisionActionParamsDigitalWalletToken) MarshalJSON ¶ added in v0.1.1
func (r RealTimeDecisionActionParamsDigitalWalletToken) MarshalJSON() (data []byte, err error)
type RealTimeDecisionActionParamsDigitalWalletTokenApproval ¶
type RealTimeDecisionActionParamsDigitalWalletTokenApproval struct {
// The identifier of the Card Profile to assign to the Digital Wallet token.
CardProfileID param.Field[string] `json:"card_profile_id,required"`
// An email address that can be used to verify the cardholder via one-time
// passcode.
Email param.Field[string] `json:"email"`
// A phone number that can be used to verify the cardholder via one-time passcode
// over SMS.
Phone param.Field[string] `json:"phone"`
}
If your application approves the provisioning attempt, this contains metadata about the digital wallet token that will be generated.
func (RealTimeDecisionActionParamsDigitalWalletTokenApproval) MarshalJSON ¶ added in v0.1.1
func (r RealTimeDecisionActionParamsDigitalWalletTokenApproval) MarshalJSON() (data []byte, err error)
type RealTimeDecisionActionParamsDigitalWalletTokenDecline ¶
type RealTimeDecisionActionParamsDigitalWalletTokenDecline struct {
// Why the tokenization attempt was declined. This is for logging purposes only and
// is not displayed to the end-user.
Reason param.Field[string] `json:"reason"`
}
If your application declines the provisioning attempt, this contains details about the decline.
func (RealTimeDecisionActionParamsDigitalWalletTokenDecline) MarshalJSON ¶ added in v0.1.1
func (r RealTimeDecisionActionParamsDigitalWalletTokenDecline) MarshalJSON() (data []byte, err error)
type RealTimeDecisionCardAuthorization ¶
type RealTimeDecisionCardAuthorization struct {
// The identifier of the Account the authorization will debit.
AccountID string `json:"account_id,required"`
// The identifier of the Card that is being authorized.
CardID string `json:"card_id,required"`
// Whether or not the authorization was approved.
Decision RealTimeDecisionCardAuthorizationDecision `json:"decision,required,nullable"`
// If the authorization was made via a Digital Wallet Token (such as an Apple Pay
// purchase), the identifier of the token that was used.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required"`
// The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
// card is transacting with.
MerchantCategoryCode string `json:"merchant_category_code,required,nullable"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required,nullable"`
// The merchant descriptor of the merchant the card is transacting with.
MerchantDescriptor string `json:"merchant_descriptor,required"`
// Fields specific to the `network`
NetworkDetails RealTimeDecisionCardAuthorizationNetworkDetails `json:"network_details,required"`
// If the authorization was made in-person with a physical card, the Physical Card
// that was used.
PhysicalCardID string `json:"physical_card_id,required,nullable"`
// The amount of the attempted authorization in the currency the card user sees at
// the time of purchase, in the minor unit of that currency. For dollars, for
// example, this is cents.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
// user sees at the time of purchase.
PresentmentCurrency string `json:"presentment_currency,required"`
// Fields specific to the type of request, such as an incremental authorization.
RequestDetails RealTimeDecisionCardAuthorizationRequestDetails `json:"request_details,required"`
// The amount of the attempted authorization in the currency it will be settled in.
// This currency is the same as that of the Account the card belongs to.
SettlementAmount int64 `json:"settlement_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the
// transaction will be settled in.
SettlementCurrency string `json:"settlement_currency,required"`
JSON realTimeDecisionCardAuthorizationJSON
}
Fields related to a card authorization.
func (*RealTimeDecisionCardAuthorization) UnmarshalJSON ¶
func (r *RealTimeDecisionCardAuthorization) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionCardAuthorizationDecision ¶
type RealTimeDecisionCardAuthorizationDecision string
Whether or not the authorization was approved.
const ( // Approve the authorization. RealTimeDecisionCardAuthorizationDecisionApprove RealTimeDecisionCardAuthorizationDecision = "approve" // Decline the authorization. RealTimeDecisionCardAuthorizationDecisionDecline RealTimeDecisionCardAuthorizationDecision = "decline" )
type RealTimeDecisionCardAuthorizationNetworkDetails ¶
type RealTimeDecisionCardAuthorizationNetworkDetails struct {
// The payment network used to process this card authorization
Category RealTimeDecisionCardAuthorizationNetworkDetailsCategory `json:"category,required"`
// Fields specific to the `visa` network
Visa RealTimeDecisionCardAuthorizationNetworkDetailsVisa `json:"visa,required,nullable"`
JSON realTimeDecisionCardAuthorizationNetworkDetailsJSON
}
Fields specific to the `network`
func (*RealTimeDecisionCardAuthorizationNetworkDetails) UnmarshalJSON ¶
func (r *RealTimeDecisionCardAuthorizationNetworkDetails) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionCardAuthorizationNetworkDetailsCategory ¶ added in v0.6.0
type RealTimeDecisionCardAuthorizationNetworkDetailsCategory string
The payment network used to process this card authorization
const ( // Visa RealTimeDecisionCardAuthorizationNetworkDetailsCategoryVisa RealTimeDecisionCardAuthorizationNetworkDetailsCategory = "visa" )
type RealTimeDecisionCardAuthorizationNetworkDetailsVisa ¶
type RealTimeDecisionCardAuthorizationNetworkDetailsVisa struct {
// For electronic commerce transactions, this identifies the level of security used
// in obtaining the customer's payment credential. For mail or telephone order
// transactions, identifies the type of mail or telephone order.
ElectronicCommerceIndicator RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator `json:"electronic_commerce_indicator,required,nullable"`
// The method used to enter the cardholder's primary account number and card
// expiration date
PointOfServiceEntryMode RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode `json:"point_of_service_entry_mode,required,nullable"`
JSON realTimeDecisionCardAuthorizationNetworkDetailsVisaJSON
}
Fields specific to the `visa` network
func (*RealTimeDecisionCardAuthorizationNetworkDetailsVisa) UnmarshalJSON ¶
func (r *RealTimeDecisionCardAuthorizationNetworkDetailsVisa) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator ¶
type RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator string
For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
const ( // Single transaction of a mail/phone order: Use to indicate that the transaction // is a mail/phone order purchase, not a recurring transaction or installment // payment. For domestic transactions in the US region, this value may also // indicate one bill payment transaction in the card-present or card-absent // environments. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorMailPhoneOrder RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "mail_phone_order" // Recurring transaction: Payment indicator used to indicate a recurring // transaction that originates from an acquirer in the US region. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorRecurring RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "recurring" // Installment payment: Payment indicator used to indicate one purchase of goods or // services that is billed to the account in multiple charges over a period of time // agreed upon by the cardholder and merchant from transactions that originate from // an acquirer in the US region. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorInstallment RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "installment" // Unknown classification: other mail order: Use to indicate that the type of // mail/telephone order is unknown. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorUnknownMailPhoneOrder RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "unknown_mail_phone_order" // Secure electronic commerce transaction: Use to indicate that the electronic // commerce transaction has been authenticated using e.g., 3-D Secure RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorSecureElectronicCommerce RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "secure_electronic_commerce" // Non-authenticated security transaction at a 3-D Secure-capable merchant, and // merchant attempted to authenticate the cardholder using 3-D Secure: Use to // identify an electronic commerce transaction where the merchant attempted to // authenticate the cardholder using 3-D Secure, but was unable to complete the // authentication because the issuer or cardholder does not participate in the 3-D // Secure program. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransactionAt3DSCapableMerchant RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction_at_3ds_capable_merchant" // Non-authenticated security transaction: Use to identify an electronic commerce // transaction that uses data encryption for security however , cardholder // authentication is not performed using 3-D Secure. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonAuthenticatedSecurityTransaction RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_authenticated_security_transaction" // Non-secure transaction: Use to identify an electronic commerce transaction that // has no data protection. RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicatorNonSecureTransaction RealTimeDecisionCardAuthorizationNetworkDetailsVisaElectronicCommerceIndicator = "non_secure_transaction" )
type RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode ¶ added in v0.7.1
type RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode string
The method used to enter the cardholder's primary account number and card expiration date
const ( // Unknown RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeUnknown RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "unknown" // Manual key entry RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeManual RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "manual" // Magnetic stripe read, without card verification value RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripeNoCvv RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe_no_cvv" // Optical code RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeOpticalCode RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "optical_code" // Contact chip card RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCard RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card" // Contactless read of chip card RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactless RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless" // Transaction initiated using a credential that has previously been stored on file RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeCredentialOnFile RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "credential_on_file" // Magnetic stripe read RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeMagneticStripe RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "magnetic_stripe" // Contactless read of magnetic stripe data RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeContactlessMagneticStripe RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "contactless_magnetic_stripe" // Contact chip card, without card verification value RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryModeIntegratedCircuitCardNoCvv RealTimeDecisionCardAuthorizationNetworkDetailsVisaPointOfServiceEntryMode = "integrated_circuit_card_no_cvv" )
type RealTimeDecisionCardAuthorizationRequestDetails ¶ added in v0.6.0
type RealTimeDecisionCardAuthorizationRequestDetails struct {
// The type of this request (e.g., an initial authorization or an incremental
// authorization.)
Category RealTimeDecisionCardAuthorizationRequestDetailsCategory `json:"category,required"`
// Fields specific to the category `incremental_authorization`.
IncrementalAuthorization RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization `json:"incremental_authorization,required,nullable"`
// Fields specific to the category `initial_authorization`.
InitialAuthorization interface{} `json:"initial_authorization,required,nullable"`
JSON realTimeDecisionCardAuthorizationRequestDetailsJSON
}
Fields specific to the type of request, such as an incremental authorization.
func (*RealTimeDecisionCardAuthorizationRequestDetails) UnmarshalJSON ¶ added in v0.6.0
func (r *RealTimeDecisionCardAuthorizationRequestDetails) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionCardAuthorizationRequestDetailsCategory ¶ added in v0.6.0
type RealTimeDecisionCardAuthorizationRequestDetailsCategory string
The type of this request (e.g., an initial authorization or an incremental authorization.)
const ( // A regular, standalone authorization. RealTimeDecisionCardAuthorizationRequestDetailsCategoryInitialAuthorization RealTimeDecisionCardAuthorizationRequestDetailsCategory = "initial_authorization" // An incremental request to increase the amount of an existing authorization. RealTimeDecisionCardAuthorizationRequestDetailsCategoryIncrementalAuthorization RealTimeDecisionCardAuthorizationRequestDetailsCategory = "incremental_authorization" )
type RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization ¶ added in v0.6.0
type RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization struct {
// The card payment for this authorization and increment.
CardPaymentID string `json:"card_payment_id,required"`
// The identifier of the card authorization this request is attempting to
// increment.
OriginalCardAuthorizationID string `json:"original_card_authorization_id,required"`
JSON realTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorizationJSON
}
Fields specific to the category `incremental_authorization`.
func (*RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization) UnmarshalJSON ¶ added in v0.6.0
func (r *RealTimeDecisionCardAuthorizationRequestDetailsIncrementalAuthorization) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionCategory ¶
type RealTimeDecisionCategory string
The category of the Real-Time Decision.
const ( // A card is being authorized. RealTimeDecisionCategoryCardAuthorizationRequested RealTimeDecisionCategory = "card_authorization_requested" // A card is being loaded into a digital wallet. RealTimeDecisionCategoryDigitalWalletTokenRequested RealTimeDecisionCategory = "digital_wallet_token_requested" // A card is being loaded into a digital wallet and requires cardholder // authentication. RealTimeDecisionCategoryDigitalWalletAuthenticationRequested RealTimeDecisionCategory = "digital_wallet_authentication_requested" )
type RealTimeDecisionDigitalWalletAuthentication ¶
type RealTimeDecisionDigitalWalletAuthentication struct {
// The identifier of the Card that is being tokenized.
CardID string `json:"card_id,required"`
// The channel to send the card user their one-time passcode.
Channel RealTimeDecisionDigitalWalletAuthenticationChannel `json:"channel,required"`
// The digital wallet app being used.
DigitalWallet RealTimeDecisionDigitalWalletAuthenticationDigitalWallet `json:"digital_wallet,required"`
// The email to send the one-time passcode to if `channel` is equal to `email`.
Email string `json:"email,required,nullable"`
// The one-time passcode to send the card user.
OneTimePasscode string `json:"one_time_passcode,required"`
// The phone number to send the one-time passcode to if `channel` is equal to
// `sms`.
Phone string `json:"phone,required,nullable"`
// Whether your application successfully delivered the one-time passcode.
Result RealTimeDecisionDigitalWalletAuthenticationResult `json:"result,required,nullable"`
JSON realTimeDecisionDigitalWalletAuthenticationJSON
}
Fields related to a digital wallet authentication attempt.
func (*RealTimeDecisionDigitalWalletAuthentication) UnmarshalJSON ¶
func (r *RealTimeDecisionDigitalWalletAuthentication) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionDigitalWalletAuthenticationChannel ¶
type RealTimeDecisionDigitalWalletAuthenticationChannel string
The channel to send the card user their one-time passcode.
const ( // Send one-time passcodes over SMS. RealTimeDecisionDigitalWalletAuthenticationChannelSMS RealTimeDecisionDigitalWalletAuthenticationChannel = "sms" // Send one-time passcodes over email. RealTimeDecisionDigitalWalletAuthenticationChannelEmail RealTimeDecisionDigitalWalletAuthenticationChannel = "email" )
type RealTimeDecisionDigitalWalletAuthenticationDigitalWallet ¶
type RealTimeDecisionDigitalWalletAuthenticationDigitalWallet string
The digital wallet app being used.
const ( // Apple Pay RealTimeDecisionDigitalWalletAuthenticationDigitalWalletApplePay RealTimeDecisionDigitalWalletAuthenticationDigitalWallet = "apple_pay" // Google Pay RealTimeDecisionDigitalWalletAuthenticationDigitalWalletGooglePay RealTimeDecisionDigitalWalletAuthenticationDigitalWallet = "google_pay" )
type RealTimeDecisionDigitalWalletAuthenticationResult ¶
type RealTimeDecisionDigitalWalletAuthenticationResult string
Whether your application successfully delivered the one-time passcode.
const ( // Your application successfully delivered the one-time passcode to the cardholder. RealTimeDecisionDigitalWalletAuthenticationResultSuccess RealTimeDecisionDigitalWalletAuthenticationResult = "success" // Your application failed to deliver the one-time passcode to the cardholder. RealTimeDecisionDigitalWalletAuthenticationResultFailure RealTimeDecisionDigitalWalletAuthenticationResult = "failure" )
type RealTimeDecisionDigitalWalletToken ¶
type RealTimeDecisionDigitalWalletToken struct {
// The identifier of the Card that is being tokenized.
CardID string `json:"card_id,required"`
// The identifier of the Card Profile that was set via the real time decision. This
// will be null until the real time decision is responded to or if the real time
// decision did not set a card profile.
CardProfileID string `json:"card_profile_id,required,nullable"`
// Whether or not the provisioning request was approved. This will be null until
// the real time decision is responded to.
Decision RealTimeDecisionDigitalWalletTokenDecision `json:"decision,required,nullable"`
// The digital wallet app being used.
DigitalWallet RealTimeDecisionDigitalWalletTokenDigitalWallet `json:"digital_wallet,required"`
JSON realTimeDecisionDigitalWalletTokenJSON
}
Fields related to a digital wallet token provisioning attempt.
func (*RealTimeDecisionDigitalWalletToken) UnmarshalJSON ¶
func (r *RealTimeDecisionDigitalWalletToken) UnmarshalJSON(data []byte) (err error)
type RealTimeDecisionDigitalWalletTokenDecision ¶
type RealTimeDecisionDigitalWalletTokenDecision string
Whether or not the provisioning request was approved. This will be null until the real time decision is responded to.
const ( // Approve the provisioning request. RealTimeDecisionDigitalWalletTokenDecisionApprove RealTimeDecisionDigitalWalletTokenDecision = "approve" // Decline the provisioning request. RealTimeDecisionDigitalWalletTokenDecisionDecline RealTimeDecisionDigitalWalletTokenDecision = "decline" )
type RealTimeDecisionDigitalWalletTokenDigitalWallet ¶
type RealTimeDecisionDigitalWalletTokenDigitalWallet string
The digital wallet app being used.
const ( // Apple Pay RealTimeDecisionDigitalWalletTokenDigitalWalletApplePay RealTimeDecisionDigitalWalletTokenDigitalWallet = "apple_pay" // Google Pay RealTimeDecisionDigitalWalletTokenDigitalWalletGooglePay RealTimeDecisionDigitalWalletTokenDigitalWallet = "google_pay" )
type RealTimeDecisionService ¶
type RealTimeDecisionService struct {
Options []option.RequestOption
}
RealTimeDecisionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRealTimeDecisionService method instead.
func NewRealTimeDecisionService ¶
func NewRealTimeDecisionService(opts ...option.RequestOption) (r *RealTimeDecisionService)
NewRealTimeDecisionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*RealTimeDecisionService) Action ¶
func (r *RealTimeDecisionService) Action(ctx context.Context, realTimeDecisionID string, body RealTimeDecisionActionParams, opts ...option.RequestOption) (res *RealTimeDecision, err error)
Action a Real-Time Decision
func (*RealTimeDecisionService) Get ¶
func (r *RealTimeDecisionService) Get(ctx context.Context, realTimeDecisionID string, opts ...option.RequestOption) (res *RealTimeDecision, err error)
Retrieve a Real-Time Decision
type RealTimeDecisionStatus ¶
type RealTimeDecisionStatus string
The status of the Real-Time Decision.
const ( // The decision is pending action via real-time webhook. RealTimeDecisionStatusPending RealTimeDecisionStatus = "pending" // Your webhook actioned the real-time decision. RealTimeDecisionStatusResponded RealTimeDecisionStatus = "responded" // Your webhook failed to respond to the authorization in time. RealTimeDecisionStatusTimedOut RealTimeDecisionStatus = "timed_out" )
type RealTimeDecisionType ¶
type RealTimeDecisionType string
A constant representing the object's type. For this resource it will always be `real_time_decision`.
const (
RealTimeDecisionTypeRealTimeDecision RealTimeDecisionType = "real_time_decision"
)
type RealTimePaymentsTransfer ¶
type RealTimePaymentsTransfer struct {
// The Real-Time Payments Transfer's identifier.
ID string `json:"id,required"`
// The Account from which the transfer was sent.
AccountID string `json:"account_id,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// If your account requires approvals for transfers and the transfer was approved,
// this will contain details of the approval.
Approval RealTimePaymentsTransferApproval `json:"approval,required,nullable"`
// If your account requires approvals for transfers and the transfer was not
// approved, this will contain details of the cancellation.
Cancellation RealTimePaymentsTransferCancellation `json:"cancellation,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The name of the transfer's recipient as provided by the sender.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
// currency. For real-time payments transfers this is always equal to `USD`.
Currency RealTimePaymentsTransferCurrency `json:"currency,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The destination American Bankers' Association (ABA) Routing Transit Number
// (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// The identifier of the External Account the transfer was made to, if any.
ExternalAccountID string `json:"external_account_id,required,nullable"`
// The ID for the pending transaction representing the transfer. A pending
// transaction is created when the transfer
// [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
// by someone else in your organization.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// If the transfer is rejected by Real-Time Payments or the destination financial
// institution, this will contain supplemental details.
Rejection RealTimePaymentsTransferRejection `json:"rejection,required,nullable"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The Account Number the recipient will see as having sent the transfer.
SourceAccountNumberID string `json:"source_account_number_id,required"`
// The lifecycle status of the transfer.
Status RealTimePaymentsTransferStatus `json:"status,required"`
// After the transfer is submitted to Real-Time Payments, this will contain
// supplemental details.
Submission RealTimePaymentsTransferSubmission `json:"submission,required,nullable"`
// The Transaction funding the transfer once it is complete.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `real_time_payments_transfer`.
Type RealTimePaymentsTransferType `json:"type,required"`
// The unique identifier you chose for this transfer.
UniqueIdentifier string `json:"unique_identifier,required,nullable"`
JSON realTimePaymentsTransferJSON
}
Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.
func (*RealTimePaymentsTransfer) UnmarshalJSON ¶
func (r *RealTimePaymentsTransfer) UnmarshalJSON(data []byte) (err error)
type RealTimePaymentsTransferApproval ¶
type RealTimePaymentsTransferApproval struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was approved.
ApprovedAt time.Time `json:"approved_at,required" format:"date-time"`
// If the Transfer was approved by a user in the dashboard, the email address of
// that user.
ApprovedBy string `json:"approved_by,required,nullable"`
JSON realTimePaymentsTransferApprovalJSON
}
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
func (*RealTimePaymentsTransferApproval) UnmarshalJSON ¶
func (r *RealTimePaymentsTransferApproval) UnmarshalJSON(data []byte) (err error)
type RealTimePaymentsTransferCancellation ¶
type RealTimePaymentsTransferCancellation struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Transfer was canceled.
CanceledAt time.Time `json:"canceled_at,required" format:"date-time"`
// If the Transfer was canceled by a user in the dashboard, the email address of
// that user.
CanceledBy string `json:"canceled_by,required,nullable"`
JSON realTimePaymentsTransferCancellationJSON
}
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
func (*RealTimePaymentsTransferCancellation) UnmarshalJSON ¶
func (r *RealTimePaymentsTransferCancellation) UnmarshalJSON(data []byte) (err error)
type RealTimePaymentsTransferCurrency ¶
type RealTimePaymentsTransferCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`.
const ( // Canadian Dollar (CAD) RealTimePaymentsTransferCurrencyCad RealTimePaymentsTransferCurrency = "CAD" // Swiss Franc (CHF) RealTimePaymentsTransferCurrencyChf RealTimePaymentsTransferCurrency = "CHF" // Euro (EUR) RealTimePaymentsTransferCurrencyEur RealTimePaymentsTransferCurrency = "EUR" // British Pound (GBP) RealTimePaymentsTransferCurrencyGbp RealTimePaymentsTransferCurrency = "GBP" // Japanese Yen (JPY) RealTimePaymentsTransferCurrencyJpy RealTimePaymentsTransferCurrency = "JPY" // US Dollar (USD) RealTimePaymentsTransferCurrencyUsd RealTimePaymentsTransferCurrency = "USD" )
type RealTimePaymentsTransferListParams ¶
type RealTimePaymentsTransferListParams struct {
// Filter Real-Time Payments Transfers to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[RealTimePaymentsTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Filter Real-Time Payments Transfers to those made to the specified External
// Account.
ExternalAccountID param.Field[string] `query:"external_account_id"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter ACH Transfers to the one with the specified unique identifier.
UniqueIdentifier param.Field[string] `query:"unique_identifier"`
}
func (RealTimePaymentsTransferListParams) URLQuery ¶
func (r RealTimePaymentsTransferListParams) URLQuery() (v url.Values)
URLQuery serializes RealTimePaymentsTransferListParams's query parameters as `url.Values`.
type RealTimePaymentsTransferListParamsCreatedAt ¶
type RealTimePaymentsTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (RealTimePaymentsTransferListParamsCreatedAt) URLQuery ¶
func (r RealTimePaymentsTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes RealTimePaymentsTransferListParamsCreatedAt's query parameters as `url.Values`.
type RealTimePaymentsTransferNewParams ¶
type RealTimePaymentsTransferNewParams struct {
// The transfer amount in USD cents. For Real-Time Payments transfers, must be
// positive.
Amount param.Field[int64] `json:"amount,required"`
// The name of the transfer's recipient.
CreditorName param.Field[string] `json:"creditor_name,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation param.Field[string] `json:"remittance_information,required"`
// The identifier of the Account Number from which to send the transfer.
SourceAccountNumberID param.Field[string] `json:"source_account_number_id,required"`
// The destination account number.
DestinationAccountNumber param.Field[string] `json:"destination_account_number"`
// The destination American Bankers' Association (ABA) Routing Transit Number
// (RTN).
DestinationRoutingNumber param.Field[string] `json:"destination_routing_number"`
// The ID of an External Account to initiate a transfer to. If this parameter is
// provided, `destination_account_number` and `destination_routing_number` must be
// absent.
ExternalAccountID param.Field[string] `json:"external_account_id"`
// Whether the transfer requires explicit approval via the dashboard or API.
RequireApproval param.Field[bool] `json:"require_approval"`
// A unique identifier you choose for the transfer. Reusing this identifier for
// another transfer will result in an error. You can query for the transfer
// associated with this identifier using the List endpoint.
UniqueIdentifier param.Field[string] `json:"unique_identifier"`
}
func (RealTimePaymentsTransferNewParams) MarshalJSON ¶
func (r RealTimePaymentsTransferNewParams) MarshalJSON() (data []byte, err error)
type RealTimePaymentsTransferRejection ¶
type RealTimePaymentsTransferRejection struct {
// Additional information about the rejection provided by the recipient bank when
// the `reject_reason_code` is `NARRATIVE`.
RejectReasonAdditionalInformation string `json:"reject_reason_additional_information,required,nullable"`
// The reason the transfer was rejected as provided by the recipient bank or the
// Real-Time Payments network.
RejectReasonCode RealTimePaymentsTransferRejectionRejectReasonCode `json:"reject_reason_code,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was rejected.
RejectedAt time.Time `json:"rejected_at,required,nullable" format:"date-time"`
JSON realTimePaymentsTransferRejectionJSON
}
If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.
func (*RealTimePaymentsTransferRejection) UnmarshalJSON ¶
func (r *RealTimePaymentsTransferRejection) UnmarshalJSON(data []byte) (err error)
type RealTimePaymentsTransferRejectionRejectReasonCode ¶
type RealTimePaymentsTransferRejectionRejectReasonCode string
The reason the transfer was rejected as provided by the recipient bank or the Real-Time Payments network.
const ( // The destination account is closed. Corresponds to the Real-Time Payments reason // code `AC04`. RealTimePaymentsTransferRejectionRejectReasonCodeAccountClosed RealTimePaymentsTransferRejectionRejectReasonCode = "account_closed" // The destination account is currently blocked from receiving transactions. // Corresponds to the Real-Time Payments reason code `AC06`. RealTimePaymentsTransferRejectionRejectReasonCodeAccountBlocked RealTimePaymentsTransferRejectionRejectReasonCode = "account_blocked" // The destination account is ineligible to receive Real-Time Payments transfers. // Corresponds to the Real-Time Payments reason code `AC14`. RealTimePaymentsTransferRejectionRejectReasonCodeInvalidCreditorAccountType RealTimePaymentsTransferRejectionRejectReasonCode = "invalid_creditor_account_type" // The destination account does not exist. Corresponds to the Real-Time Payments // reason code `AC03`. RealTimePaymentsTransferRejectionRejectReasonCodeInvalidCreditorAccountNumber RealTimePaymentsTransferRejectionRejectReasonCode = "invalid_creditor_account_number" // The destination routing number is invalid. Corresponds to the Real-Time Payments // reason code `RC04`. RealTimePaymentsTransferRejectionRejectReasonCodeInvalidCreditorFinancialInstitutionIdentifier RealTimePaymentsTransferRejectionRejectReasonCode = "invalid_creditor_financial_institution_identifier" // The destination account holder is deceased. Corresponds to the Real-Time // Payments reason code `MD07`. RealTimePaymentsTransferRejectionRejectReasonCodeEndCustomerDeceased RealTimePaymentsTransferRejectionRejectReasonCode = "end_customer_deceased" // The reason is provided as narrative information in the additional information // field. RealTimePaymentsTransferRejectionRejectReasonCodeNarrative RealTimePaymentsTransferRejectionRejectReasonCode = "narrative" // Real-Time Payments transfers are not allowed to the destination account. // Corresponds to the Real-Time Payments reason code `AG01`. RealTimePaymentsTransferRejectionRejectReasonCodeTransactionForbidden RealTimePaymentsTransferRejectionRejectReasonCode = "transaction_forbidden" // Real-Time Payments transfers are not enabled for the destination account. // Corresponds to the Real-Time Payments reason code `AG03`. RealTimePaymentsTransferRejectionRejectReasonCodeTransactionTypeNotSupported RealTimePaymentsTransferRejectionRejectReasonCode = "transaction_type_not_supported" // The amount of the transfer is different than expected by the recipient. // Corresponds to the Real-Time Payments reason code `AM09`. RealTimePaymentsTransferRejectionRejectReasonCodeUnexpectedAmount RealTimePaymentsTransferRejectionRejectReasonCode = "unexpected_amount" // The amount is higher than the recipient is authorized to send or receive. // Corresponds to the Real-Time Payments reason code `AM14`. RealTimePaymentsTransferRejectionRejectReasonCodeAmountExceedsBankLimits RealTimePaymentsTransferRejectionRejectReasonCode = "amount_exceeds_bank_limits" // The creditor's address is required, but missing or invalid. Corresponds to the // Real-Time Payments reason code `BE04`. RealTimePaymentsTransferRejectionRejectReasonCodeInvalidCreditorAddress RealTimePaymentsTransferRejectionRejectReasonCode = "invalid_creditor_address" // The specified creditor is unknown. Corresponds to the Real-Time Payments reason // code `BE06`. RealTimePaymentsTransferRejectionRejectReasonCodeUnknownEndCustomer RealTimePaymentsTransferRejectionRejectReasonCode = "unknown_end_customer" // The debtor's address is required, but missing or invalid. Corresponds to the // Real-Time Payments reason code `BE07`. RealTimePaymentsTransferRejectionRejectReasonCodeInvalidDebtorAddress RealTimePaymentsTransferRejectionRejectReasonCode = "invalid_debtor_address" // There was a timeout processing the transfer. Corresponds to the Real-Time // Payments reason code `DS24`. RealTimePaymentsTransferRejectionRejectReasonCodeTimeout RealTimePaymentsTransferRejectionRejectReasonCode = "timeout" // Real-Time Payments transfers are not enabled for the destination account. // Corresponds to the Real-Time Payments reason code `NOAT`. RealTimePaymentsTransferRejectionRejectReasonCodeUnsupportedMessageForRecipient RealTimePaymentsTransferRejectionRejectReasonCode = "unsupported_message_for_recipient" // The destination financial institution is currently not connected to Real-Time // Payments. Corresponds to the Real-Time Payments reason code `9912`. RealTimePaymentsTransferRejectionRejectReasonCodeRecipientConnectionNotAvailable RealTimePaymentsTransferRejectionRejectReasonCode = "recipient_connection_not_available" // Real-Time Payments is currently unavailable. Corresponds to the Real-Time // Payments reason code `9948`. RealTimePaymentsTransferRejectionRejectReasonCodeRealTimePaymentsSuspended RealTimePaymentsTransferRejectionRejectReasonCode = "real_time_payments_suspended" // The destination financial institution is currently signed off of Real-Time // Payments. Corresponds to the Real-Time Payments reason code `9910`. RealTimePaymentsTransferRejectionRejectReasonCodeInstructedAgentSignedOff RealTimePaymentsTransferRejectionRejectReasonCode = "instructed_agent_signed_off" // The transfer was rejected due to an internal Increase issue. We have been // notified. RealTimePaymentsTransferRejectionRejectReasonCodeProcessingError RealTimePaymentsTransferRejectionRejectReasonCode = "processing_error" // Some other error or issue has occurred. RealTimePaymentsTransferRejectionRejectReasonCodeOther RealTimePaymentsTransferRejectionRejectReasonCode = "other" )
type RealTimePaymentsTransferService ¶
type RealTimePaymentsTransferService struct {
Options []option.RequestOption
}
RealTimePaymentsTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRealTimePaymentsTransferService method instead.
func NewRealTimePaymentsTransferService ¶
func NewRealTimePaymentsTransferService(opts ...option.RequestOption) (r *RealTimePaymentsTransferService)
NewRealTimePaymentsTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*RealTimePaymentsTransferService) Get ¶
func (r *RealTimePaymentsTransferService) Get(ctx context.Context, realTimePaymentsTransferID string, opts ...option.RequestOption) (res *RealTimePaymentsTransfer, err error)
Retrieve a Real-Time Payments Transfer
func (*RealTimePaymentsTransferService) List ¶
func (r *RealTimePaymentsTransferService) List(ctx context.Context, query RealTimePaymentsTransferListParams, opts ...option.RequestOption) (res *shared.Page[RealTimePaymentsTransfer], err error)
List Real-Time Payments Transfers
func (*RealTimePaymentsTransferService) ListAutoPaging ¶
func (r *RealTimePaymentsTransferService) ListAutoPaging(ctx context.Context, query RealTimePaymentsTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[RealTimePaymentsTransfer]
List Real-Time Payments Transfers
func (*RealTimePaymentsTransferService) New ¶
func (r *RealTimePaymentsTransferService) New(ctx context.Context, body RealTimePaymentsTransferNewParams, opts ...option.RequestOption) (res *RealTimePaymentsTransfer, err error)
Create a Real-Time Payments Transfer
type RealTimePaymentsTransferStatus ¶
type RealTimePaymentsTransferStatus string
The lifecycle status of the transfer.
const ( // The transfer is pending approval. RealTimePaymentsTransferStatusPendingApproval RealTimePaymentsTransferStatus = "pending_approval" // The transfer has been canceled. RealTimePaymentsTransferStatusCanceled RealTimePaymentsTransferStatus = "canceled" // The transfer is queued to be submitted to Real-Time Payments. RealTimePaymentsTransferStatusPendingSubmission RealTimePaymentsTransferStatus = "pending_submission" // The transfer has been submitted and is pending a response from Real-Time // Payments. RealTimePaymentsTransferStatusSubmitted RealTimePaymentsTransferStatus = "submitted" // The transfer has been sent successfully and is complete. RealTimePaymentsTransferStatusComplete RealTimePaymentsTransferStatus = "complete" // The transfer was rejected by the network or the recipient's bank. RealTimePaymentsTransferStatusRejected RealTimePaymentsTransferStatus = "rejected" // The transfer requires attention from an Increase operator. RealTimePaymentsTransferStatusRequiresAttention RealTimePaymentsTransferStatus = "requires_attention" )
type RealTimePaymentsTransferSubmission ¶
type RealTimePaymentsTransferSubmission struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was submitted to The Clearing House.
SubmittedAt time.Time `json:"submitted_at,required,nullable" format:"date-time"`
// The Real-Time Payments network identification of the transfer.
TransactionIdentification string `json:"transaction_identification,required"`
JSON realTimePaymentsTransferSubmissionJSON
}
After the transfer is submitted to Real-Time Payments, this will contain supplemental details.
func (*RealTimePaymentsTransferSubmission) UnmarshalJSON ¶
func (r *RealTimePaymentsTransferSubmission) UnmarshalJSON(data []byte) (err error)
type RealTimePaymentsTransferType ¶
type RealTimePaymentsTransferType string
A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.
const (
RealTimePaymentsTransferTypeRealTimePaymentsTransfer RealTimePaymentsTransferType = "real_time_payments_transfer"
)
type RoutingNumber ¶
type RoutingNumber struct {
// This routing number's support for ACH Transfers.
ACHTransfers RoutingNumberACHTransfers `json:"ach_transfers,required"`
// The name of the financial institution belonging to a routing number.
Name string `json:"name,required"`
// This routing number's support for Real-Time Payments Transfers.
RealTimePaymentsTransfers RoutingNumberRealTimePaymentsTransfers `json:"real_time_payments_transfers,required"`
// The nine digit routing number identifier.
RoutingNumber string `json:"routing_number,required"`
// A constant representing the object's type. For this resource it will always be
// `routing_number`.
Type RoutingNumberType `json:"type,required"`
// This routing number's support for Wire Transfers.
WireTransfers RoutingNumberWireTransfers `json:"wire_transfers,required"`
JSON routingNumberJSON
}
Routing numbers are used to identify your bank in a financial transaction.
func (*RoutingNumber) UnmarshalJSON ¶
func (r *RoutingNumber) UnmarshalJSON(data []byte) (err error)
type RoutingNumberACHTransfers ¶
type RoutingNumberACHTransfers string
This routing number's support for ACH Transfers.
const ( // The routing number can receive this transfer type. RoutingNumberACHTransfersSupported RoutingNumberACHTransfers = "supported" // The routing number cannot receive this transfer type. RoutingNumberACHTransfersNotSupported RoutingNumberACHTransfers = "not_supported" )
type RoutingNumberListParams ¶
type RoutingNumberListParams struct {
// Filter financial institutions by routing number.
RoutingNumber param.Field[string] `query:"routing_number,required"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (RoutingNumberListParams) URLQuery ¶
func (r RoutingNumberListParams) URLQuery() (v url.Values)
URLQuery serializes RoutingNumberListParams's query parameters as `url.Values`.
type RoutingNumberRealTimePaymentsTransfers ¶
type RoutingNumberRealTimePaymentsTransfers string
This routing number's support for Real-Time Payments Transfers.
const ( // The routing number can receive this transfer type. RoutingNumberRealTimePaymentsTransfersSupported RoutingNumberRealTimePaymentsTransfers = "supported" // The routing number cannot receive this transfer type. RoutingNumberRealTimePaymentsTransfersNotSupported RoutingNumberRealTimePaymentsTransfers = "not_supported" )
type RoutingNumberService ¶
type RoutingNumberService struct {
Options []option.RequestOption
}
RoutingNumberService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRoutingNumberService method instead.
func NewRoutingNumberService ¶
func NewRoutingNumberService(opts ...option.RequestOption) (r *RoutingNumberService)
NewRoutingNumberService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*RoutingNumberService) List ¶
func (r *RoutingNumberService) List(ctx context.Context, query RoutingNumberListParams, opts ...option.RequestOption) (res *shared.Page[RoutingNumber], err error)
You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.
func (*RoutingNumberService) ListAutoPaging ¶
func (r *RoutingNumberService) ListAutoPaging(ctx context.Context, query RoutingNumberListParams, opts ...option.RequestOption) *shared.PageAutoPager[RoutingNumber]
You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.
type RoutingNumberType ¶
type RoutingNumberType string
A constant representing the object's type. For this resource it will always be `routing_number`.
const (
RoutingNumberTypeRoutingNumber RoutingNumberType = "routing_number"
)
type RoutingNumberWireTransfers ¶
type RoutingNumberWireTransfers string
This routing number's support for Wire Transfers.
const ( // The routing number can receive this transfer type. RoutingNumberWireTransfersSupported RoutingNumberWireTransfers = "supported" // The routing number cannot receive this transfer type. RoutingNumberWireTransfersNotSupported RoutingNumberWireTransfers = "not_supported" )
type SimulationACHTransferNewInboundParams ¶
type SimulationACHTransferNewInboundParams struct {
// The identifier of the Account Number the inbound ACH Transfer is for.
AccountNumberID param.Field[string] `json:"account_number_id,required"`
// The transfer amount in cents. A positive amount originates a credit transfer
// pushing funds to the receiving account. A negative amount originates a debit
// transfer pulling funds from the receiving account.
Amount param.Field[int64] `json:"amount,required"`
// The description of the date of the transfer.
CompanyDescriptiveDate param.Field[string] `json:"company_descriptive_date"`
// Data associated with the transfer set by the sender.
CompanyDiscretionaryData param.Field[string] `json:"company_discretionary_data"`
// The description of the transfer set by the sender.
CompanyEntryDescription param.Field[string] `json:"company_entry_description"`
// The sender's company id.
CompanyID param.Field[string] `json:"company_id"`
// The name of the sender.
CompanyName param.Field[string] `json:"company_name"`
}
func (SimulationACHTransferNewInboundParams) MarshalJSON ¶
func (r SimulationACHTransferNewInboundParams) MarshalJSON() (data []byte, err error)
type SimulationACHTransferReturnParams ¶
type SimulationACHTransferReturnParams struct {
// The reason why the Federal Reserve or destination bank returned this transfer.
// Defaults to `no_account`.
Reason param.Field[SimulationACHTransferReturnParamsReason] `json:"reason"`
}
func (SimulationACHTransferReturnParams) MarshalJSON ¶
func (r SimulationACHTransferReturnParams) MarshalJSON() (data []byte, err error)
type SimulationACHTransferReturnParamsReason ¶
type SimulationACHTransferReturnParamsReason string
The reason why the Federal Reserve or destination bank returned this transfer. Defaults to `no_account`.
const ( // Code R01. Insufficient funds in the source account. SimulationACHTransferReturnParamsReasonInsufficientFund SimulationACHTransferReturnParamsReason = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. SimulationACHTransferReturnParamsReasonNoAccount SimulationACHTransferReturnParamsReason = "no_account" // Code R02. The account is closed. SimulationACHTransferReturnParamsReasonAccountClosed SimulationACHTransferReturnParamsReason = "account_closed" // Code R04. The account number is invalid at the receiving bank. SimulationACHTransferReturnParamsReasonInvalidAccountNumberStructure SimulationACHTransferReturnParamsReason = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. SimulationACHTransferReturnParamsReasonAccountFrozenEntryReturnedPerOfacInstruction SimulationACHTransferReturnParamsReason = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. SimulationACHTransferReturnParamsReasonCreditEntryRefusedByReceiver SimulationACHTransferReturnParamsReason = "credit_entry_refused_by_receiver" // Class code. SimulationACHTransferReturnParamsReasonUnauthorizedDebitToConsumerAccountUsingCorporateSecCode SimulationACHTransferReturnParamsReason = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. SimulationACHTransferReturnParamsReasonCorporateCustomerAdvisedNotAuthorized SimulationACHTransferReturnParamsReason = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. SimulationACHTransferReturnParamsReasonPaymentStopped SimulationACHTransferReturnParamsReason = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. SimulationACHTransferReturnParamsReasonNonTransactionAccount SimulationACHTransferReturnParamsReason = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. SimulationACHTransferReturnParamsReasonUncollectedFunds SimulationACHTransferReturnParamsReason = "uncollected_funds" // Code R28. The routing number is incorrect. SimulationACHTransferReturnParamsReasonRoutingNumberCheckDigitError SimulationACHTransferReturnParamsReason = "routing_number_check_digit_error" SimulationACHTransferReturnParamsReasonCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete SimulationACHTransferReturnParamsReason = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. SimulationACHTransferReturnParamsReasonAmountFieldError SimulationACHTransferReturnParamsReason = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. SimulationACHTransferReturnParamsReasonAuthorizationRevokedByCustomer SimulationACHTransferReturnParamsReason = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. SimulationACHTransferReturnParamsReasonInvalidACHRoutingNumber SimulationACHTransferReturnParamsReason = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. SimulationACHTransferReturnParamsReasonFileRecordEditCriteria SimulationACHTransferReturnParamsReason = "file_record_edit_criteria" // Code R45. The individual name field was invalid. SimulationACHTransferReturnParamsReasonEnrInvalidIndividualName SimulationACHTransferReturnParamsReason = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. SimulationACHTransferReturnParamsReasonReturnedPerOdfiRequest SimulationACHTransferReturnParamsReason = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. SimulationACHTransferReturnParamsReasonLimitedParticipationDfi SimulationACHTransferReturnParamsReason = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. SimulationACHTransferReturnParamsReasonIncorrectlyCodedOutboundInternationalPayment SimulationACHTransferReturnParamsReason = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. SimulationACHTransferReturnParamsReasonAccountSoldToAnotherDfi SimulationACHTransferReturnParamsReason = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. SimulationACHTransferReturnParamsReasonAddendaError SimulationACHTransferReturnParamsReason = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. SimulationACHTransferReturnParamsReasonBeneficiaryOrAccountHolderDeceased SimulationACHTransferReturnParamsReason = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. SimulationACHTransferReturnParamsReasonCustomerAdvisedNotWithinAuthorizationTerms SimulationACHTransferReturnParamsReason = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). SimulationACHTransferReturnParamsReasonCorrectedReturn SimulationACHTransferReturnParamsReason = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. SimulationACHTransferReturnParamsReasonDuplicateEntry SimulationACHTransferReturnParamsReason = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. SimulationACHTransferReturnParamsReasonDuplicateReturn SimulationACHTransferReturnParamsReason = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrDuplicateEnrollment SimulationACHTransferReturnParamsReason = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrInvalidDfiAccountNumber SimulationACHTransferReturnParamsReason = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrInvalidIndividualIDNumber SimulationACHTransferReturnParamsReason = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrInvalidRepresentativePayeeIndicator SimulationACHTransferReturnParamsReason = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrInvalidTransactionCode SimulationACHTransferReturnParamsReason = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrReturnOfEnrEntry SimulationACHTransferReturnParamsReason = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. SimulationACHTransferReturnParamsReasonEnrRoutingNumberCheckDigitError SimulationACHTransferReturnParamsReason = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. SimulationACHTransferReturnParamsReasonEntryNotProcessedByGateway SimulationACHTransferReturnParamsReason = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. SimulationACHTransferReturnParamsReasonFieldError SimulationACHTransferReturnParamsReason = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. SimulationACHTransferReturnParamsReasonForeignReceivingDfiUnableToSettle SimulationACHTransferReturnParamsReason = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. SimulationACHTransferReturnParamsReasonIatEntryCodingError SimulationACHTransferReturnParamsReason = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. SimulationACHTransferReturnParamsReasonImproperEffectiveEntryDate SimulationACHTransferReturnParamsReason = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. SimulationACHTransferReturnParamsReasonImproperSourceDocumentSourceDocumentPresented SimulationACHTransferReturnParamsReason = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. SimulationACHTransferReturnParamsReasonInvalidCompanyID SimulationACHTransferReturnParamsReason = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. SimulationACHTransferReturnParamsReasonInvalidForeignReceivingDfiIdentification SimulationACHTransferReturnParamsReason = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. SimulationACHTransferReturnParamsReasonInvalidIndividualIDNumber SimulationACHTransferReturnParamsReason = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. SimulationACHTransferReturnParamsReasonItemAndRckEntryPresentedForPayment SimulationACHTransferReturnParamsReason = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. SimulationACHTransferReturnParamsReasonItemRelatedToRckEntryIsIneligible SimulationACHTransferReturnParamsReason = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. SimulationACHTransferReturnParamsReasonMandatoryFieldError SimulationACHTransferReturnParamsReason = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. SimulationACHTransferReturnParamsReasonMisroutedDishonoredReturn SimulationACHTransferReturnParamsReason = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. SimulationACHTransferReturnParamsReasonMisroutedReturn SimulationACHTransferReturnParamsReason = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. SimulationACHTransferReturnParamsReasonNoErrorsFound SimulationACHTransferReturnParamsReason = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. SimulationACHTransferReturnParamsReasonNonAcceptanceOfR62DishonoredReturn SimulationACHTransferReturnParamsReason = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. SimulationACHTransferReturnParamsReasonNonParticipantInIatProgram SimulationACHTransferReturnParamsReason = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. SimulationACHTransferReturnParamsReasonPermissibleReturnEntry SimulationACHTransferReturnParamsReason = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. SimulationACHTransferReturnParamsReasonPermissibleReturnEntryNotAccepted SimulationACHTransferReturnParamsReason = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. SimulationACHTransferReturnParamsReasonRdfiNonSettlement SimulationACHTransferReturnParamsReason = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. SimulationACHTransferReturnParamsReasonRdfiParticipantInCheckTruncationProgram SimulationACHTransferReturnParamsReason = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. SimulationACHTransferReturnParamsReasonRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity SimulationACHTransferReturnParamsReason = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. SimulationACHTransferReturnParamsReasonReturnNotADuplicate SimulationACHTransferReturnParamsReason = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. SimulationACHTransferReturnParamsReasonReturnOfErroneousOrReversingDebit SimulationACHTransferReturnParamsReason = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. SimulationACHTransferReturnParamsReasonReturnOfImproperCreditEntry SimulationACHTransferReturnParamsReason = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. SimulationACHTransferReturnParamsReasonReturnOfImproperDebitEntry SimulationACHTransferReturnParamsReason = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. SimulationACHTransferReturnParamsReasonReturnOfXckEntry SimulationACHTransferReturnParamsReason = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. SimulationACHTransferReturnParamsReasonSourceDocumentPresentedForPayment SimulationACHTransferReturnParamsReason = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. SimulationACHTransferReturnParamsReasonStateLawAffectingRckAcceptance SimulationACHTransferReturnParamsReason = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. SimulationACHTransferReturnParamsReasonStopPaymentOnItemRelatedToRckEntry SimulationACHTransferReturnParamsReason = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. SimulationACHTransferReturnParamsReasonStopPaymentOnSourceDocument SimulationACHTransferReturnParamsReason = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. SimulationACHTransferReturnParamsReasonTimelyOriginalReturn SimulationACHTransferReturnParamsReason = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. SimulationACHTransferReturnParamsReasonTraceNumberError SimulationACHTransferReturnParamsReason = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. SimulationACHTransferReturnParamsReasonUntimelyDishonoredReturn SimulationACHTransferReturnParamsReason = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. SimulationACHTransferReturnParamsReasonUntimelyReturn SimulationACHTransferReturnParamsReason = "untimely_return" )
type SimulationACHTransferService ¶
type SimulationACHTransferService struct {
Options []option.RequestOption
}
SimulationACHTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationACHTransferService method instead.
func NewSimulationACHTransferService ¶
func NewSimulationACHTransferService(opts ...option.RequestOption) (r *SimulationACHTransferService)
NewSimulationACHTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationACHTransferService) NewInbound ¶
func (r *SimulationACHTransferService) NewInbound(ctx context.Context, body SimulationACHTransferNewInboundParams, opts ...option.RequestOption) (res *ACHTransferSimulation, err error)
Simulates an inbound ACH transfer to your account. This imitates initiating a transaction to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the `amount` is positive or negative. The result of calling this API will be either a Transaction(#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed.
func (*SimulationACHTransferService) Return ¶
func (r *SimulationACHTransferService) Return(ctx context.Context, achTransferID string, body SimulationACHTransferReturnParams, opts ...option.RequestOption) (res *ACHTransfer, err error)
Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a `status` of `submitted`.
func (*SimulationACHTransferService) Submit ¶
func (r *SimulationACHTransferService) Submit(ctx context.Context, achTransferID string, opts ...option.RequestOption) (res *ACHTransfer, err error)
Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_submission`. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of `submitted`.
type SimulationAccountStatementNewParams ¶
type SimulationAccountStatementNewParams struct {
// The identifier of the Account the statement is for.
AccountID param.Field[string] `json:"account_id,required"`
}
func (SimulationAccountStatementNewParams) MarshalJSON ¶
func (r SimulationAccountStatementNewParams) MarshalJSON() (data []byte, err error)
type SimulationAccountStatementService ¶
type SimulationAccountStatementService struct {
Options []option.RequestOption
}
SimulationAccountStatementService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationAccountStatementService method instead.
func NewSimulationAccountStatementService ¶
func NewSimulationAccountStatementService(opts ...option.RequestOption) (r *SimulationAccountStatementService)
NewSimulationAccountStatementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationAccountStatementService) New ¶
func (r *SimulationAccountStatementService) New(ctx context.Context, body SimulationAccountStatementNewParams, opts ...option.RequestOption) (res *AccountStatement, err error)
Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month.
type SimulationAccountTransferService ¶
type SimulationAccountTransferService struct {
Options []option.RequestOption
}
SimulationAccountTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationAccountTransferService method instead.
func NewSimulationAccountTransferService ¶
func NewSimulationAccountTransferService(opts ...option.RequestOption) (r *SimulationAccountTransferService)
NewSimulationAccountTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationAccountTransferService) Complete ¶
func (r *SimulationAccountTransferService) Complete(ctx context.Context, accountTransferID string, opts ...option.RequestOption) (res *AccountTransfer, err error)
If your account is configured to require approval for each transfer, this endpoint simulates the approval of an [Account Transfer](#account-transfers). You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a `status` of `pending_approval`.
type SimulationCardAuthorizeParams ¶
type SimulationCardAuthorizeParams struct {
// The authorization amount in cents.
Amount param.Field[int64] `json:"amount,required"`
// The identifier of the Card to be authorized.
CardID param.Field[string] `json:"card_id"`
// The identifier of the Digital Wallet Token to be authorized.
DigitalWalletTokenID param.Field[string] `json:"digital_wallet_token_id"`
// The identifier of the Event Subscription to use. If provided, will override the
// default real time event subscription. Because you can only create one real time
// decision event subscription, you can use this field to route events to any
// specified event subscription for testing purposes.
EventSubscriptionID param.Field[string] `json:"event_subscription_id"`
// The identifier of the Physical Card to be authorized.
PhysicalCardID param.Field[string] `json:"physical_card_id"`
}
func (SimulationCardAuthorizeParams) MarshalJSON ¶
func (r SimulationCardAuthorizeParams) MarshalJSON() (data []byte, err error)
type SimulationCardDisputeActionParams ¶
type SimulationCardDisputeActionParams struct {
// The status to move the dispute to.
Status param.Field[SimulationCardDisputeActionParamsStatus] `json:"status,required"`
// Why the dispute was rejected. Not required for accepting disputes.
Explanation param.Field[string] `json:"explanation"`
}
func (SimulationCardDisputeActionParams) MarshalJSON ¶
func (r SimulationCardDisputeActionParams) MarshalJSON() (data []byte, err error)
type SimulationCardDisputeActionParamsStatus ¶
type SimulationCardDisputeActionParamsStatus string
The status to move the dispute to.
const ( // The Card Dispute has been accepted and your funds have been returned. SimulationCardDisputeActionParamsStatusAccepted SimulationCardDisputeActionParamsStatus = "accepted" // The Card Dispute has been rejected. SimulationCardDisputeActionParamsStatusRejected SimulationCardDisputeActionParamsStatus = "rejected" )
type SimulationCardDisputeService ¶
type SimulationCardDisputeService struct {
Options []option.RequestOption
}
SimulationCardDisputeService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCardDisputeService method instead.
func NewSimulationCardDisputeService ¶
func NewSimulationCardDisputeService(opts ...option.RequestOption) (r *SimulationCardDisputeService)
NewSimulationCardDisputeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCardDisputeService) Action ¶
func (r *SimulationCardDisputeService) Action(ctx context.Context, cardDisputeID string, body SimulationCardDisputeActionParams, opts ...option.RequestOption) (res *CardDispute, err error)
After a [Card Dispute](#card-disputes) is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of `pending_reviewing`.
type SimulationCardProfileService ¶ added in v0.4.0
type SimulationCardProfileService struct {
Options []option.RequestOption
}
SimulationCardProfileService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCardProfileService method instead.
func NewSimulationCardProfileService ¶ added in v0.4.0
func NewSimulationCardProfileService(opts ...option.RequestOption) (r *SimulationCardProfileService)
NewSimulationCardProfileService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCardProfileService) Approve ¶ added in v0.4.0
func (r *SimulationCardProfileService) Approve(ctx context.Context, cardProfileID string, opts ...option.RequestOption) (res *CardProfile, err error)
After a [Card Profile](#card-profile) is created in production, the images will be uploaded to Visa within one day. Since Card Profiles are not uploaded to Visa in sandbox, this endpoint simulates that step. Invoking this simulation triggers the webhooks Increase sends when the Card Profile is approved and updates the status of the Card Profile.
type SimulationCardRefundNewParams ¶
type SimulationCardRefundNewParams struct {
// The identifier for the Transaction to refund. The Transaction's source must have
// a category of card_settlement.
TransactionID param.Field[string] `json:"transaction_id,required"`
}
func (SimulationCardRefundNewParams) MarshalJSON ¶
func (r SimulationCardRefundNewParams) MarshalJSON() (data []byte, err error)
type SimulationCardRefundService ¶
type SimulationCardRefundService struct {
Options []option.RequestOption
}
SimulationCardRefundService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCardRefundService method instead.
func NewSimulationCardRefundService ¶
func NewSimulationCardRefundService(opts ...option.RequestOption) (r *SimulationCardRefundService)
NewSimulationCardRefundService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCardRefundService) New ¶
func (r *SimulationCardRefundService) New(ctx context.Context, body SimulationCardRefundNewParams, opts ...option.RequestOption) (res *Transaction, err error)
Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.
type SimulationCardService ¶
type SimulationCardService struct {
Options []option.RequestOption
}
SimulationCardService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCardService method instead.
func NewSimulationCardService ¶
func NewSimulationCardService(opts ...option.RequestOption) (r *SimulationCardService)
NewSimulationCardService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCardService) Authorize ¶
func (r *SimulationCardService) Authorize(ctx context.Context, body SimulationCardAuthorizeParams, opts ...option.RequestOption) (res *CardAuthorizationSimulation, err error)
Simulates a purchase authorization on a Card(#cards). Depending on the balance available to the card and the `amount` submitted, the authorization activity will result in a [Pending Transaction](#pending-transactions) of type `card_authorization` or a [Declined Transaction](#declined-transactions) of type `card_decline`. You can pass either a Card id or a [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different ways purchases can be made.
func (*SimulationCardService) Settlement ¶
func (r *SimulationCardService) Settlement(ctx context.Context, body SimulationCardSettlementParams, opts ...option.RequestOption) (res *Transaction, err error)
Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.
type SimulationCardSettlementParams ¶
type SimulationCardSettlementParams struct {
// The identifier of the Card to create a settlement on.
CardID param.Field[string] `json:"card_id,required"`
// The identifier of the Pending Transaction for the Card Authorization you wish to
// settle.
PendingTransactionID param.Field[string] `json:"pending_transaction_id,required"`
// The amount to be settled. This defaults to the amount of the Pending Transaction
// being settled.
Amount param.Field[int64] `json:"amount"`
}
func (SimulationCardSettlementParams) MarshalJSON ¶
func (r SimulationCardSettlementParams) MarshalJSON() (data []byte, err error)
type SimulationCheckDepositService ¶
type SimulationCheckDepositService struct {
Options []option.RequestOption
}
SimulationCheckDepositService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCheckDepositService method instead.
func NewSimulationCheckDepositService ¶
func NewSimulationCheckDepositService(opts ...option.RequestOption) (r *SimulationCheckDepositService)
NewSimulationCheckDepositService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCheckDepositService) Reject ¶
func (r *SimulationCheckDepositService) Reject(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to factors like poor image quality. This Check Deposit must first have a `status` of `pending`.
func (*SimulationCheckDepositService) Return ¶
func (r *SimulationCheckDepositService) Return(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.
func (*SimulationCheckDepositService) Submit ¶
func (r *SimulationCheckDepositService) Submit(ctx context.Context, checkDepositID string, opts ...option.RequestOption) (res *CheckDeposit, err error)
Simulates the submission of a [Check Deposit](#check-deposits) to the Federal Reserve. This Check Deposit must first have a `status` of `pending`.
type SimulationCheckTransferService ¶
type SimulationCheckTransferService struct {
Options []option.RequestOption
}
SimulationCheckTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationCheckTransferService method instead.
func NewSimulationCheckTransferService ¶
func NewSimulationCheckTransferService(opts ...option.RequestOption) (r *SimulationCheckTransferService)
NewSimulationCheckTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationCheckTransferService) Deposit ¶
func (r *SimulationCheckTransferService) Deposit(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
Simulates a [Check Transfer](#check-transfers) being deposited at a bank. This transfer must first have a `status` of `mailed`.
func (*SimulationCheckTransferService) Mail ¶
func (r *SimulationCheckTransferService) Mail(ctx context.Context, checkTransferID string, opts ...option.RequestOption) (res *CheckTransfer, err error)
Simulates the mailing of a [Check Transfer](#check-transfers), which happens once per weekday in production but can be sped up in sandbox. This transfer must first have a `status` of `pending_approval` or `pending_submission`.
type SimulationDigitalWalletTokenRequestNewParams ¶
type SimulationDigitalWalletTokenRequestNewParams struct {
// The identifier of the Card to be authorized.
CardID param.Field[string] `json:"card_id,required"`
}
func (SimulationDigitalWalletTokenRequestNewParams) MarshalJSON ¶
func (r SimulationDigitalWalletTokenRequestNewParams) MarshalJSON() (data []byte, err error)
type SimulationDigitalWalletTokenRequestNewResponse ¶ added in v0.3.0
type SimulationDigitalWalletTokenRequestNewResponse struct {
// If the simulated tokenization attempt was declined, this field contains details
// as to why.
DeclineReason SimulationDigitalWalletTokenRequestNewResponseDeclineReason `json:"decline_reason,required,nullable"`
// If the simulated tokenization attempt was accepted, this field contains the id
// of the Digital Wallet Token that was created.
DigitalWalletTokenID string `json:"digital_wallet_token_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `inbound_digital_wallet_token_request_simulation_result`.
Type SimulationDigitalWalletTokenRequestNewResponseType `json:"type,required"`
JSON simulationDigitalWalletTokenRequestNewResponseJSON
}
The results of a Digital Wallet Token simulation.
func (*SimulationDigitalWalletTokenRequestNewResponse) UnmarshalJSON ¶ added in v0.3.0
func (r *SimulationDigitalWalletTokenRequestNewResponse) UnmarshalJSON(data []byte) (err error)
type SimulationDigitalWalletTokenRequestNewResponseDeclineReason ¶ added in v0.3.0
type SimulationDigitalWalletTokenRequestNewResponseDeclineReason string
If the simulated tokenization attempt was declined, this field contains details as to why.
const ( // The card is not active. SimulationDigitalWalletTokenRequestNewResponseDeclineReasonCardNotActive SimulationDigitalWalletTokenRequestNewResponseDeclineReason = "card_not_active" // The card does not have a two-factor authentication method. SimulationDigitalWalletTokenRequestNewResponseDeclineReasonNoVerificationMethod SimulationDigitalWalletTokenRequestNewResponseDeclineReason = "no_verification_method" // Your webhook timed out when evaluating the token provisioning attempt. SimulationDigitalWalletTokenRequestNewResponseDeclineReasonWebhookTimedOut SimulationDigitalWalletTokenRequestNewResponseDeclineReason = "webhook_timed_out" // Your webhook declined the token provisioning attempt. SimulationDigitalWalletTokenRequestNewResponseDeclineReasonWebhookDeclined SimulationDigitalWalletTokenRequestNewResponseDeclineReason = "webhook_declined" )
type SimulationDigitalWalletTokenRequestNewResponseType ¶ added in v0.3.0
type SimulationDigitalWalletTokenRequestNewResponseType string
A constant representing the object's type. For this resource it will always be `inbound_digital_wallet_token_request_simulation_result`.
const (
SimulationDigitalWalletTokenRequestNewResponseTypeInboundDigitalWalletTokenRequestSimulationResult SimulationDigitalWalletTokenRequestNewResponseType = "inbound_digital_wallet_token_request_simulation_result"
)
type SimulationDigitalWalletTokenRequestService ¶
type SimulationDigitalWalletTokenRequestService struct {
Options []option.RequestOption
}
SimulationDigitalWalletTokenRequestService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationDigitalWalletTokenRequestService method instead.
func NewSimulationDigitalWalletTokenRequestService ¶
func NewSimulationDigitalWalletTokenRequestService(opts ...option.RequestOption) (r *SimulationDigitalWalletTokenRequestService)
NewSimulationDigitalWalletTokenRequestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationDigitalWalletTokenRequestService) New ¶
func (r *SimulationDigitalWalletTokenRequestService) New(ctx context.Context, body SimulationDigitalWalletTokenRequestNewParams, opts ...option.RequestOption) (res *SimulationDigitalWalletTokenRequestNewResponse, err error)
Simulates a user attempting add a Card(#cards) to a digital wallet such as Apple Pay.
type SimulationDocumentNewParams ¶
type SimulationDocumentNewParams struct {
// The identifier of the Account the tax document is for.
AccountID param.Field[string] `json:"account_id,required"`
}
func (SimulationDocumentNewParams) MarshalJSON ¶
func (r SimulationDocumentNewParams) MarshalJSON() (data []byte, err error)
type SimulationDocumentService ¶
type SimulationDocumentService struct {
Options []option.RequestOption
}
SimulationDocumentService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationDocumentService method instead.
func NewSimulationDocumentService ¶
func NewSimulationDocumentService(opts ...option.RequestOption) (r *SimulationDocumentService)
NewSimulationDocumentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationDocumentService) New ¶
func (r *SimulationDocumentService) New(ctx context.Context, body SimulationDocumentNewParams, opts ...option.RequestOption) (res *Document, err error)
Simulates an tax document being created for an account.
type SimulationInboundFundsHoldReleaseResponse ¶ added in v0.5.0
type SimulationInboundFundsHoldReleaseResponse struct {
// The Inbound Funds Hold identifier.
ID string `json:"id,required"`
// The held amount in the minor unit of the account's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// When the hold will be released automatically. Certain conditions may cause it to
// be released before this time.
AutomaticallyReleasesAt time.Time `json:"automatically_releases_at,required" format:"date-time"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold
// was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's
// currency.
Currency SimulationInboundFundsHoldReleaseResponseCurrency `json:"currency,required"`
// The ID of the Transaction for which funds were held.
HeldTransactionID string `json:"held_transaction_id,required,nullable"`
// The ID of the Pending Transaction representing the held funds.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// When the hold was released (if it has been released).
ReleasedAt time.Time `json:"released_at,required,nullable" format:"date-time"`
// The status of the hold.
Status SimulationInboundFundsHoldReleaseResponseStatus `json:"status,required"`
// A constant representing the object's type. For this resource it will always be
// `inbound_funds_hold`.
Type SimulationInboundFundsHoldReleaseResponseType `json:"type,required"`
JSON simulationInboundFundsHoldReleaseResponseJSON
}
We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution.
func (*SimulationInboundFundsHoldReleaseResponse) UnmarshalJSON ¶ added in v0.5.0
func (r *SimulationInboundFundsHoldReleaseResponse) UnmarshalJSON(data []byte) (err error)
type SimulationInboundFundsHoldReleaseResponseCurrency ¶ added in v0.5.0
type SimulationInboundFundsHoldReleaseResponseCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.
const ( // Canadian Dollar (CAD) SimulationInboundFundsHoldReleaseResponseCurrencyCad SimulationInboundFundsHoldReleaseResponseCurrency = "CAD" // Swiss Franc (CHF) SimulationInboundFundsHoldReleaseResponseCurrencyChf SimulationInboundFundsHoldReleaseResponseCurrency = "CHF" // Euro (EUR) SimulationInboundFundsHoldReleaseResponseCurrencyEur SimulationInboundFundsHoldReleaseResponseCurrency = "EUR" // British Pound (GBP) SimulationInboundFundsHoldReleaseResponseCurrencyGbp SimulationInboundFundsHoldReleaseResponseCurrency = "GBP" // Japanese Yen (JPY) SimulationInboundFundsHoldReleaseResponseCurrencyJpy SimulationInboundFundsHoldReleaseResponseCurrency = "JPY" // US Dollar (USD) SimulationInboundFundsHoldReleaseResponseCurrencyUsd SimulationInboundFundsHoldReleaseResponseCurrency = "USD" )
type SimulationInboundFundsHoldReleaseResponseStatus ¶ added in v0.5.0
type SimulationInboundFundsHoldReleaseResponseStatus string
The status of the hold.
const ( // Funds are still being held. SimulationInboundFundsHoldReleaseResponseStatusHeld SimulationInboundFundsHoldReleaseResponseStatus = "held" // Funds have been released. SimulationInboundFundsHoldReleaseResponseStatusComplete SimulationInboundFundsHoldReleaseResponseStatus = "complete" )
type SimulationInboundFundsHoldReleaseResponseType ¶ added in v0.5.0
type SimulationInboundFundsHoldReleaseResponseType string
A constant representing the object's type. For this resource it will always be `inbound_funds_hold`.
const (
SimulationInboundFundsHoldReleaseResponseTypeInboundFundsHold SimulationInboundFundsHoldReleaseResponseType = "inbound_funds_hold"
)
type SimulationInboundFundsHoldService ¶ added in v0.5.0
type SimulationInboundFundsHoldService struct {
Options []option.RequestOption
}
SimulationInboundFundsHoldService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationInboundFundsHoldService method instead.
func NewSimulationInboundFundsHoldService ¶ added in v0.5.0
func NewSimulationInboundFundsHoldService(opts ...option.RequestOption) (r *SimulationInboundFundsHoldService)
NewSimulationInboundFundsHoldService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationInboundFundsHoldService) Release ¶ added in v0.5.0
func (r *SimulationInboundFundsHoldService) Release(ctx context.Context, inboundFundsHoldID string, opts ...option.RequestOption) (res *SimulationInboundFundsHoldReleaseResponse, err error)
This endpoint simulates immediately releasing an inbound funds hold, which might be created as a result of e.g., an ACH debit.
type SimulationInboundWireDrawdownRequestNewParams ¶
type SimulationInboundWireDrawdownRequestNewParams struct {
// The amount being requested in cents.
Amount param.Field[int64] `json:"amount,required"`
// The drawdown request's beneficiary's account number.
BeneficiaryAccountNumber param.Field[string] `json:"beneficiary_account_number,required"`
// The drawdown request's beneficiary's routing number.
BeneficiaryRoutingNumber param.Field[string] `json:"beneficiary_routing_number,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
// requested. Will always be "USD".
Currency param.Field[string] `json:"currency,required"`
// A message from the drawdown request's originator.
MessageToRecipient param.Field[string] `json:"message_to_recipient,required"`
// The drawdown request's originator's account number.
OriginatorAccountNumber param.Field[string] `json:"originator_account_number,required"`
// The drawdown request's originator's routing number.
OriginatorRoutingNumber param.Field[string] `json:"originator_routing_number,required"`
// The Account Number to which the recipient of this request is being requested to
// send funds from.
RecipientAccountNumberID param.Field[string] `json:"recipient_account_number_id,required"`
// Line 1 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine1 param.Field[string] `json:"beneficiary_address_line1"`
// Line 2 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine2 param.Field[string] `json:"beneficiary_address_line2"`
// Line 3 of the drawdown request's beneficiary's address.
BeneficiaryAddressLine3 param.Field[string] `json:"beneficiary_address_line3"`
// The drawdown request's beneficiary's name.
BeneficiaryName param.Field[string] `json:"beneficiary_name"`
// Line 1 of the drawdown request's originator's address.
OriginatorAddressLine1 param.Field[string] `json:"originator_address_line1"`
// Line 2 of the drawdown request's originator's address.
OriginatorAddressLine2 param.Field[string] `json:"originator_address_line2"`
// Line 3 of the drawdown request's originator's address.
OriginatorAddressLine3 param.Field[string] `json:"originator_address_line3"`
// The drawdown request's originator's name.
OriginatorName param.Field[string] `json:"originator_name"`
// Line 1 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine1 param.Field[string] `json:"originator_to_beneficiary_information_line1"`
// Line 2 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine2 param.Field[string] `json:"originator_to_beneficiary_information_line2"`
// Line 3 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine3 param.Field[string] `json:"originator_to_beneficiary_information_line3"`
// Line 4 of the information conveyed from the originator of the message to the
// beneficiary.
OriginatorToBeneficiaryInformationLine4 param.Field[string] `json:"originator_to_beneficiary_information_line4"`
}
func (SimulationInboundWireDrawdownRequestNewParams) MarshalJSON ¶
func (r SimulationInboundWireDrawdownRequestNewParams) MarshalJSON() (data []byte, err error)
type SimulationInboundWireDrawdownRequestService ¶
type SimulationInboundWireDrawdownRequestService struct {
Options []option.RequestOption
}
SimulationInboundWireDrawdownRequestService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationInboundWireDrawdownRequestService method instead.
func NewSimulationInboundWireDrawdownRequestService ¶
func NewSimulationInboundWireDrawdownRequestService(opts ...option.RequestOption) (r *SimulationInboundWireDrawdownRequestService)
NewSimulationInboundWireDrawdownRequestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationInboundWireDrawdownRequestService) New ¶
func (r *SimulationInboundWireDrawdownRequestService) New(ctx context.Context, body SimulationInboundWireDrawdownRequestNewParams, opts ...option.RequestOption) (res *InboundWireDrawdownRequest, err error)
Simulates receiving an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
type SimulationInterestPaymentNewParams ¶
type SimulationInterestPaymentNewParams struct {
// The identifier of the Account Number the Interest Payment is for.
AccountID param.Field[string] `json:"account_id,required"`
// The interest amount in cents. Must be positive.
Amount param.Field[int64] `json:"amount,required"`
// The end of the interest period. If not provided, defaults to the current time.
PeriodEnd param.Field[time.Time] `json:"period_end" format:"date-time"`
// The start of the interest period. If not provided, defaults to the current time.
PeriodStart param.Field[time.Time] `json:"period_start" format:"date-time"`
}
func (SimulationInterestPaymentNewParams) MarshalJSON ¶
func (r SimulationInterestPaymentNewParams) MarshalJSON() (data []byte, err error)
type SimulationInterestPaymentService ¶
type SimulationInterestPaymentService struct {
Options []option.RequestOption
}
SimulationInterestPaymentService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationInterestPaymentService method instead.
func NewSimulationInterestPaymentService ¶
func NewSimulationInterestPaymentService(opts ...option.RequestOption) (r *SimulationInterestPaymentService)
NewSimulationInterestPaymentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationInterestPaymentService) New ¶
func (r *SimulationInterestPaymentService) New(ctx context.Context, body SimulationInterestPaymentNewParams, opts ...option.RequestOption) (res *InterestPaymentSimulationResult, err error)
Simulates an interest payment to your account. In production, this happens automatically on the first of each month.
type SimulationProgramNewParams ¶ added in v0.1.1
type SimulationProgramNewParams struct {
// The name of the program being added.
Name param.Field[string] `json:"name,required"`
}
func (SimulationProgramNewParams) MarshalJSON ¶ added in v0.1.1
func (r SimulationProgramNewParams) MarshalJSON() (data []byte, err error)
type SimulationProgramService ¶ added in v0.1.1
type SimulationProgramService struct {
Options []option.RequestOption
}
SimulationProgramService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationProgramService method instead.
func NewSimulationProgramService ¶ added in v0.1.1
func NewSimulationProgramService(opts ...option.RequestOption) (r *SimulationProgramService)
NewSimulationProgramService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationProgramService) New ¶ added in v0.1.1
func (r *SimulationProgramService) New(ctx context.Context, body SimulationProgramNewParams, opts ...option.RequestOption) (res *Program, err error)
Simulates a program being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, `program_id` is a required field when creating accounts.
type SimulationRealTimePaymentsTransferCompleteParams ¶
type SimulationRealTimePaymentsTransferCompleteParams struct {
// If set, the simulation will reject the transfer.
Rejection param.Field[SimulationRealTimePaymentsTransferCompleteParamsRejection] `json:"rejection"`
}
func (SimulationRealTimePaymentsTransferCompleteParams) MarshalJSON ¶
func (r SimulationRealTimePaymentsTransferCompleteParams) MarshalJSON() (data []byte, err error)
type SimulationRealTimePaymentsTransferCompleteParamsRejection ¶
type SimulationRealTimePaymentsTransferCompleteParamsRejection struct {
// The reason code that the simulated rejection will have.
RejectReasonCode param.Field[SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode] `json:"reject_reason_code,required"`
}
If set, the simulation will reject the transfer.
func (SimulationRealTimePaymentsTransferCompleteParamsRejection) MarshalJSON ¶ added in v0.1.1
func (r SimulationRealTimePaymentsTransferCompleteParamsRejection) MarshalJSON() (data []byte, err error)
type SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode ¶
type SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode string
The reason code that the simulated rejection will have.
const ( // The destination account is closed. Corresponds to the Real-Time Payments reason // code `AC04`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeAccountClosed SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "account_closed" // The destination account is currently blocked from receiving transactions. // Corresponds to the Real-Time Payments reason code `AC06`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeAccountBlocked SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "account_blocked" // The destination account is ineligible to receive Real-Time Payments transfers. // Corresponds to the Real-Time Payments reason code `AC14`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInvalidCreditorAccountType SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "invalid_creditor_account_type" // The destination account does not exist. Corresponds to the Real-Time Payments // reason code `AC03`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInvalidCreditorAccountNumber SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "invalid_creditor_account_number" // The destination routing number is invalid. Corresponds to the Real-Time Payments // reason code `RC04`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInvalidCreditorFinancialInstitutionIdentifier SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "invalid_creditor_financial_institution_identifier" // The destination account holder is deceased. Corresponds to the Real-Time // Payments reason code `MD07`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeEndCustomerDeceased SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "end_customer_deceased" // The reason is provided as narrative information in the additional information // field. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeNarrative SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "narrative" // Real-Time Payments transfers are not allowed to the destination account. // Corresponds to the Real-Time Payments reason code `AG01`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeTransactionForbidden SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "transaction_forbidden" // Real-Time Payments transfers are not enabled for the destination account. // Corresponds to the Real-Time Payments reason code `AG03`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeTransactionTypeNotSupported SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "transaction_type_not_supported" // The amount of the transfer is different than expected by the recipient. // Corresponds to the Real-Time Payments reason code `AM09`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeUnexpectedAmount SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "unexpected_amount" // The amount is higher than the recipient is authorized to send or receive. // Corresponds to the Real-Time Payments reason code `AM14`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeAmountExceedsBankLimits SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "amount_exceeds_bank_limits" // The creditor's address is required, but missing or invalid. Corresponds to the // Real-Time Payments reason code `BE04`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInvalidCreditorAddress SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "invalid_creditor_address" // The specified creditor is unknown. Corresponds to the Real-Time Payments reason // code `BE06`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeUnknownEndCustomer SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "unknown_end_customer" // The debtor's address is required, but missing or invalid. Corresponds to the // Real-Time Payments reason code `BE07`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInvalidDebtorAddress SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "invalid_debtor_address" // There was a timeout processing the transfer. Corresponds to the Real-Time // Payments reason code `DS24`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeTimeout SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "timeout" // Real-Time Payments transfers are not enabled for the destination account. // Corresponds to the Real-Time Payments reason code `NOAT`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeUnsupportedMessageForRecipient SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "unsupported_message_for_recipient" // The destination financial institution is currently not connected to Real-Time // Payments. Corresponds to the Real-Time Payments reason code `9912`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeRecipientConnectionNotAvailable SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "recipient_connection_not_available" // Real-Time Payments is currently unavailable. Corresponds to the Real-Time // Payments reason code `9948`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeRealTimePaymentsSuspended SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "real_time_payments_suspended" // The destination financial institution is currently signed off of Real-Time // Payments. Corresponds to the Real-Time Payments reason code `9910`. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeInstructedAgentSignedOff SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "instructed_agent_signed_off" // The transfer was rejected due to an internal Increase issue. We have been // notified. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeProcessingError SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "processing_error" // Some other error or issue has occurred. SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCodeOther SimulationRealTimePaymentsTransferCompleteParamsRejectionRejectReasonCode = "other" )
type SimulationRealTimePaymentsTransferNewInboundParams ¶
type SimulationRealTimePaymentsTransferNewInboundParams struct {
// The identifier of the Account Number the inbound Real-Time Payments Transfer is
// for.
AccountNumberID param.Field[string] `json:"account_number_id,required"`
// The transfer amount in USD cents. Must be positive.
Amount param.Field[int64] `json:"amount,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber param.Field[string] `json:"debtor_account_number"`
// The name provided by the sender of the transfer.
DebtorName param.Field[string] `json:"debtor_name"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber param.Field[string] `json:"debtor_routing_number"`
// Additional information included with the transfer.
RemittanceInformation param.Field[string] `json:"remittance_information"`
// The identifier of a pending Request for Payment that this transfer will fulfill.
RequestForPaymentID param.Field[string] `json:"request_for_payment_id"`
}
func (SimulationRealTimePaymentsTransferNewInboundParams) MarshalJSON ¶
func (r SimulationRealTimePaymentsTransferNewInboundParams) MarshalJSON() (data []byte, err error)
type SimulationRealTimePaymentsTransferService ¶
type SimulationRealTimePaymentsTransferService struct {
Options []option.RequestOption
}
SimulationRealTimePaymentsTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationRealTimePaymentsTransferService method instead.
func NewSimulationRealTimePaymentsTransferService ¶
func NewSimulationRealTimePaymentsTransferService(opts ...option.RequestOption) (r *SimulationRealTimePaymentsTransferService)
NewSimulationRealTimePaymentsTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationRealTimePaymentsTransferService) Complete ¶
func (r *SimulationRealTimePaymentsTransferService) Complete(ctx context.Context, realTimePaymentsTransferID string, body SimulationRealTimePaymentsTransferCompleteParams, opts ...option.RequestOption) (res *RealTimePaymentsTransfer, err error)
Simulates submission of a Real-Time Payments transfer and handling the response from the destination financial institution. This transfer must first have a `status` of `pending_submission`.
func (*SimulationRealTimePaymentsTransferService) NewInbound ¶
func (r *SimulationRealTimePaymentsTransferService) NewInbound(ctx context.Context, body SimulationRealTimePaymentsTransferNewInboundParams, opts ...option.RequestOption) (res *InboundRealTimePaymentsTransferSimulationResult, err error)
Simulates an inbound Real-Time Payments transfer to your account. Real-Time Payments are a beta feature.
type SimulationService ¶
type SimulationService struct {
Options []option.RequestOption
AccountTransfers *SimulationAccountTransferService
AccountStatements *SimulationAccountStatementService
ACHTransfers *SimulationACHTransferService
CardDisputes *SimulationCardDisputeService
CardProfiles *SimulationCardProfileService
CardRefunds *SimulationCardRefundService
CheckTransfers *SimulationCheckTransferService
Documents *SimulationDocumentService
DigitalWalletTokenRequests *SimulationDigitalWalletTokenRequestService
CheckDeposits *SimulationCheckDepositService
Programs *SimulationProgramService
InboundWireDrawdownRequests *SimulationInboundWireDrawdownRequestService
InboundFundsHolds *SimulationInboundFundsHoldService
InterestPayments *SimulationInterestPaymentService
WireTransfers *SimulationWireTransferService
Cards *SimulationCardService
RealTimePaymentsTransfers *SimulationRealTimePaymentsTransferService
}
SimulationService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationService method instead.
func NewSimulationService ¶
func NewSimulationService(opts ...option.RequestOption) (r *SimulationService)
NewSimulationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type SimulationWireTransferNewInboundParams ¶
type SimulationWireTransferNewInboundParams struct {
// The identifier of the Account Number the inbound Wire Transfer is for.
AccountNumberID param.Field[string] `json:"account_number_id,required"`
// The transfer amount in cents. Must be positive.
Amount param.Field[int64] `json:"amount,required"`
// The sending bank will set beneficiary_address_line1 in production. You can
// simulate any value here.
BeneficiaryAddressLine1 param.Field[string] `json:"beneficiary_address_line1"`
// The sending bank will set beneficiary_address_line2 in production. You can
// simulate any value here.
BeneficiaryAddressLine2 param.Field[string] `json:"beneficiary_address_line2"`
// The sending bank will set beneficiary_address_line3 in production. You can
// simulate any value here.
BeneficiaryAddressLine3 param.Field[string] `json:"beneficiary_address_line3"`
// The sending bank will set beneficiary_name in production. You can simulate any
// value here.
BeneficiaryName param.Field[string] `json:"beneficiary_name"`
// The sending bank will set beneficiary_reference in production. You can simulate
// any value here.
BeneficiaryReference param.Field[string] `json:"beneficiary_reference"`
// The sending bank will set originator_address_line1 in production. You can
// simulate any value here.
OriginatorAddressLine1 param.Field[string] `json:"originator_address_line1"`
// The sending bank will set originator_address_line2 in production. You can
// simulate any value here.
OriginatorAddressLine2 param.Field[string] `json:"originator_address_line2"`
// The sending bank will set originator_address_line3 in production. You can
// simulate any value here.
OriginatorAddressLine3 param.Field[string] `json:"originator_address_line3"`
// The sending bank will set originator_name in production. You can simulate any
// value here.
OriginatorName param.Field[string] `json:"originator_name"`
// The sending bank will set originator_to_beneficiary_information_line1 in
// production. You can simulate any value here.
OriginatorToBeneficiaryInformationLine1 param.Field[string] `json:"originator_to_beneficiary_information_line1"`
// The sending bank will set originator_to_beneficiary_information_line2 in
// production. You can simulate any value here.
OriginatorToBeneficiaryInformationLine2 param.Field[string] `json:"originator_to_beneficiary_information_line2"`
// The sending bank will set originator_to_beneficiary_information_line3 in
// production. You can simulate any value here.
OriginatorToBeneficiaryInformationLine3 param.Field[string] `json:"originator_to_beneficiary_information_line3"`
// The sending bank will set originator_to_beneficiary_information_line4 in
// production. You can simulate any value here.
OriginatorToBeneficiaryInformationLine4 param.Field[string] `json:"originator_to_beneficiary_information_line4"`
}
func (SimulationWireTransferNewInboundParams) MarshalJSON ¶
func (r SimulationWireTransferNewInboundParams) MarshalJSON() (data []byte, err error)
type SimulationWireTransferService ¶
type SimulationWireTransferService struct {
Options []option.RequestOption
}
SimulationWireTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSimulationWireTransferService method instead.
func NewSimulationWireTransferService ¶
func NewSimulationWireTransferService(opts ...option.RequestOption) (r *SimulationWireTransferService)
NewSimulationWireTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*SimulationWireTransferService) NewInbound ¶
func (r *SimulationWireTransferService) NewInbound(ctx context.Context, body SimulationWireTransferNewInboundParams, opts ...option.RequestOption) (res *WireTransferSimulation, err error)
Simulates an inbound Wire Transfer to your account.
type SupplementalDocument ¶ added in v0.1.1
type SupplementalDocument struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
// Supplemental Document was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The File containing the document.
FileID string `json:"file_id,required"`
// A constant representing the object's type. For this resource it will always be
// `entity_supplemental_document`.
Type SupplementalDocumentType `json:"type,required"`
JSON supplementalDocumentJSON
}
Supplemental Documents are uploaded files connected to an Entity during onboarding.
func (*SupplementalDocument) UnmarshalJSON ¶ added in v0.1.1
func (r *SupplementalDocument) UnmarshalJSON(data []byte) (err error)
type SupplementalDocumentType ¶ added in v0.1.1
type SupplementalDocumentType string
A constant representing the object's type. For this resource it will always be `entity_supplemental_document`.
const (
SupplementalDocumentTypeEntitySupplementalDocument SupplementalDocumentType = "entity_supplemental_document"
)
type Transaction ¶
type Transaction struct {
// The Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Transaction amount in the minor unit of its currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// Transaction's currency. This will match the currency on the Transaction's
// Account.
Currency TransactionCurrency `json:"currency,required"`
// An informational message describing this transaction. Use the fields in `source`
// to get more detailed information. This field appears as the line-item on the
// statement.
Description string `json:"description,required"`
// The identifier for the route this Transaction came through. Routes are things
// like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Transaction came through.
RouteType TransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Transaction. Note that for backwards compatibility reasons, additional
// undocumented keys may appear in this object. These should be treated as
// deprecated and will be removed in the future.
Source TransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `transaction`.
Type TransactionType `json:"type,required"`
JSON transactionJSON
}
Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement.
func (*Transaction) UnmarshalJSON ¶
func (r *Transaction) UnmarshalJSON(data []byte) (err error)
type TransactionCurrency ¶
type TransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
const ( // Canadian Dollar (CAD) TransactionCurrencyCad TransactionCurrency = "CAD" // Swiss Franc (CHF) TransactionCurrencyChf TransactionCurrency = "CHF" // Euro (EUR) TransactionCurrencyEur TransactionCurrency = "EUR" // British Pound (GBP) TransactionCurrencyGbp TransactionCurrency = "GBP" // Japanese Yen (JPY) TransactionCurrencyJpy TransactionCurrency = "JPY" // US Dollar (USD) TransactionCurrencyUsd TransactionCurrency = "USD" )
type TransactionListParams ¶
type TransactionListParams struct {
// Filter Transactions for those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
Category param.Field[TransactionListParamsCategory] `query:"category"`
CreatedAt param.Field[TransactionListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Transactions for those belonging to the specified route. This could be a
// Card ID or an Account Number ID.
RouteID param.Field[string] `query:"route_id"`
}
func (TransactionListParams) URLQuery ¶
func (r TransactionListParams) URLQuery() (v url.Values)
URLQuery serializes TransactionListParams's query parameters as `url.Values`.
type TransactionListParamsCategory ¶
type TransactionListParamsCategory struct {
// Return results whose value is in the provided list. For GET requests, this
// should be encoded as a comma-delimited string, such as `?in=one,two,three`.
In param.Field[[]TransactionListParamsCategoryIn] `query:"in"`
}
func (TransactionListParamsCategory) URLQuery ¶
func (r TransactionListParamsCategory) URLQuery() (v url.Values)
URLQuery serializes TransactionListParamsCategory's query parameters as `url.Values`.
type TransactionListParamsCategoryIn ¶
type TransactionListParamsCategoryIn string
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. TransactionListParamsCategoryInAccountTransferIntention TransactionListParamsCategoryIn = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. TransactionListParamsCategoryInACHTransferIntention TransactionListParamsCategoryIn = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. TransactionListParamsCategoryInACHTransferRejection TransactionListParamsCategoryIn = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. TransactionListParamsCategoryInACHTransferReturn TransactionListParamsCategoryIn = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. TransactionListParamsCategoryInCardDisputeAcceptance TransactionListParamsCategoryIn = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. TransactionListParamsCategoryInCardRefund TransactionListParamsCategoryIn = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. TransactionListParamsCategoryInCardRevenuePayment TransactionListParamsCategoryIn = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. TransactionListParamsCategoryInCardSettlement TransactionListParamsCategoryIn = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. TransactionListParamsCategoryInCheckDepositAcceptance TransactionListParamsCategoryIn = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. TransactionListParamsCategoryInCheckDepositReturn TransactionListParamsCategoryIn = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. TransactionListParamsCategoryInCheckTransferDeposit TransactionListParamsCategoryIn = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. TransactionListParamsCategoryInCheckTransferIntention TransactionListParamsCategoryIn = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. TransactionListParamsCategoryInCheckTransferStopPaymentRequest TransactionListParamsCategoryIn = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. TransactionListParamsCategoryInFeePayment TransactionListParamsCategoryIn = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. TransactionListParamsCategoryInInboundACHTransfer TransactionListParamsCategoryIn = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. TransactionListParamsCategoryInInboundACHTransferReturnIntention TransactionListParamsCategoryIn = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. TransactionListParamsCategoryInInboundCheck TransactionListParamsCategoryIn = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. TransactionListParamsCategoryInInboundInternationalACHTransfer TransactionListParamsCategoryIn = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. TransactionListParamsCategoryInInboundRealTimePaymentsTransferConfirmation TransactionListParamsCategoryIn = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. TransactionListParamsCategoryInInboundWireDrawdownPayment TransactionListParamsCategoryIn = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. TransactionListParamsCategoryInInboundWireDrawdownPaymentReversal TransactionListParamsCategoryIn = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. TransactionListParamsCategoryInInboundWireReversal TransactionListParamsCategoryIn = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. TransactionListParamsCategoryInInboundWireTransfer TransactionListParamsCategoryIn = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. TransactionListParamsCategoryInInterestPayment TransactionListParamsCategoryIn = "interest_payment" // Internal Source: details will be under the `internal_source` object. TransactionListParamsCategoryInInternalSource TransactionListParamsCategoryIn = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. TransactionListParamsCategoryInRealTimePaymentsTransferAcknowledgement TransactionListParamsCategoryIn = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. TransactionListParamsCategoryInSampleFunds TransactionListParamsCategoryIn = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. TransactionListParamsCategoryInWireTransferIntention TransactionListParamsCategoryIn = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. TransactionListParamsCategoryInWireTransferRejection TransactionListParamsCategoryIn = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. TransactionListParamsCategoryInOther TransactionListParamsCategoryIn = "other" )
type TransactionListParamsCreatedAt ¶
type TransactionListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (TransactionListParamsCreatedAt) URLQuery ¶
func (r TransactionListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes TransactionListParamsCreatedAt's query parameters as `url.Values`.
type TransactionRouteType ¶
type TransactionRouteType string
The type of the route this Transaction came through.
const ( // An Account Number. TransactionRouteTypeAccountNumber TransactionRouteType = "account_number" // A Card. TransactionRouteTypeCard TransactionRouteType = "card" )
type TransactionService ¶
type TransactionService struct {
Options []option.RequestOption
}
TransactionService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTransactionService method instead.
func NewTransactionService ¶
func NewTransactionService(opts ...option.RequestOption) (r *TransactionService)
NewTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*TransactionService) Get ¶
func (r *TransactionService) Get(ctx context.Context, transactionID string, opts ...option.RequestOption) (res *Transaction, err error)
Retrieve a Transaction
func (*TransactionService) List ¶
func (r *TransactionService) List(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) (res *shared.Page[Transaction], err error)
List Transactions
func (*TransactionService) ListAutoPaging ¶
func (r *TransactionService) ListAutoPaging(ctx context.Context, query TransactionListParams, opts ...option.RequestOption) *shared.PageAutoPager[Transaction]
List Transactions
type TransactionSource ¶
type TransactionSource struct {
// An Account Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_intention`.
AccountTransferIntention TransactionSourceAccountTransferIntention `json:"account_transfer_intention,required,nullable"`
// An ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_intention`.
ACHTransferIntention TransactionSourceACHTransferIntention `json:"ach_transfer_intention,required,nullable"`
// An ACH Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_rejection`.
ACHTransferRejection TransactionSourceACHTransferRejection `json:"ach_transfer_rejection,required,nullable"`
// An ACH Transfer Return object. This field will be present in the JSON response
// if and only if `category` is equal to `ach_transfer_return`.
ACHTransferReturn TransactionSourceACHTransferReturn `json:"ach_transfer_return,required,nullable"`
// A Card Dispute Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `card_dispute_acceptance`.
CardDisputeAcceptance TransactionSourceCardDisputeAcceptance `json:"card_dispute_acceptance,required,nullable"`
// A Card Refund object. This field will be present in the JSON response if and
// only if `category` is equal to `card_refund`.
CardRefund TransactionSourceCardRefund `json:"card_refund,required,nullable"`
// A Card Revenue Payment object. This field will be present in the JSON response
// if and only if `category` is equal to `card_revenue_payment`.
CardRevenuePayment TransactionSourceCardRevenuePayment `json:"card_revenue_payment,required,nullable"`
// A Card Settlement object. This field will be present in the JSON response if and
// only if `category` is equal to `card_settlement`.
CardSettlement TransactionSourceCardSettlement `json:"card_settlement,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category TransactionSourceCategory `json:"category,required"`
// A Check Deposit Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_acceptance`.
CheckDepositAcceptance TransactionSourceCheckDepositAcceptance `json:"check_deposit_acceptance,required,nullable"`
// A Check Deposit Return object. This field will be present in the JSON response
// if and only if `category` is equal to `check_deposit_return`.
CheckDepositReturn TransactionSourceCheckDepositReturn `json:"check_deposit_return,required,nullable"`
// A Check Transfer Deposit object. This field will be present in the JSON response
// if and only if `category` is equal to `check_transfer_deposit`.
CheckTransferDeposit TransactionSourceCheckTransferDeposit `json:"check_transfer_deposit,required,nullable"`
// A Check Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_intention`.
CheckTransferIntention TransactionSourceCheckTransferIntention `json:"check_transfer_intention,required,nullable"`
// A Check Transfer Stop Payment Request object. This field will be present in the
// JSON response if and only if `category` is equal to
// `check_transfer_stop_payment_request`.
CheckTransferStopPaymentRequest TransactionSourceCheckTransferStopPaymentRequest `json:"check_transfer_stop_payment_request,required,nullable"`
// A Fee Payment object. This field will be present in the JSON response if and
// only if `category` is equal to `fee_payment`.
FeePayment TransactionSourceFeePayment `json:"fee_payment,required,nullable"`
// An Inbound ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_ach_transfer`.
InboundACHTransfer TransactionSourceInboundACHTransfer `json:"inbound_ach_transfer,required,nullable"`
// An Inbound Check object. This field will be present in the JSON response if and
// only if `category` is equal to `inbound_check`.
InboundCheck TransactionSourceInboundCheck `json:"inbound_check,required,nullable"`
// An Inbound International ACH Transfer object. This field will be present in the
// JSON response if and only if `category` is equal to
// `inbound_international_ach_transfer`.
InboundInternationalACHTransfer TransactionSourceInboundInternationalACHTransfer `json:"inbound_international_ach_transfer,required,nullable"`
// An Inbound Real-Time Payments Transfer Confirmation object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_confirmation`.
InboundRealTimePaymentsTransferConfirmation TransactionSourceInboundRealTimePaymentsTransferConfirmation `json:"inbound_real_time_payments_transfer_confirmation,required,nullable"`
// An Inbound Wire Drawdown Payment object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
InboundWireDrawdownPayment TransactionSourceInboundWireDrawdownPayment `json:"inbound_wire_drawdown_payment,required,nullable"`
// An Inbound Wire Drawdown Payment Reversal object. This field will be present in
// the JSON response if and only if `category` is equal to
// `inbound_wire_drawdown_payment_reversal`.
InboundWireDrawdownPaymentReversal TransactionSourceInboundWireDrawdownPaymentReversal `json:"inbound_wire_drawdown_payment_reversal,required,nullable"`
// An Inbound Wire Reversal object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_reversal`.
InboundWireReversal TransactionSourceInboundWireReversal `json:"inbound_wire_reversal,required,nullable"`
// An Inbound Wire Transfer object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_transfer`.
InboundWireTransfer TransactionSourceInboundWireTransfer `json:"inbound_wire_transfer,required,nullable"`
// An Interest Payment object. This field will be present in the JSON response if
// and only if `category` is equal to `interest_payment`.
InterestPayment TransactionSourceInterestPayment `json:"interest_payment,required,nullable"`
// An Internal Source object. This field will be present in the JSON response if
// and only if `category` is equal to `internal_source`.
InternalSource TransactionSourceInternalSource `json:"internal_source,required,nullable"`
// A Real-Time Payments Transfer Acknowledgement object. This field will be present
// in the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_acknowledgement`.
RealTimePaymentsTransferAcknowledgement TransactionSourceRealTimePaymentsTransferAcknowledgement `json:"real_time_payments_transfer_acknowledgement,required,nullable"`
// A Sample Funds object. This field will be present in the JSON response if and
// only if `category` is equal to `sample_funds`.
SampleFunds TransactionSourceSampleFunds `json:"sample_funds,required,nullable"`
// A Wire Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_intention`.
WireTransferIntention TransactionSourceWireTransferIntention `json:"wire_transfer_intention,required,nullable"`
// A Wire Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_rejection`.
WireTransferRejection TransactionSourceWireTransferRejection `json:"wire_transfer_rejection,required,nullable"`
JSON transactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*TransactionSource) UnmarshalJSON ¶
func (r *TransactionSource) UnmarshalJSON(data []byte) (err error)
type TransactionSourceACHTransferIntention ¶
type TransactionSourceACHTransferIntention struct {
AccountNumber string `json:"account_number,required"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
RoutingNumber string `json:"routing_number,required"`
StatementDescriptor string `json:"statement_descriptor,required"`
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceACHTransferIntentionJSON
}
An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
func (*TransactionSourceACHTransferIntention) UnmarshalJSON ¶
func (r *TransactionSourceACHTransferIntention) UnmarshalJSON(data []byte) (err error)
type TransactionSourceACHTransferRejection ¶
type TransactionSourceACHTransferRejection struct {
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceACHTransferRejectionJSON
}
An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
func (*TransactionSourceACHTransferRejection) UnmarshalJSON ¶
func (r *TransactionSourceACHTransferRejection) UnmarshalJSON(data []byte) (err error)
type TransactionSourceACHTransferReturn ¶
type TransactionSourceACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode TransactionSourceACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceACHTransferReturnJSON
}
An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
func (*TransactionSourceACHTransferReturn) UnmarshalJSON ¶
func (r *TransactionSourceACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type TransactionSourceACHTransferReturnReturnReasonCode ¶
type TransactionSourceACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. TransactionSourceACHTransferReturnReturnReasonCodeInsufficientFund TransactionSourceACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. TransactionSourceACHTransferReturnReturnReasonCodeNoAccount TransactionSourceACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. TransactionSourceACHTransferReturnReturnReasonCodeAccountClosed TransactionSourceACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. TransactionSourceACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure TransactionSourceACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. TransactionSourceACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction TransactionSourceACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. TransactionSourceACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver TransactionSourceACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. TransactionSourceACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode TransactionSourceACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. TransactionSourceACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized TransactionSourceACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. TransactionSourceACHTransferReturnReturnReasonCodePaymentStopped TransactionSourceACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. TransactionSourceACHTransferReturnReturnReasonCodeNonTransactionAccount TransactionSourceACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. TransactionSourceACHTransferReturnReturnReasonCodeUncollectedFunds TransactionSourceACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. TransactionSourceACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError TransactionSourceACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" TransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete TransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. TransactionSourceACHTransferReturnReturnReasonCodeAmountFieldError TransactionSourceACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. TransactionSourceACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer TransactionSourceACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. TransactionSourceACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber TransactionSourceACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. TransactionSourceACHTransferReturnReturnReasonCodeFileRecordEditCriteria TransactionSourceACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. TransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualName TransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. TransactionSourceACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest TransactionSourceACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. TransactionSourceACHTransferReturnReturnReasonCodeLimitedParticipationDfi TransactionSourceACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. TransactionSourceACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment TransactionSourceACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. TransactionSourceACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi TransactionSourceACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. TransactionSourceACHTransferReturnReturnReasonCodeAddendaError TransactionSourceACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. TransactionSourceACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased TransactionSourceACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. TransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms TransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). TransactionSourceACHTransferReturnReturnReasonCodeCorrectedReturn TransactionSourceACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. TransactionSourceACHTransferReturnReturnReasonCodeDuplicateEntry TransactionSourceACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. TransactionSourceACHTransferReturnReturnReasonCodeDuplicateReturn TransactionSourceACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment TransactionSourceACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber TransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber TransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator TransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode TransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry TransactionSourceACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. TransactionSourceACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError TransactionSourceACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. TransactionSourceACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway TransactionSourceACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. TransactionSourceACHTransferReturnReturnReasonCodeFieldError TransactionSourceACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. TransactionSourceACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle TransactionSourceACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. TransactionSourceACHTransferReturnReturnReasonCodeIatEntryCodingError TransactionSourceACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. TransactionSourceACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate TransactionSourceACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. TransactionSourceACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented TransactionSourceACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. TransactionSourceACHTransferReturnReturnReasonCodeInvalidCompanyID TransactionSourceACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. TransactionSourceACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification TransactionSourceACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. TransactionSourceACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber TransactionSourceACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. TransactionSourceACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment TransactionSourceACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. TransactionSourceACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible TransactionSourceACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. TransactionSourceACHTransferReturnReturnReasonCodeMandatoryFieldError TransactionSourceACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. TransactionSourceACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn TransactionSourceACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. TransactionSourceACHTransferReturnReturnReasonCodeMisroutedReturn TransactionSourceACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. TransactionSourceACHTransferReturnReturnReasonCodeNoErrorsFound TransactionSourceACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. TransactionSourceACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn TransactionSourceACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. TransactionSourceACHTransferReturnReturnReasonCodeNonParticipantInIatProgram TransactionSourceACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. TransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntry TransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. TransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted TransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. TransactionSourceACHTransferReturnReturnReasonCodeRdfiNonSettlement TransactionSourceACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. TransactionSourceACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram TransactionSourceACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. TransactionSourceACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity TransactionSourceACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. TransactionSourceACHTransferReturnReturnReasonCodeReturnNotADuplicate TransactionSourceACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. TransactionSourceACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit TransactionSourceACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. TransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry TransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. TransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry TransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. TransactionSourceACHTransferReturnReturnReasonCodeReturnOfXckEntry TransactionSourceACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. TransactionSourceACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment TransactionSourceACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. TransactionSourceACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance TransactionSourceACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. TransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry TransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. TransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument TransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. TransactionSourceACHTransferReturnReturnReasonCodeTimelyOriginalReturn TransactionSourceACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. TransactionSourceACHTransferReturnReturnReasonCodeTraceNumberError TransactionSourceACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. TransactionSourceACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn TransactionSourceACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. TransactionSourceACHTransferReturnReturnReasonCodeUntimelyReturn TransactionSourceACHTransferReturnReturnReasonCode = "untimely_return" )
type TransactionSourceAccountTransferIntention ¶
type TransactionSourceAccountTransferIntention struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency TransactionSourceAccountTransferIntentionCurrency `json:"currency,required"`
// The description you chose to give the transfer.
Description string `json:"description,required"`
// The identifier of the Account to where the Account Transfer was sent.
DestinationAccountID string `json:"destination_account_id,required"`
// The identifier of the Account from where the Account Transfer was sent.
SourceAccountID string `json:"source_account_id,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceAccountTransferIntentionJSON
}
An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
func (*TransactionSourceAccountTransferIntention) UnmarshalJSON ¶
func (r *TransactionSourceAccountTransferIntention) UnmarshalJSON(data []byte) (err error)
type TransactionSourceAccountTransferIntentionCurrency ¶
type TransactionSourceAccountTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) TransactionSourceAccountTransferIntentionCurrencyCad TransactionSourceAccountTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceAccountTransferIntentionCurrencyChf TransactionSourceAccountTransferIntentionCurrency = "CHF" // Euro (EUR) TransactionSourceAccountTransferIntentionCurrencyEur TransactionSourceAccountTransferIntentionCurrency = "EUR" // British Pound (GBP) TransactionSourceAccountTransferIntentionCurrencyGbp TransactionSourceAccountTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceAccountTransferIntentionCurrencyJpy TransactionSourceAccountTransferIntentionCurrency = "JPY" // US Dollar (USD) TransactionSourceAccountTransferIntentionCurrencyUsd TransactionSourceAccountTransferIntentionCurrency = "USD" )
type TransactionSourceCardDisputeAcceptance ¶
type TransactionSourceCardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON transactionSourceCardDisputeAcceptanceJSON
}
A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
func (*TransactionSourceCardDisputeAcceptance) UnmarshalJSON ¶
func (r *TransactionSourceCardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefund ¶
type TransactionSourceCardRefund struct {
// The Card Refund identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency TransactionSourceCardRefundCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails TransactionSourceCardRefundPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_refund`.
Type TransactionSourceCardRefundType `json:"type,required"`
JSON transactionSourceCardRefundJSON
}
A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
func (*TransactionSourceCardRefund) UnmarshalJSON ¶
func (r *TransactionSourceCardRefund) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundCurrency ¶
type TransactionSourceCardRefundCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) TransactionSourceCardRefundCurrencyCad TransactionSourceCardRefundCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCardRefundCurrencyChf TransactionSourceCardRefundCurrency = "CHF" // Euro (EUR) TransactionSourceCardRefundCurrencyEur TransactionSourceCardRefundCurrency = "EUR" // British Pound (GBP) TransactionSourceCardRefundCurrencyGbp TransactionSourceCardRefundCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCardRefundCurrencyJpy TransactionSourceCardRefundCurrency = "JPY" // US Dollar (USD) TransactionSourceCardRefundCurrencyUsd TransactionSourceCardRefundCurrency = "USD" )
type TransactionSourceCardRefundPurchaseDetails ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetails struct {
// Fields specific to car rentals.
CarRental TransactionSourceCardRefundPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging TransactionSourceCardRefundPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel TransactionSourceCardRefundPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*TransactionSourceCardRefundPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsCarRental ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*TransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesNoExtraCharge TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesGas TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesExtraMileage TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesLateReturn TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesOneWayServiceFee TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation TransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesParkingViolation TransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNotApplicable TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle TransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type TransactionSourceCardRefundPurchaseDetailsLodging ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*TransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesNoExtraCharge TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesRestaurant TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesGiftShop TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesMiniBar TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesTelephone TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "telephone" // Other TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesOther TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "other" // Laundry TransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesLaundry TransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "laundry" )
type TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNotApplicable TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNoShow TransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatFreeText TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatOrderNumber TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber TransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type TransactionSourceCardRefundPurchaseDetailsTravel ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary TransactionSourceCardRefundPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []TransactionSourceCardRefundPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*TransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*TransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther TransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsTravelAncillaryServiceJSON
}
func (*TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryNone TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBundledService TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryChangeFee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCargo TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGiftCard TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryLounge TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMedical TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryOther TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPets TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategorySeatFees TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStandby TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryServiceFee TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStore TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryTravelService TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUpgrades TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryWifi TransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorNoCredit TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorOther TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket TransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket TransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNone TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNewTicket TransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type TransactionSourceCardRefundPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON transactionSourceCardRefundPurchaseDetailsTravelTripLegJSON
}
func (*TransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeNone TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed TransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type TransactionSourceCardRefundType ¶
type TransactionSourceCardRefundType string
A constant representing the object's type. For this resource it will always be `card_refund`.
const (
TransactionSourceCardRefundTypeCardRefund TransactionSourceCardRefundType = "card_refund"
)
type TransactionSourceCardRevenuePayment ¶
type TransactionSourceCardRevenuePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency TransactionSourceCardRevenuePaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
// The account the card belonged to.
TransactedOnAccountID string `json:"transacted_on_account_id,required,nullable"`
JSON transactionSourceCardRevenuePaymentJSON
}
A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
func (*TransactionSourceCardRevenuePayment) UnmarshalJSON ¶
func (r *TransactionSourceCardRevenuePayment) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardRevenuePaymentCurrency ¶
type TransactionSourceCardRevenuePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) TransactionSourceCardRevenuePaymentCurrencyCad TransactionSourceCardRevenuePaymentCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCardRevenuePaymentCurrencyChf TransactionSourceCardRevenuePaymentCurrency = "CHF" // Euro (EUR) TransactionSourceCardRevenuePaymentCurrencyEur TransactionSourceCardRevenuePaymentCurrency = "EUR" // British Pound (GBP) TransactionSourceCardRevenuePaymentCurrencyGbp TransactionSourceCardRevenuePaymentCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCardRevenuePaymentCurrencyJpy TransactionSourceCardRevenuePaymentCurrency = "JPY" // US Dollar (USD) TransactionSourceCardRevenuePaymentCurrencyUsd TransactionSourceCardRevenuePaymentCurrency = "USD" )
type TransactionSourceCardSettlement ¶
type TransactionSourceCardSettlement struct {
// The Card Settlement identifier.
ID string `json:"id,required"`
// The amount in the minor unit of the transaction's settlement currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The Card Authorization that was created prior to this Card Settlement, if on
// exists.
CardAuthorization string `json:"card_authorization,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's settlement currency.
Currency TransactionSourceCardSettlementCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The amount in the minor unit of the transaction's presentment currency.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's presentment currency.
PresentmentCurrency string `json:"presentment_currency,required"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails TransactionSourceCardSettlementPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_settlement`.
Type TransactionSourceCardSettlementType `json:"type,required"`
JSON transactionSourceCardSettlementJSON
}
A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
func (*TransactionSourceCardSettlement) UnmarshalJSON ¶
func (r *TransactionSourceCardSettlement) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementCurrency ¶
type TransactionSourceCardSettlementCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
const ( // Canadian Dollar (CAD) TransactionSourceCardSettlementCurrencyCad TransactionSourceCardSettlementCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCardSettlementCurrencyChf TransactionSourceCardSettlementCurrency = "CHF" // Euro (EUR) TransactionSourceCardSettlementCurrencyEur TransactionSourceCardSettlementCurrency = "EUR" // British Pound (GBP) TransactionSourceCardSettlementCurrencyGbp TransactionSourceCardSettlementCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCardSettlementCurrencyJpy TransactionSourceCardSettlementCurrency = "JPY" // US Dollar (USD) TransactionSourceCardSettlementCurrencyUsd TransactionSourceCardSettlementCurrency = "USD" )
type TransactionSourceCardSettlementPurchaseDetails ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetails struct {
// Fields specific to car rentals.
CarRental TransactionSourceCardSettlementPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging TransactionSourceCardSettlementPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel TransactionSourceCardSettlementPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*TransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsCarRental ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*TransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesNoExtraCharge TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesGas TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesExtraMileage TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesLateReturn TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesOneWayServiceFee TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesParkingViolation TransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNotApplicable TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle TransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type TransactionSourceCardSettlementPurchaseDetailsLodging ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*TransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesNoExtraCharge TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesRestaurant TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesGiftShop TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesMiniBar TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesTelephone TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "telephone" // Other TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesOther TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "other" // Laundry TransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesLaundry TransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "laundry" )
type TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNotApplicable TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNoShow TransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatFreeText TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatOrderNumber TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber TransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type TransactionSourceCardSettlementPurchaseDetailsTravel ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary TransactionSourceCardSettlementPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*TransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*TransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsTravelAncillaryServiceJSON
}
func (*TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryNone TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBundledService TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryChangeFee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCargo TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGiftCard TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryLounge TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMedical TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryOther TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPets TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategorySeatFees TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStandby TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryServiceFee TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStore TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryTravelService TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUpgrades TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryWifi TransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorNoCredit TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorOther TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket TransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket TransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNone TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNewTicket TransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON transactionSourceCardSettlementPurchaseDetailsTravelTripLegJSON
}
func (*TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *TransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeNone TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed TransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type TransactionSourceCardSettlementType ¶
type TransactionSourceCardSettlementType string
A constant representing the object's type. For this resource it will always be `card_settlement`.
const (
TransactionSourceCardSettlementTypeCardSettlement TransactionSourceCardSettlementType = "card_settlement"
)
type TransactionSourceCategory ¶
type TransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. TransactionSourceCategoryAccountTransferIntention TransactionSourceCategory = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. TransactionSourceCategoryACHTransferIntention TransactionSourceCategory = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. TransactionSourceCategoryACHTransferRejection TransactionSourceCategory = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. TransactionSourceCategoryACHTransferReturn TransactionSourceCategory = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. TransactionSourceCategoryCardDisputeAcceptance TransactionSourceCategory = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. TransactionSourceCategoryCardRefund TransactionSourceCategory = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. TransactionSourceCategoryCardRevenuePayment TransactionSourceCategory = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. TransactionSourceCategoryCardSettlement TransactionSourceCategory = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. TransactionSourceCategoryCheckDepositAcceptance TransactionSourceCategory = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. TransactionSourceCategoryCheckDepositReturn TransactionSourceCategory = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. TransactionSourceCategoryCheckTransferDeposit TransactionSourceCategory = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. TransactionSourceCategoryCheckTransferIntention TransactionSourceCategory = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. TransactionSourceCategoryCheckTransferStopPaymentRequest TransactionSourceCategory = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. TransactionSourceCategoryFeePayment TransactionSourceCategory = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. TransactionSourceCategoryInboundACHTransfer TransactionSourceCategory = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. TransactionSourceCategoryInboundACHTransferReturnIntention TransactionSourceCategory = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. TransactionSourceCategoryInboundCheck TransactionSourceCategory = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. TransactionSourceCategoryInboundInternationalACHTransfer TransactionSourceCategory = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. TransactionSourceCategoryInboundRealTimePaymentsTransferConfirmation TransactionSourceCategory = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. TransactionSourceCategoryInboundWireDrawdownPayment TransactionSourceCategory = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. TransactionSourceCategoryInboundWireDrawdownPaymentReversal TransactionSourceCategory = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. TransactionSourceCategoryInboundWireReversal TransactionSourceCategory = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. TransactionSourceCategoryInboundWireTransfer TransactionSourceCategory = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. TransactionSourceCategoryInterestPayment TransactionSourceCategory = "interest_payment" // Internal Source: details will be under the `internal_source` object. TransactionSourceCategoryInternalSource TransactionSourceCategory = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. TransactionSourceCategoryRealTimePaymentsTransferAcknowledgement TransactionSourceCategory = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. TransactionSourceCategorySampleFunds TransactionSourceCategory = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. TransactionSourceCategoryWireTransferIntention TransactionSourceCategory = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. TransactionSourceCategoryWireTransferRejection TransactionSourceCategory = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. TransactionSourceCategoryOther TransactionSourceCategory = "other" )
type TransactionSourceCheckDepositAcceptance ¶
type TransactionSourceCheckDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency TransactionSourceCheckDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON transactionSourceCheckDepositAcceptanceJSON
}
A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
func (*TransactionSourceCheckDepositAcceptance) UnmarshalJSON ¶
func (r *TransactionSourceCheckDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCheckDepositAcceptanceCurrency ¶
type TransactionSourceCheckDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) TransactionSourceCheckDepositAcceptanceCurrencyCad TransactionSourceCheckDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCheckDepositAcceptanceCurrencyChf TransactionSourceCheckDepositAcceptanceCurrency = "CHF" // Euro (EUR) TransactionSourceCheckDepositAcceptanceCurrencyEur TransactionSourceCheckDepositAcceptanceCurrency = "EUR" // British Pound (GBP) TransactionSourceCheckDepositAcceptanceCurrencyGbp TransactionSourceCheckDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCheckDepositAcceptanceCurrencyJpy TransactionSourceCheckDepositAcceptanceCurrency = "JPY" // US Dollar (USD) TransactionSourceCheckDepositAcceptanceCurrencyUsd TransactionSourceCheckDepositAcceptanceCurrency = "USD" )
type TransactionSourceCheckDepositReturn ¶
type TransactionSourceCheckDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency TransactionSourceCheckDepositReturnCurrency `json:"currency,required"`
ReturnReason TransactionSourceCheckDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON transactionSourceCheckDepositReturnJSON
}
A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
func (*TransactionSourceCheckDepositReturn) UnmarshalJSON ¶
func (r *TransactionSourceCheckDepositReturn) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCheckDepositReturnCurrency ¶
type TransactionSourceCheckDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) TransactionSourceCheckDepositReturnCurrencyCad TransactionSourceCheckDepositReturnCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCheckDepositReturnCurrencyChf TransactionSourceCheckDepositReturnCurrency = "CHF" // Euro (EUR) TransactionSourceCheckDepositReturnCurrencyEur TransactionSourceCheckDepositReturnCurrency = "EUR" // British Pound (GBP) TransactionSourceCheckDepositReturnCurrencyGbp TransactionSourceCheckDepositReturnCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCheckDepositReturnCurrencyJpy TransactionSourceCheckDepositReturnCurrency = "JPY" // US Dollar (USD) TransactionSourceCheckDepositReturnCurrencyUsd TransactionSourceCheckDepositReturnCurrency = "USD" )
type TransactionSourceCheckDepositReturnReturnReason ¶
type TransactionSourceCheckDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. TransactionSourceCheckDepositReturnReturnReasonACHConversionNotSupported TransactionSourceCheckDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. TransactionSourceCheckDepositReturnReturnReasonClosedAccount TransactionSourceCheckDepositReturnReturnReason = "closed_account" // The check has already been deposited. TransactionSourceCheckDepositReturnReturnReasonDuplicateSubmission TransactionSourceCheckDepositReturnReturnReason = "duplicate_submission" // Insufficient funds TransactionSourceCheckDepositReturnReturnReasonInsufficientFunds TransactionSourceCheckDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. TransactionSourceCheckDepositReturnReturnReasonNoAccount TransactionSourceCheckDepositReturnReturnReason = "no_account" // The check was not authorized. TransactionSourceCheckDepositReturnReturnReasonNotAuthorized TransactionSourceCheckDepositReturnReturnReason = "not_authorized" // The check is too old. TransactionSourceCheckDepositReturnReturnReasonStaleDated TransactionSourceCheckDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. TransactionSourceCheckDepositReturnReturnReasonStopPayment TransactionSourceCheckDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. TransactionSourceCheckDepositReturnReturnReasonUnknownReason TransactionSourceCheckDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. TransactionSourceCheckDepositReturnReturnReasonUnmatchedDetails TransactionSourceCheckDepositReturnReturnReason = "unmatched_details" // The image could not be read. TransactionSourceCheckDepositReturnReturnReasonUnreadableImage TransactionSourceCheckDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. TransactionSourceCheckDepositReturnReturnReasonEndorsementIrregular TransactionSourceCheckDepositReturnReturnReason = "endorsement_irregular" )
type TransactionSourceCheckTransferDeposit ¶ added in v0.3.0
type TransactionSourceCheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type TransactionSourceCheckTransferDepositType `json:"type,required"`
JSON transactionSourceCheckTransferDepositJSON
}
A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`.
func (*TransactionSourceCheckTransferDeposit) UnmarshalJSON ¶ added in v0.3.0
func (r *TransactionSourceCheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCheckTransferDepositType ¶ added in v0.3.0
type TransactionSourceCheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
TransactionSourceCheckTransferDepositTypeCheckTransferDeposit TransactionSourceCheckTransferDepositType = "check_transfer_deposit"
)
type TransactionSourceCheckTransferIntention ¶
type TransactionSourceCheckTransferIntention struct {
// The city of the check's destination.
AddressCity string `json:"address_city,required,nullable"`
// The street address of the check's destination.
AddressLine1 string `json:"address_line1,required,nullable"`
// The second line of the address of the check's destination.
AddressLine2 string `json:"address_line2,required,nullable"`
// The state of the check's destination.
AddressState string `json:"address_state,required,nullable"`
// The postal code of the check's destination.
AddressZip string `json:"address_zip,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency TransactionSourceCheckTransferIntentionCurrency `json:"currency,required"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required,nullable"`
// The identifier of the Check Transfer with which this is associated.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceCheckTransferIntentionJSON
}
A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
func (*TransactionSourceCheckTransferIntention) UnmarshalJSON ¶
func (r *TransactionSourceCheckTransferIntention) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCheckTransferIntentionCurrency ¶
type TransactionSourceCheckTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) TransactionSourceCheckTransferIntentionCurrencyCad TransactionSourceCheckTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceCheckTransferIntentionCurrencyChf TransactionSourceCheckTransferIntentionCurrency = "CHF" // Euro (EUR) TransactionSourceCheckTransferIntentionCurrencyEur TransactionSourceCheckTransferIntentionCurrency = "EUR" // British Pound (GBP) TransactionSourceCheckTransferIntentionCurrencyGbp TransactionSourceCheckTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceCheckTransferIntentionCurrencyJpy TransactionSourceCheckTransferIntentionCurrency = "JPY" // US Dollar (USD) TransactionSourceCheckTransferIntentionCurrencyUsd TransactionSourceCheckTransferIntentionCurrency = "USD" )
type TransactionSourceCheckTransferStopPaymentRequest ¶
type TransactionSourceCheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason TransactionSourceCheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type TransactionSourceCheckTransferStopPaymentRequestType `json:"type,required"`
JSON transactionSourceCheckTransferStopPaymentRequestJSON
}
A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
func (*TransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *TransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type TransactionSourceCheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type TransactionSourceCheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. TransactionSourceCheckTransferStopPaymentRequestReasonMailDeliveryFailed TransactionSourceCheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. TransactionSourceCheckTransferStopPaymentRequestReasonRejectedByIncrease TransactionSourceCheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. TransactionSourceCheckTransferStopPaymentRequestReasonUnknown TransactionSourceCheckTransferStopPaymentRequestReason = "unknown" )
type TransactionSourceCheckTransferStopPaymentRequestType ¶
type TransactionSourceCheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
TransactionSourceCheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest TransactionSourceCheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type TransactionSourceFeePayment ¶
type TransactionSourceFeePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency TransactionSourceFeePaymentCurrency `json:"currency,required"`
// The start of this payment's fee period, usually the first day of a month.
FeePeriodStart time.Time `json:"fee_period_start,required" format:"date"`
JSON transactionSourceFeePaymentJSON
}
A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
func (*TransactionSourceFeePayment) UnmarshalJSON ¶
func (r *TransactionSourceFeePayment) UnmarshalJSON(data []byte) (err error)
type TransactionSourceFeePaymentCurrency ¶
type TransactionSourceFeePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) TransactionSourceFeePaymentCurrencyCad TransactionSourceFeePaymentCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceFeePaymentCurrencyChf TransactionSourceFeePaymentCurrency = "CHF" // Euro (EUR) TransactionSourceFeePaymentCurrencyEur TransactionSourceFeePaymentCurrency = "EUR" // British Pound (GBP) TransactionSourceFeePaymentCurrencyGbp TransactionSourceFeePaymentCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceFeePaymentCurrencyJpy TransactionSourceFeePaymentCurrency = "JPY" // US Dollar (USD) TransactionSourceFeePaymentCurrencyUsd TransactionSourceFeePaymentCurrency = "USD" )
type TransactionSourceInboundACHTransfer ¶
type TransactionSourceInboundACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCompanyID string `json:"originator_company_id,required"`
OriginatorCompanyName string `json:"originator_company_name,required"`
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
ReceiverName string `json:"receiver_name,required,nullable"`
TraceNumber string `json:"trace_number,required"`
JSON transactionSourceInboundACHTransferJSON
}
An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
func (*TransactionSourceInboundACHTransfer) UnmarshalJSON ¶
func (r *TransactionSourceInboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundCheck ¶
type TransactionSourceInboundCheck struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
CheckFrontImageFileID string `json:"check_front_image_file_id,required,nullable"`
CheckNumber string `json:"check_number,required,nullable"`
CheckRearImageFileID string `json:"check_rear_image_file_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency TransactionSourceInboundCheckCurrency `json:"currency,required"`
JSON transactionSourceInboundCheckJSON
}
An Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
func (*TransactionSourceInboundCheck) UnmarshalJSON ¶
func (r *TransactionSourceInboundCheck) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundCheckCurrency ¶
type TransactionSourceInboundCheckCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) TransactionSourceInboundCheckCurrencyCad TransactionSourceInboundCheckCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceInboundCheckCurrencyChf TransactionSourceInboundCheckCurrency = "CHF" // Euro (EUR) TransactionSourceInboundCheckCurrencyEur TransactionSourceInboundCheckCurrency = "EUR" // British Pound (GBP) TransactionSourceInboundCheckCurrencyGbp TransactionSourceInboundCheckCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceInboundCheckCurrencyJpy TransactionSourceInboundCheckCurrency = "JPY" // US Dollar (USD) TransactionSourceInboundCheckCurrencyUsd TransactionSourceInboundCheckCurrency = "USD" )
type TransactionSourceInboundInternationalACHTransfer ¶
type TransactionSourceInboundInternationalACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON transactionSourceInboundInternationalACHTransferJSON
}
An Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
func (*TransactionSourceInboundInternationalACHTransfer) UnmarshalJSON ¶
func (r *TransactionSourceInboundInternationalACHTransfer) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundRealTimePaymentsTransferConfirmation ¶
type TransactionSourceInboundRealTimePaymentsTransferConfirmation struct {
// The amount in the minor unit of the transfer's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
// currency. This will always be "USD" for a Real-Time Payments transfer.
Currency TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the transfer
TransactionIdentification string `json:"transaction_identification,required"`
JSON transactionSourceInboundRealTimePaymentsTransferConfirmationJSON
}
An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
func (*TransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON ¶
func (r *TransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency ¶
type TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyCad TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyChf TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CHF" // Euro (EUR) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyEur TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "EUR" // British Pound (GBP) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyGbp TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyJpy TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "JPY" // US Dollar (USD) TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyUsd TransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "USD" )
type TransactionSourceInboundWireDrawdownPayment ¶
type TransactionSourceInboundWireDrawdownPayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
JSON transactionSourceInboundWireDrawdownPaymentJSON
}
An Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
func (*TransactionSourceInboundWireDrawdownPayment) UnmarshalJSON ¶
func (r *TransactionSourceInboundWireDrawdownPayment) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundWireDrawdownPaymentReversal ¶
type TransactionSourceInboundWireDrawdownPaymentReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
JSON transactionSourceInboundWireDrawdownPaymentReversalJSON
}
An Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
func (*TransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON ¶
func (r *TransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundWireReversal ¶
type TransactionSourceInboundWireReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON transactionSourceInboundWireReversalJSON
}
An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
func (*TransactionSourceInboundWireReversal) UnmarshalJSON ¶
func (r *TransactionSourceInboundWireReversal) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInboundWireTransfer ¶
type TransactionSourceInboundWireTransfer struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
JSON transactionSourceInboundWireTransferJSON
}
An Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
func (*TransactionSourceInboundWireTransfer) UnmarshalJSON ¶
func (r *TransactionSourceInboundWireTransfer) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInterestPayment ¶
type TransactionSourceInterestPayment struct {
// The account on which the interest was accrued.
AccruedOnAccountID string `json:"accrued_on_account_id,required,nullable"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency TransactionSourceInterestPaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
JSON transactionSourceInterestPaymentJSON
}
An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
func (*TransactionSourceInterestPayment) UnmarshalJSON ¶
func (r *TransactionSourceInterestPayment) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInterestPaymentCurrency ¶
type TransactionSourceInterestPaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) TransactionSourceInterestPaymentCurrencyCad TransactionSourceInterestPaymentCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceInterestPaymentCurrencyChf TransactionSourceInterestPaymentCurrency = "CHF" // Euro (EUR) TransactionSourceInterestPaymentCurrencyEur TransactionSourceInterestPaymentCurrency = "EUR" // British Pound (GBP) TransactionSourceInterestPaymentCurrencyGbp TransactionSourceInterestPaymentCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceInterestPaymentCurrencyJpy TransactionSourceInterestPaymentCurrency = "JPY" // US Dollar (USD) TransactionSourceInterestPaymentCurrencyUsd TransactionSourceInterestPaymentCurrency = "USD" )
type TransactionSourceInternalSource ¶
type TransactionSourceInternalSource struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency TransactionSourceInternalSourceCurrency `json:"currency,required"`
Reason TransactionSourceInternalSourceReason `json:"reason,required"`
JSON transactionSourceInternalSourceJSON
}
An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
func (*TransactionSourceInternalSource) UnmarshalJSON ¶
func (r *TransactionSourceInternalSource) UnmarshalJSON(data []byte) (err error)
type TransactionSourceInternalSourceCurrency ¶
type TransactionSourceInternalSourceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) TransactionSourceInternalSourceCurrencyCad TransactionSourceInternalSourceCurrency = "CAD" // Swiss Franc (CHF) TransactionSourceInternalSourceCurrencyChf TransactionSourceInternalSourceCurrency = "CHF" // Euro (EUR) TransactionSourceInternalSourceCurrencyEur TransactionSourceInternalSourceCurrency = "EUR" // British Pound (GBP) TransactionSourceInternalSourceCurrencyGbp TransactionSourceInternalSourceCurrency = "GBP" // Japanese Yen (JPY) TransactionSourceInternalSourceCurrencyJpy TransactionSourceInternalSourceCurrency = "JPY" // US Dollar (USD) TransactionSourceInternalSourceCurrencyUsd TransactionSourceInternalSourceCurrency = "USD" )
type TransactionSourceInternalSourceReason ¶
type TransactionSourceInternalSourceReason string
const ( // Account closure TransactionSourceInternalSourceReasonAccountClosure TransactionSourceInternalSourceReason = "account_closure" // Bank migration TransactionSourceInternalSourceReasonBankMigration TransactionSourceInternalSourceReason = "bank_migration" // Cashback TransactionSourceInternalSourceReasonCashback TransactionSourceInternalSourceReason = "cashback" // Check adjustment TransactionSourceInternalSourceReasonCheckAdjustment TransactionSourceInternalSourceReason = "check_adjustment" // Collection receivable TransactionSourceInternalSourceReasonCollectionReceivable TransactionSourceInternalSourceReason = "collection_receivable" // Empyreal adjustment TransactionSourceInternalSourceReasonEmpyrealAdjustment TransactionSourceInternalSourceReason = "empyreal_adjustment" // Error TransactionSourceInternalSourceReasonError TransactionSourceInternalSourceReason = "error" // Error correction TransactionSourceInternalSourceReasonErrorCorrection TransactionSourceInternalSourceReason = "error_correction" // Fees TransactionSourceInternalSourceReasonFees TransactionSourceInternalSourceReason = "fees" // Interest TransactionSourceInternalSourceReasonInterest TransactionSourceInternalSourceReason = "interest" // Negative balance forgiveness TransactionSourceInternalSourceReasonNegativeBalanceForgiveness TransactionSourceInternalSourceReason = "negative_balance_forgiveness" // Sample funds TransactionSourceInternalSourceReasonSampleFunds TransactionSourceInternalSourceReason = "sample_funds" // Sample funds return TransactionSourceInternalSourceReasonSampleFundsReturn TransactionSourceInternalSourceReason = "sample_funds_return" )
type TransactionSourceRealTimePaymentsTransferAcknowledgement ¶
type TransactionSourceRealTimePaymentsTransferAcknowledgement struct {
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The identifier of the Real-Time Payments Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON transactionSourceRealTimePaymentsTransferAcknowledgementJSON
}
A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
func (*TransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON ¶
func (r *TransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type TransactionSourceSampleFunds ¶
type TransactionSourceSampleFunds struct {
// Where the sample funds came from.
Originator string `json:"originator,required"`
JSON transactionSourceSampleFundsJSON
}
A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
func (*TransactionSourceSampleFunds) UnmarshalJSON ¶
func (r *TransactionSourceSampleFunds) UnmarshalJSON(data []byte) (err error)
type TransactionSourceWireTransferIntention ¶
type TransactionSourceWireTransferIntention struct {
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON transactionSourceWireTransferIntentionJSON
}
A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
func (*TransactionSourceWireTransferIntention) UnmarshalJSON ¶
func (r *TransactionSourceWireTransferIntention) UnmarshalJSON(data []byte) (err error)
type TransactionSourceWireTransferRejection ¶
type TransactionSourceWireTransferRejection struct {
TransferID string `json:"transfer_id,required"`
JSON transactionSourceWireTransferRejectionJSON
}
A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
func (*TransactionSourceWireTransferRejection) UnmarshalJSON ¶
func (r *TransactionSourceWireTransferRejection) UnmarshalJSON(data []byte) (err error)
type TransactionType ¶
type TransactionType string
A constant representing the object's type. For this resource it will always be `transaction`.
const (
TransactionTypeTransaction TransactionType = "transaction"
)
type WireDrawdownRequest ¶
type WireDrawdownRequest struct {
// The Wire drawdown request identifier.
ID string `json:"id,required"`
// The Account Number to which the recipient of this request is being requested to
// send funds.
AccountNumberID string `json:"account_number_id,required"`
// The amount being requested in cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
// requested. Will always be "USD".
Currency string `json:"currency,required"`
// If the recipient fulfills the drawdown request by sending funds, then this will
// be the identifier of the corresponding Transaction.
FulfillmentTransactionID string `json:"fulfillment_transaction_id,required,nullable"`
// The message the recipient will see as part of the drawdown request.
MessageToRecipient string `json:"message_to_recipient,required"`
// The drawdown request's recipient's account number.
RecipientAccountNumber string `json:"recipient_account_number,required"`
// Line 1 of the drawdown request's recipient's address.
RecipientAddressLine1 string `json:"recipient_address_line1,required,nullable"`
// Line 2 of the drawdown request's recipient's address.
RecipientAddressLine2 string `json:"recipient_address_line2,required,nullable"`
// Line 3 of the drawdown request's recipient's address.
RecipientAddressLine3 string `json:"recipient_address_line3,required,nullable"`
// The drawdown request's recipient's name.
RecipientName string `json:"recipient_name,required,nullable"`
// The drawdown request's recipient's routing number.
RecipientRoutingNumber string `json:"recipient_routing_number,required"`
// The lifecycle status of the drawdown request.
Status WireDrawdownRequestStatus `json:"status,required"`
// After the drawdown request is submitted to Fedwire, this will contain
// supplemental details.
Submission WireDrawdownRequestSubmission `json:"submission,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `wire_drawdown_request`.
Type WireDrawdownRequestType `json:"type,required"`
JSON wireDrawdownRequestJSON
}
Wire drawdown requests enable you to request that someone else send you a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
func (*WireDrawdownRequest) UnmarshalJSON ¶
func (r *WireDrawdownRequest) UnmarshalJSON(data []byte) (err error)
type WireDrawdownRequestListParams ¶
type WireDrawdownRequestListParams struct {
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
}
func (WireDrawdownRequestListParams) URLQuery ¶
func (r WireDrawdownRequestListParams) URLQuery() (v url.Values)
URLQuery serializes WireDrawdownRequestListParams's query parameters as `url.Values`.
type WireDrawdownRequestNewParams ¶
type WireDrawdownRequestNewParams struct {
// The Account Number to which the recipient should send funds.
AccountNumberID param.Field[string] `json:"account_number_id,required"`
// The amount requested from the recipient, in cents.
Amount param.Field[int64] `json:"amount,required"`
// A message the recipient will see as part of the request.
MessageToRecipient param.Field[string] `json:"message_to_recipient,required"`
// The drawdown request's recipient's account number.
RecipientAccountNumber param.Field[string] `json:"recipient_account_number,required"`
// The drawdown request's recipient's name.
RecipientName param.Field[string] `json:"recipient_name,required"`
// The drawdown request's recipient's routing number.
RecipientRoutingNumber param.Field[string] `json:"recipient_routing_number,required"`
// Line 1 of the drawdown request's recipient's address.
RecipientAddressLine1 param.Field[string] `json:"recipient_address_line1"`
// Line 2 of the drawdown request's recipient's address.
RecipientAddressLine2 param.Field[string] `json:"recipient_address_line2"`
// Line 3 of the drawdown request's recipient's address.
RecipientAddressLine3 param.Field[string] `json:"recipient_address_line3"`
}
func (WireDrawdownRequestNewParams) MarshalJSON ¶
func (r WireDrawdownRequestNewParams) MarshalJSON() (data []byte, err error)
type WireDrawdownRequestService ¶
type WireDrawdownRequestService struct {
Options []option.RequestOption
}
WireDrawdownRequestService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWireDrawdownRequestService method instead.
func NewWireDrawdownRequestService ¶
func NewWireDrawdownRequestService(opts ...option.RequestOption) (r *WireDrawdownRequestService)
NewWireDrawdownRequestService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*WireDrawdownRequestService) Get ¶
func (r *WireDrawdownRequestService) Get(ctx context.Context, wireDrawdownRequestID string, opts ...option.RequestOption) (res *WireDrawdownRequest, err error)
Retrieve a Wire Drawdown Request
func (*WireDrawdownRequestService) List ¶
func (r *WireDrawdownRequestService) List(ctx context.Context, query WireDrawdownRequestListParams, opts ...option.RequestOption) (res *shared.Page[WireDrawdownRequest], err error)
List Wire Drawdown Requests
func (*WireDrawdownRequestService) ListAutoPaging ¶
func (r *WireDrawdownRequestService) ListAutoPaging(ctx context.Context, query WireDrawdownRequestListParams, opts ...option.RequestOption) *shared.PageAutoPager[WireDrawdownRequest]
List Wire Drawdown Requests
func (*WireDrawdownRequestService) New ¶
func (r *WireDrawdownRequestService) New(ctx context.Context, body WireDrawdownRequestNewParams, opts ...option.RequestOption) (res *WireDrawdownRequest, err error)
Create a Wire Drawdown Request
type WireDrawdownRequestStatus ¶
type WireDrawdownRequestStatus string
The lifecycle status of the drawdown request.
const ( // The drawdown request is queued to be submitted to Fedwire. WireDrawdownRequestStatusPendingSubmission WireDrawdownRequestStatus = "pending_submission" // The drawdown request has been sent and the recipient should respond in some way. WireDrawdownRequestStatusPendingResponse WireDrawdownRequestStatus = "pending_response" // The drawdown request has been fulfilled by the recipient. WireDrawdownRequestStatusFulfilled WireDrawdownRequestStatus = "fulfilled" // The drawdown request has been refused by the recipient. WireDrawdownRequestStatusRefused WireDrawdownRequestStatus = "refused" )
type WireDrawdownRequestSubmission ¶
type WireDrawdownRequestSubmission struct {
// The input message accountability data (IMAD) uniquely identifying the submission
// with Fedwire.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
JSON wireDrawdownRequestSubmissionJSON
}
After the drawdown request is submitted to Fedwire, this will contain supplemental details.
func (*WireDrawdownRequestSubmission) UnmarshalJSON ¶
func (r *WireDrawdownRequestSubmission) UnmarshalJSON(data []byte) (err error)
type WireDrawdownRequestType ¶
type WireDrawdownRequestType string
A constant representing the object's type. For this resource it will always be `wire_drawdown_request`.
const (
WireDrawdownRequestTypeWireDrawdownRequest WireDrawdownRequestType = "wire_drawdown_request"
)
type WireTransfer ¶
type WireTransfer struct {
// The wire transfer's identifier.
ID string `json:"id,required"`
// The Account to which the transfer belongs.
AccountID string `json:"account_id,required"`
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// If your account requires approvals for transfers and the transfer was approved,
// this will contain details of the approval.
Approval WireTransferApproval `json:"approval,required,nullable"`
// The beneficiary's address line 1.
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
// The beneficiary's address line 2.
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
// The beneficiary's address line 3.
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
// The beneficiary's name.
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
// If your account requires approvals for transfers and the transfer was not
// approved, this will contain details of the cancellation.
Cancellation WireTransferCancellation `json:"cancellation,required,nullable"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
// currency. For wire transfers this is always equal to `usd`.
Currency WireTransferCurrency `json:"currency,required"`
// The identifier of the External Account the transfer was made to, if any.
ExternalAccountID string `json:"external_account_id,required,nullable"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required,nullable"`
// The transfer's network.
Network WireTransferNetwork `json:"network,required"`
// The ID for the pending transaction representing the transfer. A pending
// transaction is created when the transfer
// [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals)
// by someone else in your organization.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// If your transfer is reversed, this will contain details of the reversal.
Reversal WireTransferReversal `json:"reversal,required,nullable"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
// The lifecycle status of the transfer.
Status WireTransferStatus `json:"status,required"`
// After the transfer is submitted to Fedwire, this will contain supplemental
// details.
Submission WireTransferSubmission `json:"submission,required,nullable"`
// The ID for the transaction funding the transfer.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `wire_transfer`.
Type WireTransferType `json:"type,required"`
// The unique identifier you chose for this transfer.
UniqueIdentifier string `json:"unique_identifier,required,nullable"`
JSON wireTransferJSON
}
Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
func (*WireTransfer) UnmarshalJSON ¶
func (r *WireTransfer) UnmarshalJSON(data []byte) (err error)
type WireTransferApproval ¶
type WireTransferApproval struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was approved.
ApprovedAt time.Time `json:"approved_at,required" format:"date-time"`
// If the Transfer was approved by a user in the dashboard, the email address of
// that user.
ApprovedBy string `json:"approved_by,required,nullable"`
JSON wireTransferApprovalJSON
}
If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
func (*WireTransferApproval) UnmarshalJSON ¶
func (r *WireTransferApproval) UnmarshalJSON(data []byte) (err error)
type WireTransferCancellation ¶
type WireTransferCancellation struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Transfer was canceled.
CanceledAt time.Time `json:"canceled_at,required" format:"date-time"`
// If the Transfer was canceled by a user in the dashboard, the email address of
// that user.
CanceledBy string `json:"canceled_by,required,nullable"`
JSON wireTransferCancellationJSON
}
If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
func (*WireTransferCancellation) UnmarshalJSON ¶
func (r *WireTransferCancellation) UnmarshalJSON(data []byte) (err error)
type WireTransferCurrency ¶
type WireTransferCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`.
const ( // Canadian Dollar (CAD) WireTransferCurrencyCad WireTransferCurrency = "CAD" // Swiss Franc (CHF) WireTransferCurrencyChf WireTransferCurrency = "CHF" // Euro (EUR) WireTransferCurrencyEur WireTransferCurrency = "EUR" // British Pound (GBP) WireTransferCurrencyGbp WireTransferCurrency = "GBP" // Japanese Yen (JPY) WireTransferCurrencyJpy WireTransferCurrency = "JPY" // US Dollar (USD) WireTransferCurrencyUsd WireTransferCurrency = "USD" )
type WireTransferListParams ¶
type WireTransferListParams struct {
// Filter Wire Transfers to those belonging to the specified Account.
AccountID param.Field[string] `query:"account_id"`
CreatedAt param.Field[WireTransferListParamsCreatedAt] `query:"created_at"`
// Return the page of entries after this one.
Cursor param.Field[string] `query:"cursor"`
// Filter Wire Transfers to those made to the specified External Account.
ExternalAccountID param.Field[string] `query:"external_account_id"`
// Limit the size of the list that is returned. The default (and maximum) is 100
// objects.
Limit param.Field[int64] `query:"limit"`
// Filter Wire Transfers to the one with the specified unique identifier.
UniqueIdentifier param.Field[string] `query:"unique_identifier"`
}
func (WireTransferListParams) URLQuery ¶
func (r WireTransferListParams) URLQuery() (v url.Values)
URLQuery serializes WireTransferListParams's query parameters as `url.Values`.
type WireTransferListParamsCreatedAt ¶
type WireTransferListParamsCreatedAt struct {
// Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
After param.Field[time.Time] `query:"after" format:"date-time"`
// Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
// timestamp.
Before param.Field[time.Time] `query:"before" format:"date-time"`
// Return results on or after this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrAfter param.Field[time.Time] `query:"on_or_after" format:"date-time"`
// Return results on or before this
// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
OnOrBefore param.Field[time.Time] `query:"on_or_before" format:"date-time"`
}
func (WireTransferListParamsCreatedAt) URLQuery ¶
func (r WireTransferListParamsCreatedAt) URLQuery() (v url.Values)
URLQuery serializes WireTransferListParamsCreatedAt's query parameters as `url.Values`.
type WireTransferNetwork ¶
type WireTransferNetwork string
The transfer's network.
const (
WireTransferNetworkWire WireTransferNetwork = "wire"
)
type WireTransferNewParams ¶
type WireTransferNewParams struct {
// The identifier for the account that will send the transfer.
AccountID param.Field[string] `json:"account_id,required"`
// The transfer amount in cents.
Amount param.Field[int64] `json:"amount,required"`
// The beneficiary's name.
BeneficiaryName param.Field[string] `json:"beneficiary_name,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient param.Field[string] `json:"message_to_recipient,required"`
// The account number for the destination account.
AccountNumber param.Field[string] `json:"account_number"`
// The beneficiary's address line 1.
BeneficiaryAddressLine1 param.Field[string] `json:"beneficiary_address_line1"`
// The beneficiary's address line 2.
BeneficiaryAddressLine2 param.Field[string] `json:"beneficiary_address_line2"`
// The beneficiary's address line 3.
BeneficiaryAddressLine3 param.Field[string] `json:"beneficiary_address_line3"`
// The ID of an External Account to initiate a transfer to. If this parameter is
// provided, `account_number` and `routing_number` must be absent.
ExternalAccountID param.Field[string] `json:"external_account_id"`
// Whether the transfer requires explicit approval via the dashboard or API.
RequireApproval param.Field[bool] `json:"require_approval"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
// destination account.
RoutingNumber param.Field[string] `json:"routing_number"`
// A unique identifier you choose for the transfer. Reusing this identifier for
// another transfer will result in an error. You can query for the transfer
// associated with this identifier using the List endpoint.
UniqueIdentifier param.Field[string] `json:"unique_identifier"`
}
func (WireTransferNewParams) MarshalJSON ¶
func (r WireTransferNewParams) MarshalJSON() (data []byte, err error)
type WireTransferReversal ¶
type WireTransferReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON wireTransferReversalJSON
}
If your transfer is reversed, this will contain details of the reversal.
func (*WireTransferReversal) UnmarshalJSON ¶
func (r *WireTransferReversal) UnmarshalJSON(data []byte) (err error)
type WireTransferService ¶
type WireTransferService struct {
Options []option.RequestOption
}
WireTransferService contains methods and other services that help with interacting with the increase API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWireTransferService method instead.
func NewWireTransferService ¶
func NewWireTransferService(opts ...option.RequestOption) (r *WireTransferService)
NewWireTransferService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*WireTransferService) Approve ¶
func (r *WireTransferService) Approve(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
Approve a Wire Transfer
func (*WireTransferService) Cancel ¶
func (r *WireTransferService) Cancel(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
Cancel a pending Wire Transfer
func (*WireTransferService) Get ¶
func (r *WireTransferService) Get(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
Retrieve a Wire Transfer
func (*WireTransferService) List ¶
func (r *WireTransferService) List(ctx context.Context, query WireTransferListParams, opts ...option.RequestOption) (res *shared.Page[WireTransfer], err error)
List Wire Transfers
func (*WireTransferService) ListAutoPaging ¶
func (r *WireTransferService) ListAutoPaging(ctx context.Context, query WireTransferListParams, opts ...option.RequestOption) *shared.PageAutoPager[WireTransfer]
List Wire Transfers
func (*WireTransferService) New ¶
func (r *WireTransferService) New(ctx context.Context, body WireTransferNewParams, opts ...option.RequestOption) (res *WireTransfer, err error)
Create a Wire Transfer
func (*WireTransferService) Reverse ¶
func (r *WireTransferService) Reverse(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
Simulates the reversal of a [Wire Transfer](#wire-transfers) by the Federal Reserve due to error conditions. This will also create a Transaction(#transaction) to account for the returned funds. This Wire Transfer must first have a `status` of `complete`.'
func (*WireTransferService) Submit ¶
func (r *WireTransferService) Submit(ctx context.Context, wireTransferID string, opts ...option.RequestOption) (res *WireTransfer, err error)
Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_creating`.
type WireTransferSimulation ¶
type WireTransferSimulation struct {
// If the Wire Transfer attempt succeeds, this will contain the resulting
// [Transaction](#transactions) object. The Transaction's `source` will be of
// `category: inbound_wire_transfer`.
Transaction WireTransferSimulationTransaction `json:"transaction,required"`
// A constant representing the object's type. For this resource it will always be
// `inbound_wire_transfer_simulation_result`.
Type WireTransferSimulationType `json:"type,required"`
JSON wireTransferSimulationJSON
}
The results of an inbound Wire Transfer simulation.
func (*WireTransferSimulation) UnmarshalJSON ¶
func (r *WireTransferSimulation) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransaction ¶
type WireTransferSimulationTransaction struct {
// The Transaction identifier.
ID string `json:"id,required"`
// The identifier for the Account the Transaction belongs to.
AccountID string `json:"account_id,required"`
// The Transaction amount in the minor unit of its currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the
// Transaction occurred.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// Transaction's currency. This will match the currency on the Transaction's
// Account.
Currency WireTransferSimulationTransactionCurrency `json:"currency,required"`
// An informational message describing this transaction. Use the fields in `source`
// to get more detailed information. This field appears as the line-item on the
// statement.
Description string `json:"description,required"`
// The identifier for the route this Transaction came through. Routes are things
// like cards and ACH details.
RouteID string `json:"route_id,required,nullable"`
// The type of the route this Transaction came through.
RouteType WireTransferSimulationTransactionRouteType `json:"route_type,required,nullable"`
// This is an object giving more details on the network-level event that caused the
// Transaction. Note that for backwards compatibility reasons, additional
// undocumented keys may appear in this object. These should be treated as
// deprecated and will be removed in the future.
Source WireTransferSimulationTransactionSource `json:"source,required"`
// A constant representing the object's type. For this resource it will always be
// `transaction`.
Type WireTransferSimulationTransactionType `json:"type,required"`
JSON wireTransferSimulationTransactionJSON
}
If the Wire Transfer attempt succeeds, this will contain the resulting Transaction(#transactions) object. The Transaction's `source` will be of `category: inbound_wire_transfer`.
func (*WireTransferSimulationTransaction) UnmarshalJSON ¶
func (r *WireTransferSimulationTransaction) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionCurrency ¶
type WireTransferSimulationTransactionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionCurrencyCad WireTransferSimulationTransactionCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionCurrencyChf WireTransferSimulationTransactionCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionCurrencyEur WireTransferSimulationTransactionCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionCurrencyGbp WireTransferSimulationTransactionCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionCurrencyJpy WireTransferSimulationTransactionCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionCurrencyUsd WireTransferSimulationTransactionCurrency = "USD" )
type WireTransferSimulationTransactionRouteType ¶
type WireTransferSimulationTransactionRouteType string
The type of the route this Transaction came through.
const ( // An Account Number. WireTransferSimulationTransactionRouteTypeAccountNumber WireTransferSimulationTransactionRouteType = "account_number" // A Card. WireTransferSimulationTransactionRouteTypeCard WireTransferSimulationTransactionRouteType = "card" )
type WireTransferSimulationTransactionSource ¶
type WireTransferSimulationTransactionSource struct {
// An Account Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `account_transfer_intention`.
AccountTransferIntention WireTransferSimulationTransactionSourceAccountTransferIntention `json:"account_transfer_intention,required,nullable"`
// An ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_intention`.
ACHTransferIntention WireTransferSimulationTransactionSourceACHTransferIntention `json:"ach_transfer_intention,required,nullable"`
// An ACH Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `ach_transfer_rejection`.
ACHTransferRejection WireTransferSimulationTransactionSourceACHTransferRejection `json:"ach_transfer_rejection,required,nullable"`
// An ACH Transfer Return object. This field will be present in the JSON response
// if and only if `category` is equal to `ach_transfer_return`.
ACHTransferReturn WireTransferSimulationTransactionSourceACHTransferReturn `json:"ach_transfer_return,required,nullable"`
// A Card Dispute Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `card_dispute_acceptance`.
CardDisputeAcceptance WireTransferSimulationTransactionSourceCardDisputeAcceptance `json:"card_dispute_acceptance,required,nullable"`
// A Card Refund object. This field will be present in the JSON response if and
// only if `category` is equal to `card_refund`.
CardRefund WireTransferSimulationTransactionSourceCardRefund `json:"card_refund,required,nullable"`
// A Card Revenue Payment object. This field will be present in the JSON response
// if and only if `category` is equal to `card_revenue_payment`.
CardRevenuePayment WireTransferSimulationTransactionSourceCardRevenuePayment `json:"card_revenue_payment,required,nullable"`
// A Card Settlement object. This field will be present in the JSON response if and
// only if `category` is equal to `card_settlement`.
CardSettlement WireTransferSimulationTransactionSourceCardSettlement `json:"card_settlement,required,nullable"`
// The type of the resource. We may add additional possible values for this enum
// over time; your application should be able to handle such additions gracefully.
Category WireTransferSimulationTransactionSourceCategory `json:"category,required"`
// A Check Deposit Acceptance object. This field will be present in the JSON
// response if and only if `category` is equal to `check_deposit_acceptance`.
CheckDepositAcceptance WireTransferSimulationTransactionSourceCheckDepositAcceptance `json:"check_deposit_acceptance,required,nullable"`
// A Check Deposit Return object. This field will be present in the JSON response
// if and only if `category` is equal to `check_deposit_return`.
CheckDepositReturn WireTransferSimulationTransactionSourceCheckDepositReturn `json:"check_deposit_return,required,nullable"`
// A Check Transfer Deposit object. This field will be present in the JSON response
// if and only if `category` is equal to `check_transfer_deposit`.
CheckTransferDeposit WireTransferSimulationTransactionSourceCheckTransferDeposit `json:"check_transfer_deposit,required,nullable"`
// A Check Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `check_transfer_intention`.
CheckTransferIntention WireTransferSimulationTransactionSourceCheckTransferIntention `json:"check_transfer_intention,required,nullable"`
// A Check Transfer Stop Payment Request object. This field will be present in the
// JSON response if and only if `category` is equal to
// `check_transfer_stop_payment_request`.
CheckTransferStopPaymentRequest WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest `json:"check_transfer_stop_payment_request,required,nullable"`
// A Fee Payment object. This field will be present in the JSON response if and
// only if `category` is equal to `fee_payment`.
FeePayment WireTransferSimulationTransactionSourceFeePayment `json:"fee_payment,required,nullable"`
// An Inbound ACH Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_ach_transfer`.
InboundACHTransfer WireTransferSimulationTransactionSourceInboundACHTransfer `json:"inbound_ach_transfer,required,nullable"`
// An Inbound Check object. This field will be present in the JSON response if and
// only if `category` is equal to `inbound_check`.
InboundCheck WireTransferSimulationTransactionSourceInboundCheck `json:"inbound_check,required,nullable"`
// An Inbound International ACH Transfer object. This field will be present in the
// JSON response if and only if `category` is equal to
// `inbound_international_ach_transfer`.
InboundInternationalACHTransfer WireTransferSimulationTransactionSourceInboundInternationalACHTransfer `json:"inbound_international_ach_transfer,required,nullable"`
// An Inbound Real-Time Payments Transfer Confirmation object. This field will be
// present in the JSON response if and only if `category` is equal to
// `inbound_real_time_payments_transfer_confirmation`.
InboundRealTimePaymentsTransferConfirmation WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation `json:"inbound_real_time_payments_transfer_confirmation,required,nullable"`
// An Inbound Wire Drawdown Payment object. This field will be present in the JSON
// response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
InboundWireDrawdownPayment WireTransferSimulationTransactionSourceInboundWireDrawdownPayment `json:"inbound_wire_drawdown_payment,required,nullable"`
// An Inbound Wire Drawdown Payment Reversal object. This field will be present in
// the JSON response if and only if `category` is equal to
// `inbound_wire_drawdown_payment_reversal`.
InboundWireDrawdownPaymentReversal WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal `json:"inbound_wire_drawdown_payment_reversal,required,nullable"`
// An Inbound Wire Reversal object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_reversal`.
InboundWireReversal WireTransferSimulationTransactionSourceInboundWireReversal `json:"inbound_wire_reversal,required,nullable"`
// An Inbound Wire Transfer object. This field will be present in the JSON response
// if and only if `category` is equal to `inbound_wire_transfer`.
InboundWireTransfer WireTransferSimulationTransactionSourceInboundWireTransfer `json:"inbound_wire_transfer,required,nullable"`
// An Interest Payment object. This field will be present in the JSON response if
// and only if `category` is equal to `interest_payment`.
InterestPayment WireTransferSimulationTransactionSourceInterestPayment `json:"interest_payment,required,nullable"`
// An Internal Source object. This field will be present in the JSON response if
// and only if `category` is equal to `internal_source`.
InternalSource WireTransferSimulationTransactionSourceInternalSource `json:"internal_source,required,nullable"`
// A Real-Time Payments Transfer Acknowledgement object. This field will be present
// in the JSON response if and only if `category` is equal to
// `real_time_payments_transfer_acknowledgement`.
RealTimePaymentsTransferAcknowledgement WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement `json:"real_time_payments_transfer_acknowledgement,required,nullable"`
// A Sample Funds object. This field will be present in the JSON response if and
// only if `category` is equal to `sample_funds`.
SampleFunds WireTransferSimulationTransactionSourceSampleFunds `json:"sample_funds,required,nullable"`
// A Wire Transfer Intention object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_intention`.
WireTransferIntention WireTransferSimulationTransactionSourceWireTransferIntention `json:"wire_transfer_intention,required,nullable"`
// A Wire Transfer Rejection object. This field will be present in the JSON
// response if and only if `category` is equal to `wire_transfer_rejection`.
WireTransferRejection WireTransferSimulationTransactionSourceWireTransferRejection `json:"wire_transfer_rejection,required,nullable"`
JSON wireTransferSimulationTransactionSourceJSON
}
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
func (*WireTransferSimulationTransactionSource) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSource) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceACHTransferIntention ¶
type WireTransferSimulationTransactionSourceACHTransferIntention struct {
AccountNumber string `json:"account_number,required"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
RoutingNumber string `json:"routing_number,required"`
StatementDescriptor string `json:"statement_descriptor,required"`
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceACHTransferIntentionJSON
}
An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
func (*WireTransferSimulationTransactionSourceACHTransferIntention) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceACHTransferIntention) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceACHTransferRejection ¶
type WireTransferSimulationTransactionSourceACHTransferRejection struct {
// The identifier of the ACH Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceACHTransferRejectionJSON
}
An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
func (*WireTransferSimulationTransactionSourceACHTransferRejection) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceACHTransferRejection) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceACHTransferReturn ¶
type WireTransferSimulationTransactionSourceACHTransferReturn struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the transfer was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The three character ACH return code, in the range R01 to R85.
RawReturnReasonCode string `json:"raw_return_reason_code,required"`
// Why the ACH Transfer was returned.
ReturnReasonCode WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode `json:"return_reason_code,required"`
// The identifier of the Transaction associated with this return.
TransactionID string `json:"transaction_id,required"`
// The identifier of the ACH Transfer associated with this return.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceACHTransferReturnJSON
}
An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
func (*WireTransferSimulationTransactionSourceACHTransferReturn) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceACHTransferReturn) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode ¶
type WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode string
Why the ACH Transfer was returned.
const ( // Code R01. Insufficient funds in the source account. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInsufficientFund WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "insufficient_fund" // Code R03. The account does not exist or the receiving bank was unable to locate // it. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNoAccount WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "no_account" // Code R02. The account is closed. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountClosed WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_closed" // Code R04. The account number is invalid at the receiving bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidAccountNumberStructure WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_account_number_structure" // Code R16. The account was frozen per the Office of Foreign Assets Control. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountFrozenEntryReturnedPerOfacInstruction WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_frozen_entry_returned_per_ofac_instruction" // Code R23. The receiving bank account refused a credit transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCreditEntryRefusedByReceiver WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "credit_entry_refused_by_receiver" // Class code. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUnauthorizedDebitToConsumerAccountUsingCorporateSecCode WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "unauthorized_debit_to_consumer_account_using_corporate_sec_code" // Code R29. The corporate customer reversed the transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCorporateCustomerAdvisedNotAuthorized WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "corporate_customer_advised_not_authorized" // Code R08. The receiving bank stopped payment on this transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePaymentStopped WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "payment_stopped" // Code R20. The receiving bank account does not perform transfers. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonTransactionAccount WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_transaction_account" // Code R09. The receiving bank account does not have enough available balance for // the transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUncollectedFunds WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "uncollected_funds" // Code R28. The routing number is incorrect. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRoutingNumberCheckDigitError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "routing_number_check_digit_error" WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedUnauthorizedImproperIneligibleOrIncomplete WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_unauthorized_improper_ineligible_or_incomplete" // Code R19. The amount field is incorrect or too large. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAmountFieldError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "amount_field_error" // Code R07. The customer who initiated the transfer revoked authorization. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAuthorizationRevokedByCustomer WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "authorization_revoked_by_customer" // Code R13. The routing number is invalid. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidACHRoutingNumber WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_ach_routing_number" // Code R17. The receiving bank is unable to process a field in the transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeFileRecordEditCriteria WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "file_record_edit_criteria" // Code R45. The individual name field was invalid. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualName WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_name" // Code R06. The originating financial institution reversed the transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnedPerOdfiRequest WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "returned_per_odfi_request" // Code R34. The receiving bank's regulatory supervisor has limited their // participation. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeLimitedParticipationDfi WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "limited_participation_dfi" // Code R85. The outbound international ACH transfer was incorrect. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeIncorrectlyCodedOutboundInternationalPayment WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "incorrectly_coded_outbound_international_payment" // Code R12. A rare return reason. The account was sold to another bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAccountSoldToAnotherDfi WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "account_sold_to_another_dfi" // Code R25. The addenda record is incorrect or missing. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeAddendaError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "addenda_error" // Code R15. A rare return reason. The account holder is deceased. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeBeneficiaryOrAccountHolderDeceased WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "beneficiary_or_account_holder_deceased" // Code R11. A rare return reason. The customer authorized some payment to the // sender, but this payment was not in error. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCustomerAdvisedNotWithinAuthorizationTerms WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "customer_advised_not_within_authorization_terms" // Code R74. A rare return reason. Sent in response to a return that was returned // with code `field_error`. The latest return should include the corrected // field(s). WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeCorrectedReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "corrected_return" // Code R24. A rare return reason. The receiving bank received an exact duplicate // entry with the same trace number and amount. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeDuplicateEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_entry" // Code R67. A rare return reason. The return this message refers to was a // duplicate. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeDuplicateReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "duplicate_return" // Code R47. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrDuplicateEnrollment WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_duplicate_enrollment" // Code R43. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidDfiAccountNumber WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_dfi_account_number" // Code R44. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidIndividualIDNumber WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_individual_id_number" // Code R46. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidRepresentativePayeeIndicator WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_representative_payee_indicator" // Code R41. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrInvalidTransactionCode WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_invalid_transaction_code" // Code R40. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrReturnOfEnrEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_return_of_enr_entry" // Code R42. A rare return reason. Only used for US Government agency non-monetary // automatic enrollment messages. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEnrRoutingNumberCheckDigitError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "enr_routing_number_check_digit_error" // Code R84. A rare return reason. The International ACH Transfer cannot be // processed by the gateway. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeEntryNotProcessedByGateway WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "entry_not_processed_by_gateway" // Code R69. A rare return reason. One or more of the fields in the ACH were // malformed. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeFieldError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "field_error" // Code R83. A rare return reason. The Foreign receiving bank was unable to settle // this ACH transfer. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeForeignReceivingDfiUnableToSettle WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "foreign_receiving_dfi_unable_to_settle" // Code R80. A rare return reason. The International ACH Transfer is malformed. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeIatEntryCodingError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "iat_entry_coding_error" // Code R18. A rare return reason. The ACH has an improper effective entry date // field. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeImproperEffectiveEntryDate WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "improper_effective_entry_date" // Code R39. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeImproperSourceDocumentSourceDocumentPresented WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "improper_source_document_source_document_presented" // Code R21. A rare return reason. The Company ID field of the ACH was invalid. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidCompanyID WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_company_id" // Code R82. A rare return reason. The foreign receiving bank identifier for an // International ACH Transfer was invalid. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidForeignReceivingDfiIdentification WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_foreign_receiving_dfi_identification" // Code R22. A rare return reason. The Individual ID number field of the ACH was // invalid. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeInvalidIndividualIDNumber WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "invalid_individual_id_number" // Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the // original check were presented to the bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeItemAndRckEntryPresentedForPayment WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "item_and_rck_entry_presented_for_payment" // Code R51. A rare return reason. The Represented Check ("RCK") entry is // ineligible. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeItemRelatedToRckEntryIsIneligible WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "item_related_to_rck_entry_is_ineligible" // Code R26. A rare return reason. The ACH is missing a required field. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMandatoryFieldError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "mandatory_field_error" // Code R71. A rare return reason. The receiving bank does not recognize the // routing number in a dishonored return entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMisroutedDishonoredReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_dishonored_return" // Code R61. A rare return reason. The receiving bank does not recognize the // routing number in a return entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeMisroutedReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "misrouted_return" // Code R76. A rare return reason. Sent in response to a return, the bank does not // find the errors alleged by the returning bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNoErrorsFound WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "no_errors_found" // Code R77. A rare return reason. The receiving bank does not accept the return of // the erroneous debit. The funds are not available at the receiving bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonAcceptanceOfR62DishonoredReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_acceptance_of_r62_dishonored_return" // Code R81. A rare return reason. The receiving bank does not accept International // ACH Transfers. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeNonParticipantInIatProgram WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "non_participant_in_iat_program" // Code R31. A rare return reason. A return that has been agreed to be accepted by // the receiving bank, despite falling outside of the usual return timeframe. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry" // Code R70. A rare return reason. The receiving bank had not approved this return. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodePermissibleReturnEntryNotAccepted WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "permissible_return_entry_not_accepted" // Code R32. A rare return reason. The receiving bank could not settle this // transaction. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRdfiNonSettlement WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_non_settlement" // Code R30. A rare return reason. The receiving bank does not accept Check // Truncation ACH transfers. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRdfiParticipantInCheckTruncationProgram WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "rdfi_participant_in_check_truncation_program" // Code R14. A rare return reason. The payee is deceased. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeRepresentativePayeeDeceasedOrUnableToContinueInThatCapacity WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "representative_payee_deceased_or_unable_to_continue_in_that_capacity" // Code R75. A rare return reason. The originating bank disputes that an earlier // `duplicate_entry` return was actually a duplicate. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnNotADuplicate WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_not_a_duplicate" // Code R62. A rare return reason. The originating bank made a mistake earlier and // this return corrects it. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfErroneousOrReversingDebit WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_erroneous_or_reversing_debit" // Code R36. A rare return reason. Return of a malformed credit entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperCreditEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_credit_entry" // Code R35. A rare return reason. Return of a malformed debit entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfImproperDebitEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_improper_debit_entry" // Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeReturnOfXckEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "return_of_xck_entry" // Code R37. A rare return reason. The source document related to this ACH, usually // an ACH check conversion, was presented to the bank. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeSourceDocumentPresentedForPayment WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "source_document_presented_for_payment" // Code R50. A rare return reason. State law prevents the bank from accepting the // Represented Check ("RCK") entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStateLawAffectingRckAcceptance WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "state_law_affecting_rck_acceptance" // Code R52. A rare return reason. A stop payment was issued on a Represented Check // ("RCK") entry. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnItemRelatedToRckEntry WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_item_related_to_rck_entry" // Code R38. A rare return reason. The source attached to the ACH, usually an ACH // check conversion, includes a stop payment. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeStopPaymentOnSourceDocument WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "stop_payment_on_source_document" // Code R73. A rare return reason. The bank receiving an `untimely_return` believes // it was on time. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeTimelyOriginalReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "timely_original_return" // Code R27. A rare return reason. An ACH Return's trace number does not match an // originated ACH. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeTraceNumberError WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "trace_number_error" // Code R72. A rare return reason. The dishonored return was sent too late. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUntimelyDishonoredReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "untimely_dishonored_return" // Code R68. A rare return reason. The return was sent too late. WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCodeUntimelyReturn WireTransferSimulationTransactionSourceACHTransferReturnReturnReasonCode = "untimely_return" )
type WireTransferSimulationTransactionSourceAccountTransferIntention ¶
type WireTransferSimulationTransactionSourceAccountTransferIntention struct {
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
// account currency.
Currency WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency `json:"currency,required"`
// The description you chose to give the transfer.
Description string `json:"description,required"`
// The identifier of the Account to where the Account Transfer was sent.
DestinationAccountID string `json:"destination_account_id,required"`
// The identifier of the Account from where the Account Transfer was sent.
SourceAccountID string `json:"source_account_id,required"`
// The identifier of the Account Transfer that led to this Pending Transaction.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceAccountTransferIntentionJSON
}
An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
func (*WireTransferSimulationTransactionSourceAccountTransferIntention) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceAccountTransferIntention) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency ¶
type WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyCad WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyChf WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyEur WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyGbp WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyJpy WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceAccountTransferIntentionCurrencyUsd WireTransferSimulationTransactionSourceAccountTransferIntentionCurrency = "USD" )
type WireTransferSimulationTransactionSourceCardDisputeAcceptance ¶
type WireTransferSimulationTransactionSourceCardDisputeAcceptance struct {
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the Card Dispute was accepted.
AcceptedAt time.Time `json:"accepted_at,required" format:"date-time"`
// The identifier of the Card Dispute that was accepted.
CardDisputeID string `json:"card_dispute_id,required"`
// The identifier of the Transaction that was created to return the disputed funds
// to your account.
TransactionID string `json:"transaction_id,required"`
JSON wireTransferSimulationTransactionSourceCardDisputeAcceptanceJSON
}
A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
func (*WireTransferSimulationTransactionSourceCardDisputeAcceptance) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCardDisputeAcceptance) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefund ¶
type WireTransferSimulationTransactionSourceCardRefund struct {
// The Card Refund identifier.
ID string `json:"id,required"`
// The pending amount in the minor unit of the transaction's currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency WireTransferSimulationTransactionSourceCardRefundCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails WireTransferSimulationTransactionSourceCardRefundPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_refund`.
Type WireTransferSimulationTransactionSourceCardRefundType `json:"type,required"`
JSON wireTransferSimulationTransactionSourceCardRefundJSON
}
A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
func (*WireTransferSimulationTransactionSourceCardRefund) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCardRefund) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundCurrency ¶
type WireTransferSimulationTransactionSourceCardRefundCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCardRefundCurrencyCad WireTransferSimulationTransactionSourceCardRefundCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCardRefundCurrencyChf WireTransferSimulationTransactionSourceCardRefundCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCardRefundCurrencyEur WireTransferSimulationTransactionSourceCardRefundCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCardRefundCurrencyGbp WireTransferSimulationTransactionSourceCardRefundCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCardRefundCurrencyJpy WireTransferSimulationTransactionSourceCardRefundCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCardRefundCurrencyUsd WireTransferSimulationTransactionSourceCardRefundCurrency = "USD" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetails ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetails struct {
// Fields specific to car rentals.
CarRental WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesNoExtraCharge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesGas WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesExtraMileage WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesLateReturn WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesOneWayServiceFee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraChargesParkingViolation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNotApplicable WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesNoExtraCharge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesRestaurant WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesGiftShop WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesMiniBar WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesTelephone WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "telephone" // Other WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesOther WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "other" // Laundry WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraChargesLaundry WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingExtraCharges = "laundry" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNotApplicable WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicatorNoShow WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatFreeText WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatOrderNumber WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServiceJSON
}
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryNone WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBundledService WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryChangeFee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCargo WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGiftCard WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryLounge WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMedical WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryOther WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryPets WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategorySeatFees WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStandby WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryServiceFee WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryStore WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryTravelService WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryUpgrades WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategoryWifi WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorNoCredit WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorOther WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNone WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicatorNewTicket WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegJSON
}
func (*WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeNone WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed WireTransferSimulationTransactionSourceCardRefundPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type WireTransferSimulationTransactionSourceCardRefundType ¶
type WireTransferSimulationTransactionSourceCardRefundType string
A constant representing the object's type. For this resource it will always be `card_refund`.
const (
WireTransferSimulationTransactionSourceCardRefundTypeCardRefund WireTransferSimulationTransactionSourceCardRefundType = "card_refund"
)
type WireTransferSimulationTransactionSourceCardRevenuePayment ¶
type WireTransferSimulationTransactionSourceCardRevenuePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
// The account the card belonged to.
TransactedOnAccountID string `json:"transacted_on_account_id,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardRevenuePaymentJSON
}
A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
func (*WireTransferSimulationTransactionSourceCardRevenuePayment) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCardRevenuePayment) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency ¶
type WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyCad WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyChf WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyEur WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyGbp WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyJpy WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCardRevenuePaymentCurrencyUsd WireTransferSimulationTransactionSourceCardRevenuePaymentCurrency = "USD" )
type WireTransferSimulationTransactionSourceCardSettlement ¶
type WireTransferSimulationTransactionSourceCardSettlement struct {
// The Card Settlement identifier.
ID string `json:"id,required"`
// The amount in the minor unit of the transaction's settlement currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// The Card Authorization that was created prior to this Card Settlement, if on
// exists.
CardAuthorization string `json:"card_authorization,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's settlement currency.
Currency WireTransferSimulationTransactionSourceCardSettlementCurrency `json:"currency,required"`
// The merchant identifier (commonly abbreviated as MID) of the merchant the card
// is transacting with.
MerchantAcceptorID string `json:"merchant_acceptor_id,required,nullable"`
// The 4-digit MCC describing the merchant's business.
MerchantCategoryCode string `json:"merchant_category_code,required"`
// The city the merchant resides in.
MerchantCity string `json:"merchant_city,required,nullable"`
// The country the merchant resides in.
MerchantCountry string `json:"merchant_country,required"`
// The name of the merchant.
MerchantName string `json:"merchant_name,required,nullable"`
// The state the merchant resides in.
MerchantState string `json:"merchant_state,required,nullable"`
// The identifier of the Pending Transaction associated with this Transaction.
PendingTransactionID string `json:"pending_transaction_id,required,nullable"`
// The amount in the minor unit of the transaction's presentment currency.
PresentmentAmount int64 `json:"presentment_amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's presentment currency.
PresentmentCurrency string `json:"presentment_currency,required"`
// Additional details about the card purchase, such as tax and industry-specific
// fields.
PurchaseDetails WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails `json:"purchase_details,required,nullable"`
// The identifier of the Transaction associated with this Transaction.
TransactionID string `json:"transaction_id,required"`
// A constant representing the object's type. For this resource it will always be
// `card_settlement`.
Type WireTransferSimulationTransactionSourceCardSettlementType `json:"type,required"`
JSON wireTransferSimulationTransactionSourceCardSettlementJSON
}
A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
func (*WireTransferSimulationTransactionSourceCardSettlement) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCardSettlement) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementCurrency ¶
type WireTransferSimulationTransactionSourceCardSettlementCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCardSettlementCurrencyCad WireTransferSimulationTransactionSourceCardSettlementCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCardSettlementCurrencyChf WireTransferSimulationTransactionSourceCardSettlementCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCardSettlementCurrencyEur WireTransferSimulationTransactionSourceCardSettlementCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCardSettlementCurrencyGbp WireTransferSimulationTransactionSourceCardSettlementCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCardSettlementCurrencyJpy WireTransferSimulationTransactionSourceCardSettlementCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCardSettlementCurrencyUsd WireTransferSimulationTransactionSourceCardSettlementCurrency = "USD" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails struct {
// Fields specific to car rentals.
CarRental WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental `json:"car_rental,required,nullable"`
// An identifier from the merchant for the customer or consumer.
CustomerReferenceIdentifier string `json:"customer_reference_identifier,required,nullable"`
// The state or provincial tax amount in minor units.
LocalTaxAmount int64 `json:"local_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
LocalTaxCurrency string `json:"local_tax_currency,required,nullable"`
// Fields specific to lodging.
Lodging WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging `json:"lodging,required,nullable"`
// The national tax amount in minor units.
NationalTaxAmount int64 `json:"national_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
// assessed.
NationalTaxCurrency string `json:"national_tax_currency,required,nullable"`
// An identifier from the merchant for the purchase to the issuer and cardholder.
PurchaseIdentifier string `json:"purchase_identifier,required,nullable"`
// The format of the purchase identifier.
PurchaseIdentifierFormat WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat `json:"purchase_identifier_format,required,nullable"`
// Fields specific to travel.
Travel WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel `json:"travel,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsJSON
}
Additional details about the card purchase, such as tax and industry-specific fields.
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetails) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental struct {
// Code indicating the vehicle's class.
CarClassCode string `json:"car_class_code,required,nullable"`
// Date the customer picked up the car or, in the case of a no-show or pre-pay
// transaction, the scheduled pick up date.
CheckoutDate time.Time `json:"checkout_date,required,nullable" format:"date"`
// Daily rate being charged for the vehicle.
DailyRentalRateAmount int64 `json:"daily_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
// rate.
DailyRentalRateCurrency string `json:"daily_rental_rate_currency,required,nullable"`
// Number of days the vehicle was rented.
DaysRented int64 `json:"days_rented,required,nullable"`
// Additional charges (gas, late fee, etc.) being billed.
ExtraCharges WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges `json:"extra_charges,required,nullable"`
// Fuel charges for the vehicle.
FuelChargesAmount int64 `json:"fuel_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
// assessed.
FuelChargesCurrency string `json:"fuel_charges_currency,required,nullable"`
// Any insurance being charged for the vehicle.
InsuranceChargesAmount int64 `json:"insurance_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
// charges assessed.
InsuranceChargesCurrency string `json:"insurance_charges_currency,required,nullable"`
// An indicator that the cardholder is being billed for a reserved vehicle that was
// not actually rented (that is, a "no-show" charge).
NoShowIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Charges for returning the vehicle at a different location than where it was
// picked up.
OneWayDropOffChargesAmount int64 `json:"one_way_drop_off_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
// drop-off charges assessed.
OneWayDropOffChargesCurrency string `json:"one_way_drop_off_charges_currency,required,nullable"`
// Name of the person renting the vehicle.
RenterName string `json:"renter_name,required,nullable"`
// Weekly rate being charged for the vehicle.
WeeklyRentalRateAmount int64 `json:"weekly_rental_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
// rental rate.
WeeklyRentalRateCurrency string `json:"weekly_rental_rate_currency,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalJSON
}
Fields specific to car rentals.
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRental) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges string
Additional charges (gas, late fee, etc.) being billed.
const ( // No extra charge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesNoExtraCharge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "no_extra_charge" // Gas WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesGas WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "gas" // Extra mileage WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesExtraMileage WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "extra_mileage" // Late return WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesLateReturn WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "late_return" // One way service fee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesOneWayServiceFee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "one_way_service_fee" // Parking violation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraChargesParkingViolation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalExtraCharges = "parking_violation" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator string
An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge).
const ( // Not applicable WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNotApplicable WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "not_applicable" // No show for specialized vehicle WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicatorNoShowForSpecializedVehicle WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsCarRentalNoShowIndicator = "no_show_for_specialized_vehicle" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging struct {
// Date the customer checked in.
CheckInDate time.Time `json:"check_in_date,required,nullable" format:"date"`
// Daily rate being charged for the room.
DailyRoomRateAmount int64 `json:"daily_room_rate_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
// rate.
DailyRoomRateCurrency string `json:"daily_room_rate_currency,required,nullable"`
// Additional charges (phone, late check-out, etc.) being billed.
ExtraCharges WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges `json:"extra_charges,required,nullable"`
// Folio cash advances for the room.
FolioCashAdvancesAmount int64 `json:"folio_cash_advances_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
// advances.
FolioCashAdvancesCurrency string `json:"folio_cash_advances_currency,required,nullable"`
// Food and beverage charges for the room.
FoodBeverageChargesAmount int64 `json:"food_beverage_charges_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
// beverage charges.
FoodBeverageChargesCurrency string `json:"food_beverage_charges_currency,required,nullable"`
// Indicator that the cardholder is being billed for a reserved room that was not
// actually used.
NoShowIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator `json:"no_show_indicator,required,nullable"`
// Prepaid expenses being charged for the room.
PrepaidExpensesAmount int64 `json:"prepaid_expenses_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
// expenses.
PrepaidExpensesCurrency string `json:"prepaid_expenses_currency,required,nullable"`
// Number of nights the room was rented.
RoomNights int64 `json:"room_nights,required,nullable"`
// Total room tax being charged.
TotalRoomTaxAmount int64 `json:"total_room_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
// tax.
TotalRoomTaxCurrency string `json:"total_room_tax_currency,required,nullable"`
// Total tax being charged for the room.
TotalTaxAmount int64 `json:"total_tax_amount,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
// assessed.
TotalTaxCurrency string `json:"total_tax_currency,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingJSON
}
Fields specific to lodging.
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodging) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges string
Additional charges (phone, late check-out, etc.) being billed.
const ( // No extra charge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesNoExtraCharge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "no_extra_charge" // Restaurant WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesRestaurant WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "restaurant" // Gift shop WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesGiftShop WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "gift_shop" // Mini bar WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesMiniBar WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "mini_bar" // Telephone WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesTelephone WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "telephone" // Other WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesOther WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "other" // Laundry WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraChargesLaundry WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingExtraCharges = "laundry" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator string
Indicator that the cardholder is being billed for a reserved room that was not actually used.
const ( // Not applicable WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNotApplicable WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "not_applicable" // No show WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicatorNoShow WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsLodgingNoShowIndicator = "no_show" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat string
The format of the purchase identifier.
const ( // Free text WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatFreeText WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "free_text" // Order number WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatOrderNumber WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "order_number" // Rental agreement number WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatRentalAgreementNumber WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "rental_agreement_number" // Hotel folio number WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatHotelFolioNumber WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "hotel_folio_number" // Invoice number WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormatInvoiceNumber WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsPurchaseIdentifierFormat = "invoice_number" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel struct {
// Ancillary purchases in addition to the airfare.
Ancillary WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary `json:"ancillary,required,nullable"`
// Indicates the computerized reservation system used to book the ticket.
ComputerizedReservationSystem string `json:"computerized_reservation_system,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Date of departure.
DepartureDate time.Time `json:"departure_date,required,nullable" format:"date"`
// Code for the originating city or airport.
OriginationCityAirportCode string `json:"origination_city_airport_code,required,nullable"`
// Name of the passenger.
PassengerName string `json:"passenger_name,required,nullable"`
// Indicates whether this ticket is non-refundable.
RestrictedTicketIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator `json:"restricted_ticket_indicator,required,nullable"`
// Indicates why a ticket was changed.
TicketChangeIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator `json:"ticket_change_indicator,required,nullable"`
// Ticket number.
TicketNumber string `json:"ticket_number,required,nullable"`
// Code for the travel agency if the ticket was issued by a travel agency.
TravelAgencyCode string `json:"travel_agency_code,required,nullable"`
// Name of the travel agency if the ticket was issued by a travel agency.
TravelAgencyName string `json:"travel_agency_name,required,nullable"`
// Fields specific to each leg of the journey.
TripLegs []WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg `json:"trip_legs,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelJSON
}
Fields specific to travel.
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravel) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary struct {
// If this purchase has a connection or relationship to another purchase, such as a
// baggage fee for a passenger transport ticket, this field should contain the
// ticket document number for the other purchase.
ConnectedTicketDocumentNumber string `json:"connected_ticket_document_number,required,nullable"`
// Indicates the reason for a credit to the cardholder.
CreditReasonIndicator WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator `json:"credit_reason_indicator,required,nullable"`
// Name of the passenger or description of the ancillary purchase.
PassengerNameOrDescription string `json:"passenger_name_or_description,required,nullable"`
// Additional travel charges, such as baggage fees.
Services []WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService `json:"services,required"`
// Ticket document number.
TicketDocumentNumber string `json:"ticket_document_number,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryJSON
}
Ancillary purchases in addition to the airfare.
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillary) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorNoCredit WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Other WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicatorOther WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryCreditReasonIndicator = "other" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService struct {
// Category of the ancillary service.
Category WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory `json:"category,required,nullable"`
// Sub-category of the ancillary service, free-form.
SubCategory string `json:"sub_category,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServiceJSON
}
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryService) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory string
Category of the ancillary service.
const ( // None WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryNone WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "none" // Bundled service WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBundledService WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "bundled_service" // Baggage fee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryBaggageFee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "baggage_fee" // Change fee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryChangeFee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "change_fee" // Cargo WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCargo WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "cargo" // Carbon offset WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryCarbonOffset WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "carbon_offset" // Frequent flyer WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryFrequentFlyer WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "frequent_flyer" // Gift card WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGiftCard WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "gift_card" // Ground transport WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryGroundTransport WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "ground_transport" // In-flight entertainment WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryInFlightEntertainment WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "in_flight_entertainment" // Lounge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryLounge WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "lounge" // Medical WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMedical WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "medical" // Meal beverage WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryMealBeverage WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "meal_beverage" // Other WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryOther WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "other" // Passenger assist fee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPassengerAssistFee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "passenger_assist_fee" // Pets WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryPets WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "pets" // Seat fees WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategorySeatFees WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "seat_fees" // Standby WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStandby WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "standby" // Service fee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryServiceFee WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "service_fee" // Store WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryStore WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "store" // Travel service WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryTravelService WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "travel_service" // Unaccompanied travel WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUnaccompaniedTravel WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "unaccompanied_travel" // Upgrades WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryUpgrades WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "upgrades" // Wi-fi WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategoryWifi WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelAncillaryServicesCategory = "wifi" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator string
Indicates the reason for a credit to the cardholder.
const ( // No credit WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorNoCredit WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "no_credit" // Passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "passenger_transport_ancillary_purchase_cancellation" // Airline ticket and passenger transport ancillary purchase cancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketAndPassengerTransportAncillaryPurchaseCancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_and_passenger_transport_ancillary_purchase_cancellation" // Airline ticket cancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorAirlineTicketCancellation WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "airline_ticket_cancellation" // Other WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorOther WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "other" // Partial refund of airline ticket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicatorPartialRefundOfAirlineTicket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelCreditReasonIndicator = "partial_refund_of_airline_ticket" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator string
Indicates whether this ticket is non-refundable.
const ( // No restrictions WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorNoRestrictions WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "no_restrictions" // Restricted non-refundable ticket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicatorRestrictedNonRefundableTicket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelRestrictedTicketIndicator = "restricted_non_refundable_ticket" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator string
Indicates why a ticket was changed.
const ( // None WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNone WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "none" // Change to existing ticket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorChangeToExistingTicket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "change_to_existing_ticket" // New ticket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicatorNewTicket WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTicketChangeIndicator = "new_ticket" )
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg struct {
// Carrier code (e.g., United Airlines, Jet Blue, etc.).
CarrierCode string `json:"carrier_code,required,nullable"`
// Code for the destination city or airport.
DestinationCityAirportCode string `json:"destination_city_airport_code,required,nullable"`
// Fare basis code.
FareBasisCode string `json:"fare_basis_code,required,nullable"`
// Flight number.
FlightNumber string `json:"flight_number,required,nullable"`
// Service class (e.g., first class, business class, etc.).
ServiceClass string `json:"service_class,required,nullable"`
// Indicates whether a stopover is allowed on this ticket.
StopOverCode WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode `json:"stop_over_code,required,nullable"`
JSON wireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegJSON
}
func (*WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON ¶ added in v0.6.2
func (r *WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLeg) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode ¶ added in v0.6.2
type WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode string
Indicates whether a stopover is allowed on this ticket.
const ( // None WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeNone WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "none" // Stop over allowed WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverAllowed WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_allowed" // Stop over not allowed WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCodeStopOverNotAllowed WireTransferSimulationTransactionSourceCardSettlementPurchaseDetailsTravelTripLegsStopOverCode = "stop_over_not_allowed" )
type WireTransferSimulationTransactionSourceCardSettlementType ¶
type WireTransferSimulationTransactionSourceCardSettlementType string
A constant representing the object's type. For this resource it will always be `card_settlement`.
const (
WireTransferSimulationTransactionSourceCardSettlementTypeCardSettlement WireTransferSimulationTransactionSourceCardSettlementType = "card_settlement"
)
type WireTransferSimulationTransactionSourceCategory ¶
type WireTransferSimulationTransactionSourceCategory string
The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
const ( // Account Transfer Intention: details will be under the // `account_transfer_intention` object. WireTransferSimulationTransactionSourceCategoryAccountTransferIntention WireTransferSimulationTransactionSourceCategory = "account_transfer_intention" // ACH Transfer Intention: details will be under the `ach_transfer_intention` // object. WireTransferSimulationTransactionSourceCategoryACHTransferIntention WireTransferSimulationTransactionSourceCategory = "ach_transfer_intention" // ACH Transfer Rejection: details will be under the `ach_transfer_rejection` // object. WireTransferSimulationTransactionSourceCategoryACHTransferRejection WireTransferSimulationTransactionSourceCategory = "ach_transfer_rejection" // ACH Transfer Return: details will be under the `ach_transfer_return` object. WireTransferSimulationTransactionSourceCategoryACHTransferReturn WireTransferSimulationTransactionSourceCategory = "ach_transfer_return" // Card Dispute Acceptance: details will be under the `card_dispute_acceptance` // object. WireTransferSimulationTransactionSourceCategoryCardDisputeAcceptance WireTransferSimulationTransactionSourceCategory = "card_dispute_acceptance" // Card Refund: details will be under the `card_refund` object. WireTransferSimulationTransactionSourceCategoryCardRefund WireTransferSimulationTransactionSourceCategory = "card_refund" // Card Revenue Payment: details will be under the `card_revenue_payment` object. WireTransferSimulationTransactionSourceCategoryCardRevenuePayment WireTransferSimulationTransactionSourceCategory = "card_revenue_payment" // Card Settlement: details will be under the `card_settlement` object. WireTransferSimulationTransactionSourceCategoryCardSettlement WireTransferSimulationTransactionSourceCategory = "card_settlement" // Check Deposit Acceptance: details will be under the `check_deposit_acceptance` // object. WireTransferSimulationTransactionSourceCategoryCheckDepositAcceptance WireTransferSimulationTransactionSourceCategory = "check_deposit_acceptance" // Check Deposit Return: details will be under the `check_deposit_return` object. WireTransferSimulationTransactionSourceCategoryCheckDepositReturn WireTransferSimulationTransactionSourceCategory = "check_deposit_return" // Check Transfer Deposit: details will be under the `check_transfer_deposit` // object. WireTransferSimulationTransactionSourceCategoryCheckTransferDeposit WireTransferSimulationTransactionSourceCategory = "check_transfer_deposit" // Check Transfer Intention: details will be under the `check_transfer_intention` // object. WireTransferSimulationTransactionSourceCategoryCheckTransferIntention WireTransferSimulationTransactionSourceCategory = "check_transfer_intention" // Check Transfer Stop Payment Request: details will be under the // `check_transfer_stop_payment_request` object. WireTransferSimulationTransactionSourceCategoryCheckTransferStopPaymentRequest WireTransferSimulationTransactionSourceCategory = "check_transfer_stop_payment_request" // Fee Payment: details will be under the `fee_payment` object. WireTransferSimulationTransactionSourceCategoryFeePayment WireTransferSimulationTransactionSourceCategory = "fee_payment" // Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` // object. WireTransferSimulationTransactionSourceCategoryInboundACHTransfer WireTransferSimulationTransactionSourceCategory = "inbound_ach_transfer" // Inbound ACH Transfer Return Intention: details will be under the // `inbound_ach_transfer_return_intention` object. WireTransferSimulationTransactionSourceCategoryInboundACHTransferReturnIntention WireTransferSimulationTransactionSourceCategory = "inbound_ach_transfer_return_intention" // Inbound Check: details will be under the `inbound_check` object. WireTransferSimulationTransactionSourceCategoryInboundCheck WireTransferSimulationTransactionSourceCategory = "inbound_check" // Inbound International ACH Transfer: details will be under the // `inbound_international_ach_transfer` object. WireTransferSimulationTransactionSourceCategoryInboundInternationalACHTransfer WireTransferSimulationTransactionSourceCategory = "inbound_international_ach_transfer" // Inbound Real-Time Payments Transfer Confirmation: details will be under the // `inbound_real_time_payments_transfer_confirmation` object. WireTransferSimulationTransactionSourceCategoryInboundRealTimePaymentsTransferConfirmation WireTransferSimulationTransactionSourceCategory = "inbound_real_time_payments_transfer_confirmation" // Inbound Wire Drawdown Payment: details will be under the // `inbound_wire_drawdown_payment` object. WireTransferSimulationTransactionSourceCategoryInboundWireDrawdownPayment WireTransferSimulationTransactionSourceCategory = "inbound_wire_drawdown_payment" // Inbound Wire Drawdown Payment Reversal: details will be under the // `inbound_wire_drawdown_payment_reversal` object. WireTransferSimulationTransactionSourceCategoryInboundWireDrawdownPaymentReversal WireTransferSimulationTransactionSourceCategory = "inbound_wire_drawdown_payment_reversal" // Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object. WireTransferSimulationTransactionSourceCategoryInboundWireReversal WireTransferSimulationTransactionSourceCategory = "inbound_wire_reversal" // Inbound Wire Transfer: details will be under the `inbound_wire_transfer` object. WireTransferSimulationTransactionSourceCategoryInboundWireTransfer WireTransferSimulationTransactionSourceCategory = "inbound_wire_transfer" // Interest Payment: details will be under the `interest_payment` object. WireTransferSimulationTransactionSourceCategoryInterestPayment WireTransferSimulationTransactionSourceCategory = "interest_payment" // Internal Source: details will be under the `internal_source` object. WireTransferSimulationTransactionSourceCategoryInternalSource WireTransferSimulationTransactionSourceCategory = "internal_source" // Real-Time Payments Transfer Acknowledgement: details will be under the // `real_time_payments_transfer_acknowledgement` object. WireTransferSimulationTransactionSourceCategoryRealTimePaymentsTransferAcknowledgement WireTransferSimulationTransactionSourceCategory = "real_time_payments_transfer_acknowledgement" // Sample Funds: details will be under the `sample_funds` object. WireTransferSimulationTransactionSourceCategorySampleFunds WireTransferSimulationTransactionSourceCategory = "sample_funds" // Wire Transfer Intention: details will be under the `wire_transfer_intention` // object. WireTransferSimulationTransactionSourceCategoryWireTransferIntention WireTransferSimulationTransactionSourceCategory = "wire_transfer_intention" // Wire Transfer Rejection: details will be under the `wire_transfer_rejection` // object. WireTransferSimulationTransactionSourceCategoryWireTransferRejection WireTransferSimulationTransactionSourceCategory = "wire_transfer_rejection" // The Transaction was made for an undocumented or deprecated reason. WireTransferSimulationTransactionSourceCategoryOther WireTransferSimulationTransactionSourceCategory = "other" )
type WireTransferSimulationTransactionSourceCheckDepositAcceptance ¶
type WireTransferSimulationTransactionSourceCheckDepositAcceptance struct {
// The account number printed on the check.
AccountNumber string `json:"account_number,required"`
// The amount to be deposited in the minor unit of the transaction's currency. For
// dollars, for example, this is cents.
Amount int64 `json:"amount,required"`
// An additional line of metadata printed on the check. This typically includes the
// check number for business checks.
AuxiliaryOnUs string `json:"auxiliary_on_us,required,nullable"`
// The ID of the Check Deposit that was accepted.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency `json:"currency,required"`
// The routing number printed on the check.
RoutingNumber string `json:"routing_number,required"`
// The check serial number, if present, for consumer checks. For business checks,
// the serial number is usually in the `auxiliary_on_us` field.
SerialNumber string `json:"serial_number,required,nullable"`
JSON wireTransferSimulationTransactionSourceCheckDepositAcceptanceJSON
}
A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
func (*WireTransferSimulationTransactionSourceCheckDepositAcceptance) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCheckDepositAcceptance) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency ¶
type WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyCad WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyChf WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyEur WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyGbp WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyJpy WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrencyUsd WireTransferSimulationTransactionSourceCheckDepositAcceptanceCurrency = "USD" )
type WireTransferSimulationTransactionSourceCheckDepositReturn ¶
type WireTransferSimulationTransactionSourceCheckDepositReturn struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The identifier of the Check Deposit that was returned.
CheckDepositID string `json:"check_deposit_id,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency WireTransferSimulationTransactionSourceCheckDepositReturnCurrency `json:"currency,required"`
ReturnReason WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason `json:"return_reason,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the check deposit was returned.
ReturnedAt time.Time `json:"returned_at,required" format:"date-time"`
// The identifier of the transaction that reversed the original check deposit
// transaction.
TransactionID string `json:"transaction_id,required"`
JSON wireTransferSimulationTransactionSourceCheckDepositReturnJSON
}
A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
func (*WireTransferSimulationTransactionSourceCheckDepositReturn) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCheckDepositReturn) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCheckDepositReturnCurrency ¶
type WireTransferSimulationTransactionSourceCheckDepositReturnCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyCad WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyChf WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyEur WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyGbp WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyJpy WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCheckDepositReturnCurrencyUsd WireTransferSimulationTransactionSourceCheckDepositReturnCurrency = "USD" )
type WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason ¶
type WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason string
const ( // The check doesn't allow ACH conversion. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonACHConversionNotSupported WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "ach_conversion_not_supported" // The account is closed. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonClosedAccount WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "closed_account" // The check has already been deposited. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonDuplicateSubmission WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "duplicate_submission" // Insufficient funds WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonInsufficientFunds WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "insufficient_funds" // No account was found matching the check details. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonNoAccount WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "no_account" // The check was not authorized. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonNotAuthorized WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "not_authorized" // The check is too old. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonStaleDated WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "stale_dated" // The payment has been stopped by the account holder. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonStopPayment WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "stop_payment" // The reason for the return is unknown. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnknownReason WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unknown_reason" // The image doesn't match the details submitted. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnmatchedDetails WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unmatched_details" // The image could not be read. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonUnreadableImage WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "unreadable_image" // The check endorsement was irregular. WireTransferSimulationTransactionSourceCheckDepositReturnReturnReasonEndorsementIrregular WireTransferSimulationTransactionSourceCheckDepositReturnReturnReason = "endorsement_irregular" )
type WireTransferSimulationTransactionSourceCheckTransferDeposit ¶ added in v0.3.0
type WireTransferSimulationTransactionSourceCheckTransferDeposit struct {
// The identifier of the API File object containing an image of the back of the
// deposited check.
BackImageFileID string `json:"back_image_file_id,required,nullable"`
// When the check was deposited.
DepositedAt time.Time `json:"deposited_at,required" format:"date-time"`
// The identifier of the API File object containing an image of the front of the
// deposited check.
FrontImageFileID string `json:"front_image_file_id,required,nullable"`
// The identifier of the Transaction object created when the check was deposited.
TransactionID string `json:"transaction_id,required,nullable"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_deposit`.
Type WireTransferSimulationTransactionSourceCheckTransferDepositType `json:"type,required"`
JSON wireTransferSimulationTransactionSourceCheckTransferDepositJSON
}
A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`.
func (*WireTransferSimulationTransactionSourceCheckTransferDeposit) UnmarshalJSON ¶ added in v0.3.0
func (r *WireTransferSimulationTransactionSourceCheckTransferDeposit) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCheckTransferDepositType ¶ added in v0.3.0
type WireTransferSimulationTransactionSourceCheckTransferDepositType string
A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
const (
WireTransferSimulationTransactionSourceCheckTransferDepositTypeCheckTransferDeposit WireTransferSimulationTransactionSourceCheckTransferDepositType = "check_transfer_deposit"
)
type WireTransferSimulationTransactionSourceCheckTransferIntention ¶
type WireTransferSimulationTransactionSourceCheckTransferIntention struct {
// The city of the check's destination.
AddressCity string `json:"address_city,required,nullable"`
// The street address of the check's destination.
AddressLine1 string `json:"address_line1,required,nullable"`
// The second line of the address of the check's destination.
AddressLine2 string `json:"address_line2,required,nullable"`
// The state of the check's destination.
AddressState string `json:"address_state,required,nullable"`
// The postal code of the check's destination.
AddressZip string `json:"address_zip,required,nullable"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's
// currency.
Currency WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency `json:"currency,required"`
// The name that will be printed on the check.
RecipientName string `json:"recipient_name,required,nullable"`
// The identifier of the Check Transfer with which this is associated.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceCheckTransferIntentionJSON
}
A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
func (*WireTransferSimulationTransactionSourceCheckTransferIntention) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCheckTransferIntention) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency ¶
type WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyCad WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyChf WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyEur WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyGbp WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyJpy WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceCheckTransferIntentionCurrencyUsd WireTransferSimulationTransactionSourceCheckTransferIntentionCurrency = "USD" )
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest ¶
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest struct {
// The reason why this transfer was stopped.
Reason WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason `json:"reason,required"`
// The time the stop-payment was requested.
RequestedAt time.Time `json:"requested_at,required" format:"date-time"`
// The ID of the check transfer that was stopped.
TransferID string `json:"transfer_id,required"`
// A constant representing the object's type. For this resource it will always be
// `check_transfer_stop_payment_request`.
Type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType `json:"type,required"`
JSON wireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestJSON
}
A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
func (*WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequest) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason ¶ added in v0.4.0
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason string
The reason why this transfer was stopped.
const ( // The check could not be delivered. WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonMailDeliveryFailed WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "mail_delivery_failed" // The check was canceled by an Increase operator who will provide details // out-of-band. WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonRejectedByIncrease WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "rejected_by_increase" // The check was stopped for another reason. WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReasonUnknown WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestReason = "unknown" )
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType ¶
type WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType string
A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
const (
WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestTypeCheckTransferStopPaymentRequest WireTransferSimulationTransactionSourceCheckTransferStopPaymentRequestType = "check_transfer_stop_payment_request"
)
type WireTransferSimulationTransactionSourceFeePayment ¶
type WireTransferSimulationTransactionSourceFeePayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency WireTransferSimulationTransactionSourceFeePaymentCurrency `json:"currency,required"`
// The start of this payment's fee period, usually the first day of a month.
FeePeriodStart time.Time `json:"fee_period_start,required" format:"date"`
JSON wireTransferSimulationTransactionSourceFeePaymentJSON
}
A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
func (*WireTransferSimulationTransactionSourceFeePayment) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceFeePayment) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceFeePaymentCurrency ¶
type WireTransferSimulationTransactionSourceFeePaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceFeePaymentCurrencyCad WireTransferSimulationTransactionSourceFeePaymentCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceFeePaymentCurrencyChf WireTransferSimulationTransactionSourceFeePaymentCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceFeePaymentCurrencyEur WireTransferSimulationTransactionSourceFeePaymentCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceFeePaymentCurrencyGbp WireTransferSimulationTransactionSourceFeePaymentCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceFeePaymentCurrencyJpy WireTransferSimulationTransactionSourceFeePaymentCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceFeePaymentCurrencyUsd WireTransferSimulationTransactionSourceFeePaymentCurrency = "USD" )
type WireTransferSimulationTransactionSourceInboundACHTransfer ¶
type WireTransferSimulationTransactionSourceInboundACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
OriginatorCompanyDescriptiveDate string `json:"originator_company_descriptive_date,required,nullable"`
OriginatorCompanyDiscretionaryData string `json:"originator_company_discretionary_data,required,nullable"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCompanyID string `json:"originator_company_id,required"`
OriginatorCompanyName string `json:"originator_company_name,required"`
ReceiverIDNumber string `json:"receiver_id_number,required,nullable"`
ReceiverName string `json:"receiver_name,required,nullable"`
TraceNumber string `json:"trace_number,required"`
JSON wireTransferSimulationTransactionSourceInboundACHTransferJSON
}
An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
func (*WireTransferSimulationTransactionSourceInboundACHTransfer) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundACHTransfer) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundCheck ¶
type WireTransferSimulationTransactionSourceInboundCheck struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
CheckFrontImageFileID string `json:"check_front_image_file_id,required,nullable"`
CheckNumber string `json:"check_number,required,nullable"`
CheckRearImageFileID string `json:"check_rear_image_file_id,required,nullable"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
// transaction's currency.
Currency WireTransferSimulationTransactionSourceInboundCheckCurrency `json:"currency,required"`
JSON wireTransferSimulationTransactionSourceInboundCheckJSON
}
An Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
func (*WireTransferSimulationTransactionSourceInboundCheck) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundCheck) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundCheckCurrency ¶
type WireTransferSimulationTransactionSourceInboundCheckCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceInboundCheckCurrencyCad WireTransferSimulationTransactionSourceInboundCheckCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceInboundCheckCurrencyChf WireTransferSimulationTransactionSourceInboundCheckCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceInboundCheckCurrencyEur WireTransferSimulationTransactionSourceInboundCheckCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceInboundCheckCurrencyGbp WireTransferSimulationTransactionSourceInboundCheckCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceInboundCheckCurrencyJpy WireTransferSimulationTransactionSourceInboundCheckCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceInboundCheckCurrencyUsd WireTransferSimulationTransactionSourceInboundCheckCurrency = "USD" )
type WireTransferSimulationTransactionSourceInboundInternationalACHTransfer ¶
type WireTransferSimulationTransactionSourceInboundInternationalACHTransfer struct {
// The amount in the minor unit of the destination account currency. For dollars,
// for example, this is cents.
Amount int64 `json:"amount,required"`
DestinationCountryCode string `json:"destination_country_code,required"`
DestinationCurrencyCode string `json:"destination_currency_code,required"`
ForeignExchangeIndicator string `json:"foreign_exchange_indicator,required"`
ForeignExchangeReference string `json:"foreign_exchange_reference,required,nullable"`
ForeignExchangeReferenceIndicator string `json:"foreign_exchange_reference_indicator,required"`
ForeignPaymentAmount int64 `json:"foreign_payment_amount,required"`
ForeignTraceNumber string `json:"foreign_trace_number,required,nullable"`
InternationalTransactionTypeCode string `json:"international_transaction_type_code,required"`
OriginatingCurrencyCode string `json:"originating_currency_code,required"`
OriginatingDepositoryFinancialInstitutionBranchCountry string `json:"originating_depository_financial_institution_branch_country,required"`
OriginatingDepositoryFinancialInstitutionID string `json:"originating_depository_financial_institution_id,required"`
OriginatingDepositoryFinancialInstitutionIDQualifier string `json:"originating_depository_financial_institution_id_qualifier,required"`
OriginatingDepositoryFinancialInstitutionName string `json:"originating_depository_financial_institution_name,required"`
OriginatorCity string `json:"originator_city,required"`
OriginatorCompanyEntryDescription string `json:"originator_company_entry_description,required"`
OriginatorCountry string `json:"originator_country,required"`
OriginatorIdentification string `json:"originator_identification,required"`
OriginatorName string `json:"originator_name,required"`
OriginatorPostalCode string `json:"originator_postal_code,required,nullable"`
OriginatorStateOrProvince string `json:"originator_state_or_province,required,nullable"`
OriginatorStreetAddress string `json:"originator_street_address,required"`
PaymentRelatedInformation string `json:"payment_related_information,required,nullable"`
PaymentRelatedInformation2 string `json:"payment_related_information2,required,nullable"`
ReceiverCity string `json:"receiver_city,required"`
ReceiverCountry string `json:"receiver_country,required"`
ReceiverIdentificationNumber string `json:"receiver_identification_number,required,nullable"`
ReceiverPostalCode string `json:"receiver_postal_code,required,nullable"`
ReceiverStateOrProvince string `json:"receiver_state_or_province,required,nullable"`
ReceiverStreetAddress string `json:"receiver_street_address,required"`
ReceivingCompanyOrIndividualName string `json:"receiving_company_or_individual_name,required"`
ReceivingDepositoryFinancialInstitutionCountry string `json:"receiving_depository_financial_institution_country,required"`
ReceivingDepositoryFinancialInstitutionID string `json:"receiving_depository_financial_institution_id,required"`
ReceivingDepositoryFinancialInstitutionIDQualifier string `json:"receiving_depository_financial_institution_id_qualifier,required"`
ReceivingDepositoryFinancialInstitutionName string `json:"receiving_depository_financial_institution_name,required"`
TraceNumber string `json:"trace_number,required"`
JSON wireTransferSimulationTransactionSourceInboundInternationalACHTransferJSON
}
An Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
func (*WireTransferSimulationTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundInternationalACHTransfer) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation ¶
type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation struct {
// The amount in the minor unit of the transfer's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The name the sender of the transfer specified as the recipient of the transfer.
CreditorName string `json:"creditor_name,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
// currency. This will always be "USD" for a Real-Time Payments transfer.
Currency WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency `json:"currency,required"`
// The account number of the account that sent the transfer.
DebtorAccountNumber string `json:"debtor_account_number,required"`
// The name provided by the sender of the transfer.
DebtorName string `json:"debtor_name,required"`
// The routing number of the account that sent the transfer.
DebtorRoutingNumber string `json:"debtor_routing_number,required"`
// Additional information included with the transfer.
RemittanceInformation string `json:"remittance_information,required,nullable"`
// The Real-Time Payments network identification of the transfer
TransactionIdentification string `json:"transaction_identification,required"`
JSON wireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationJSON
}
An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
func (*WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmation) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency ¶
type WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyCad WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyChf WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyEur WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyGbp WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyJpy WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrencyUsd WireTransferSimulationTransactionSourceInboundRealTimePaymentsTransferConfirmationCurrency = "USD" )
type WireTransferSimulationTransactionSourceInboundWireDrawdownPayment ¶
type WireTransferSimulationTransactionSourceInboundWireDrawdownPayment struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
JSON wireTransferSimulationTransactionSourceInboundWireDrawdownPaymentJSON
}
An Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
func (*WireTransferSimulationTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundWireDrawdownPayment) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal ¶
type WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
JSON wireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversalJSON
}
An Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
func (*WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundWireDrawdownPaymentReversal) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundWireReversal ¶
type WireTransferSimulationTransactionSourceInboundWireReversal struct {
// The amount that was reversed.
Amount int64 `json:"amount,required"`
// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
// the reversal was created.
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
// The description on the reversal message from Fedwire.
Description string `json:"description,required"`
// Additional financial institution information included in the wire reversal.
FinancialInstitutionToFinancialInstitutionInformation string `json:"financial_institution_to_financial_institution_information,required,nullable"`
// The Fedwire cycle date for the wire reversal.
InputCycleDate time.Time `json:"input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// The Fedwire sequence number.
InputSequenceNumber string `json:"input_sequence_number,required"`
// The Fedwire input source identifier.
InputSource string `json:"input_source,required"`
// The Fedwire cycle date for the wire transfer that was reversed.
PreviousMessageInputCycleDate time.Time `json:"previous_message_input_cycle_date,required" format:"date"`
// The Fedwire transaction identifier for the wire transfer that was reversed.
PreviousMessageInputMessageAccountabilityData string `json:"previous_message_input_message_accountability_data,required"`
// The Fedwire sequence number for the wire transfer that was reversed.
PreviousMessageInputSequenceNumber string `json:"previous_message_input_sequence_number,required"`
// The Fedwire input source identifier for the wire transfer that was reversed.
PreviousMessageInputSource string `json:"previous_message_input_source,required"`
// Information included in the wire reversal for the receiving financial
// institution.
ReceiverFinancialInstitutionInformation string `json:"receiver_financial_institution_information,required,nullable"`
// The ID for the Transaction associated with the transfer reversal.
TransactionID string `json:"transaction_id,required"`
// The ID for the Wire Transfer that is being reversed.
WireTransferID string `json:"wire_transfer_id,required"`
JSON wireTransferSimulationTransactionSourceInboundWireReversalJSON
}
An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
func (*WireTransferSimulationTransactionSourceInboundWireReversal) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundWireReversal) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInboundWireTransfer ¶
type WireTransferSimulationTransactionSourceInboundWireTransfer struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
BeneficiaryAddressLine1 string `json:"beneficiary_address_line1,required,nullable"`
BeneficiaryAddressLine2 string `json:"beneficiary_address_line2,required,nullable"`
BeneficiaryAddressLine3 string `json:"beneficiary_address_line3,required,nullable"`
BeneficiaryName string `json:"beneficiary_name,required,nullable"`
BeneficiaryReference string `json:"beneficiary_reference,required,nullable"`
Description string `json:"description,required"`
InputMessageAccountabilityData string `json:"input_message_accountability_data,required,nullable"`
OriginatorAddressLine1 string `json:"originator_address_line1,required,nullable"`
OriginatorAddressLine2 string `json:"originator_address_line2,required,nullable"`
OriginatorAddressLine3 string `json:"originator_address_line3,required,nullable"`
OriginatorName string `json:"originator_name,required,nullable"`
OriginatorToBeneficiaryInformation string `json:"originator_to_beneficiary_information,required,nullable"`
OriginatorToBeneficiaryInformationLine1 string `json:"originator_to_beneficiary_information_line1,required,nullable"`
OriginatorToBeneficiaryInformationLine2 string `json:"originator_to_beneficiary_information_line2,required,nullable"`
OriginatorToBeneficiaryInformationLine3 string `json:"originator_to_beneficiary_information_line3,required,nullable"`
OriginatorToBeneficiaryInformationLine4 string `json:"originator_to_beneficiary_information_line4,required,nullable"`
JSON wireTransferSimulationTransactionSourceInboundWireTransferJSON
}
An Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
func (*WireTransferSimulationTransactionSourceInboundWireTransfer) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInboundWireTransfer) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInterestPayment ¶
type WireTransferSimulationTransactionSourceInterestPayment struct {
// The account on which the interest was accrued.
AccruedOnAccountID string `json:"accrued_on_account_id,required,nullable"`
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency WireTransferSimulationTransactionSourceInterestPaymentCurrency `json:"currency,required"`
// The end of the period for which this transaction paid interest.
PeriodEnd time.Time `json:"period_end,required" format:"date-time"`
// The start of the period for which this transaction paid interest.
PeriodStart time.Time `json:"period_start,required" format:"date-time"`
JSON wireTransferSimulationTransactionSourceInterestPaymentJSON
}
An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
func (*WireTransferSimulationTransactionSourceInterestPayment) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInterestPayment) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInterestPaymentCurrency ¶
type WireTransferSimulationTransactionSourceInterestPaymentCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceInterestPaymentCurrencyCad WireTransferSimulationTransactionSourceInterestPaymentCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceInterestPaymentCurrencyChf WireTransferSimulationTransactionSourceInterestPaymentCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceInterestPaymentCurrencyEur WireTransferSimulationTransactionSourceInterestPaymentCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceInterestPaymentCurrencyGbp WireTransferSimulationTransactionSourceInterestPaymentCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceInterestPaymentCurrencyJpy WireTransferSimulationTransactionSourceInterestPaymentCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceInterestPaymentCurrencyUsd WireTransferSimulationTransactionSourceInterestPaymentCurrency = "USD" )
type WireTransferSimulationTransactionSourceInternalSource ¶
type WireTransferSimulationTransactionSourceInternalSource struct {
// The amount in the minor unit of the transaction's currency. For dollars, for
// example, this is cents.
Amount int64 `json:"amount,required"`
// The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction
// currency.
Currency WireTransferSimulationTransactionSourceInternalSourceCurrency `json:"currency,required"`
Reason WireTransferSimulationTransactionSourceInternalSourceReason `json:"reason,required"`
JSON wireTransferSimulationTransactionSourceInternalSourceJSON
}
An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
func (*WireTransferSimulationTransactionSourceInternalSource) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceInternalSource) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceInternalSourceCurrency ¶
type WireTransferSimulationTransactionSourceInternalSourceCurrency string
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
const ( // Canadian Dollar (CAD) WireTransferSimulationTransactionSourceInternalSourceCurrencyCad WireTransferSimulationTransactionSourceInternalSourceCurrency = "CAD" // Swiss Franc (CHF) WireTransferSimulationTransactionSourceInternalSourceCurrencyChf WireTransferSimulationTransactionSourceInternalSourceCurrency = "CHF" // Euro (EUR) WireTransferSimulationTransactionSourceInternalSourceCurrencyEur WireTransferSimulationTransactionSourceInternalSourceCurrency = "EUR" // British Pound (GBP) WireTransferSimulationTransactionSourceInternalSourceCurrencyGbp WireTransferSimulationTransactionSourceInternalSourceCurrency = "GBP" // Japanese Yen (JPY) WireTransferSimulationTransactionSourceInternalSourceCurrencyJpy WireTransferSimulationTransactionSourceInternalSourceCurrency = "JPY" // US Dollar (USD) WireTransferSimulationTransactionSourceInternalSourceCurrencyUsd WireTransferSimulationTransactionSourceInternalSourceCurrency = "USD" )
type WireTransferSimulationTransactionSourceInternalSourceReason ¶
type WireTransferSimulationTransactionSourceInternalSourceReason string
const ( // Account closure WireTransferSimulationTransactionSourceInternalSourceReasonAccountClosure WireTransferSimulationTransactionSourceInternalSourceReason = "account_closure" // Bank migration WireTransferSimulationTransactionSourceInternalSourceReasonBankMigration WireTransferSimulationTransactionSourceInternalSourceReason = "bank_migration" // Cashback WireTransferSimulationTransactionSourceInternalSourceReasonCashback WireTransferSimulationTransactionSourceInternalSourceReason = "cashback" // Check adjustment WireTransferSimulationTransactionSourceInternalSourceReasonCheckAdjustment WireTransferSimulationTransactionSourceInternalSourceReason = "check_adjustment" // Collection receivable WireTransferSimulationTransactionSourceInternalSourceReasonCollectionReceivable WireTransferSimulationTransactionSourceInternalSourceReason = "collection_receivable" // Empyreal adjustment WireTransferSimulationTransactionSourceInternalSourceReasonEmpyrealAdjustment WireTransferSimulationTransactionSourceInternalSourceReason = "empyreal_adjustment" // Error WireTransferSimulationTransactionSourceInternalSourceReasonError WireTransferSimulationTransactionSourceInternalSourceReason = "error" // Error correction WireTransferSimulationTransactionSourceInternalSourceReasonErrorCorrection WireTransferSimulationTransactionSourceInternalSourceReason = "error_correction" // Fees WireTransferSimulationTransactionSourceInternalSourceReasonFees WireTransferSimulationTransactionSourceInternalSourceReason = "fees" // Interest WireTransferSimulationTransactionSourceInternalSourceReasonInterest WireTransferSimulationTransactionSourceInternalSourceReason = "interest" // Negative balance forgiveness WireTransferSimulationTransactionSourceInternalSourceReasonNegativeBalanceForgiveness WireTransferSimulationTransactionSourceInternalSourceReason = "negative_balance_forgiveness" // Sample funds WireTransferSimulationTransactionSourceInternalSourceReasonSampleFunds WireTransferSimulationTransactionSourceInternalSourceReason = "sample_funds" // Sample funds return WireTransferSimulationTransactionSourceInternalSourceReasonSampleFundsReturn WireTransferSimulationTransactionSourceInternalSourceReason = "sample_funds_return" )
type WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement ¶
type WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement struct {
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The destination account number.
DestinationAccountNumber string `json:"destination_account_number,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
DestinationRoutingNumber string `json:"destination_routing_number,required"`
// Unstructured information that will show on the recipient's bank statement.
RemittanceInformation string `json:"remittance_information,required"`
// The identifier of the Real-Time Payments Transfer that led to this Transaction.
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgementJSON
}
A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
func (*WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceRealTimePaymentsTransferAcknowledgement) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceSampleFunds ¶
type WireTransferSimulationTransactionSourceSampleFunds struct {
// Where the sample funds came from.
Originator string `json:"originator,required"`
JSON wireTransferSimulationTransactionSourceSampleFundsJSON
}
A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
func (*WireTransferSimulationTransactionSourceSampleFunds) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceSampleFunds) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceWireTransferIntention ¶
type WireTransferSimulationTransactionSourceWireTransferIntention struct {
// The destination account number.
AccountNumber string `json:"account_number,required"`
// The transfer amount in USD cents.
Amount int64 `json:"amount,required"`
// The message that will show on the recipient's bank statement.
MessageToRecipient string `json:"message_to_recipient,required"`
// The American Bankers' Association (ABA) Routing Transit Number (RTN).
RoutingNumber string `json:"routing_number,required"`
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceWireTransferIntentionJSON
}
A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
func (*WireTransferSimulationTransactionSourceWireTransferIntention) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceWireTransferIntention) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionSourceWireTransferRejection ¶
type WireTransferSimulationTransactionSourceWireTransferRejection struct {
TransferID string `json:"transfer_id,required"`
JSON wireTransferSimulationTransactionSourceWireTransferRejectionJSON
}
A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
func (*WireTransferSimulationTransactionSourceWireTransferRejection) UnmarshalJSON ¶
func (r *WireTransferSimulationTransactionSourceWireTransferRejection) UnmarshalJSON(data []byte) (err error)
type WireTransferSimulationTransactionType ¶
type WireTransferSimulationTransactionType string
A constant representing the object's type. For this resource it will always be `transaction`.
const (
WireTransferSimulationTransactionTypeTransaction WireTransferSimulationTransactionType = "transaction"
)
type WireTransferSimulationType ¶
type WireTransferSimulationType string
A constant representing the object's type. For this resource it will always be `inbound_wire_transfer_simulation_result`.
const (
WireTransferSimulationTypeInboundWireTransferSimulationResult WireTransferSimulationType = "inbound_wire_transfer_simulation_result"
)
type WireTransferStatus ¶
type WireTransferStatus string
The lifecycle status of the transfer.
const ( // The transfer has been canceled. WireTransferStatusCanceled WireTransferStatus = "canceled" // The transfer requires attention from an Increase operator. WireTransferStatusRequiresAttention WireTransferStatus = "requires_attention" // The transfer is pending approval. WireTransferStatusPendingApproval WireTransferStatus = "pending_approval" // The transfer has been rejected. WireTransferStatusRejected WireTransferStatus = "rejected" // The transfer has been reversed. WireTransferStatusReversed WireTransferStatus = "reversed" // The transfer is complete. WireTransferStatusComplete WireTransferStatus = "complete" // The transfer is pending creation. WireTransferStatusPendingCreating WireTransferStatus = "pending_creating" )
type WireTransferSubmission ¶
type WireTransferSubmission struct {
// The accountability data for the submission.
InputMessageAccountabilityData string `json:"input_message_accountability_data,required"`
// When this wire transfer was submitted to Fedwire.
SubmittedAt time.Time `json:"submitted_at,required" format:"date-time"`
JSON wireTransferSubmissionJSON
}
After the transfer is submitted to Fedwire, this will contain supplemental details.
func (*WireTransferSubmission) UnmarshalJSON ¶
func (r *WireTransferSubmission) UnmarshalJSON(data []byte) (err error)
type WireTransferType ¶
type WireTransferType string
A constant representing the object's type. For this resource it will always be `wire_transfer`.
const (
WireTransferTypeWireTransfer WireTransferType = "wire_transfer"
)
Source Files
¶
- account.go
- accountnumber.go
- accountstatement.go
- accounttransfer.go
- achprenotification.go
- achtransfer.go
- aliases.go
- balancelookup.go
- bookkeepingaccount.go
- bookkeepingentry.go
- bookkeepingentryset.go
- card.go
- carddispute.go
- cardprofile.go
- cardpurchasesupplement.go
- checkdeposit.go
- checktransfer.go
- client.go
- declinedtransaction.go
- digitalwallettoken.go
- document.go
- entity.go
- entitybeneficialowner.go
- entitysupplementaldocument.go
- event.go
- eventsubscription.go
- export.go
- externalaccount.go
- field.go
- file.go
- group.go
- inboundachtransfer.go
- inboundwiredrawdownrequest.go
- limit.go
- oauthconnection.go
- pendingtransaction.go
- program.go
- realtimedecision.go
- realtimepaymentstransfer.go
- routingnumber.go
- simulation.go
- simulationaccountstatement.go
- simulationaccounttransfer.go
- simulationachtransfer.go
- simulationcard.go
- simulationcarddispute.go
- simulationcardprofile.go
- simulationcardrefund.go
- simulationcheckdeposit.go
- simulationchecktransfer.go
- simulationdigitalwallettokenrequest.go
- simulationdocument.go
- simulationinboundfundshold.go
- simulationinboundwiredrawdownrequest.go
- simulationinterestpayment.go
- simulationprogram.go
- simulationrealtimepaymentstransfer.go
- simulationwiretransfer.go
- transaction.go
- wiredrawdownrequest.go
- wiretransfer.go