stripe / stripe-go / 11295426688

//

//

// File generated from our OpenAPI spec

//

//

package stripe

import "encoding/json"

// Controls whether this SetupIntent will accept redirect-based payment methods.

//

// Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.

type SetupIntentAutomaticPaymentMethodsAllowRedirects string

// List of values that SetupIntentAutomaticPaymentMethodsAllowRedirects can take

const (

        SetupIntentAutomaticPaymentMethodsAllowRedirectsAlways SetupIntentAutomaticPaymentMethodsAllowRedirects = "always"

        SetupIntentAutomaticPaymentMethodsAllowRedirectsNever  SetupIntentAutomaticPaymentMethodsAllowRedirects = "never"

)

// Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.

type SetupIntentCancellationReason string

// List of values that SetupIntentCancellationReason can take

const (

        SetupIntentCancellationReasonAbandoned           SetupIntentCancellationReason = "abandoned"

        SetupIntentCancellationReasonDuplicate           SetupIntentCancellationReason = "duplicate"

        SetupIntentCancellationReasonRequestedByCustomer SetupIntentCancellationReason = "requested_by_customer"

)

// Indicates the directions of money movement for which this payment method is intended to be used.

//

// Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

type SetupIntentFlowDirection string

// List of values that SetupIntentFlowDirection can take

const (

        SetupIntentFlowDirectionInbound  SetupIntentFlowDirection = "inbound"

        SetupIntentFlowDirectionOutbound SetupIntentFlowDirection = "outbound"

)

// Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.

type SetupIntentNextActionType string

// List of values that SetupIntentNextActionType can take

const (

        SetupIntentNextActionTypeRedirectToURL           SetupIntentNextActionType = "redirect_to_url"

        SetupIntentNextActionTypeUseStripeSDK            SetupIntentNextActionType = "use_stripe_sdk"

        SetupIntentNextActionTypeAlipayHandleRedirect    SetupIntentNextActionType = "alipay_handle_redirect"

        SetupIntentNextActionTypeOXXODisplayDetails      SetupIntentNextActionType = "oxxo_display_details"

        SetupIntentNextActionTypeVerifyWithMicrodeposits SetupIntentNextActionType = "verify_with_microdeposits"

)

// The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

type SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType string

// List of values that SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType can take

const (

        SetupIntentNextActionVerifyWithMicrodepositsMicrodepositTypeAmounts        SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType = "amounts"

        SetupIntentNextActionVerifyWithMicrodepositsMicrodepositTypeDescriptorCode SetupIntentNextActionVerifyWithMicrodepositsMicrodepositType = "descriptor_code"

)

// Currency supported by the bank account

type SetupIntentPaymentMethodOptionsACSSDebitCurrency string

// List of values that SetupIntentPaymentMethodOptionsACSSDebitCurrency can take

const (

        SetupIntentPaymentMethodOptionsACSSDebitCurrencyCAD SetupIntentPaymentMethodOptionsACSSDebitCurrency = "cad"

        SetupIntentPaymentMethodOptionsACSSDebitCurrencyUSD SetupIntentPaymentMethodOptionsACSSDebitCurrency = "usd"

)

// List of Stripe products where this mandate can be selected automatically.

type SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultFor string

// List of values that SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultFor can take

const (

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultForInvoice      SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultFor = "invoice"

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultForSubscription SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsDefaultFor = "subscription"

)

// Payment schedule for the mandate.

type SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentSchedule string

// List of values that SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentSchedule can take

const (

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentScheduleCombined SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentSchedule = "combined"

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentScheduleInterval SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentSchedule = "interval"

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentScheduleSporadic SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsPaymentSchedule = "sporadic"

)

// Transaction type of the mandate.

type SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionType string

// List of values that SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionType can take

const (

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionTypeBusiness SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionType = "business"

        SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionTypePersonal SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsTransactionType = "personal"

)

// Bank account verification method.

type SetupIntentPaymentMethodOptionsACSSDebitVerificationMethod string

// List of values that SetupIntentPaymentMethodOptionsACSSDebitVerificationMethod can take

const (

        SetupIntentPaymentMethodOptionsACSSDebitVerificationMethodAutomatic     SetupIntentPaymentMethodOptionsACSSDebitVerificationMethod = "automatic"

        SetupIntentPaymentMethodOptionsACSSDebitVerificationMethodInstant       SetupIntentPaymentMethodOptionsACSSDebitVerificationMethod = "instant"

        SetupIntentPaymentMethodOptionsACSSDebitVerificationMethodMicrodeposits SetupIntentPaymentMethodOptionsACSSDebitVerificationMethod = "microdeposits"

)

// One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.

type SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType string

// List of values that SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType can take

const (

        SetupIntentPaymentMethodOptionsCardMandateOptionsAmountTypeFixed   SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType = "fixed"

        SetupIntentPaymentMethodOptionsCardMandateOptionsAmountTypeMaximum SetupIntentPaymentMethodOptionsCardMandateOptionsAmountType = "maximum"

)

// Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.

type SetupIntentPaymentMethodOptionsCardMandateOptionsInterval string

// List of values that SetupIntentPaymentMethodOptionsCardMandateOptionsInterval can take

const (

        SetupIntentPaymentMethodOptionsCardMandateOptionsIntervalDay      SetupIntentPaymentMethodOptionsCardMandateOptionsInterval = "day"

        SetupIntentPaymentMethodOptionsCardMandateOptionsIntervalMonth    SetupIntentPaymentMethodOptionsCardMandateOptionsInterval = "month"

        SetupIntentPaymentMethodOptionsCardMandateOptionsIntervalSporadic SetupIntentPaymentMethodOptionsCardMandateOptionsInterval = "sporadic"

        SetupIntentPaymentMethodOptionsCardMandateOptionsIntervalWeek     SetupIntentPaymentMethodOptionsCardMandateOptionsInterval = "week"

        SetupIntentPaymentMethodOptionsCardMandateOptionsIntervalYear     SetupIntentPaymentMethodOptionsCardMandateOptionsInterval = "year"

)

// Specifies the type of mandates supported. Possible values are `india`.

type SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedType string

// List of values that SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedType can take

const (

        SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedTypeIndia SetupIntentPaymentMethodOptionsCardMandateOptionsSupportedType = "india"

)

// Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.

type SetupIntentPaymentMethodOptionsCardNetwork string

// List of values that SetupIntentPaymentMethodOptionsCardNetwork can take

const (

        SetupIntentPaymentMethodOptionsCardNetworkAmex            SetupIntentPaymentMethodOptionsCardNetwork = "amex"

        SetupIntentPaymentMethodOptionsCardNetworkCartesBancaires SetupIntentPaymentMethodOptionsCardNetwork = "cartes_bancaires"

        SetupIntentPaymentMethodOptionsCardNetworkDiners          SetupIntentPaymentMethodOptionsCardNetwork = "diners"

        SetupIntentPaymentMethodOptionsCardNetworkDiscover        SetupIntentPaymentMethodOptionsCardNetwork = "discover"

        SetupIntentPaymentMethodOptionsCardNetworkEFTPOSAU        SetupIntentPaymentMethodOptionsCardNetwork = "eftpos_au"

        SetupIntentPaymentMethodOptionsCardNetworkGirocard        SetupIntentPaymentMethodOptionsCardNetwork = "girocard"

        SetupIntentPaymentMethodOptionsCardNetworkInterac         SetupIntentPaymentMethodOptionsCardNetwork = "interac"

        SetupIntentPaymentMethodOptionsCardNetworkJCB             SetupIntentPaymentMethodOptionsCardNetwork = "jcb"

        SetupIntentPaymentMethodOptionsCardNetworkMastercard      SetupIntentPaymentMethodOptionsCardNetwork = "mastercard"

        SetupIntentPaymentMethodOptionsCardNetworkUnionpay        SetupIntentPaymentMethodOptionsCardNetwork = "unionpay"

        SetupIntentPaymentMethodOptionsCardNetworkUnknown         SetupIntentPaymentMethodOptionsCardNetwork = "unknown"

        SetupIntentPaymentMethodOptionsCardNetworkVisa            SetupIntentPaymentMethodOptionsCardNetwork = "visa"

)

// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.

type SetupIntentPaymentMethodOptionsCardRequestThreeDSecure string

// List of values that SetupIntentPaymentMethodOptionsCardRequestThreeDSecure can take

const (

        SetupIntentPaymentMethodOptionsCardRequestThreeDSecureAny       SetupIntentPaymentMethodOptionsCardRequestThreeDSecure = "any"

        SetupIntentPaymentMethodOptionsCardRequestThreeDSecureAutomatic SetupIntentPaymentMethodOptionsCardRequestThreeDSecure = "automatic"

        SetupIntentPaymentMethodOptionsCardRequestThreeDSecureChallenge SetupIntentPaymentMethodOptionsCardRequestThreeDSecure = "challenge"

)

// The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.

type SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType string

// List of values that SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType can take

const (

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountTypeFixed   SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType = "fixed"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountTypeMaximum SetupIntentPaymentMethodOptionsPaytoMandateOptionsAmountType = "maximum"

)

// The periodicity at which payments will be collected.

type SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule string

// List of values that SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule can take

const (

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleAdhoc       SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "adhoc"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleAnnual      SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "annual"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleDaily       SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "daily"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleFortnightly SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "fortnightly"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleMonthly     SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "monthly"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleQuarterly   SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "quarterly"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleSemiAnnual  SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "semi_annual"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentScheduleWeekly      SetupIntentPaymentMethodOptionsPaytoMandateOptionsPaymentSchedule = "weekly"

)

// The purpose for which payments are made. Defaults to retail.

type SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose string

// List of values that SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose can take

const (

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeDependantSupport SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "dependant_support"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeGovernment       SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "government"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeLoan             SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "loan"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeMortgage         SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "mortgage"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeOther            SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "other"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposePension          SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "pension"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposePersonal         SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "personal"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeRetail           SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "retail"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeSalary           SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "salary"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeTax              SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "tax"

        SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurposeUtility          SetupIntentPaymentMethodOptionsPaytoMandateOptionsPurpose = "utility"

)

// The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.

type SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategoryChecking SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory = "checking"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategorySavings  SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory = "savings"

)

// Settings for configuring manual entry of account details.

type SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryMode string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryMode can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryModeAutomatic SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryMode = "automatic"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryModeCustom    SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsManualEntryMode = "custom"

)

// The list of permissions to request. The `payment_method` permission must be included.

type SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionBalances      SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "balances"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionOwnership     SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "ownership"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "payment_method"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions  SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "transactions"

)

// Data features requested to be retrieved upon account creation.

type SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchBalances         SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "balances"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchInferredBalances SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "inferred_balances"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchOwnership        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "ownership"

        SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchTransactions     SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "transactions"

)

// Mandate collection method

type SetupIntentPaymentMethodOptionsUSBankAccountMandateOptionsCollectionMethod string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountMandateOptionsCollectionMethod can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountMandateOptionsCollectionMethodPaper SetupIntentPaymentMethodOptionsUSBankAccountMandateOptionsCollectionMethod = "paper"

)

// Bank account verification method.

type SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethod string

// List of values that SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethod can take

const (

        SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethodAutomatic     SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethod = "automatic"

        SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethodInstant       SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethod = "instant"

        SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethodMicrodeposits SetupIntentPaymentMethodOptionsUSBankAccountVerificationMethod = "microdeposits"

)

// [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.

type SetupIntentStatus string

// List of values that SetupIntentStatus can take

const (

        SetupIntentStatusCanceled              SetupIntentStatus = "canceled"

        SetupIntentStatusProcessing            SetupIntentStatus = "processing"

        SetupIntentStatusRequiresAction        SetupIntentStatus = "requires_action"

        SetupIntentStatusRequiresConfirmation  SetupIntentStatus = "requires_confirmation"

        SetupIntentStatusRequiresPaymentMethod SetupIntentStatus = "requires_payment_method"

        SetupIntentStatusSucceeded             SetupIntentStatus = "succeeded"

)

// Indicates how the payment method is intended to be used in the future.

//

// Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.

type SetupIntentUsage string

// List of values that SetupIntentUsage can take

const (

        SetupIntentUsageOffSession SetupIntentUsage = "off_session"

        SetupIntentUsageOnSession  SetupIntentUsage = "on_session"

)

// Returns a list of SetupIntents.

type SetupIntentListParams struct {

        ListParams `form:"*"`

        // If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

        //

        // It can only be used for this Stripe Account's own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

        AttachToSelf *bool `form:"attach_to_self"`

        // A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

        Created *int64 `form:"created"`

        // A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

        CreatedRange *RangeQueryParams `form:"created"`

        // Only return SetupIntents for the customer specified by this customer ID.

        Customer *string `form:"customer"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

        // Only return SetupIntents that associate with the specified payment method.

        PaymentMethod *string `form:"payment_method"`

}

// AddExpand appends a new field to expand.

// When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.

type SetupIntentAutomaticPaymentMethodsParams struct {

        // Controls whether this SetupIntent will accept redirect-based payment methods.

        //

        // Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup.

        AllowRedirects *string `form:"allow_redirects"`

        // Whether this feature is enabled.

        Enabled *bool `form:"enabled"`

}

// If this is a Mandate accepted offline, this hash contains details about the offline acceptance.

type SetupIntentMandateDataCustomerAcceptanceOfflineParams struct{}

// If this is a Mandate accepted online, this hash contains details about the online acceptance.

type SetupIntentMandateDataCustomerAcceptanceOnlineParams struct {

        // The IP address from which the Mandate was accepted by the customer.

        IPAddress *string `form:"ip_address"`

        // The user agent of the browser from which the Mandate was accepted by the customer.

        UserAgent *string `form:"user_agent"`

}

// This hash contains details about the customer acceptance of the Mandate.

type SetupIntentMandateDataCustomerAcceptanceParams struct {

        // The time at which the customer accepted the Mandate.

        AcceptedAt *int64 `form:"accepted_at"`

        // If this is a Mandate accepted offline, this hash contains details about the offline acceptance.

        Offline *SetupIntentMandateDataCustomerAcceptanceOfflineParams `form:"offline"`

        // If this is a Mandate accepted online, this hash contains details about the online acceptance.

        Online *SetupIntentMandateDataCustomerAcceptanceOnlineParams `form:"online"`

        // The type of customer acceptance information included with the Mandate. One of `online` or `offline`.

        Type MandateCustomerAcceptanceType `form:"type"`

}

// This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).

type SetupIntentMandateDataParams struct {

        // This hash contains details about the customer acceptance of the Mandate.

        CustomerAcceptance *SetupIntentMandateDataCustomerAcceptanceParams `form:"customer_acceptance"`

}

// If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.

type SetupIntentPaymentMethodDataACSSDebitParams struct {

        // Customer's bank account number.

        AccountNumber *string `form:"account_number"`

        // Institution number of the customer's bank.

        InstitutionNumber *string `form:"institution_number"`

        // Transit number of the customer's bank.

        TransitNumber *string `form:"transit_number"`

}

// If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.

type SetupIntentPaymentMethodDataAffirmParams struct{}

// If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

type SetupIntentPaymentMethodDataAfterpayClearpayParams struct{}

// If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.

type SetupIntentPaymentMethodDataAlipayParams struct{}

// If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

type SetupIntentPaymentMethodDataAmazonPayParams struct{}

// If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.

type SetupIntentPaymentMethodDataAUBECSDebitParams struct {

        // The account number for the bank account.

        AccountNumber *string `form:"account_number"`

        // Bank-State-Branch number of the bank account.

        BSBNumber *string `form:"bsb_number"`

}

// If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

type SetupIntentPaymentMethodDataBACSDebitParams struct {

        // Account number of the bank account that the funds will be debited from.

        AccountNumber *string `form:"account_number"`

        // Sort code of the bank account. (e.g., `10-20-30`)

        SortCode *string `form:"sort_code"`

}

// If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.

type SetupIntentPaymentMethodDataBancontactParams struct{}

// Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

type SetupIntentPaymentMethodDataBillingDetailsParams struct {

        // Billing address.

        Address *AddressParams `form:"address"`

        // Email address.

        Email *string `form:"email"`

        // Full name.

        Name *string `form:"name"`

        // Billing phone number (including extension).

        Phone *string `form:"phone"`

}

// If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.

type SetupIntentPaymentMethodDataBLIKParams struct{}

// If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.

type SetupIntentPaymentMethodDataBoletoParams struct {

        // The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)

        TaxID *string `form:"tax_id"`

}

// If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.

type SetupIntentPaymentMethodDataCashAppParams struct{}

// If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.

type SetupIntentPaymentMethodDataCustomerBalanceParams struct{}

// If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.

type SetupIntentPaymentMethodDataEPSParams struct {

        // The customer's bank.

        Bank *string `form:"bank"`

}

// If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.

type SetupIntentPaymentMethodDataFPXParams struct {

        // Account holder type for FPX transaction

        AccountHolderType *string `form:"account_holder_type"`

        // The customer's bank.

        Bank *string `form:"bank"`

}

// If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.

type SetupIntentPaymentMethodDataGiropayParams struct{}

// If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.

type SetupIntentPaymentMethodDataGrabpayParams struct{}

// If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.

type SetupIntentPaymentMethodDataIDEALParams struct {

        // The customer's bank.

        Bank *string `form:"bank"`

}

// If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.

type SetupIntentPaymentMethodDataInteracPresentParams struct{}

// If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.

type SetupIntentPaymentMethodDataKakaoPayParams struct{}

// Customer's date of birth

type SetupIntentPaymentMethodDataKlarnaDOBParams struct {

        // The day of birth, between 1 and 31.

        Day *int64 `form:"day"`

        // The month of birth, between 1 and 12.

        Month *int64 `form:"month"`

        // The four-digit year of birth.

        Year *int64 `form:"year"`

}

// If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.

type SetupIntentPaymentMethodDataKlarnaParams struct {

        // Customer's date of birth

        DOB *SetupIntentPaymentMethodDataKlarnaDOBParams `form:"dob"`

}

// If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.

type SetupIntentPaymentMethodDataKonbiniParams struct{}

// If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.

type SetupIntentPaymentMethodDataKrCardParams struct{}

// If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.

type SetupIntentPaymentMethodDataLinkParams struct{}

// If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.

type SetupIntentPaymentMethodDataMbWayParams struct{}

// If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.

type SetupIntentPaymentMethodDataMobilepayParams struct{}

// If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.

type SetupIntentPaymentMethodDataMultibancoParams struct{}

// If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.

type SetupIntentPaymentMethodDataNaverPayParams struct {

        // Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.

        Funding *string `form:"funding"`

}

// If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.

type SetupIntentPaymentMethodDataOXXOParams struct{}

// If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.

type SetupIntentPaymentMethodDataP24Params struct {

        // The customer's bank.

        Bank *string `form:"bank"`

}

// If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.

type SetupIntentPaymentMethodDataPaycoParams struct{}

// If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.

type SetupIntentPaymentMethodDataPayNowParams struct{}

// If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.

type SetupIntentPaymentMethodDataPaypalParams struct{}

// If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.

type SetupIntentPaymentMethodDataPaytoParams struct {

        // The account number for the bank account.

        AccountNumber *string `form:"account_number"`

        // Bank-State-Branch number of the bank account.

        BSBNumber *string `form:"bsb_number"`

        // The PayID alias for the bank account.

        PayID *string `form:"pay_id"`

}

// If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.

type SetupIntentPaymentMethodDataPixParams struct{}

// If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.

type SetupIntentPaymentMethodDataPromptPayParams struct{}

// Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.

type SetupIntentPaymentMethodDataRadarOptionsParams struct {

        // A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

        Session *string `form:"session"`

}

// Customer's date of birth

type SetupIntentPaymentMethodDataRechnungDOBParams struct {

        // The day of birth, between 1 and 31.

        Day *int64 `form:"day"`

        // The month of birth, between 1 and 12.

        Month *int64 `form:"month"`

        // The four-digit year of birth.

        Year *int64 `form:"year"`

}

// If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.

type SetupIntentPaymentMethodDataRechnungParams struct {

        // Customer's date of birth

        DOB *SetupIntentPaymentMethodDataRechnungDOBParams `form:"dob"`

}

// If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.

type SetupIntentPaymentMethodDataRevolutPayParams struct{}

// If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.

type SetupIntentPaymentMethodDataSamsungPayParams struct{}

// If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.

type SetupIntentPaymentMethodDataSEPADebitParams struct {

        // IBAN of the bank account.

        IBAN *string `form:"iban"`

}

// If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.

type SetupIntentPaymentMethodDataSofortParams struct {

        // Two-letter ISO code representing the country the bank account is located in.

        Country *string `form:"country"`

}

// If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.

type SetupIntentPaymentMethodDataSwishParams struct{}

// If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

type SetupIntentPaymentMethodDataTWINTParams struct{}

// If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.

type SetupIntentPaymentMethodDataUSBankAccountParams struct {

        // Account holder type: individual or company.

        AccountHolderType *string `form:"account_holder_type"`

        // Account number of the bank account.

        AccountNumber *string `form:"account_number"`

        // Account type: checkings or savings. Defaults to checking if omitted.

        AccountType *string `form:"account_type"`

        // The ID of a Financial Connections Account to use as a payment method.

        FinancialConnectionsAccount *string `form:"financial_connections_account"`

        // Routing number of the bank account.

        RoutingNumber *string `form:"routing_number"`

}

// If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.

type SetupIntentPaymentMethodDataWeChatPayParams struct{}

// If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.

type SetupIntentPaymentMethodDataZipParams struct{}

// When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)

// value in the SetupIntent.

type SetupIntentPaymentMethodDataParams struct {

        // If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.

        ACSSDebit *SetupIntentPaymentMethodDataACSSDebitParams `form:"acss_debit"`

        // If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.

        Affirm *SetupIntentPaymentMethodDataAffirmParams `form:"affirm"`

        // If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

        AfterpayClearpay *SetupIntentPaymentMethodDataAfterpayClearpayParams `form:"afterpay_clearpay"`

        // If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.

        Alipay *SetupIntentPaymentMethodDataAlipayParams `form:"alipay"`

        // This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.

        AllowRedisplay *string `form:"allow_redisplay"`

        // If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

        AmazonPay *SetupIntentPaymentMethodDataAmazonPayParams `form:"amazon_pay"`

        // If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.

        AUBECSDebit *SetupIntentPaymentMethodDataAUBECSDebitParams `form:"au_becs_debit"`

        // If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

        BACSDebit *SetupIntentPaymentMethodDataBACSDebitParams `form:"bacs_debit"`

        // If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.

        Bancontact *SetupIntentPaymentMethodDataBancontactParams `form:"bancontact"`

        // Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

        BillingDetails *SetupIntentPaymentMethodDataBillingDetailsParams `form:"billing_details"`

        // If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.

        BLIK *SetupIntentPaymentMethodDataBLIKParams `form:"blik"`

        // If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.

        Boleto *SetupIntentPaymentMethodDataBoletoParams `form:"boleto"`

        // If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.

        CashApp *SetupIntentPaymentMethodDataCashAppParams `form:"cashapp"`

        // If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.

        CustomerBalance *SetupIntentPaymentMethodDataCustomerBalanceParams `form:"customer_balance"`

        // If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.

        EPS *SetupIntentPaymentMethodDataEPSParams `form:"eps"`

        // If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.

        FPX *SetupIntentPaymentMethodDataFPXParams `form:"fpx"`

        // If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.

        Giropay *SetupIntentPaymentMethodDataGiropayParams `form:"giropay"`

        // If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.

        Grabpay *SetupIntentPaymentMethodDataGrabpayParams `form:"grabpay"`

        // If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.

        IDEAL *SetupIntentPaymentMethodDataIDEALParams `form:"ideal"`

        // If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.

        InteracPresent *SetupIntentPaymentMethodDataInteracPresentParams `form:"interac_present"`

        // If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.

        KakaoPay *SetupIntentPaymentMethodDataKakaoPayParams `form:"kakao_pay"`

        // If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.

        Klarna *SetupIntentPaymentMethodDataKlarnaParams `form:"klarna"`

        // If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.

        Konbini *SetupIntentPaymentMethodDataKonbiniParams `form:"konbini"`

        // If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.

        KrCard *SetupIntentPaymentMethodDataKrCardParams `form:"kr_card"`

        // If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.

        Link *SetupIntentPaymentMethodDataLinkParams `form:"link"`

        // If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.

        MbWay *SetupIntentPaymentMethodDataMbWayParams `form:"mb_way"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

        Metadata map[string]string `form:"metadata"`

        // If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method.

        Mobilepay *SetupIntentPaymentMethodDataMobilepayParams `form:"mobilepay"`

        // If this is a `multibanco` PaymentMethod, this hash contains details about the Multibanco payment method.

        Multibanco *SetupIntentPaymentMethodDataMultibancoParams `form:"multibanco"`

        // If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.

        NaverPay *SetupIntentPaymentMethodDataNaverPayParams `form:"naver_pay"`

        // If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.

        OXXO *SetupIntentPaymentMethodDataOXXOParams `form:"oxxo"`

        // If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.

        P24 *SetupIntentPaymentMethodDataP24Params `form:"p24"`

        // If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.

        Payco *SetupIntentPaymentMethodDataPaycoParams `form:"payco"`

        // If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.

        PayNow *SetupIntentPaymentMethodDataPayNowParams `form:"paynow"`

        // If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.

        Paypal *SetupIntentPaymentMethodDataPaypalParams `form:"paypal"`

        // If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.

        Payto *SetupIntentPaymentMethodDataPaytoParams `form:"payto"`

        // If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.

        Pix *SetupIntentPaymentMethodDataPixParams `form:"pix"`

        // If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.

        PromptPay *SetupIntentPaymentMethodDataPromptPayParams `form:"promptpay"`

        // Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.

        RadarOptions *SetupIntentPaymentMethodDataRadarOptionsParams `form:"radar_options"`

        // If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.

        Rechnung *SetupIntentPaymentMethodDataRechnungParams `form:"rechnung"`

        // If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.

        RevolutPay *SetupIntentPaymentMethodDataRevolutPayParams `form:"revolut_pay"`

        // If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.

        SamsungPay *SetupIntentPaymentMethodDataSamsungPayParams `form:"samsung_pay"`

        // If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.

        SEPADebit *SetupIntentPaymentMethodDataSEPADebitParams `form:"sepa_debit"`

        // If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.

        Sofort *SetupIntentPaymentMethodDataSofortParams `form:"sofort"`

        // If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method.

        Swish *SetupIntentPaymentMethodDataSwishParams `form:"swish"`

        // If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

        TWINT *SetupIntentPaymentMethodDataTWINTParams `form:"twint"`

        // The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

        Type *string `form:"type"`

        // If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.

        USBankAccount *SetupIntentPaymentMethodDataUSBankAccountParams `form:"us_bank_account"`

        // If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.

        WeChatPay *SetupIntentPaymentMethodDataWeChatPayParams `form:"wechat_pay"`

        // If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.

        Zip *SetupIntentPaymentMethodDataZipParams `form:"zip"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// Additional fields for Mandate creation

type SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsParams struct {

        // A URL for custom mandate text to render during confirmation step.

        // The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,

        // or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.

        CustomMandateURL *string `form:"custom_mandate_url"`

        // List of Stripe products where this mandate can be selected automatically.

        DefaultFor []*string `form:"default_for"`

        // Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.

        IntervalDescription *string `form:"interval_description"`

        // Payment schedule for the mandate.

        PaymentSchedule *string `form:"payment_schedule"`

        // Transaction type of the mandate.

        TransactionType *string `form:"transaction_type"`

}

// If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.

type SetupIntentPaymentMethodOptionsACSSDebitParams struct {

        // Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

        Currency *string `form:"currency"`

        // Additional fields for Mandate creation

        MandateOptions *SetupIntentPaymentMethodOptionsACSSDebitMandateOptionsParams `form:"mandate_options"`

        // Bank account verification method.

        VerificationMethod *string `form:"verification_method"`

}

// If this is a `amazon_pay` SetupIntent, this sub-hash contains details about the AmazonPay payment method options.

type SetupIntentPaymentMethodOptionsAmazonPayParams struct{}

// Additional fields for Mandate creation

type SetupIntentPaymentMethodOptionsBACSDebitMandateOptionsParams struct{}

// If this is a `bacs_debit` SetupIntent, this sub-hash contains details about the Bacs Debit payment method options.

type SetupIntentPaymentMethodOptionsBACSDebitParams struct {

        // Additional fields for Mandate creation

        MandateOptions *SetupIntentPaymentMethodOptionsBACSDebitMandateOptionsParams `form:"mandate_options"`

}

// Configuration options for setting up an eMandate for cards issued in India.

type SetupIntentPaymentMethodOptionsCardMandateOptionsParams struct {

        // Amount to be charged for future payments.

        Amount *int64 `form:"amount"`

        // One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.

        AmountType *string `form:"amount_type"`

        // Currency in which future payments will be charged. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

        Currency *string `form:"currency"`

        // A description of the mandate or subscription that is meant to be displayed to the customer.

        Description *string `form:"description"`

        // End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.

        EndDate *int64 `form:"end_date"`

        // Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.

        Interval *string `form:"interval"`

        // The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.

        IntervalCount *int64 `form:"interval_count"`

        // Unique identifier for the mandate or subscription.

        Reference *string `form:"reference"`

        // Start date of the mandate or subscription. Start date should not be lesser than yesterday.

        StartDate *int64 `form:"start_date"`

        // Specifies the type of mandates supported. Possible values are `india`.

        SupportedTypes []*string `form:"supported_types"`

}

// Cartes Bancaires-specific 3DS fields.

type SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesParams struct {

        // The cryptogram calculation algorithm used by the card Issuer's ACS

        // to calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.

        // messageExtension: CB-AVALGO

        CbAvalgo *string `form:"cb_avalgo"`

        // The exemption indicator returned from Cartes Bancaires in the ARes.

        // message extension: CB-EXEMPTION; string (4 characters)

        // This is a 3 byte bitmap (low significant byte first and most significant

        // bit first) that has been Base64 encoded

        CbExemption *string `form:"cb_exemption"`

        // The risk score returned from Cartes Bancaires in the ARes.

        // message extension: CB-SCORE; numeric value 0-99

        CbScore *int64 `form:"cb_score"`

}

// Network specific 3DS fields. Network specific arguments require an

// explicit card brand choice. The parameter `payment_method_options.card.network“

// must be populated accordingly

type SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsParams struct {

        // Cartes Bancaires-specific 3DS fields.

        CartesBancaires *SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesParams `form:"cartes_bancaires"`

}

// If 3D Secure authentication was performed with a third-party provider,

// the authentication details to use for this setup.

type SetupIntentPaymentMethodOptionsCardThreeDSecureParams struct {

        // The `transStatus` returned from the card Issuer's ACS in the ARes.

        AresTransStatus *string `form:"ares_trans_status"`

        // The cryptogram, also known as the "authentication value" (AAV, CAVV or

        // AEVV). This value is 20 bytes, base64-encoded into a 28-character string.

        // (Most 3D Secure providers will return the base64-encoded version, which

        // is what you should specify here.)

        Cryptogram *string `form:"cryptogram"`

        // The Electronic Commerce Indicator (ECI) is returned by your 3D Secure

        // provider and indicates what degree of authentication was performed.

        ElectronicCommerceIndicator *string `form:"electronic_commerce_indicator"`

        // Network specific 3DS fields. Network specific arguments require an

        // explicit card brand choice. The parameter `payment_method_options.card.network``

        // must be populated accordingly

        NetworkOptions *SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsParams `form:"network_options"`

        // The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the

        // AReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.

        RequestorChallengeIndicator *string `form:"requestor_challenge_indicator"`

        // For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server

        // Transaction ID (dsTransID).

        TransactionID *string `form:"transaction_id"`

        // The version of 3D Secure that was performed.

        Version *string `form:"version"`

}

// Configuration for any card setup attempted on this SetupIntent.

type SetupIntentPaymentMethodOptionsCardParams struct {

        // Configuration options for setting up an eMandate for cards issued in India.

        MandateOptions *SetupIntentPaymentMethodOptionsCardMandateOptionsParams `form:"mandate_options"`

        // When specified, this parameter signals that a card has been collected

        // as MOTO (Mail Order Telephone Order) and thus out of scope for SCA. This

        // parameter can only be provided during confirmation.

        MOTO *bool `form:"moto"`

        // Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the SetupIntent. Can be only set confirm-time.

        Network *string `form:"network"`

        // We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.

        RequestThreeDSecure *string `form:"request_three_d_secure"`

        // If 3D Secure authentication was performed with a third-party provider,

        // the authentication details to use for this setup.

        ThreeDSecure *SetupIntentPaymentMethodOptionsCardThreeDSecureParams `form:"three_d_secure"`

}

// If this is a `card_present` PaymentMethod, this sub-hash contains details about the card-present payment method options.

type SetupIntentPaymentMethodOptionsCardPresentParams struct{}

// If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.

type SetupIntentPaymentMethodOptionsLinkParams struct {

        // [Deprecated] This is a legacy parameter that no longer has any function.

        // Deprecated:

        PersistentToken *string `form:"persistent_token"`

}

// If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.

type SetupIntentPaymentMethodOptionsPaypalParams struct {

        // The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

        BillingAgreementID *string `form:"billing_agreement_id"`

        Currency           *string `form:"currency"`

        // The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.

        Subsellers []*string `form:"subsellers"`

}

// Additional fields for Mandate creation.

type SetupIntentPaymentMethodOptionsPaytoMandateOptionsParams struct {

        // Amount that will be collected. It is required when `amount_type` is `fixed`.

        Amount *int64 `form:"amount"`

        // The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.

        AmountType *string `form:"amount_type"`

        // Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.

        EndDate *string `form:"end_date"`

        // The periodicity at which payments will be collected.

        PaymentSchedule *string `form:"payment_schedule"`

        // The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.

        PaymentsPerPeriod *int64 `form:"payments_per_period"`

        // The purpose for which payments are made. Defaults to retail.

        Purpose *string `form:"purpose"`

        // Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.

        StartDate *string `form:"start_date"`

}

// If this is a `payto` SetupIntent, this sub-hash contains details about the PayTo payment method options.

type SetupIntentPaymentMethodOptionsPaytoParams struct {

        // Additional fields for Mandate creation.

        MandateOptions *SetupIntentPaymentMethodOptionsPaytoMandateOptionsParams `form:"mandate_options"`

}

// Additional fields for Mandate creation

type SetupIntentPaymentMethodOptionsSEPADebitMandateOptionsParams struct{}

// If this is a `sepa_debit` SetupIntent, this sub-hash contains details about the SEPA Debit payment method options.

type SetupIntentPaymentMethodOptionsSEPADebitParams struct {

        // Additional fields for Mandate creation

        MandateOptions *SetupIntentPaymentMethodOptionsSEPADebitMandateOptionsParams `form:"mandate_options"`

}

// Provide filters for the linked accounts that the customer can select for the payment method

type SetupIntentPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersParams struct {

        // The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.

        AccountSubcategories []*string `form:"account_subcategories"`

        // ID of the institution to use to filter for selectable accounts.

        Institution *string `form:"institution"`