Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. SetupIntent
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.SetupIntent

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you’re ready to collect your customer’s payment credentials. Don’t maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    Create SetupIntent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SetupIntent(name: string, args?: SetupIntentArgs, opts?: CustomResourceOptions);
    @overload
def SetupIntent(resource_name: str,
                args: Optional[SetupIntentArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def SetupIntent(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                attach_to_self: Optional[bool] = None,
                automatic_payment_methods: Optional[SetupIntentAutomaticPaymentMethodsArgs] = None,
                confirm: Optional[bool] = None,
                confirmation_token: Optional[str] = None,
                customer: Optional[str] = None,
                customer_account: Optional[str] = None,
                description: Optional[str] = None,
                excluded_payment_method_types: Optional[Sequence[str]] = None,
                flow_directions: Optional[Sequence[str]] = None,
                mandate_data: Optional[SetupIntentMandateDataArgs] = None,
                metadata: Optional[Mapping[str, str]] = None,
                on_behalf_of: Optional[str] = None,
                payment_method: Optional[str] = None,
                payment_method_configuration: Optional[str] = None,
                payment_method_data: Optional[SetupIntentPaymentMethodDataArgs] = None,
                payment_method_options: Optional[SetupIntentPaymentMethodOptionsArgs] = None,
                payment_method_types: Optional[Sequence[str]] = None,
                return_url: Optional[str] = None,
                single_use: Optional[SetupIntentSingleUseArgs] = None,
                usage: Optional[str] = None,
                use_stripe_sdk: Optional[bool] = None)
    func NewSetupIntent(ctx *Context, name string, args *SetupIntentArgs, opts ...ResourceOption) (*SetupIntent, error)
    public SetupIntent(string name, SetupIntentArgs? args = null, CustomResourceOptions? opts = null)
    public SetupIntent(String name, SetupIntentArgs args)
public SetupIntent(String name, SetupIntentArgs args, CustomResourceOptions options)

    type: stripe:SetupIntent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_setup_intent" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SetupIntentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SetupIntentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SetupIntentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SetupIntentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SetupIntentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var setupIntentResource = new Stripe.SetupIntent("setupIntentResource", new()
{
    AttachToSelf = false,
    AutomaticPaymentMethods = new Stripe.Inputs.SetupIntentAutomaticPaymentMethodsArgs
    {
        Enabled = false,
        AllowRedirects = "string",
    },
    Confirm = false,
    ConfirmationToken = "string",
    Customer = "string",
    CustomerAccount = "string",
    Description = "string",
    ExcludedPaymentMethodTypes = new[]
    {
        "string",
    },
    FlowDirections = new[]
    {
        "string",
    },
    MandateData = new Stripe.Inputs.SetupIntentMandateDataArgs
    {
        CustomerAcceptance = new Stripe.Inputs.SetupIntentMandateDataCustomerAcceptanceArgs
        {
            Type = "string",
            AcceptedAt = 0.0,
            Online = new Stripe.Inputs.SetupIntentMandateDataCustomerAcceptanceOnlineArgs
            {
                IpAddress = "string",
                UserAgent = "string",
            },
        },
    },
    Metadata = 
    {
        { "string", "string" },
    },
    OnBehalfOf = "string",
    PaymentMethod = "string",
    PaymentMethodConfiguration = "string",
    PaymentMethodData = new Stripe.Inputs.SetupIntentPaymentMethodDataArgs
    {
        Type = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        AuBecsDebit = new Stripe.Inputs.SetupIntentPaymentMethodDataAuBecsDebitArgs
        {
            AccountNumber = "string",
            BsbNumber = "string",
        },
        BacsDebit = new Stripe.Inputs.SetupIntentPaymentMethodDataBacsDebitArgs
        {
            AccountNumber = "string",
            SortCode = "string",
        },
        BillingDetails = new Stripe.Inputs.SetupIntentPaymentMethodDataBillingDetailsArgs
        {
            Address = new Stripe.Inputs.SetupIntentPaymentMethodDataBillingDetailsAddressArgs
            {
                City = "string",
                Country = "string",
                Line1 = "string",
                Line2 = "string",
                PostalCode = "string",
                State = "string",
            },
            Email = "string",
            Name = "string",
            Phone = "string",
            TaxId = "string",
        },
        Boleto = new Stripe.Inputs.SetupIntentPaymentMethodDataBoletoArgs
        {
            TaxId = "string",
        },
        Eps = new Stripe.Inputs.SetupIntentPaymentMethodDataEpsArgs
        {
            Bank = "string",
        },
        Fpx = new Stripe.Inputs.SetupIntentPaymentMethodDataFpxArgs
        {
            Bank = "string",
            AccountHolderType = "string",
        },
        Ideal = new Stripe.Inputs.SetupIntentPaymentMethodDataIdealArgs
        {
            Bank = "string",
        },
        AcssDebit = new Stripe.Inputs.SetupIntentPaymentMethodDataAcssDebitArgs
        {
            AccountNumber = "string",
            InstitutionNumber = "string",
            TransitNumber = "string",
        },
        Klarna = new Stripe.Inputs.SetupIntentPaymentMethodDataKlarnaArgs
        {
            Dob = new Stripe.Inputs.SetupIntentPaymentMethodDataKlarnaDobArgs
            {
                Day = 0.0,
                Month = 0.0,
                Year = 0.0,
            },
        },
        P24 = new Stripe.Inputs.SetupIntentPaymentMethodDataP24Args
        {
            Bank = "string",
        },
        NzBankAccount = new Stripe.Inputs.SetupIntentPaymentMethodDataNzBankAccountArgs
        {
            AccountNumber = "string",
            BankCode = "string",
            BranchCode = "string",
            Suffix = "string",
            AccountHolderName = "string",
            Reference = "string",
        },
        NaverPay = new Stripe.Inputs.SetupIntentPaymentMethodDataNaverPayArgs
        {
            Funding = "string",
        },
        Payto = new Stripe.Inputs.SetupIntentPaymentMethodDataPaytoArgs
        {
            AccountNumber = "string",
            BsbNumber = "string",
            PayId = "string",
        },
        RadarOptions = new Stripe.Inputs.SetupIntentPaymentMethodDataRadarOptionsArgs
        {
            Session = "string",
        },
        SepaDebit = new Stripe.Inputs.SetupIntentPaymentMethodDataSepaDebitArgs
        {
            Iban = "string",
        },
        Sofort = new Stripe.Inputs.SetupIntentPaymentMethodDataSofortArgs
        {
            Country = "string",
        },
        AllowRedisplay = "string",
        Upi = new Stripe.Inputs.SetupIntentPaymentMethodDataUpiArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodDataUpiMandateOptionsArgs
            {
                Amount = 0.0,
                AmountType = "string",
                Description = "string",
                EndDate = 0.0,
            },
        },
        UsBankAccount = new Stripe.Inputs.SetupIntentPaymentMethodDataUsBankAccountArgs
        {
            AccountHolderType = "string",
            AccountNumber = "string",
            AccountType = "string",
            FinancialConnectionsAccount = "string",
            RoutingNumber = "string",
        },
    },
    PaymentMethodOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsArgs
    {
        AcssDebit = new Stripe.Inputs.SetupIntentPaymentMethodOptionsAcssDebitArgs
        {
            Currency = "string",
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsAcssDebitMandateOptionsArgs
            {
                CustomMandateUrl = "string",
                DefaultFors = new[]
                {
                    "string",
                },
                IntervalDescription = "string",
                PaymentSchedule = "string",
                TransactionType = "string",
            },
            VerificationMethod = "string",
        },
        BacsDebit = new Stripe.Inputs.SetupIntentPaymentMethodOptionsBacsDebitArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsBacsDebitMandateOptionsArgs
            {
                ReferencePrefix = "string",
            },
        },
        Card = new Stripe.Inputs.SetupIntentPaymentMethodOptionsCardArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsCardMandateOptionsArgs
            {
                Amount = 0.0,
                AmountType = "string",
                Currency = "string",
                Interval = "string",
                Reference = "string",
                StartDate = 0.0,
                Description = "string",
                EndDate = 0.0,
                IntervalCount = 0.0,
                SupportedTypes = new[]
                {
                    "string",
                },
            },
            Moto = false,
            Network = "string",
            RequestThreeDSecure = "string",
            ThreeDSecure = new Stripe.Inputs.SetupIntentPaymentMethodOptionsCardThreeDSecureArgs
            {
                AresTransStatus = "string",
                Cryptogram = "string",
                ElectronicCommerceIndicator = "string",
                NetworkOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsArgs
                {
                    CartesBancaires = new Stripe.Inputs.SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesArgs
                    {
                        CbAvalgo = "string",
                        CbExemption = "string",
                        CbScore = 0.0,
                    },
                },
                RequestorChallengeIndicator = "string",
                TransactionId = "string",
                Version = "string",
            },
        },
        Klarna = new Stripe.Inputs.SetupIntentPaymentMethodOptionsKlarnaArgs
        {
            Currency = "string",
            OnDemand = new Stripe.Inputs.SetupIntentPaymentMethodOptionsKlarnaOnDemandArgs
            {
                AverageAmount = 0.0,
                MaximumAmount = 0.0,
                MinimumAmount = 0.0,
                PurchaseInterval = "string",
                PurchaseIntervalCount = 0.0,
            },
            PreferredLocale = "string",
            Subscriptions = new[]
            {
                new Stripe.Inputs.SetupIntentPaymentMethodOptionsKlarnaSubscriptionArgs
                {
                    Interval = "string",
                    NextBilling = new Stripe.Inputs.SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBillingArgs
                    {
                        Amount = 0.0,
                        Date = "string",
                    },
                    Reference = "string",
                    IntervalCount = 0.0,
                    Name = "string",
                },
            },
        },
        Link = new Stripe.Inputs.SetupIntentPaymentMethodOptionsLinkArgs
        {
            PersistentToken = "string",
        },
        Paypal = new Stripe.Inputs.SetupIntentPaymentMethodOptionsPaypalArgs
        {
            BillingAgreementId = "string",
        },
        Payto = new Stripe.Inputs.SetupIntentPaymentMethodOptionsPaytoArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsPaytoMandateOptionsArgs
            {
                Amount = 0.0,
                AmountType = "string",
                EndDate = "string",
                PaymentSchedule = "string",
                PaymentsPerPeriod = 0.0,
                Purpose = "string",
                StartDate = "string",
            },
        },
        Pix = new Stripe.Inputs.SetupIntentPaymentMethodOptionsPixArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsPixMandateOptionsArgs
            {
                Amount = 0.0,
                AmountIncludesIof = "string",
                AmountType = "string",
                Currency = "string",
                EndDate = "string",
                PaymentSchedule = "string",
                Reference = "string",
                StartDate = "string",
            },
        },
        SepaDebit = new Stripe.Inputs.SetupIntentPaymentMethodOptionsSepaDebitArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsSepaDebitMandateOptionsArgs
            {
                ReferencePrefix = "string",
            },
        },
        Upi = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUpiArgs
        {
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUpiMandateOptionsArgs
            {
                Amount = 0.0,
                AmountType = "string",
                Description = "string",
                EndDate = 0.0,
            },
            SetupFutureUsage = "string",
        },
        UsBankAccount = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUsBankAccountArgs
        {
            FinancialConnections = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs
            {
                Filters = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs
                {
                    AccountSubcategories = new[]
                    {
                        "string",
                    },
                },
                Permissions = new[]
                {
                    "string",
                },
                Prefetches = new[]
                {
                    "string",
                },
                ReturnUrl = "string",
            },
            MandateOptions = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsArgs
            {
                CollectionMethod = "string",
            },
            Networks = new Stripe.Inputs.SetupIntentPaymentMethodOptionsUsBankAccountNetworksArgs
            {
                Requesteds = new[]
                {
                    "string",
                },
            },
            VerificationMethod = "string",
        },
    },
    PaymentMethodTypes = new[]
    {
        "string",
    },
    ReturnUrl = "string",
    SingleUse = new Stripe.Inputs.SetupIntentSingleUseArgs
    {
        Amount = 0.0,
        Currency = "string",
    },
    Usage = "string",
    UseStripeSdk = false,
});

    example, err := stripe.NewSetupIntent(ctx, "setupIntentResource", &stripe.SetupIntentArgs{
	AttachToSelf: pulumi.Bool(false),
	AutomaticPaymentMethods: &stripe.SetupIntentAutomaticPaymentMethodsArgs{
		Enabled:        pulumi.Bool(false),
		AllowRedirects: pulumi.String("string"),
	},
	Confirm:           pulumi.Bool(false),
	ConfirmationToken: pulumi.String("string"),
	Customer:          pulumi.String("string"),
	CustomerAccount:   pulumi.String("string"),
	Description:       pulumi.String("string"),
	ExcludedPaymentMethodTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	FlowDirections: pulumi.StringArray{
		pulumi.String("string"),
	},
	MandateData: &stripe.SetupIntentMandateDataArgs{
		CustomerAcceptance: &stripe.SetupIntentMandateDataCustomerAcceptanceArgs{
			Type:       pulumi.String("string"),
			AcceptedAt: pulumi.Float64(0),
			Online: &stripe.SetupIntentMandateDataCustomerAcceptanceOnlineArgs{
				IpAddress: pulumi.String("string"),
				UserAgent: pulumi.String("string"),
			},
		},
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OnBehalfOf:                 pulumi.String("string"),
	PaymentMethod:              pulumi.String("string"),
	PaymentMethodConfiguration: pulumi.String("string"),
	PaymentMethodData: &stripe.SetupIntentPaymentMethodDataArgs{
		Type: pulumi.String("string"),
		Metadata: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		AuBecsDebit: &stripe.SetupIntentPaymentMethodDataAuBecsDebitArgs{
			AccountNumber: pulumi.String("string"),
			BsbNumber:     pulumi.String("string"),
		},
		BacsDebit: &stripe.SetupIntentPaymentMethodDataBacsDebitArgs{
			AccountNumber: pulumi.String("string"),
			SortCode:      pulumi.String("string"),
		},
		BillingDetails: &stripe.SetupIntentPaymentMethodDataBillingDetailsArgs{
			Address: &stripe.SetupIntentPaymentMethodDataBillingDetailsAddressArgs{
				City:       pulumi.String("string"),
				Country:    pulumi.String("string"),
				Line1:      pulumi.String("string"),
				Line2:      pulumi.String("string"),
				PostalCode: pulumi.String("string"),
				State:      pulumi.String("string"),
			},
			Email: pulumi.String("string"),
			Name:  pulumi.String("string"),
			Phone: pulumi.String("string"),
			TaxId: pulumi.String("string"),
		},
		Boleto: &stripe.SetupIntentPaymentMethodDataBoletoArgs{
			TaxId: pulumi.String("string"),
		},
		Eps: &stripe.SetupIntentPaymentMethodDataEpsArgs{
			Bank: pulumi.String("string"),
		},
		Fpx: &stripe.SetupIntentPaymentMethodDataFpxArgs{
			Bank:              pulumi.String("string"),
			AccountHolderType: pulumi.String("string"),
		},
		Ideal: &stripe.SetupIntentPaymentMethodDataIdealArgs{
			Bank: pulumi.String("string"),
		},
		AcssDebit: &stripe.SetupIntentPaymentMethodDataAcssDebitArgs{
			AccountNumber:     pulumi.String("string"),
			InstitutionNumber: pulumi.String("string"),
			TransitNumber:     pulumi.String("string"),
		},
		Klarna: &stripe.SetupIntentPaymentMethodDataKlarnaArgs{
			Dob: &stripe.SetupIntentPaymentMethodDataKlarnaDobArgs{
				Day:   pulumi.Float64(0),
				Month: pulumi.Float64(0),
				Year:  pulumi.Float64(0),
			},
		},
		P24: &stripe.SetupIntentPaymentMethodDataP24Args{
			Bank: pulumi.String("string"),
		},
		NzBankAccount: &stripe.SetupIntentPaymentMethodDataNzBankAccountArgs{
			AccountNumber:     pulumi.String("string"),
			BankCode:          pulumi.String("string"),
			BranchCode:        pulumi.String("string"),
			Suffix:            pulumi.String("string"),
			AccountHolderName: pulumi.String("string"),
			Reference:         pulumi.String("string"),
		},
		NaverPay: &stripe.SetupIntentPaymentMethodDataNaverPayArgs{
			Funding: pulumi.String("string"),
		},
		Payto: &stripe.SetupIntentPaymentMethodDataPaytoArgs{
			AccountNumber: pulumi.String("string"),
			BsbNumber:     pulumi.String("string"),
			PayId:         pulumi.String("string"),
		},
		RadarOptions: &stripe.SetupIntentPaymentMethodDataRadarOptionsArgs{
			Session: pulumi.String("string"),
		},
		SepaDebit: &stripe.SetupIntentPaymentMethodDataSepaDebitArgs{
			Iban: pulumi.String("string"),
		},
		Sofort: &stripe.SetupIntentPaymentMethodDataSofortArgs{
			Country: pulumi.String("string"),
		},
		AllowRedisplay: pulumi.String("string"),
		Upi: &stripe.SetupIntentPaymentMethodDataUpiArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodDataUpiMandateOptionsArgs{
				Amount:      pulumi.Float64(0),
				AmountType:  pulumi.String("string"),
				Description: pulumi.String("string"),
				EndDate:     pulumi.Float64(0),
			},
		},
		UsBankAccount: &stripe.SetupIntentPaymentMethodDataUsBankAccountArgs{
			AccountHolderType:           pulumi.String("string"),
			AccountNumber:               pulumi.String("string"),
			AccountType:                 pulumi.String("string"),
			FinancialConnectionsAccount: pulumi.String("string"),
			RoutingNumber:               pulumi.String("string"),
		},
	},
	PaymentMethodOptions: &stripe.SetupIntentPaymentMethodOptionsArgs{
		AcssDebit: &stripe.SetupIntentPaymentMethodOptionsAcssDebitArgs{
			Currency: pulumi.String("string"),
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsAcssDebitMandateOptionsArgs{
				CustomMandateUrl: pulumi.String("string"),
				DefaultFors: pulumi.StringArray{
					pulumi.String("string"),
				},
				IntervalDescription: pulumi.String("string"),
				PaymentSchedule:     pulumi.String("string"),
				TransactionType:     pulumi.String("string"),
			},
			VerificationMethod: pulumi.String("string"),
		},
		BacsDebit: &stripe.SetupIntentPaymentMethodOptionsBacsDebitArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsBacsDebitMandateOptionsArgs{
				ReferencePrefix: pulumi.String("string"),
			},
		},
		Card: &stripe.SetupIntentPaymentMethodOptionsCardArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsCardMandateOptionsArgs{
				Amount:        pulumi.Float64(0),
				AmountType:    pulumi.String("string"),
				Currency:      pulumi.String("string"),
				Interval:      pulumi.String("string"),
				Reference:     pulumi.String("string"),
				StartDate:     pulumi.Float64(0),
				Description:   pulumi.String("string"),
				EndDate:       pulumi.Float64(0),
				IntervalCount: pulumi.Float64(0),
				SupportedTypes: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Moto:                pulumi.Bool(false),
			Network:             pulumi.String("string"),
			RequestThreeDSecure: pulumi.String("string"),
			ThreeDSecure: &stripe.SetupIntentPaymentMethodOptionsCardThreeDSecureArgs{
				AresTransStatus:             pulumi.String("string"),
				Cryptogram:                  pulumi.String("string"),
				ElectronicCommerceIndicator: pulumi.String("string"),
				NetworkOptions: &stripe.SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsArgs{
					CartesBancaires: &stripe.SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesArgs{
						CbAvalgo:    pulumi.String("string"),
						CbExemption: pulumi.String("string"),
						CbScore:     pulumi.Float64(0),
					},
				},
				RequestorChallengeIndicator: pulumi.String("string"),
				TransactionId:               pulumi.String("string"),
				Version:                     pulumi.String("string"),
			},
		},
		Klarna: &stripe.SetupIntentPaymentMethodOptionsKlarnaArgs{
			Currency: pulumi.String("string"),
			OnDemand: &stripe.SetupIntentPaymentMethodOptionsKlarnaOnDemandArgs{
				AverageAmount:         pulumi.Float64(0),
				MaximumAmount:         pulumi.Float64(0),
				MinimumAmount:         pulumi.Float64(0),
				PurchaseInterval:      pulumi.String("string"),
				PurchaseIntervalCount: pulumi.Float64(0),
			},
			PreferredLocale: pulumi.String("string"),
			Subscriptions: stripe.SetupIntentPaymentMethodOptionsKlarnaSubscriptionArray{
				&stripe.SetupIntentPaymentMethodOptionsKlarnaSubscriptionArgs{
					Interval: pulumi.String("string"),
					NextBilling: &stripe.SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBillingArgs{
						Amount: pulumi.Float64(0),
						Date:   pulumi.String("string"),
					},
					Reference:     pulumi.String("string"),
					IntervalCount: pulumi.Float64(0),
					Name:          pulumi.String("string"),
				},
			},
		},
		Link: &stripe.SetupIntentPaymentMethodOptionsLinkArgs{
			PersistentToken: pulumi.String("string"),
		},
		Paypal: &stripe.SetupIntentPaymentMethodOptionsPaypalArgs{
			BillingAgreementId: pulumi.String("string"),
		},
		Payto: &stripe.SetupIntentPaymentMethodOptionsPaytoArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsPaytoMandateOptionsArgs{
				Amount:            pulumi.Float64(0),
				AmountType:        pulumi.String("string"),
				EndDate:           pulumi.String("string"),
				PaymentSchedule:   pulumi.String("string"),
				PaymentsPerPeriod: pulumi.Float64(0),
				Purpose:           pulumi.String("string"),
				StartDate:         pulumi.String("string"),
			},
		},
		Pix: &stripe.SetupIntentPaymentMethodOptionsPixArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsPixMandateOptionsArgs{
				Amount:            pulumi.Float64(0),
				AmountIncludesIof: pulumi.String("string"),
				AmountType:        pulumi.String("string"),
				Currency:          pulumi.String("string"),
				EndDate:           pulumi.String("string"),
				PaymentSchedule:   pulumi.String("string"),
				Reference:         pulumi.String("string"),
				StartDate:         pulumi.String("string"),
			},
		},
		SepaDebit: &stripe.SetupIntentPaymentMethodOptionsSepaDebitArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsSepaDebitMandateOptionsArgs{
				ReferencePrefix: pulumi.String("string"),
			},
		},
		Upi: &stripe.SetupIntentPaymentMethodOptionsUpiArgs{
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsUpiMandateOptionsArgs{
				Amount:      pulumi.Float64(0),
				AmountType:  pulumi.String("string"),
				Description: pulumi.String("string"),
				EndDate:     pulumi.Float64(0),
			},
			SetupFutureUsage: pulumi.String("string"),
		},
		UsBankAccount: &stripe.SetupIntentPaymentMethodOptionsUsBankAccountArgs{
			FinancialConnections: &stripe.SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs{
				Filters: &stripe.SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs{
					AccountSubcategories: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				Permissions: pulumi.StringArray{
					pulumi.String("string"),
				},
				Prefetches: pulumi.StringArray{
					pulumi.String("string"),
				},
				ReturnUrl: pulumi.String("string"),
			},
			MandateOptions: &stripe.SetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsArgs{
				CollectionMethod: pulumi.String("string"),
			},
			Networks: &stripe.SetupIntentPaymentMethodOptionsUsBankAccountNetworksArgs{
				Requesteds: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			VerificationMethod: pulumi.String("string"),
		},
	},
	PaymentMethodTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReturnUrl: pulumi.String("string"),
	SingleUse: &stripe.SetupIntentSingleUseArgs{
		Amount:   pulumi.Float64(0),
		Currency: pulumi.String("string"),
	},
	Usage:        pulumi.String("string"),
	UseStripeSdk: pulumi.Bool(false),
})

    resource "stripe_setup_intent" "setupIntentResource" {
  lifecycle {
    create_before_destroy = true
  }
  attach_to_self = false
  automatic_payment_methods = {
    enabled         = false
    allow_redirects = "string"
  }
  confirm                       = false
  confirmation_token            = "string"
  customer                      = "string"
  customer_account              = "string"
  description                   = "string"
  excluded_payment_method_types = ["string"]
  flow_directions               = ["string"]
  mandate_data = {
    customer_acceptance = {
      type        = "string"
      accepted_at = 0
      online = {
        ip_address = "string"
        user_agent = "string"
      }
    }
  }
  metadata = {
    "string" = "string"
  }
  on_behalf_of                 = "string"
  payment_method               = "string"
  payment_method_configuration = "string"
  payment_method_data = {
    type = "string"
    metadata = {
      "string" = "string"
    }
    au_becs_debit = {
      account_number = "string"
      bsb_number     = "string"
    }
    bacs_debit = {
      account_number = "string"
      sort_code      = "string"
    }
    billing_details = {
      address = {
        city        = "string"
        country     = "string"
        line1       = "string"
        line2       = "string"
        postal_code = "string"
        state       = "string"
      }
      email  = "string"
      name   = "string"
      phone  = "string"
      tax_id = "string"
    }
    boleto = {
      tax_id = "string"
    }
    eps = {
      bank = "string"
    }
    fpx = {
      bank                = "string"
      account_holder_type = "string"
    }
    ideal = {
      bank = "string"
    }
    acss_debit = {
      account_number     = "string"
      institution_number = "string"
      transit_number     = "string"
    }
    klarna = {
      dob = {
        day   = 0
        month = 0
        year  = 0
      }
    }
    p24 = {
      bank = "string"
    }
    nz_bank_account = {
      account_number      = "string"
      bank_code           = "string"
      branch_code         = "string"
      suffix              = "string"
      account_holder_name = "string"
      reference           = "string"
    }
    naver_pay = {
      funding = "string"
    }
    payto = {
      account_number = "string"
      bsb_number     = "string"
      pay_id         = "string"
    }
    radar_options = {
      session = "string"
    }
    sepa_debit = {
      iban = "string"
    }
    sofort = {
      country = "string"
    }
    allow_redisplay = "string"
    upi = {
      mandate_options = {
        amount      = 0
        amount_type = "string"
        description = "string"
        end_date    = 0
      }
    }
    us_bank_account = {
      account_holder_type           = "string"
      account_number                = "string"
      account_type                  = "string"
      financial_connections_account = "string"
      routing_number                = "string"
    }
  }
  payment_method_options = {
    acss_debit = {
      currency = "string"
      mandate_options = {
        custom_mandate_url   = "string"
        default_fors         = ["string"]
        interval_description = "string"
        payment_schedule     = "string"
        transaction_type     = "string"
      }
      verification_method = "string"
    }
    bacs_debit = {
      mandate_options = {
        reference_prefix = "string"
      }
    }
    card = {
      mandate_options = {
        amount          = 0
        amount_type     = "string"
        currency        = "string"
        interval        = "string"
        reference       = "string"
        start_date      = 0
        description     = "string"
        end_date        = 0
        interval_count  = 0
        supported_types = ["string"]
      }
      moto                   = false
      network                = "string"
      request_three_d_secure = "string"
      three_d_secure = {
        ares_trans_status             = "string"
        cryptogram                    = "string"
        electronic_commerce_indicator = "string"
        network_options = {
          cartes_bancaires = {
            cb_avalgo    = "string"
            cb_exemption = "string"
            cb_score     = 0
          }
        }
        requestor_challenge_indicator = "string"
        transaction_id                = "string"
        version                       = "string"
      }
    }
    klarna = {
      currency = "string"
      on_demand = {
        average_amount          = 0
        maximum_amount          = 0
        minimum_amount          = 0
        purchase_interval       = "string"
        purchase_interval_count = 0
      }
      preferred_locale = "string"
      subscriptions = [{
        interval = "string"
        next_billing = {
          amount = 0
          date   = "string"
        }
        reference      = "string"
        interval_count = 0
        name           = "string"
      }]
    }
    link = {
      persistent_token = "string"
    }
    paypal = {
      billing_agreement_id = "string"
    }
    payto = {
      mandate_options = {
        amount              = 0
        amount_type         = "string"
        end_date            = "string"
        payment_schedule    = "string"
        payments_per_period = 0
        purpose             = "string"
        start_date          = "string"
      }
    }
    pix = {
      mandate_options = {
        amount              = 0
        amount_includes_iof = "string"
        amount_type         = "string"
        currency            = "string"
        end_date            = "string"
        payment_schedule    = "string"
        reference           = "string"
        start_date          = "string"
      }
    }
    sepa_debit = {
      mandate_options = {
        reference_prefix = "string"
      }
    }
    upi = {
      mandate_options = {
        amount      = 0
        amount_type = "string"
        description = "string"
        end_date    = 0
      }
      setup_future_usage = "string"
    }
    us_bank_account = {
      financial_connections = {
        filters = {
          account_subcategories = ["string"]
        }
        permissions = ["string"]
        prefetches  = ["string"]
        return_url  = "string"
      }
      mandate_options = {
        collection_method = "string"
      }
      networks = {
        requesteds = ["string"]
      }
      verification_method = "string"
    }
  }
  payment_method_types = ["string"]
  return_url           = "string"
  single_use = {
    amount   = 0
    currency = "string"
  }
  usage          = "string"
  use_stripe_sdk = false
}

    var setupIntentResource = new SetupIntent("setupIntentResource", SetupIntentArgs.builder()
    .attachToSelf(false)
    .automaticPaymentMethods(SetupIntentAutomaticPaymentMethodsArgs.builder()
        .enabled(false)
        .allowRedirects("string")
        .build())
    .confirm(false)
    .confirmationToken("string")
    .customer("string")
    .customerAccount("string")
    .description("string")
    .excludedPaymentMethodTypes("string")
    .flowDirections("string")
    .mandateData(SetupIntentMandateDataArgs.builder()
        .customerAcceptance(SetupIntentMandateDataCustomerAcceptanceArgs.builder()
            .type("string")
            .acceptedAt(0.0)
            .online(SetupIntentMandateDataCustomerAcceptanceOnlineArgs.builder()
                .ipAddress("string")
                .userAgent("string")
                .build())
            .build())
        .build())
    .metadata(Map.of("string", "string"))
    .onBehalfOf("string")
    .paymentMethod("string")
    .paymentMethodConfiguration("string")
    .paymentMethodData(SetupIntentPaymentMethodDataArgs.builder()
        .type("string")
        .metadata(Map.of("string", "string"))
        .auBecsDebit(SetupIntentPaymentMethodDataAuBecsDebitArgs.builder()
            .accountNumber("string")
            .bsbNumber("string")
            .build())
        .bacsDebit(SetupIntentPaymentMethodDataBacsDebitArgs.builder()
            .accountNumber("string")
            .sortCode("string")
            .build())
        .billingDetails(SetupIntentPaymentMethodDataBillingDetailsArgs.builder()
            .address(SetupIntentPaymentMethodDataBillingDetailsAddressArgs.builder()
                .city("string")
                .country("string")
                .line1("string")
                .line2("string")
                .postalCode("string")
                .state("string")
                .build())
            .email("string")
            .name("string")
            .phone("string")
            .taxId("string")
            .build())
        .boleto(SetupIntentPaymentMethodDataBoletoArgs.builder()
            .taxId("string")
            .build())
        .eps(SetupIntentPaymentMethodDataEpsArgs.builder()
            .bank("string")
            .build())
        .fpx(SetupIntentPaymentMethodDataFpxArgs.builder()
            .bank("string")
            .accountHolderType("string")
            .build())
        .ideal(SetupIntentPaymentMethodDataIdealArgs.builder()
            .bank("string")
            .build())
        .acssDebit(SetupIntentPaymentMethodDataAcssDebitArgs.builder()
            .accountNumber("string")
            .institutionNumber("string")
            .transitNumber("string")
            .build())
        .klarna(SetupIntentPaymentMethodDataKlarnaArgs.builder()
            .dob(SetupIntentPaymentMethodDataKlarnaDobArgs.builder()
                .day(0.0)
                .month(0.0)
                .year(0.0)
                .build())
            .build())
        .p24(SetupIntentPaymentMethodDataP24Args.builder()
            .bank("string")
            .build())
        .nzBankAccount(SetupIntentPaymentMethodDataNzBankAccountArgs.builder()
            .accountNumber("string")
            .bankCode("string")
            .branchCode("string")
            .suffix("string")
            .accountHolderName("string")
            .reference("string")
            .build())
        .naverPay(SetupIntentPaymentMethodDataNaverPayArgs.builder()
            .funding("string")
            .build())
        .payto(SetupIntentPaymentMethodDataPaytoArgs.builder()
            .accountNumber("string")
            .bsbNumber("string")
            .payId("string")
            .build())
        .radarOptions(SetupIntentPaymentMethodDataRadarOptionsArgs.builder()
            .session("string")
            .build())
        .sepaDebit(SetupIntentPaymentMethodDataSepaDebitArgs.builder()
            .iban("string")
            .build())
        .sofort(SetupIntentPaymentMethodDataSofortArgs.builder()
            .country("string")
            .build())
        .allowRedisplay("string")
        .upi(SetupIntentPaymentMethodDataUpiArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodDataUpiMandateOptionsArgs.builder()
                .amount(0.0)
                .amountType("string")
                .description("string")
                .endDate(0.0)
                .build())
            .build())
        .usBankAccount(SetupIntentPaymentMethodDataUsBankAccountArgs.builder()
            .accountHolderType("string")
            .accountNumber("string")
            .accountType("string")
            .financialConnectionsAccount("string")
            .routingNumber("string")
            .build())
        .build())
    .paymentMethodOptions(SetupIntentPaymentMethodOptionsArgs.builder()
        .acssDebit(SetupIntentPaymentMethodOptionsAcssDebitArgs.builder()
            .currency("string")
            .mandateOptions(SetupIntentPaymentMethodOptionsAcssDebitMandateOptionsArgs.builder()
                .customMandateUrl("string")
                .defaultFors("string")
                .intervalDescription("string")
                .paymentSchedule("string")
                .transactionType("string")
                .build())
            .verificationMethod("string")
            .build())
        .bacsDebit(SetupIntentPaymentMethodOptionsBacsDebitArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsBacsDebitMandateOptionsArgs.builder()
                .referencePrefix("string")
                .build())
            .build())
        .card(SetupIntentPaymentMethodOptionsCardArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsCardMandateOptionsArgs.builder()
                .amount(0.0)
                .amountType("string")
                .currency("string")
                .interval("string")
                .reference("string")
                .startDate(0.0)
                .description("string")
                .endDate(0.0)
                .intervalCount(0.0)
                .supportedTypes("string")
                .build())
            .moto(false)
            .network("string")
            .requestThreeDSecure("string")
            .threeDSecure(SetupIntentPaymentMethodOptionsCardThreeDSecureArgs.builder()
                .aresTransStatus("string")
                .cryptogram("string")
                .electronicCommerceIndicator("string")
                .networkOptions(SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsArgs.builder()
                    .cartesBancaires(SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesArgs.builder()
                        .cbAvalgo("string")
                        .cbExemption("string")
                        .cbScore(0.0)
                        .build())
                    .build())
                .requestorChallengeIndicator("string")
                .transactionId("string")
                .version("string")
                .build())
            .build())
        .klarna(SetupIntentPaymentMethodOptionsKlarnaArgs.builder()
            .currency("string")
            .onDemand(SetupIntentPaymentMethodOptionsKlarnaOnDemandArgs.builder()
                .averageAmount(0.0)
                .maximumAmount(0.0)
                .minimumAmount(0.0)
                .purchaseInterval("string")
                .purchaseIntervalCount(0.0)
                .build())
            .preferredLocale("string")
            .subscriptions(SetupIntentPaymentMethodOptionsKlarnaSubscriptionArgs.builder()
                .interval("string")
                .nextBilling(SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBillingArgs.builder()
                    .amount(0.0)
                    .date("string")
                    .build())
                .reference("string")
                .intervalCount(0.0)
                .name("string")
                .build())
            .build())
        .link(SetupIntentPaymentMethodOptionsLinkArgs.builder()
            .persistentToken("string")
            .build())
        .paypal(SetupIntentPaymentMethodOptionsPaypalArgs.builder()
            .billingAgreementId("string")
            .build())
        .payto(SetupIntentPaymentMethodOptionsPaytoArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsPaytoMandateOptionsArgs.builder()
                .amount(0.0)
                .amountType("string")
                .endDate("string")
                .paymentSchedule("string")
                .paymentsPerPeriod(0.0)
                .purpose("string")
                .startDate("string")
                .build())
            .build())
        .pix(SetupIntentPaymentMethodOptionsPixArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsPixMandateOptionsArgs.builder()
                .amount(0.0)
                .amountIncludesIof("string")
                .amountType("string")
                .currency("string")
                .endDate("string")
                .paymentSchedule("string")
                .reference("string")
                .startDate("string")
                .build())
            .build())
        .sepaDebit(SetupIntentPaymentMethodOptionsSepaDebitArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsSepaDebitMandateOptionsArgs.builder()
                .referencePrefix("string")
                .build())
            .build())
        .upi(SetupIntentPaymentMethodOptionsUpiArgs.builder()
            .mandateOptions(SetupIntentPaymentMethodOptionsUpiMandateOptionsArgs.builder()
                .amount(0.0)
                .amountType("string")
                .description("string")
                .endDate(0.0)
                .build())
            .setupFutureUsage("string")
            .build())
        .usBankAccount(SetupIntentPaymentMethodOptionsUsBankAccountArgs.builder()
            .financialConnections(SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs.builder()
                .filters(SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs.builder()
                    .accountSubcategories("string")
                    .build())
                .permissions("string")
                .prefetches("string")
                .returnUrl("string")
                .build())
            .mandateOptions(SetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsArgs.builder()
                .collectionMethod("string")
                .build())
            .networks(SetupIntentPaymentMethodOptionsUsBankAccountNetworksArgs.builder()
                .requesteds("string")
                .build())
            .verificationMethod("string")
            .build())
        .build())
    .paymentMethodTypes("string")
    .returnUrl("string")
    .singleUse(SetupIntentSingleUseArgs.builder()
        .amount(0.0)
        .currency("string")
        .build())
    .usage("string")
    .useStripeSdk(false)
    .build());

    setup_intent_resource = stripe.SetupIntent("setupIntentResource",
    attach_to_self=False,
    automatic_payment_methods={
        "enabled": False,
        "allow_redirects": "string",
    },
    confirm=False,
    confirmation_token="string",
    customer="string",
    customer_account="string",
    description="string",
    excluded_payment_method_types=["string"],
    flow_directions=["string"],
    mandate_data={
        "customer_acceptance": {
            "type": "string",
            "accepted_at": float(0),
            "online": {
                "ip_address": "string",
                "user_agent": "string",
            },
        },
    },
    metadata={
        "string": "string",
    },
    on_behalf_of="string",
    payment_method="string",
    payment_method_configuration="string",
    payment_method_data={
        "type": "string",
        "metadata": {
            "string": "string",
        },
        "au_becs_debit": {
            "account_number": "string",
            "bsb_number": "string",
        },
        "bacs_debit": {
            "account_number": "string",
            "sort_code": "string",
        },
        "billing_details": {
            "address": {
                "city": "string",
                "country": "string",
                "line1": "string",
                "line2": "string",
                "postal_code": "string",
                "state": "string",
            },
            "email": "string",
            "name": "string",
            "phone": "string",
            "tax_id": "string",
        },
        "boleto": {
            "tax_id": "string",
        },
        "eps": {
            "bank": "string",
        },
        "fpx": {
            "bank": "string",
            "account_holder_type": "string",
        },
        "ideal": {
            "bank": "string",
        },
        "acss_debit": {
            "account_number": "string",
            "institution_number": "string",
            "transit_number": "string",
        },
        "klarna": {
            "dob": {
                "day": float(0),
                "month": float(0),
                "year": float(0),
            },
        },
        "p24": {
            "bank": "string",
        },
        "nz_bank_account": {
            "account_number": "string",
            "bank_code": "string",
            "branch_code": "string",
            "suffix": "string",
            "account_holder_name": "string",
            "reference": "string",
        },
        "naver_pay": {
            "funding": "string",
        },
        "payto": {
            "account_number": "string",
            "bsb_number": "string",
            "pay_id": "string",
        },
        "radar_options": {
            "session": "string",
        },
        "sepa_debit": {
            "iban": "string",
        },
        "sofort": {
            "country": "string",
        },
        "allow_redisplay": "string",
        "upi": {
            "mandate_options": {
                "amount": float(0),
                "amount_type": "string",
                "description": "string",
                "end_date": float(0),
            },
        },
        "us_bank_account": {
            "account_holder_type": "string",
            "account_number": "string",
            "account_type": "string",
            "financial_connections_account": "string",
            "routing_number": "string",
        },
    },
    payment_method_options={
        "acss_debit": {
            "currency": "string",
            "mandate_options": {
                "custom_mandate_url": "string",
                "default_fors": ["string"],
                "interval_description": "string",
                "payment_schedule": "string",
                "transaction_type": "string",
            },
            "verification_method": "string",
        },
        "bacs_debit": {
            "mandate_options": {
                "reference_prefix": "string",
            },
        },
        "card": {
            "mandate_options": {
                "amount": float(0),
                "amount_type": "string",
                "currency": "string",
                "interval": "string",
                "reference": "string",
                "start_date": float(0),
                "description": "string",
                "end_date": float(0),
                "interval_count": float(0),
                "supported_types": ["string"],
            },
            "moto": False,
            "network": "string",
            "request_three_d_secure": "string",
            "three_d_secure": {
                "ares_trans_status": "string",
                "cryptogram": "string",
                "electronic_commerce_indicator": "string",
                "network_options": {
                    "cartes_bancaires": {
                        "cb_avalgo": "string",
                        "cb_exemption": "string",
                        "cb_score": float(0),
                    },
                },
                "requestor_challenge_indicator": "string",
                "transaction_id": "string",
                "version": "string",
            },
        },
        "klarna": {
            "currency": "string",
            "on_demand": {
                "average_amount": float(0),
                "maximum_amount": float(0),
                "minimum_amount": float(0),
                "purchase_interval": "string",
                "purchase_interval_count": float(0),
            },
            "preferred_locale": "string",
            "subscriptions": [{
                "interval": "string",
                "next_billing": {
                    "amount": float(0),
                    "date": "string",
                },
                "reference": "string",
                "interval_count": float(0),
                "name": "string",
            }],
        },
        "link": {
            "persistent_token": "string",
        },
        "paypal": {
            "billing_agreement_id": "string",
        },
        "payto": {
            "mandate_options": {
                "amount": float(0),
                "amount_type": "string",
                "end_date": "string",
                "payment_schedule": "string",
                "payments_per_period": float(0),
                "purpose": "string",
                "start_date": "string",
            },
        },
        "pix": {
            "mandate_options": {
                "amount": float(0),
                "amount_includes_iof": "string",
                "amount_type": "string",
                "currency": "string",
                "end_date": "string",
                "payment_schedule": "string",
                "reference": "string",
                "start_date": "string",
            },
        },
        "sepa_debit": {
            "mandate_options": {
                "reference_prefix": "string",
            },
        },
        "upi": {
            "mandate_options": {
                "amount": float(0),
                "amount_type": "string",
                "description": "string",
                "end_date": float(0),
            },
            "setup_future_usage": "string",
        },
        "us_bank_account": {
            "financial_connections": {
                "filters": {
                    "account_subcategories": ["string"],
                },
                "permissions": ["string"],
                "prefetches": ["string"],
                "return_url": "string",
            },
            "mandate_options": {
                "collection_method": "string",
            },
            "networks": {
                "requesteds": ["string"],
            },
            "verification_method": "string",
        },
    },
    payment_method_types=["string"],
    return_url="string",
    single_use={
        "amount": float(0),
        "currency": "string",
    },
    usage="string",
    use_stripe_sdk=False)

    const setupIntentResource = new stripe.SetupIntent("setupIntentResource", {
    attachToSelf: false,
    automaticPaymentMethods: {
        enabled: false,
        allowRedirects: "string",
    },
    confirm: false,
    confirmationToken: "string",
    customer: "string",
    customerAccount: "string",
    description: "string",
    excludedPaymentMethodTypes: ["string"],
    flowDirections: ["string"],
    mandateData: {
        customerAcceptance: {
            type: "string",
            acceptedAt: 0,
            online: {
                ipAddress: "string",
                userAgent: "string",
            },
        },
    },
    metadata: {
        string: "string",
    },
    onBehalfOf: "string",
    paymentMethod: "string",
    paymentMethodConfiguration: "string",
    paymentMethodData: {
        type: "string",
        metadata: {
            string: "string",
        },
        auBecsDebit: {
            accountNumber: "string",
            bsbNumber: "string",
        },
        bacsDebit: {
            accountNumber: "string",
            sortCode: "string",
        },
        billingDetails: {
            address: {
                city: "string",
                country: "string",
                line1: "string",
                line2: "string",
                postalCode: "string",
                state: "string",
            },
            email: "string",
            name: "string",
            phone: "string",
            taxId: "string",
        },
        boleto: {
            taxId: "string",
        },
        eps: {
            bank: "string",
        },
        fpx: {
            bank: "string",
            accountHolderType: "string",
        },
        ideal: {
            bank: "string",
        },
        acssDebit: {
            accountNumber: "string",
            institutionNumber: "string",
            transitNumber: "string",
        },
        klarna: {
            dob: {
                day: 0,
                month: 0,
                year: 0,
            },
        },
        p24: {
            bank: "string",
        },
        nzBankAccount: {
            accountNumber: "string",
            bankCode: "string",
            branchCode: "string",
            suffix: "string",
            accountHolderName: "string",
            reference: "string",
        },
        naverPay: {
            funding: "string",
        },
        payto: {
            accountNumber: "string",
            bsbNumber: "string",
            payId: "string",
        },
        radarOptions: {
            session: "string",
        },
        sepaDebit: {
            iban: "string",
        },
        sofort: {
            country: "string",
        },
        allowRedisplay: "string",
        upi: {
            mandateOptions: {
                amount: 0,
                amountType: "string",
                description: "string",
                endDate: 0,
            },
        },
        usBankAccount: {
            accountHolderType: "string",
            accountNumber: "string",
            accountType: "string",
            financialConnectionsAccount: "string",
            routingNumber: "string",
        },
    },
    paymentMethodOptions: {
        acssDebit: {
            currency: "string",
            mandateOptions: {
                customMandateUrl: "string",
                defaultFors: ["string"],
                intervalDescription: "string",
                paymentSchedule: "string",
                transactionType: "string",
            },
            verificationMethod: "string",
        },
        bacsDebit: {
            mandateOptions: {
                referencePrefix: "string",
            },
        },
        card: {
            mandateOptions: {
                amount: 0,
                amountType: "string",
                currency: "string",
                interval: "string",
                reference: "string",
                startDate: 0,
                description: "string",
                endDate: 0,
                intervalCount: 0,
                supportedTypes: ["string"],
            },
            moto: false,
            network: "string",
            requestThreeDSecure: "string",
            threeDSecure: {
                aresTransStatus: "string",
                cryptogram: "string",
                electronicCommerceIndicator: "string",
                networkOptions: {
                    cartesBancaires: {
                        cbAvalgo: "string",
                        cbExemption: "string",
                        cbScore: 0,
                    },
                },
                requestorChallengeIndicator: "string",
                transactionId: "string",
                version: "string",
            },
        },
        klarna: {
            currency: "string",
            onDemand: {
                averageAmount: 0,
                maximumAmount: 0,
                minimumAmount: 0,
                purchaseInterval: "string",
                purchaseIntervalCount: 0,
            },
            preferredLocale: "string",
            subscriptions: [{
                interval: "string",
                nextBilling: {
                    amount: 0,
                    date: "string",
                },
                reference: "string",
                intervalCount: 0,
                name: "string",
            }],
        },
        link: {
            persistentToken: "string",
        },
        paypal: {
            billingAgreementId: "string",
        },
        payto: {
            mandateOptions: {
                amount: 0,
                amountType: "string",
                endDate: "string",
                paymentSchedule: "string",
                paymentsPerPeriod: 0,
                purpose: "string",
                startDate: "string",
            },
        },
        pix: {
            mandateOptions: {
                amount: 0,
                amountIncludesIof: "string",
                amountType: "string",
                currency: "string",
                endDate: "string",
                paymentSchedule: "string",
                reference: "string",
                startDate: "string",
            },
        },
        sepaDebit: {
            mandateOptions: {
                referencePrefix: "string",
            },
        },
        upi: {
            mandateOptions: {
                amount: 0,
                amountType: "string",
                description: "string",
                endDate: 0,
            },
            setupFutureUsage: "string",
        },
        usBankAccount: {
            financialConnections: {
                filters: {
                    accountSubcategories: ["string"],
                },
                permissions: ["string"],
                prefetches: ["string"],
                returnUrl: "string",
            },
            mandateOptions: {
                collectionMethod: "string",
            },
            networks: {
                requesteds: ["string"],
            },
            verificationMethod: "string",
        },
    },
    paymentMethodTypes: ["string"],
    returnUrl: "string",
    singleUse: {
        amount: 0,
        currency: "string",
    },
    usage: "string",
    useStripeSdk: false,
});

    type: stripe:SetupIntent
properties:
    attachToSelf: false
    automaticPaymentMethods:
        allowRedirects: string
        enabled: false
    confirm: false
    confirmationToken: string
    customer: string
    customerAccount: string
    description: string
    excludedPaymentMethodTypes:
        - string
    flowDirections:
        - string
    mandateData:
        customerAcceptance:
            acceptedAt: 0
            online:
                ipAddress: string
                userAgent: string
            type: string
    metadata:
        string: string
    onBehalfOf: string
    paymentMethod: string
    paymentMethodConfiguration: string
    paymentMethodData:
        acssDebit:
            accountNumber: string
            institutionNumber: string
            transitNumber: string
        allowRedisplay: string
        auBecsDebit:
            accountNumber: string
            bsbNumber: string
        bacsDebit:
            accountNumber: string
            sortCode: string
        billingDetails:
            address:
                city: string
                country: string
                line1: string
                line2: string
                postalCode: string
                state: string
            email: string
            name: string
            phone: string
            taxId: string
        boleto:
            taxId: string
        eps:
            bank: string
        fpx:
            accountHolderType: string
            bank: string
        ideal:
            bank: string
        klarna:
            dob:
                day: 0
                month: 0
                year: 0
        metadata:
            string: string
        naverPay:
            funding: string
        nzBankAccount:
            accountHolderName: string
            accountNumber: string
            bankCode: string
            branchCode: string
            reference: string
            suffix: string
        p24:
            bank: string
        payto:
            accountNumber: string
            bsbNumber: string
            payId: string
        radarOptions:
            session: string
        sepaDebit:
            iban: string
        sofort:
            country: string
        type: string
        upi:
            mandateOptions:
                amount: 0
                amountType: string
                description: string
                endDate: 0
        usBankAccount:
            accountHolderType: string
            accountNumber: string
            accountType: string
            financialConnectionsAccount: string
            routingNumber: string
    paymentMethodOptions:
        acssDebit:
            currency: string
            mandateOptions:
                customMandateUrl: string
                defaultFors:
                    - string
                intervalDescription: string
                paymentSchedule: string
                transactionType: string
            verificationMethod: string
        bacsDebit:
            mandateOptions:
                referencePrefix: string
        card:
            mandateOptions:
                amount: 0
                amountType: string
                currency: string
                description: string
                endDate: 0
                interval: string
                intervalCount: 0
                reference: string
                startDate: 0
                supportedTypes:
                    - string
            moto: false
            network: string
            requestThreeDSecure: string
            threeDSecure:
                aresTransStatus: string
                cryptogram: string
                electronicCommerceIndicator: string
                networkOptions:
                    cartesBancaires:
                        cbAvalgo: string
                        cbExemption: string
                        cbScore: 0
                requestorChallengeIndicator: string
                transactionId: string
                version: string
        klarna:
            currency: string
            onDemand:
                averageAmount: 0
                maximumAmount: 0
                minimumAmount: 0
                purchaseInterval: string
                purchaseIntervalCount: 0
            preferredLocale: string
            subscriptions:
                - interval: string
                  intervalCount: 0
                  name: string
                  nextBilling:
                    amount: 0
                    date: string
                  reference: string
        link:
            persistentToken: string
        paypal:
            billingAgreementId: string
        payto:
            mandateOptions:
                amount: 0
                amountType: string
                endDate: string
                paymentSchedule: string
                paymentsPerPeriod: 0
                purpose: string
                startDate: string
        pix:
            mandateOptions:
                amount: 0
                amountIncludesIof: string
                amountType: string
                currency: string
                endDate: string
                paymentSchedule: string
                reference: string
                startDate: string
        sepaDebit:
            mandateOptions:
                referencePrefix: string
        upi:
            mandateOptions:
                amount: 0
                amountType: string
                description: string
                endDate: 0
            setupFutureUsage: string
        usBankAccount:
            financialConnections:
                filters:
                    accountSubcategories:
                        - string
                permissions:
                    - string
                prefetches:
                    - string
                returnUrl: string
            mandateOptions:
                collectionMethod: string
            networks:
                requesteds:
                    - string
            verificationMethod: string
    paymentMethodTypes:
        - string
    returnUrl: string
    singleUse:
        amount: 0
        currency: string
    usage: string
    useStripeSdk: false

    SetupIntent Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SetupIntent resource accepts the following input properties:

    AttachToSelf bool

    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.

    AutomaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    Confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    ConfirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    Customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    CustomerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    ExcludedPaymentMethodTypes List<string>
    Payment method types that are excluded from this SetupIntent.
    FlowDirections List<string>

    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.

    MandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    OnBehalfOf string
    The account (if any) for which the setup is intended.
    PaymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    PaymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    PaymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    PaymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    PaymentMethodTypes List<string>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    ReturnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    SingleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    Usage string

    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.

    UseStripeSdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    AttachToSelf bool

    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.

    AutomaticPaymentMethods SetupIntentAutomaticPaymentMethodsArgs
    Settings for dynamic payment methods compatible with this Setup Intent
    Confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    ConfirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    Customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    CustomerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    ExcludedPaymentMethodTypes []string
    Payment method types that are excluded from this SetupIntent.
    FlowDirections []string

    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.

    MandateData SetupIntentMandateDataArgs
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    OnBehalfOf string
    The account (if any) for which the setup is intended.
    PaymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    PaymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    PaymentMethodData SetupIntentPaymentMethodDataArgs
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    PaymentMethodOptions SetupIntentPaymentMethodOptionsArgs
    Payment method-specific configuration for this SetupIntent.
    PaymentMethodTypes []string
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    ReturnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    SingleUse SetupIntentSingleUseArgs

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    Usage string

    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.

    UseStripeSdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    attach_to_self bool

    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.

    automatic_payment_methods object
    Settings for dynamic payment methods compatible with this Setup Intent
    confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmation_token string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customer_account string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    excluded_payment_method_types list(string)
    Payment method types that are excluded from this SetupIntent.
    flow_directions list(string)

    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.

    mandate_data object
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    on_behalf_of string
    The account (if any) for which the setup is intended.
    payment_method string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    payment_method_configuration string
    The ID of the payment method configuration to use with this SetupIntent.
    payment_method_data object
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    payment_method_options object
    Payment method-specific configuration for this SetupIntent.
    payment_method_types list(string)
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    return_url string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    single_use object

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    usage string

    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.

    use_stripe_sdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    attachToSelf Boolean

    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.

    automaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    confirm Boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken String

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    customer String

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount String

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes List<String>
    Payment method types that are excluded from this SetupIntent.
    flowDirections List<String>

    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.

    mandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    onBehalfOf String
    The account (if any) for which the setup is intended.
    paymentMethod String
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration String
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl String
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    usage String

    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.

    useStripeSdk Boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    attachToSelf boolean

    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.

    automaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    confirm boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes string[]
    Payment method types that are excluded from this SetupIntent.
    flowDirections string[]

    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.

    mandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    onBehalfOf string
    The account (if any) for which the setup is intended.
    paymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes string[]
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    usage string

    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.

    useStripeSdk boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    attach_to_self bool

    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.

    automatic_payment_methods SetupIntentAutomaticPaymentMethodsArgs
    Settings for dynamic payment methods compatible with this Setup Intent
    confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmation_token str

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    customer str

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customer_account str

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    excluded_payment_method_types Sequence[str]
    Payment method types that are excluded from this SetupIntent.
    flow_directions Sequence[str]

    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.

    mandate_data SetupIntentMandateDataArgs
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    on_behalf_of str
    The account (if any) for which the setup is intended.
    payment_method str
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    payment_method_configuration str
    The ID of the payment method configuration to use with this SetupIntent.
    payment_method_data SetupIntentPaymentMethodDataArgs
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    payment_method_options SetupIntentPaymentMethodOptionsArgs
    Payment method-specific configuration for this SetupIntent.
    payment_method_types Sequence[str]
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    return_url str
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    single_use SetupIntentSingleUseArgs

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    usage str

    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.

    use_stripe_sdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    attachToSelf Boolean

    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.

    automaticPaymentMethods Property Map
    Settings for dynamic payment methods compatible with this Setup Intent
    confirm Boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken String

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    customer String

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount String

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes List<String>
    Payment method types that are excluded from this SetupIntent.
    flowDirections List<String>

    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.

    mandateData Property Map
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    onBehalfOf String
    The account (if any) for which the setup is intended.
    paymentMethod String
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration String
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodData Property Map
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions Property Map
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl String
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse Property Map

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    usage String

    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.

    useStripeSdk Boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SetupIntent resource produces the following output properties:

    Application string
    ID of the Connect application that created the SetupIntent.
    CancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    ClientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    LatestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SetupIntentManagedPayments
    Mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    NextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PaymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    SingleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    Status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    Application string
    ID of the Connect application that created the SetupIntent.
    CancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    ClientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    LatestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SetupIntentManagedPayments
    Mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    NextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    PaymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    SingleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    Status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    application string
    ID of the Connect application that created the SetupIntent.
    cancellation_reason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    client_secret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    last_setup_error object
    The error encountered in the previous SetupIntent confirmation.
    latest_attempt string
    The most recent SetupAttempt for this SetupIntent.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments object
    mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    next_action object
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object string
    String representing the object's type. Objects of the same type share the same value.
    payment_method_configuration_details object
    Information about the payment method configuration used for this Setup Intent.
    single_use_mandate string
    ID of the single_use Mandate generated by the SetupIntent.
    status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    application String
    ID of the Connect application that created the SetupIntent.
    cancellationReason String
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret String

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt String
    The most recent SetupAttempt for this SetupIntent.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SetupIntentManagedPayments
    mandate String
    ID of the multi use Mandate generated by the SetupIntent.
    nextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object String
    String representing the object's type. Objects of the same type share the same value.
    paymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    singleUseMandate String
    ID of the single_use Mandate generated by the SetupIntent.
    status String
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    application string
    ID of the Connect application that created the SetupIntent.
    cancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SetupIntentManagedPayments
    mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    nextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object string
    String representing the object's type. Objects of the same type share the same value.
    paymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    singleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    application str
    ID of the Connect application that created the SetupIntent.
    cancellation_reason str
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    client_secret str

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id str
    The provider-assigned unique ID for this managed resource.
    last_setup_error SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    latest_attempt str
    The most recent SetupAttempt for this SetupIntent.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments SetupIntentManagedPayments
    mandate str
    ID of the multi use Mandate generated by the SetupIntent.
    next_action SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object str
    String representing the object's type. Objects of the same type share the same value.
    payment_method_configuration_details SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    single_use_mandate str
    ID of the single_use Mandate generated by the SetupIntent.
    status str
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    application String
    ID of the Connect application that created the SetupIntent.
    cancellationReason String
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret String

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSetupError Property Map
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt String
    The most recent SetupAttempt for this SetupIntent.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments Property Map
    mandate String
    ID of the multi use Mandate generated by the SetupIntent.
    nextAction Property Map
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object String
    String representing the object's type. Objects of the same type share the same value.
    paymentMethodConfigurationDetails Property Map
    Information about the payment method configuration used for this Setup Intent.
    singleUseMandate String
    ID of the single_use Mandate generated by the SetupIntent.
    status String
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

    Look up Existing SetupIntent Resource

    Get an existing SetupIntent resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SetupIntentState, opts?: CustomResourceOptions): SetupIntent
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application: Optional[str] = None,
        attach_to_self: Optional[bool] = None,
        automatic_payment_methods: Optional[SetupIntentAutomaticPaymentMethodsArgs] = None,
        cancellation_reason: Optional[str] = None,
        client_secret: Optional[str] = None,
        confirm: Optional[bool] = None,
        confirmation_token: Optional[str] = None,
        created: Optional[float] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        description: Optional[str] = None,
        excluded_payment_method_types: Optional[Sequence[str]] = None,
        flow_directions: Optional[Sequence[str]] = None,
        last_setup_error: Optional[SetupIntentLastSetupErrorArgs] = None,
        latest_attempt: Optional[str] = None,
        livemode: Optional[bool] = None,
        managed_payments: Optional[SetupIntentManagedPaymentsArgs] = None,
        mandate: Optional[str] = None,
        mandate_data: Optional[SetupIntentMandateDataArgs] = None,
        metadata: Optional[Mapping[str, str]] = None,
        next_action: Optional[SetupIntentNextActionArgs] = None,
        object: Optional[str] = None,
        on_behalf_of: Optional[str] = None,
        payment_method: Optional[str] = None,
        payment_method_configuration: Optional[str] = None,
        payment_method_configuration_details: Optional[SetupIntentPaymentMethodConfigurationDetailsArgs] = None,
        payment_method_data: Optional[SetupIntentPaymentMethodDataArgs] = None,
        payment_method_options: Optional[SetupIntentPaymentMethodOptionsArgs] = None,
        payment_method_types: Optional[Sequence[str]] = None,
        return_url: Optional[str] = None,
        single_use: Optional[SetupIntentSingleUseArgs] = None,
        single_use_mandate: Optional[str] = None,
        status: Optional[str] = None,
        usage: Optional[str] = None,
        use_stripe_sdk: Optional[bool] = None) -> SetupIntent
    func GetSetupIntent(ctx *Context, name string, id IDInput, state *SetupIntentState, opts ...ResourceOption) (*SetupIntent, error)
    public static SetupIntent Get(string name, Input<string> id, SetupIntentState? state, CustomResourceOptions? opts = null)
    public static SetupIntent get(String name, Output<String> id, SetupIntentState state, CustomResourceOptions options)
    resources:  _:    type: stripe:SetupIntent    get:      id: ${id}
    import {
  to = stripe_setup_intent.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Application string
    ID of the Connect application that created the SetupIntent.
    AttachToSelf bool

    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.

    AutomaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    CancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    ClientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    Confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    ConfirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    CustomerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    ExcludedPaymentMethodTypes List<string>
    Payment method types that are excluded from this SetupIntent.
    FlowDirections List<string>

    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.

    LastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    LatestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SetupIntentManagedPayments
    Mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    MandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account (if any) for which the setup is intended.
    PaymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    PaymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    PaymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    PaymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    PaymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    PaymentMethodTypes List<string>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    ReturnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    SingleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    SingleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    Status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    Usage string

    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.

    UseStripeSdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    Application string
    ID of the Connect application that created the SetupIntent.
    AttachToSelf bool

    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.

    AutomaticPaymentMethods SetupIntentAutomaticPaymentMethodsArgs
    Settings for dynamic payment methods compatible with this Setup Intent
    CancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    ClientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    Confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    ConfirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    CustomerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    Description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    ExcludedPaymentMethodTypes []string
    Payment method types that are excluded from this SetupIntent.
    FlowDirections []string

    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.

    LastSetupError SetupIntentLastSetupErrorArgs
    The error encountered in the previous SetupIntent confirmation.
    LatestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    ManagedPayments SetupIntentManagedPaymentsArgs
    Mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    MandateData SetupIntentMandateDataArgs
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextAction SetupIntentNextActionArgs
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account (if any) for which the setup is intended.
    PaymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    PaymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    PaymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetailsArgs
    Information about the payment method configuration used for this Setup Intent.
    PaymentMethodData SetupIntentPaymentMethodDataArgs
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    PaymentMethodOptions SetupIntentPaymentMethodOptionsArgs
    Payment method-specific configuration for this SetupIntent.
    PaymentMethodTypes []string
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    ReturnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    SingleUse SetupIntentSingleUseArgs

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    SingleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    Status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    Usage string

    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.

    UseStripeSdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    application string
    ID of the Connect application that created the SetupIntent.
    attach_to_self bool

    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.

    automatic_payment_methods object
    Settings for dynamic payment methods compatible with this Setup Intent
    cancellation_reason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    client_secret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmation_token string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customer_account string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    excluded_payment_method_types list(string)
    Payment method types that are excluded from this SetupIntent.
    flow_directions list(string)

    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.

    last_setup_error object
    The error encountered in the previous SetupIntent confirmation.
    latest_attempt string
    The most recent SetupAttempt for this SetupIntent.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments object
    mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    mandate_data object
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_action object
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object string
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of string
    The account (if any) for which the setup is intended.
    payment_method string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    payment_method_configuration string
    The ID of the payment method configuration to use with this SetupIntent.
    payment_method_configuration_details object
    Information about the payment method configuration used for this Setup Intent.
    payment_method_data object
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    payment_method_options object
    Payment method-specific configuration for this SetupIntent.
    payment_method_types list(string)
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    return_url string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    single_use object

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    single_use_mandate string
    ID of the single_use Mandate generated by the SetupIntent.
    status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    usage string

    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.

    use_stripe_sdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    application String
    ID of the Connect application that created the SetupIntent.
    attachToSelf Boolean

    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.

    automaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    cancellationReason String
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret String

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    confirm Boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken String

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer String

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount String

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes List<String>
    Payment method types that are excluded from this SetupIntent.
    flowDirections List<String>

    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.

    lastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt String
    The most recent SetupAttempt for this SetupIntent.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SetupIntentManagedPayments
    mandate String
    ID of the multi use Mandate generated by the SetupIntent.
    mandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account (if any) for which the setup is intended.
    paymentMethod String
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration String
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    paymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl String
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    singleUseMandate String
    ID of the single_use Mandate generated by the SetupIntent.
    status String
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    usage String

    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.

    useStripeSdk Boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    application string
    ID of the Connect application that created the SetupIntent.
    attachToSelf boolean

    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.

    automaticPaymentMethods SetupIntentAutomaticPaymentMethods
    Settings for dynamic payment methods compatible with this Setup Intent
    cancellationReason string
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret string

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    confirm boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken string

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer string

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount string

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description string
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes string[]
    Payment method types that are excluded from this SetupIntent.
    flowDirections string[]

    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.

    lastSetupError SetupIntentLastSetupError
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt string
    The most recent SetupAttempt for this SetupIntent.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments SetupIntentManagedPayments
    mandate string
    ID of the multi use Mandate generated by the SetupIntent.
    mandateData SetupIntentMandateData
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextAction SetupIntentNextAction
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object string
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf string
    The account (if any) for which the setup is intended.
    paymentMethod string
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration string
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodConfigurationDetails SetupIntentPaymentMethodConfigurationDetails
    Information about the payment method configuration used for this Setup Intent.
    paymentMethodData SetupIntentPaymentMethodData
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions SetupIntentPaymentMethodOptions
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes string[]
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl string
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse SetupIntentSingleUse

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    singleUseMandate string
    ID of the single_use Mandate generated by the SetupIntent.
    status string
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    usage string

    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.

    useStripeSdk boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    application str
    ID of the Connect application that created the SetupIntent.
    attach_to_self bool

    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.

    automatic_payment_methods SetupIntentAutomaticPaymentMethodsArgs
    Settings for dynamic payment methods compatible with this Setup Intent
    cancellation_reason str
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    client_secret str

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    confirm bool
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmation_token str

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer str

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customer_account str

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description str
    An arbitrary string attached to the object. Often useful for displaying to users.
    excluded_payment_method_types Sequence[str]
    Payment method types that are excluded from this SetupIntent.
    flow_directions Sequence[str]

    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.

    last_setup_error SetupIntentLastSetupErrorArgs
    The error encountered in the previous SetupIntent confirmation.
    latest_attempt str
    The most recent SetupAttempt for this SetupIntent.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managed_payments SetupIntentManagedPaymentsArgs
    mandate str
    ID of the multi use Mandate generated by the SetupIntent.
    mandate_data SetupIntentMandateDataArgs
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_action SetupIntentNextActionArgs
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object str
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of str
    The account (if any) for which the setup is intended.
    payment_method str
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    payment_method_configuration str
    The ID of the payment method configuration to use with this SetupIntent.
    payment_method_configuration_details SetupIntentPaymentMethodConfigurationDetailsArgs
    Information about the payment method configuration used for this Setup Intent.
    payment_method_data SetupIntentPaymentMethodDataArgs
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    payment_method_options SetupIntentPaymentMethodOptionsArgs
    Payment method-specific configuration for this SetupIntent.
    payment_method_types Sequence[str]
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    return_url str
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    single_use SetupIntentSingleUseArgs

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    single_use_mandate str
    ID of the single_use Mandate generated by the SetupIntent.
    status str
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    usage str

    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.

    use_stripe_sdk bool
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
    application String
    ID of the Connect application that created the SetupIntent.
    attachToSelf Boolean

    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.

    automaticPaymentMethods Property Map
    Settings for dynamic payment methods compatible with this Setup Intent
    cancellationReason String
    Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
    clientSecret String

    The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

    The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

    confirm Boolean
    Set to true to attempt to confirm this SetupIntent immediately. This parameter defaults to false. If a card is the attached payment method, you can provide a return_url in case further authentication is necessary.
    confirmationToken String

    ID of the ConfirmationToken used to confirm this SetupIntent.

    If the provided ConfirmationToken contains properties that are also being provided in this request, such as payment_method, then the values in this request will take precedence.

    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer String

    ID of the Customer this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customerAccount String

    ID of the Account this SetupIntent belongs to, if one exists.

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description String
    An arbitrary string attached to the object. Often useful for displaying to users.
    excludedPaymentMethodTypes List<String>
    Payment method types that are excluded from this SetupIntent.
    flowDirections List<String>

    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.

    lastSetupError Property Map
    The error encountered in the previous SetupIntent confirmation.
    latestAttempt String
    The most recent SetupAttempt for this SetupIntent.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    managedPayments Property Map
    mandate String
    ID of the multi use Mandate generated by the SetupIntent.
    mandateData Property Map
    This hash contains details about the mandate to create. This parameter can only be used with confirm=true.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextAction Property Map
    If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account (if any) for which the setup is intended.
    paymentMethod String
    ID of the payment method used with this SetupIntent. If the payment method is card_present and isn't a digital wallet, then the generated_card associated with the latest_attempt is attached to the Customer instead.
    paymentMethodConfiguration String
    The ID of the payment method configuration to use with this SetupIntent.
    paymentMethodConfigurationDetails Property Map
    Information about the payment method configuration used for this Setup Intent.
    paymentMethodData Property Map
    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.
    paymentMethodOptions Property Map
    Payment method-specific configuration for this SetupIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.
    returnUrl String
    The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with confirm=true.
    singleUse Property Map

    If you populate this hash, this SetupIntent generates a single_use mandate after successful completion.

    Single-use mandates are only valid for the following payment methods: acss_debit, alipay, au_becs_debit, bacs_debit, bancontact, boleto, ideal, link, sepa_debit, and us_bank_account.

    singleUseMandate String
    ID of the single_use Mandate generated by the SetupIntent.
    status String
    Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
    usage String

    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.

    useStripeSdk Boolean
    Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.

    Supporting Types

    SetupIntentAutomaticPaymentMethods, SetupIntentAutomaticPaymentMethodsArgs

    Enabled bool
    Automatically calculates compatible payment methods
    AllowRedirects string
    Controls whether this SetupIntent will accept redirect-based payment methods.
    Enabled bool
    Automatically calculates compatible payment methods
    AllowRedirects string
    Controls whether this SetupIntent will accept redirect-based payment methods.
    enabled bool
    Automatically calculates compatible payment methods
    allow_redirects string
    Controls whether this SetupIntent will accept redirect-based payment methods.
    enabled Boolean
    Automatically calculates compatible payment methods
    allowRedirects String
    Controls whether this SetupIntent will accept redirect-based payment methods.
    enabled boolean
    Automatically calculates compatible payment methods
    allowRedirects string
    Controls whether this SetupIntent will accept redirect-based payment methods.
    enabled bool
    Automatically calculates compatible payment methods
    allow_redirects str
    Controls whether this SetupIntent will accept redirect-based payment methods.
    enabled Boolean
    Automatically calculates compatible payment methods
    allowRedirects String
    Controls whether this SetupIntent will accept redirect-based payment methods.

    SetupIntentLastSetupError, SetupIntentLastSetupErrorArgs

    AdviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    Charge string
    For card errors, the ID of the failed charge.
    Code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    DeclineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    DocUrl string
    A URL to more information about the error code reported.
    Message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    NetworkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    NetworkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    Param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    PaymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    PaymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    PaymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    RequestLogUrl string
    A URL to the request log entry in your dashboard.
    SetupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    Source string
    Type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    AdviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    Charge string
    For card errors, the ID of the failed charge.
    Code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    DeclineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    DocUrl string
    A URL to more information about the error code reported.
    Message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    NetworkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    NetworkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    Param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    PaymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    PaymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    PaymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    RequestLogUrl string
    A URL to the request log entry in your dashboard.
    SetupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    Source string
    Type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    advice_code string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge string
    For card errors, the ID of the failed charge.
    code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    decline_code string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    doc_url string
    A URL to more information about the error code reported.
    message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    network_advice_code string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    network_decline_code string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    payment_intent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    payment_method string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    payment_method_type string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    request_log_url string
    A URL to the request log entry in your dashboard.
    setup_intent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source string
    type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode String
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge String
    For card errors, the ID of the failed charge.
    code String
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode String
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl String
    A URL to more information about the error code reported.
    message String
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode String
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode String
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param String
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent String
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod String

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType String
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl String
    A URL to the request log entry in your dashboard.
    setupIntent String

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source String
    type String
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge string
    For card errors, the ID of the failed charge.
    code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl string
    A URL to more information about the error code reported.
    message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl string
    A URL to the request log entry in your dashboard.
    setupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source string
    type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    advice_code str
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge str
    For card errors, the ID of the failed charge.
    code str
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    decline_code str
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    doc_url str
    A URL to more information about the error code reported.
    message str
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    network_advice_code str
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    network_decline_code str
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param str
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    payment_intent str
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    payment_method str

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    payment_method_type str
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    request_log_url str
    A URL to the request log entry in your dashboard.
    setup_intent str

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source str
    type str
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode String
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge String
    For card errors, the ID of the failed charge.
    code String
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode String
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl String
    A URL to more information about the error code reported.
    message String
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode String
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode String
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param String
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent String
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod String

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType String
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl String
    A URL to the request log entry in your dashboard.
    setupIntent String

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source String
    type String
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

    SetupIntentManagedPayments, SetupIntentManagedPaymentsArgs

    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    Enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled bool
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.
    enabled Boolean
    Set to true to enable Managed Payments, Stripe's merchant of record solution, for this session.

    SetupIntentMandateData, SetupIntentMandateDataArgs

    CustomerAcceptance SetupIntentMandateDataCustomerAcceptance
    This hash contains details about the customer acceptance of the Mandate.
    CustomerAcceptance SetupIntentMandateDataCustomerAcceptance
    This hash contains details about the customer acceptance of the Mandate.
    customer_acceptance object
    This hash contains details about the customer acceptance of the Mandate.
    customerAcceptance SetupIntentMandateDataCustomerAcceptance
    This hash contains details about the customer acceptance of the Mandate.
    customerAcceptance SetupIntentMandateDataCustomerAcceptance
    This hash contains details about the customer acceptance of the Mandate.
    customer_acceptance SetupIntentMandateDataCustomerAcceptance
    This hash contains details about the customer acceptance of the Mandate.
    customerAcceptance Property Map
    This hash contains details about the customer acceptance of the Mandate.

    SetupIntentMandateDataCustomerAcceptance, SetupIntentMandateDataCustomerAcceptanceArgs

    Type string
    The type of customer acceptance information included with the Mandate. One of online or offline.
    AcceptedAt double
    The time at which the customer accepted the Mandate.
    Online SetupIntentMandateDataCustomerAcceptanceOnline
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    Type string
    The type of customer acceptance information included with the Mandate. One of online or offline.
    AcceptedAt float64
    The time at which the customer accepted the Mandate.
    Online SetupIntentMandateDataCustomerAcceptanceOnline
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    type string
    The type of customer acceptance information included with the Mandate. One of online or offline.
    accepted_at number
    The time at which the customer accepted the Mandate.
    online object
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    type String
    The type of customer acceptance information included with the Mandate. One of online or offline.
    acceptedAt Double
    The time at which the customer accepted the Mandate.
    online SetupIntentMandateDataCustomerAcceptanceOnline
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    type string
    The type of customer acceptance information included with the Mandate. One of online or offline.
    acceptedAt number
    The time at which the customer accepted the Mandate.
    online SetupIntentMandateDataCustomerAcceptanceOnline
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    type str
    The type of customer acceptance information included with the Mandate. One of online or offline.
    accepted_at float
    The time at which the customer accepted the Mandate.
    online SetupIntentMandateDataCustomerAcceptanceOnline
    If this is a Mandate accepted online, this hash contains details about the online acceptance.
    type String
    The type of customer acceptance information included with the Mandate. One of online or offline.
    acceptedAt Number
    The time at which the customer accepted the Mandate.
    online Property Map
    If this is a Mandate accepted online, this hash contains details about the online acceptance.

    SetupIntentMandateDataCustomerAcceptanceOnline, SetupIntentMandateDataCustomerAcceptanceOnlineArgs

    IpAddress string
    The IP address from which the Mandate was accepted by the customer.
    UserAgent string
    The user agent of the browser from which the Mandate was accepted by the customer.
    IpAddress string
    The IP address from which the Mandate was accepted by the customer.
    UserAgent string
    The user agent of the browser from which the Mandate was accepted by the customer.
    ip_address string
    The IP address from which the Mandate was accepted by the customer.
    user_agent string
    The user agent of the browser from which the Mandate was accepted by the customer.
    ipAddress String
    The IP address from which the Mandate was accepted by the customer.
    userAgent String
    The user agent of the browser from which the Mandate was accepted by the customer.
    ipAddress string
    The IP address from which the Mandate was accepted by the customer.
    userAgent string
    The user agent of the browser from which the Mandate was accepted by the customer.
    ip_address str
    The IP address from which the Mandate was accepted by the customer.
    user_agent str
    The user agent of the browser from which the Mandate was accepted by the customer.
    ipAddress String
    The IP address from which the Mandate was accepted by the customer.
    userAgent String
    The user agent of the browser from which the Mandate was accepted by the customer.

    SetupIntentNextAction, SetupIntentNextActionArgs

    CashappHandleRedirectOrDisplayQrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode
    PixDisplayQrCode SetupIntentNextActionPixDisplayQrCode
    RedirectToUrl SetupIntentNextActionRedirectToUrl
    Type string
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    UpiHandleRedirectOrDisplayQrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode
    UseStripeSdk Dictionary<string, string>
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    VerifyWithMicrodeposits SetupIntentNextActionVerifyWithMicrodeposits
    CashappHandleRedirectOrDisplayQrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode
    PixDisplayQrCode SetupIntentNextActionPixDisplayQrCode
    RedirectToUrl SetupIntentNextActionRedirectToUrl
    Type string
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    UpiHandleRedirectOrDisplayQrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode
    UseStripeSdk map[string]string
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    VerifyWithMicrodeposits SetupIntentNextActionVerifyWithMicrodeposits
    cashapp_handle_redirect_or_display_qr_code object
    pix_display_qr_code object
    redirect_to_url object
    type string
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    upi_handle_redirect_or_display_qr_code object
    use_stripe_sdk map(string)
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    verify_with_microdeposits object
    cashappHandleRedirectOrDisplayQrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode
    pixDisplayQrCode SetupIntentNextActionPixDisplayQrCode
    redirectToUrl SetupIntentNextActionRedirectToUrl
    type String
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    upiHandleRedirectOrDisplayQrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode
    useStripeSdk Map<String,String>
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    verifyWithMicrodeposits SetupIntentNextActionVerifyWithMicrodeposits
    cashappHandleRedirectOrDisplayQrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode
    pixDisplayQrCode SetupIntentNextActionPixDisplayQrCode
    redirectToUrl SetupIntentNextActionRedirectToUrl
    type string
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    upiHandleRedirectOrDisplayQrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode
    useStripeSdk {[key: string]: string}
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    verifyWithMicrodeposits SetupIntentNextActionVerifyWithMicrodeposits
    cashapp_handle_redirect_or_display_qr_code SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode
    pix_display_qr_code SetupIntentNextActionPixDisplayQrCode
    redirect_to_url SetupIntentNextActionRedirectToUrl
    type str
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    upi_handle_redirect_or_display_qr_code SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode
    use_stripe_sdk Mapping[str, str]
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    verify_with_microdeposits SetupIntentNextActionVerifyWithMicrodeposits
    cashappHandleRedirectOrDisplayQrCode Property Map
    pixDisplayQrCode Property Map
    redirectToUrl Property Map
    type String
    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
    upiHandleRedirectOrDisplayQrCode Property Map
    useStripeSdk Map<String>
    When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
    verifyWithMicrodeposits Property Map

    SetupIntentNextActionCashappHandleRedirectOrDisplayQrCode, SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeArgs

    HostedInstructionsUrl string
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    MobileAuthUrl string
    The url for mobile redirect based auth
    QrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode
    HostedInstructionsUrl string
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    MobileAuthUrl string
    The url for mobile redirect based auth
    QrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode
    hosted_instructions_url string
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    mobile_auth_url string
    The url for mobile redirect based auth
    qr_code object
    hostedInstructionsUrl String
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    mobileAuthUrl String
    The url for mobile redirect based auth
    qrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode
    hostedInstructionsUrl string
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    mobileAuthUrl string
    The url for mobile redirect based auth
    qrCode SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode
    hosted_instructions_url str
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    mobile_auth_url str
    The url for mobile redirect based auth
    qr_code SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode
    hostedInstructionsUrl String
    The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.
    mobileAuthUrl String
    The url for mobile redirect based auth
    qrCode Property Map

    SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCode, SetupIntentNextActionCashappHandleRedirectOrDisplayQrCodeQrCodeArgs

    ExpiresAt double
    The date (unix timestamp) when the QR code expires.
    ImageUrlPng string
    The imageurlpng string used to render QR code
    ImageUrlSvg string
    The imageurlsvg string used to render QR code
    ExpiresAt float64
    The date (unix timestamp) when the QR code expires.
    ImageUrlPng string
    The imageurlpng string used to render QR code
    ImageUrlSvg string
    The imageurlsvg string used to render QR code
    expires_at number
    The date (unix timestamp) when the QR code expires.
    image_url_png string
    The imageurlpng string used to render QR code
    image_url_svg string
    The imageurlsvg string used to render QR code
    expiresAt Double
    The date (unix timestamp) when the QR code expires.
    imageUrlPng String
    The imageurlpng string used to render QR code
    imageUrlSvg String
    The imageurlsvg string used to render QR code
    expiresAt number
    The date (unix timestamp) when the QR code expires.
    imageUrlPng string
    The imageurlpng string used to render QR code
    imageUrlSvg string
    The imageurlsvg string used to render QR code
    expires_at float
    The date (unix timestamp) when the QR code expires.
    image_url_png str
    The imageurlpng string used to render QR code
    image_url_svg str
    The imageurlsvg string used to render QR code
    expiresAt Number
    The date (unix timestamp) when the QR code expires.
    imageUrlPng String
    The imageurlpng string used to render QR code
    imageUrlSvg String
    The imageurlsvg string used to render QR code

    SetupIntentNextActionPixDisplayQrCode, SetupIntentNextActionPixDisplayQrCodeArgs

    Data string
    The raw data string used to generate QR code, it should be used together with QR code library.
    ExpiresAt double
    The date (unix timestamp) when the PIX expires.
    HostedInstructionsUrl string
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    ImageUrlPng string
    The imageurlpng string used to render png QR code
    ImageUrlSvg string
    The imageurlsvg string used to render svg QR code
    Data string
    The raw data string used to generate QR code, it should be used together with QR code library.
    ExpiresAt float64
    The date (unix timestamp) when the PIX expires.
    HostedInstructionsUrl string
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    ImageUrlPng string
    The imageurlpng string used to render png QR code
    ImageUrlSvg string
    The imageurlsvg string used to render svg QR code
    data string
    The raw data string used to generate QR code, it should be used together with QR code library.
    expires_at number
    The date (unix timestamp) when the PIX expires.
    hosted_instructions_url string
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    image_url_png string
    The imageurlpng string used to render png QR code
    image_url_svg string
    The imageurlsvg string used to render svg QR code
    data String
    The raw data string used to generate QR code, it should be used together with QR code library.
    expiresAt Double
    The date (unix timestamp) when the PIX expires.
    hostedInstructionsUrl String
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    imageUrlPng String
    The imageurlpng string used to render png QR code
    imageUrlSvg String
    The imageurlsvg string used to render svg QR code
    data string
    The raw data string used to generate QR code, it should be used together with QR code library.
    expiresAt number
    The date (unix timestamp) when the PIX expires.
    hostedInstructionsUrl string
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    imageUrlPng string
    The imageurlpng string used to render png QR code
    imageUrlSvg string
    The imageurlsvg string used to render svg QR code
    data str
    The raw data string used to generate QR code, it should be used together with QR code library.
    expires_at float
    The date (unix timestamp) when the PIX expires.
    hosted_instructions_url str
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    image_url_png str
    The imageurlpng string used to render png QR code
    image_url_svg str
    The imageurlsvg string used to render svg QR code
    data String
    The raw data string used to generate QR code, it should be used together with QR code library.
    expiresAt Number
    The date (unix timestamp) when the PIX expires.
    hostedInstructionsUrl String
    The URL to the hosted pix instructions page, which allows customers to view the pix QR code.
    imageUrlPng String
    The imageurlpng string used to render png QR code
    imageUrlSvg String
    The imageurlsvg string used to render svg QR code

    SetupIntentNextActionRedirectToUrl, SetupIntentNextActionRedirectToUrlArgs

    ReturnUrl string
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    Url string
    The URL you must redirect your customer to in order to authenticate.
    ReturnUrl string
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    Url string
    The URL you must redirect your customer to in order to authenticate.
    return_url string
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    url string
    The URL you must redirect your customer to in order to authenticate.
    returnUrl String
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    url String
    The URL you must redirect your customer to in order to authenticate.
    returnUrl string
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    url string
    The URL you must redirect your customer to in order to authenticate.
    return_url str
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    url str
    The URL you must redirect your customer to in order to authenticate.
    returnUrl String
    If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
    url String
    The URL you must redirect your customer to in order to authenticate.

    SetupIntentNextActionUpiHandleRedirectOrDisplayQrCode, SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeArgs

    HostedInstructionsUrl string
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    QrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode
    HostedInstructionsUrl string
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    QrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode
    hosted_instructions_url string
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    qr_code object
    hostedInstructionsUrl String
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    qrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode
    hostedInstructionsUrl string
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    qrCode SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode
    hosted_instructions_url str
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    qr_code SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode
    hostedInstructionsUrl String
    The URL to the hosted UPI instructions page, which allows customers to view the QR code.
    qrCode Property Map

    SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCode, SetupIntentNextActionUpiHandleRedirectOrDisplayQrCodeQrCodeArgs

    ExpiresAt double
    The date (unix timestamp) when the QR code expires.
    ImageUrlPng string
    The imageurlpng string used to render QR code
    ImageUrlSvg string
    The imageurlsvg string used to render QR code
    ExpiresAt float64
    The date (unix timestamp) when the QR code expires.
    ImageUrlPng string
    The imageurlpng string used to render QR code
    ImageUrlSvg string
    The imageurlsvg string used to render QR code
    expires_at number
    The date (unix timestamp) when the QR code expires.
    image_url_png string
    The imageurlpng string used to render QR code
    image_url_svg string
    The imageurlsvg string used to render QR code
    expiresAt Double
    The date (unix timestamp) when the QR code expires.
    imageUrlPng String
    The imageurlpng string used to render QR code
    imageUrlSvg String
    The imageurlsvg string used to render QR code
    expiresAt number
    The date (unix timestamp) when the QR code expires.
    imageUrlPng string
    The imageurlpng string used to render QR code
    imageUrlSvg string
    The imageurlsvg string used to render QR code
    expires_at float
    The date (unix timestamp) when the QR code expires.
    image_url_png str
    The imageurlpng string used to render QR code
    image_url_svg str
    The imageurlsvg string used to render QR code
    expiresAt Number
    The date (unix timestamp) when the QR code expires.
    imageUrlPng String
    The imageurlpng string used to render QR code
    imageUrlSvg String
    The imageurlsvg string used to render QR code

    SetupIntentNextActionVerifyWithMicrodeposits, SetupIntentNextActionVerifyWithMicrodepositsArgs

    ArrivalDate double
    The timestamp when the microdeposits are expected to land.
    HostedVerificationUrl string
    The URL for the hosted verification page, which allows customers to verify their bank account.
    MicrodepositType string
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    ArrivalDate float64
    The timestamp when the microdeposits are expected to land.
    HostedVerificationUrl string
    The URL for the hosted verification page, which allows customers to verify their bank account.
    MicrodepositType string
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    arrival_date number
    The timestamp when the microdeposits are expected to land.
    hosted_verification_url string
    The URL for the hosted verification page, which allows customers to verify their bank account.
    microdeposit_type string
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    arrivalDate Double
    The timestamp when the microdeposits are expected to land.
    hostedVerificationUrl String
    The URL for the hosted verification page, which allows customers to verify their bank account.
    microdepositType String
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    arrivalDate number
    The timestamp when the microdeposits are expected to land.
    hostedVerificationUrl string
    The URL for the hosted verification page, which allows customers to verify their bank account.
    microdepositType string
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    arrival_date float
    The timestamp when the microdeposits are expected to land.
    hosted_verification_url str
    The URL for the hosted verification page, which allows customers to verify their bank account.
    microdeposit_type str
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.
    arrivalDate Number
    The timestamp when the microdeposits are expected to land.
    hostedVerificationUrl String
    The URL for the hosted verification page, which allows customers to verify their bank account.
    microdepositType String
    The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

    SetupIntentPaymentMethodConfigurationDetails, SetupIntentPaymentMethodConfigurationDetailsArgs

    Id string
    ID of the payment method configuration used.
    Parent string
    ID of the parent payment method configuration used.
    Id string
    ID of the payment method configuration used.
    Parent string
    ID of the parent payment method configuration used.
    id string
    ID of the payment method configuration used.
    parent string
    ID of the parent payment method configuration used.
    id String
    ID of the payment method configuration used.
    parent String
    ID of the parent payment method configuration used.
    id string
    ID of the payment method configuration used.
    parent string
    ID of the parent payment method configuration used.
    id str
    ID of the payment method configuration used.
    parent str
    ID of the parent payment method configuration used.
    id String
    ID of the payment method configuration used.
    parent String
    ID of the parent payment method configuration used.

    SetupIntentPaymentMethodData, SetupIntentPaymentMethodDataArgs

    Type string
    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.
    AcssDebit SetupIntentPaymentMethodDataAcssDebit
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    AllowRedisplay string
    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.
    AuBecsDebit SetupIntentPaymentMethodDataAuBecsDebit
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    BacsDebit SetupIntentPaymentMethodDataBacsDebit
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    BillingDetails SetupIntentPaymentMethodDataBillingDetails
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    Boleto SetupIntentPaymentMethodDataBoleto
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    Eps SetupIntentPaymentMethodDataEps
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    Fpx SetupIntentPaymentMethodDataFpx
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    Ideal SetupIntentPaymentMethodDataIdeal
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    Klarna SetupIntentPaymentMethodDataKlarna
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    Metadata Dictionary<string, string>
    Set of key-value pairs 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.
    NaverPay SetupIntentPaymentMethodDataNaverPay
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    NzBankAccount SetupIntentPaymentMethodDataNzBankAccount
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    P24 SetupIntentPaymentMethodDataP24
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    Payto SetupIntentPaymentMethodDataPayto
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    RadarOptions SetupIntentPaymentMethodDataRadarOptions
    Options to configure Radar. See Radar Session for more information.
    SepaDebit SetupIntentPaymentMethodDataSepaDebit
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    Sofort SetupIntentPaymentMethodDataSofort
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    Upi SetupIntentPaymentMethodDataUpi
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    UsBankAccount SetupIntentPaymentMethodDataUsBankAccount
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    Type string
    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.
    AcssDebit SetupIntentPaymentMethodDataAcssDebit
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    AllowRedisplay string
    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.
    AuBecsDebit SetupIntentPaymentMethodDataAuBecsDebit
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    BacsDebit SetupIntentPaymentMethodDataBacsDebit
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    BillingDetails SetupIntentPaymentMethodDataBillingDetails
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    Boleto SetupIntentPaymentMethodDataBoleto
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    Eps SetupIntentPaymentMethodDataEps
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    Fpx SetupIntentPaymentMethodDataFpx
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    Ideal SetupIntentPaymentMethodDataIdeal
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    Klarna SetupIntentPaymentMethodDataKlarna
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    Metadata map[string]string
    Set of key-value pairs 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.
    NaverPay SetupIntentPaymentMethodDataNaverPay
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    NzBankAccount SetupIntentPaymentMethodDataNzBankAccount
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    P24 SetupIntentPaymentMethodDataP24
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    Payto SetupIntentPaymentMethodDataPayto
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    RadarOptions SetupIntentPaymentMethodDataRadarOptions
    Options to configure Radar. See Radar Session for more information.
    SepaDebit SetupIntentPaymentMethodDataSepaDebit
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    Sofort SetupIntentPaymentMethodDataSofort
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    Upi SetupIntentPaymentMethodDataUpi
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    UsBankAccount SetupIntentPaymentMethodDataUsBankAccount
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    type string
    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.
    acss_debit object
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    allow_redisplay string
    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.
    au_becs_debit object
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    bacs_debit object
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    billing_details object
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    boleto object
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    eps object
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    fpx object
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    ideal object
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    klarna object
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    metadata map(string)
    Set of key-value pairs 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.
    naver_pay object
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    nz_bank_account object
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    p24 object
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    payto object
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    radar_options object
    Options to configure Radar. See Radar Session for more information.
    sepa_debit object
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    sofort object
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    upi object
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    us_bank_account object
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    type String
    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.
    acssDebit SetupIntentPaymentMethodDataAcssDebit
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    allowRedisplay String
    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.
    auBecsDebit SetupIntentPaymentMethodDataAuBecsDebit
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    bacsDebit SetupIntentPaymentMethodDataBacsDebit
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    billingDetails SetupIntentPaymentMethodDataBillingDetails
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    boleto SetupIntentPaymentMethodDataBoleto
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    eps SetupIntentPaymentMethodDataEps
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    fpx SetupIntentPaymentMethodDataFpx
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    ideal SetupIntentPaymentMethodDataIdeal
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    klarna SetupIntentPaymentMethodDataKlarna
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    metadata Map<String,String>
    Set of key-value pairs 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.
    naverPay SetupIntentPaymentMethodDataNaverPay
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    nzBankAccount SetupIntentPaymentMethodDataNzBankAccount
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    p24 SetupIntentPaymentMethodDataP24
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    payto SetupIntentPaymentMethodDataPayto
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    radarOptions SetupIntentPaymentMethodDataRadarOptions
    Options to configure Radar. See Radar Session for more information.
    sepaDebit SetupIntentPaymentMethodDataSepaDebit
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    sofort SetupIntentPaymentMethodDataSofort
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    upi SetupIntentPaymentMethodDataUpi
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    usBankAccount SetupIntentPaymentMethodDataUsBankAccount
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    type string
    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.
    acssDebit SetupIntentPaymentMethodDataAcssDebit
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    allowRedisplay string
    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.
    auBecsDebit SetupIntentPaymentMethodDataAuBecsDebit
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    bacsDebit SetupIntentPaymentMethodDataBacsDebit
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    billingDetails SetupIntentPaymentMethodDataBillingDetails
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    boleto SetupIntentPaymentMethodDataBoleto
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    eps SetupIntentPaymentMethodDataEps
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    fpx SetupIntentPaymentMethodDataFpx
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    ideal SetupIntentPaymentMethodDataIdeal
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    klarna SetupIntentPaymentMethodDataKlarna
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    metadata {[key: string]: string}
    Set of key-value pairs 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.
    naverPay SetupIntentPaymentMethodDataNaverPay
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    nzBankAccount SetupIntentPaymentMethodDataNzBankAccount
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    p24 SetupIntentPaymentMethodDataP24
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    payto SetupIntentPaymentMethodDataPayto
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    radarOptions SetupIntentPaymentMethodDataRadarOptions
    Options to configure Radar. See Radar Session for more information.
    sepaDebit SetupIntentPaymentMethodDataSepaDebit
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    sofort SetupIntentPaymentMethodDataSofort
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    upi SetupIntentPaymentMethodDataUpi
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    usBankAccount SetupIntentPaymentMethodDataUsBankAccount
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    type str
    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.
    acss_debit SetupIntentPaymentMethodDataAcssDebit
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    allow_redisplay str
    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.
    au_becs_debit SetupIntentPaymentMethodDataAuBecsDebit
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    bacs_debit SetupIntentPaymentMethodDataBacsDebit
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    billing_details SetupIntentPaymentMethodDataBillingDetails
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    boleto SetupIntentPaymentMethodDataBoleto
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    eps SetupIntentPaymentMethodDataEps
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    fpx SetupIntentPaymentMethodDataFpx
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    ideal SetupIntentPaymentMethodDataIdeal
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    klarna SetupIntentPaymentMethodDataKlarna
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    metadata Mapping[str, str]
    Set of key-value pairs 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.
    naver_pay SetupIntentPaymentMethodDataNaverPay
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    nz_bank_account SetupIntentPaymentMethodDataNzBankAccount
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    p24 SetupIntentPaymentMethodDataP24
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    payto SetupIntentPaymentMethodDataPayto
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    radar_options SetupIntentPaymentMethodDataRadarOptions
    Options to configure Radar. See Radar Session for more information.
    sepa_debit SetupIntentPaymentMethodDataSepaDebit
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    sofort SetupIntentPaymentMethodDataSofort
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    upi SetupIntentPaymentMethodDataUpi
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    us_bank_account SetupIntentPaymentMethodDataUsBankAccount
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.
    type String
    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.
    acssDebit Property Map
    If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
    allowRedisplay String
    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.
    auBecsDebit Property Map
    If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
    bacsDebit Property Map
    If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
    billingDetails Property Map
    Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
    boleto Property Map
    If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
    eps Property Map
    If this is an eps PaymentMethod, this hash contains details about the EPS payment method.
    fpx Property Map
    If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
    ideal Property Map
    If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
    klarna Property Map
    If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
    metadata Map<String>
    Set of key-value pairs 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.
    naverPay Property Map
    If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
    nzBankAccount Property Map
    If this is an nzbankaccount PaymentMethod, this hash contains details about the nzbankaccount payment method.
    p24 Property Map
    If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
    payto Property Map
    If this is a payto PaymentMethod, this hash contains details about the PayTo payment method.
    radarOptions Property Map
    Options to configure Radar. See Radar Session for more information.
    sepaDebit Property Map
    If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
    sofort Property Map
    If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
    upi Property Map
    If this is a upi PaymentMethod, this hash contains details about the UPI payment method.
    usBankAccount Property Map
    If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

    SetupIntentPaymentMethodDataAcssDebit, SetupIntentPaymentMethodDataAcssDebitArgs

    AccountNumber string
    Customer's bank account number.
    InstitutionNumber string
    Institution number of the customer's bank.
    TransitNumber string
    Transit number of the customer's bank.
    AccountNumber string
    Customer's bank account number.
    InstitutionNumber string
    Institution number of the customer's bank.
    TransitNumber string
    Transit number of the customer's bank.
    account_number string
    Customer's bank account number.
    institution_number string
    Institution number of the customer's bank.
    transit_number string
    Transit number of the customer's bank.
    accountNumber String
    Customer's bank account number.
    institutionNumber String
    Institution number of the customer's bank.
    transitNumber String
    Transit number of the customer's bank.
    accountNumber string
    Customer's bank account number.
    institutionNumber string
    Institution number of the customer's bank.
    transitNumber string
    Transit number of the customer's bank.
    account_number str
    Customer's bank account number.
    institution_number str
    Institution number of the customer's bank.
    transit_number str
    Transit number of the customer's bank.
    accountNumber String
    Customer's bank account number.
    institutionNumber String
    Institution number of the customer's bank.
    transitNumber String
    Transit number of the customer's bank.

    SetupIntentPaymentMethodDataAuBecsDebit, SetupIntentPaymentMethodDataAuBecsDebitArgs

    AccountNumber string
    The account number for the bank account.
    BsbNumber string
    Bank-State-Branch number of the bank account.
    AccountNumber string
    The account number for the bank account.
    BsbNumber string
    Bank-State-Branch number of the bank account.
    account_number string
    The account number for the bank account.
    bsb_number string
    Bank-State-Branch number of the bank account.
    accountNumber String
    The account number for the bank account.
    bsbNumber String
    Bank-State-Branch number of the bank account.
    accountNumber string
    The account number for the bank account.
    bsbNumber string
    Bank-State-Branch number of the bank account.
    account_number str
    The account number for the bank account.
    bsb_number str
    Bank-State-Branch number of the bank account.
    accountNumber String
    The account number for the bank account.
    bsbNumber String
    Bank-State-Branch number of the bank account.

    SetupIntentPaymentMethodDataBacsDebit, SetupIntentPaymentMethodDataBacsDebitArgs

    AccountNumber string
    Account number of the bank account that the funds will be debited from.
    SortCode string
    Sort code of the bank account. (e.g., 10-20-30)
    AccountNumber string
    Account number of the bank account that the funds will be debited from.
    SortCode string
    Sort code of the bank account. (e.g., 10-20-30)
    account_number string
    Account number of the bank account that the funds will be debited from.
    sort_code string
    Sort code of the bank account. (e.g., 10-20-30)
    accountNumber String
    Account number of the bank account that the funds will be debited from.
    sortCode String
    Sort code of the bank account. (e.g., 10-20-30)
    accountNumber string
    Account number of the bank account that the funds will be debited from.
    sortCode string
    Sort code of the bank account. (e.g., 10-20-30)
    account_number str
    Account number of the bank account that the funds will be debited from.
    sort_code str
    Sort code of the bank account. (e.g., 10-20-30)
    accountNumber String
    Account number of the bank account that the funds will be debited from.
    sortCode String
    Sort code of the bank account. (e.g., 10-20-30)

    SetupIntentPaymentMethodDataBillingDetails, SetupIntentPaymentMethodDataBillingDetailsArgs

    Address SetupIntentPaymentMethodDataBillingDetailsAddress
    Billing address.
    Email string
    Email address.
    Name string
    Full name.
    Phone string
    Billing phone number (including extension).
    TaxId string
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    Address SetupIntentPaymentMethodDataBillingDetailsAddress
    Billing address.
    Email string
    Email address.
    Name string
    Full name.
    Phone string
    Billing phone number (including extension).
    TaxId string
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    address object
    Billing address.
    email string
    Email address.
    name string
    Full name.
    phone string
    Billing phone number (including extension).
    tax_id string
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    address SetupIntentPaymentMethodDataBillingDetailsAddress
    Billing address.
    email String
    Email address.
    name String
    Full name.
    phone String
    Billing phone number (including extension).
    taxId String
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    address SetupIntentPaymentMethodDataBillingDetailsAddress
    Billing address.
    email string
    Email address.
    name string
    Full name.
    phone string
    Billing phone number (including extension).
    taxId string
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    address SetupIntentPaymentMethodDataBillingDetailsAddress
    Billing address.
    email str
    Email address.
    name str
    Full name.
    phone str
    Billing phone number (including extension).
    tax_id str
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
    address Property Map
    Billing address.
    email String
    Email address.
    name String
    Full name.
    phone String
    Billing phone number (including extension).
    taxId String
    Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

    SetupIntentPaymentMethodDataBillingDetailsAddress, SetupIntentPaymentMethodDataBillingDetailsAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    SetupIntentPaymentMethodDataBoleto, SetupIntentPaymentMethodDataBoletoArgs

    TaxId string
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    TaxId string
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    tax_id string
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    taxId String
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    taxId string
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    tax_id str
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
    taxId String
    The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)

    SetupIntentPaymentMethodDataEps, SetupIntentPaymentMethodDataEpsArgs

    Bank string
    The customer's bank.
    Bank string
    The customer's bank.
    bank string
    The customer's bank.
    bank String
    The customer's bank.
    bank string
    The customer's bank.
    bank str
    The customer's bank.
    bank String
    The customer's bank.

    SetupIntentPaymentMethodDataFpx, SetupIntentPaymentMethodDataFpxArgs

    Bank string
    The customer's bank.
    AccountHolderType string
    Account holder type for FPX transaction
    Bank string
    The customer's bank.
    AccountHolderType string
    Account holder type for FPX transaction
    bank string
    The customer's bank.
    account_holder_type string
    Account holder type for FPX transaction
    bank String
    The customer's bank.
    accountHolderType String
    Account holder type for FPX transaction
    bank string
    The customer's bank.
    accountHolderType string
    Account holder type for FPX transaction
    bank str
    The customer's bank.
    account_holder_type str
    Account holder type for FPX transaction
    bank String
    The customer's bank.
    accountHolderType String
    Account holder type for FPX transaction

    SetupIntentPaymentMethodDataIdeal, SetupIntentPaymentMethodDataIdealArgs

    Bank string
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    Bank string
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    bank string
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    bank String
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    bank string
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    bank str
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
    bank String
    The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.

    SetupIntentPaymentMethodDataKlarna, SetupIntentPaymentMethodDataKlarnaArgs

    dob object
    Customer's date of birth
    dob Property Map
    Customer's date of birth

    SetupIntentPaymentMethodDataKlarnaDob, SetupIntentPaymentMethodDataKlarnaDobArgs

    Day double
    The day of birth, between 1 and 31.
    Month double
    The month of birth, between 1 and 12.
    Year double
    The four-digit year of birth.
    Day float64
    The day of birth, between 1 and 31.
    Month float64
    The month of birth, between 1 and 12.
    Year float64
    The four-digit year of birth.
    day number
    The day of birth, between 1 and 31.
    month number
    The month of birth, between 1 and 12.
    year number
    The four-digit year of birth.
    day Double
    The day of birth, between 1 and 31.
    month Double
    The month of birth, between 1 and 12.
    year Double
    The four-digit year of birth.
    day number
    The day of birth, between 1 and 31.
    month number
    The month of birth, between 1 and 12.
    year number
    The four-digit year of birth.
    day float
    The day of birth, between 1 and 31.
    month float
    The month of birth, between 1 and 12.
    year float
    The four-digit year of birth.
    day Number
    The day of birth, between 1 and 31.
    month Number
    The month of birth, between 1 and 12.
    year Number
    The four-digit year of birth.

    SetupIntentPaymentMethodDataNaverPay, SetupIntentPaymentMethodDataNaverPayArgs

    Funding string
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    Funding string
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    funding string
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    funding String
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    funding string
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    funding str
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.
    funding String
    Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to card.

    SetupIntentPaymentMethodDataNzBankAccount, SetupIntentPaymentMethodDataNzBankAccountArgs

    AccountNumber string
    The account number for the bank account.
    BankCode string
    The numeric code for the bank account's bank.
    BranchCode string
    The numeric code for the bank account's bank branch.
    Suffix string
    The suffix of the bank account number.
    AccountHolderName string
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    Reference string
    AccountNumber string
    The account number for the bank account.
    BankCode string
    The numeric code for the bank account's bank.
    BranchCode string
    The numeric code for the bank account's bank branch.
    Suffix string
    The suffix of the bank account number.
    AccountHolderName string
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    Reference string
    account_number string
    The account number for the bank account.
    bank_code string
    The numeric code for the bank account's bank.
    branch_code string
    The numeric code for the bank account's bank branch.
    suffix string
    The suffix of the bank account number.
    account_holder_name string
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    reference string
    accountNumber String
    The account number for the bank account.
    bankCode String
    The numeric code for the bank account's bank.
    branchCode String
    The numeric code for the bank account's bank branch.
    suffix String
    The suffix of the bank account number.
    accountHolderName String
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    reference String
    accountNumber string
    The account number for the bank account.
    bankCode string
    The numeric code for the bank account's bank.
    branchCode string
    The numeric code for the bank account's bank branch.
    suffix string
    The suffix of the bank account number.
    accountHolderName string
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    reference string
    account_number str
    The account number for the bank account.
    bank_code str
    The numeric code for the bank account's bank.
    branch_code str
    The numeric code for the bank account's bank branch.
    suffix str
    The suffix of the bank account number.
    account_holder_name str
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    reference str
    accountNumber String
    The account number for the bank account.
    bankCode String
    The numeric code for the bank account's bank.
    branchCode String
    The numeric code for the bank account's bank branch.
    suffix String
    The suffix of the bank account number.
    accountHolderName String
    The name on the bank account. Only required if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
    reference String

    SetupIntentPaymentMethodDataP24, SetupIntentPaymentMethodDataP24Args

    Bank string
    The customer's bank.
    Bank string
    The customer's bank.
    bank string
    The customer's bank.
    bank String
    The customer's bank.
    bank string
    The customer's bank.
    bank str
    The customer's bank.
    bank String
    The customer's bank.

    SetupIntentPaymentMethodDataPayto, SetupIntentPaymentMethodDataPaytoArgs

    AccountNumber string
    The account number for the bank account.
    BsbNumber string
    Bank-State-Branch number of the bank account.
    PayId string
    The PayID alias for the bank account.
    AccountNumber string
    The account number for the bank account.
    BsbNumber string
    Bank-State-Branch number of the bank account.
    PayId string
    The PayID alias for the bank account.
    account_number string
    The account number for the bank account.
    bsb_number string
    Bank-State-Branch number of the bank account.
    pay_id string
    The PayID alias for the bank account.
    accountNumber String
    The account number for the bank account.
    bsbNumber String
    Bank-State-Branch number of the bank account.
    payId String
    The PayID alias for the bank account.
    accountNumber string
    The account number for the bank account.
    bsbNumber string
    Bank-State-Branch number of the bank account.
    payId string
    The PayID alias for the bank account.
    account_number str
    The account number for the bank account.
    bsb_number str
    Bank-State-Branch number of the bank account.
    pay_id str
    The PayID alias for the bank account.
    accountNumber String
    The account number for the bank account.
    bsbNumber String
    Bank-State-Branch number of the bank account.
    payId String
    The PayID alias for the bank account.

    SetupIntentPaymentMethodDataRadarOptions, SetupIntentPaymentMethodDataRadarOptionsArgs

    Session string
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    Session string
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    session string
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    session String
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    session string
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    session str
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
    session String
    A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

    SetupIntentPaymentMethodDataSepaDebit, SetupIntentPaymentMethodDataSepaDebitArgs

    Iban string
    IBAN of the bank account.
    Iban string
    IBAN of the bank account.
    iban string
    IBAN of the bank account.
    iban String
    IBAN of the bank account.
    iban string
    IBAN of the bank account.
    iban str
    IBAN of the bank account.
    iban String
    IBAN of the bank account.

    SetupIntentPaymentMethodDataSofort, SetupIntentPaymentMethodDataSofortArgs

    Country string
    Two-letter ISO code representing the country the bank account is located in.
    Country string
    Two-letter ISO code representing the country the bank account is located in.
    country string
    Two-letter ISO code representing the country the bank account is located in.
    country String
    Two-letter ISO code representing the country the bank account is located in.
    country string
    Two-letter ISO code representing the country the bank account is located in.
    country str
    Two-letter ISO code representing the country the bank account is located in.
    country String
    Two-letter ISO code representing the country the bank account is located in.

    SetupIntentPaymentMethodDataUpi, SetupIntentPaymentMethodDataUpiArgs

    MandateOptions SetupIntentPaymentMethodDataUpiMandateOptions
    Configuration options for setting up an eMandate
    MandateOptions SetupIntentPaymentMethodDataUpiMandateOptions
    Configuration options for setting up an eMandate
    mandate_options object
    Configuration options for setting up an eMandate
    mandateOptions SetupIntentPaymentMethodDataUpiMandateOptions
    Configuration options for setting up an eMandate
    mandateOptions SetupIntentPaymentMethodDataUpiMandateOptions
    Configuration options for setting up an eMandate
    mandate_options SetupIntentPaymentMethodDataUpiMandateOptions
    Configuration options for setting up an eMandate
    mandateOptions Property Map
    Configuration options for setting up an eMandate

    SetupIntentPaymentMethodDataUpiMandateOptions, SetupIntentPaymentMethodDataUpiMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountType string
    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.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate double
    End date of the mandate or subscription.
    Amount float64
    Amount to be charged for future payments.
    AmountType string
    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.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate float64
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amount_type string
    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.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date number
    End date of the mandate or subscription.
    amount Double
    Amount to be charged for future payments.
    amountType String
    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.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Double
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amountType string
    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.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate number
    End date of the mandate or subscription.
    amount float
    Amount to be charged for future payments.
    amount_type str
    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.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date float
    End date of the mandate or subscription.
    amount Number
    Amount to be charged for future payments.
    amountType String
    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.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Number
    End date of the mandate or subscription.

    SetupIntentPaymentMethodDataUsBankAccount, SetupIntentPaymentMethodDataUsBankAccountArgs

    AccountHolderType string
    Account holder type: individual or company.
    AccountNumber string
    Account number of the bank account.
    AccountType string
    Account type: checkings or savings. Defaults to checking if omitted.
    FinancialConnectionsAccount string
    The ID of a Financial Connections Account to use as a payment method.
    RoutingNumber string
    Routing number of the bank account.
    AccountHolderType string
    Account holder type: individual or company.
    AccountNumber string
    Account number of the bank account.
    AccountType string
    Account type: checkings or savings. Defaults to checking if omitted.
    FinancialConnectionsAccount string
    The ID of a Financial Connections Account to use as a payment method.
    RoutingNumber string
    Routing number of the bank account.
    account_holder_type string
    Account holder type: individual or company.
    account_number string
    Account number of the bank account.
    account_type string
    Account type: checkings or savings. Defaults to checking if omitted.
    financial_connections_account string
    The ID of a Financial Connections Account to use as a payment method.
    routing_number string
    Routing number of the bank account.
    accountHolderType String
    Account holder type: individual or company.
    accountNumber String
    Account number of the bank account.
    accountType String
    Account type: checkings or savings. Defaults to checking if omitted.
    financialConnectionsAccount String
    The ID of a Financial Connections Account to use as a payment method.
    routingNumber String
    Routing number of the bank account.
    accountHolderType string
    Account holder type: individual or company.
    accountNumber string
    Account number of the bank account.
    accountType string
    Account type: checkings or savings. Defaults to checking if omitted.
    financialConnectionsAccount string
    The ID of a Financial Connections Account to use as a payment method.
    routingNumber string
    Routing number of the bank account.
    account_holder_type str
    Account holder type: individual or company.
    account_number str
    Account number of the bank account.
    account_type str
    Account type: checkings or savings. Defaults to checking if omitted.
    financial_connections_account str
    The ID of a Financial Connections Account to use as a payment method.
    routing_number str
    Routing number of the bank account.
    accountHolderType String
    Account holder type: individual or company.
    accountNumber String
    Account number of the bank account.
    accountType String
    Account type: checkings or savings. Defaults to checking if omitted.
    financialConnectionsAccount String
    The ID of a Financial Connections Account to use as a payment method.
    routingNumber String
    Routing number of the bank account.

    SetupIntentPaymentMethodOptions, SetupIntentPaymentMethodOptionsArgs

    SetupIntentPaymentMethodOptionsAcssDebit, SetupIntentPaymentMethodOptionsAcssDebitArgs

    Currency string
    Currency supported by the bank account
    MandateOptions SetupIntentPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    Currency string
    Currency supported by the bank account
    MandateOptions SetupIntentPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    currency string
    Currency supported by the bank account
    mandate_options object
    verification_method string
    Bank account verification method. The default value is automatic.
    currency String
    Currency supported by the bank account
    mandateOptions SetupIntentPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod String
    Bank account verification method. The default value is automatic.
    currency string
    Currency supported by the bank account
    mandateOptions SetupIntentPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod string
    Bank account verification method. The default value is automatic.
    currency str
    Currency supported by the bank account
    mandate_options SetupIntentPaymentMethodOptionsAcssDebitMandateOptions
    verification_method str
    Bank account verification method. The default value is automatic.
    currency String
    Currency supported by the bank account
    mandateOptions Property Map
    verificationMethod String
    Bank account verification method. The default value is automatic.

    SetupIntentPaymentMethodOptionsAcssDebitMandateOptions, SetupIntentPaymentMethodOptionsAcssDebitMandateOptionsArgs

    CustomMandateUrl string
    A URL for custom mandate text
    DefaultFors List<string>
    List of Stripe products where this mandate can be selected automatically.
    IntervalDescription string
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    PaymentSchedule string
    Payment schedule for the mandate.
    TransactionType string
    Transaction type of the mandate.
    CustomMandateUrl string
    A URL for custom mandate text
    DefaultFors []string
    List of Stripe products where this mandate can be selected automatically.
    IntervalDescription string
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    PaymentSchedule string
    Payment schedule for the mandate.
    TransactionType string
    Transaction type of the mandate.
    custom_mandate_url string
    A URL for custom mandate text
    default_fors list(string)
    List of Stripe products where this mandate can be selected automatically.
    interval_description string
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    payment_schedule string
    Payment schedule for the mandate.
    transaction_type string
    Transaction type of the mandate.
    customMandateUrl String
    A URL for custom mandate text
    defaultFors List<String>
    List of Stripe products where this mandate can be selected automatically.
    intervalDescription String
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    paymentSchedule String
    Payment schedule for the mandate.
    transactionType String
    Transaction type of the mandate.
    customMandateUrl string
    A URL for custom mandate text
    defaultFors string[]
    List of Stripe products where this mandate can be selected automatically.
    intervalDescription string
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    paymentSchedule string
    Payment schedule for the mandate.
    transactionType string
    Transaction type of the mandate.
    custom_mandate_url str
    A URL for custom mandate text
    default_fors Sequence[str]
    List of Stripe products where this mandate can be selected automatically.
    interval_description str
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    payment_schedule str
    Payment schedule for the mandate.
    transaction_type str
    Transaction type of the mandate.
    customMandateUrl String
    A URL for custom mandate text
    defaultFors List<String>
    List of Stripe products where this mandate can be selected automatically.
    intervalDescription String
    Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
    paymentSchedule String
    Payment schedule for the mandate.
    transactionType String
    Transaction type of the mandate.

    SetupIntentPaymentMethodOptionsBacsDebit, SetupIntentPaymentMethodOptionsBacsDebitArgs

    SetupIntentPaymentMethodOptionsBacsDebitMandateOptions, SetupIntentPaymentMethodOptionsBacsDebitMandateOptionsArgs

    ReferencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    ReferencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    reference_prefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    referencePrefix String
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    referencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    reference_prefix str
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
    referencePrefix String
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.

    SetupIntentPaymentMethodOptionsCard, SetupIntentPaymentMethodOptionsCardArgs

    MandateOptions SetupIntentPaymentMethodOptionsCardMandateOptions
    Configuration options for setting up an eMandate for cards issued in India.
    Moto bool
    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.
    Network string
    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.
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    ThreeDSecure SetupIntentPaymentMethodOptionsCardThreeDSecure
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    MandateOptions SetupIntentPaymentMethodOptionsCardMandateOptions
    Configuration options for setting up an eMandate for cards issued in India.
    Moto bool
    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.
    Network string
    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.
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    ThreeDSecure SetupIntentPaymentMethodOptionsCardThreeDSecure
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    mandate_options object
    Configuration options for setting up an eMandate for cards issued in India.
    moto bool
    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.
    network string
    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.
    request_three_d_secure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    three_d_secure object
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    mandateOptions SetupIntentPaymentMethodOptionsCardMandateOptions
    Configuration options for setting up an eMandate for cards issued in India.
    moto Boolean
    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.
    network String
    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.
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    threeDSecure SetupIntentPaymentMethodOptionsCardThreeDSecure
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    mandateOptions SetupIntentPaymentMethodOptionsCardMandateOptions
    Configuration options for setting up an eMandate for cards issued in India.
    moto boolean
    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.
    network string
    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.
    requestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    threeDSecure SetupIntentPaymentMethodOptionsCardThreeDSecure
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    mandate_options SetupIntentPaymentMethodOptionsCardMandateOptions
    Configuration options for setting up an eMandate for cards issued in India.
    moto bool
    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.
    network str
    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.
    request_three_d_secure str
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    three_d_secure SetupIntentPaymentMethodOptionsCardThreeDSecure
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.
    mandateOptions Property Map
    Configuration options for setting up an eMandate for cards issued in India.
    moto Boolean
    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.
    network String
    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.
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.
    threeDSecure Property Map
    If 3D Secure authentication was performed with a third-party provider, the authentication details to use for this setup.

    SetupIntentPaymentMethodOptionsCardMandateOptions, SetupIntentPaymentMethodOptionsCardMandateOptionsArgs

    Amount double
    Amount to be charged for future payments, specified in the presentment currency.
    AmountType string
    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.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Interval string
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    Reference string
    Unique identifier for the mandate or subscription.
    StartDate double
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate double
    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.
    IntervalCount double
    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.
    SupportedTypes List<string>
    Specifies the type of mandates supported. Possible values are india.
    Amount float64
    Amount to be charged for future payments, specified in the presentment currency.
    AmountType string
    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.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Interval string
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    Reference string
    Unique identifier for the mandate or subscription.
    StartDate float64
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate float64
    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.
    IntervalCount float64
    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.
    SupportedTypes []string
    Specifies the type of mandates supported. Possible values are india.
    amount number
    Amount to be charged for future payments, specified in the presentment currency.
    amount_type string
    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.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    interval string
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    reference string
    Unique identifier for the mandate or subscription.
    start_date number
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date number
    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.
    interval_count number
    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.
    supported_types list(string)
    Specifies the type of mandates supported. Possible values are india.
    amount Double
    Amount to be charged for future payments, specified in the presentment currency.
    amountType String
    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.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    interval String
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    reference String
    Unique identifier for the mandate or subscription.
    startDate Double
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Double
    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.
    intervalCount Double
    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.
    supportedTypes List<String>
    Specifies the type of mandates supported. Possible values are india.
    amount number
    Amount to be charged for future payments, specified in the presentment currency.
    amountType string
    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.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    interval string
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    reference string
    Unique identifier for the mandate or subscription.
    startDate number
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate number
    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.
    intervalCount number
    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.
    supportedTypes string[]
    Specifies the type of mandates supported. Possible values are india.
    amount float
    Amount to be charged for future payments, specified in the presentment currency.
    amount_type str
    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.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    interval str
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    reference str
    Unique identifier for the mandate or subscription.
    start_date float
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date float
    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.
    interval_count float
    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.
    supported_types Sequence[str]
    Specifies the type of mandates supported. Possible values are india.
    amount Number
    Amount to be charged for future payments, specified in the presentment currency.
    amountType String
    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.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    interval String
    Specifies payment frequency. One of day, week, month, year, or sporadic.
    reference String
    Unique identifier for the mandate or subscription.
    startDate Number
    Start date of the mandate or subscription. Start date should not be lesser than yesterday.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Number
    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.
    intervalCount Number
    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.
    supportedTypes List<String>
    Specifies the type of mandates supported. Possible values are india.

    SetupIntentPaymentMethodOptionsCardThreeDSecure, SetupIntentPaymentMethodOptionsCardThreeDSecureArgs

    AresTransStatus string
    The transStatus returned from the card Issuer’s ACS in the ARes.
    Cryptogram string
    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.)
    ElectronicCommerceIndicator string
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    NetworkOptions SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    RequestorChallengeIndicator string
    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.
    TransactionId string
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    Version string
    The version of 3D Secure that was performed.
    AresTransStatus string
    The transStatus returned from the card Issuer’s ACS in the ARes.
    Cryptogram string
    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.)
    ElectronicCommerceIndicator string
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    NetworkOptions SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    RequestorChallengeIndicator string
    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.
    TransactionId string
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    Version string
    The version of 3D Secure that was performed.
    ares_trans_status string
    The transStatus returned from the card Issuer’s ACS in the ARes.
    cryptogram string
    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.)
    electronic_commerce_indicator string
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    network_options object
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    requestor_challenge_indicator string
    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.
    transaction_id string
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    version string
    The version of 3D Secure that was performed.
    aresTransStatus String
    The transStatus returned from the card Issuer’s ACS in the ARes.
    cryptogram String
    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.)
    electronicCommerceIndicator String
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    networkOptions SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    requestorChallengeIndicator String
    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.
    transactionId String
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    version String
    The version of 3D Secure that was performed.
    aresTransStatus string
    The transStatus returned from the card Issuer’s ACS in the ARes.
    cryptogram string
    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.)
    electronicCommerceIndicator string
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    networkOptions SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    requestorChallengeIndicator string
    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.
    transactionId string
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    version string
    The version of 3D Secure that was performed.
    ares_trans_status str
    The transStatus returned from the card Issuer’s ACS in the ARes.
    cryptogram str
    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.)
    electronic_commerce_indicator str
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    network_options SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    requestor_challenge_indicator str
    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.
    transaction_id str
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    version str
    The version of 3D Secure that was performed.
    aresTransStatus String
    The transStatus returned from the card Issuer’s ACS in the ARes.
    cryptogram String
    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.)
    electronicCommerceIndicator String
    The Electronic Commerce Indicator (ECI) is returned by your 3D Secure provider and indicates what degree of authentication was performed.
    networkOptions Property Map
    Network specific 3DS fields. Network specific arguments require an explicit card brand choice. The parameter `payment_method_options.card.network`` must be populated accordingly
    requestorChallengeIndicator String
    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.
    transactionId String
    For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server Transaction ID (dsTransID).
    version String
    The version of 3D Secure that was performed.

    SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptions, SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsArgs

    cartes_bancaires object
    Cartes Bancaires-specific 3DS fields.
    cartesBancaires Property Map
    Cartes Bancaires-specific 3DS fields.

    SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancaires, SetupIntentPaymentMethodOptionsCardThreeDSecureNetworkOptionsCartesBancairesArgs

    CbAvalgo string
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    CbExemption string
    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
    CbScore double
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    CbAvalgo string
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    CbExemption string
    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
    CbScore float64
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    cb_avalgo string
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    cb_exemption string
    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
    cb_score number
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    cbAvalgo String
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    cbExemption String
    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
    cbScore Double
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    cbAvalgo string
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    cbExemption string
    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
    cbScore number
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    cb_avalgo str
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    cb_exemption str
    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
    cb_score float
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99
    cbAvalgo String
    The cryptogram calculation algorithm used by the card Issuer's ACS to calculate the Authentication cryptogram. Also known as cavvAlgorithm. messageExtension: CB-AVALGO
    cbExemption String
    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
    cbScore Number
    The risk score returned from Cartes Bancaires in the ARes. message extension: CB-SCORE; numeric value 0-99

    SetupIntentPaymentMethodOptionsKlarna, SetupIntentPaymentMethodOptionsKlarnaArgs

    Currency string
    The currency of the setup intent. Three letter ISO currency code.
    OnDemand SetupIntentPaymentMethodOptionsKlarnaOnDemand
    On-demand details if setting up a payment method for on-demand payments.
    PreferredLocale string
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    Subscriptions List<SetupIntentPaymentMethodOptionsKlarnaSubscription>
    Subscription details if setting up or charging a subscription
    Currency string
    The currency of the setup intent. Three letter ISO currency code.
    OnDemand SetupIntentPaymentMethodOptionsKlarnaOnDemand
    On-demand details if setting up a payment method for on-demand payments.
    PreferredLocale string
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    Subscriptions []SetupIntentPaymentMethodOptionsKlarnaSubscription
    Subscription details if setting up or charging a subscription
    currency string
    The currency of the setup intent. Three letter ISO currency code.
    on_demand object
    On-demand details if setting up a payment method for on-demand payments.
    preferred_locale string
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    subscriptions list(object)
    Subscription details if setting up or charging a subscription
    currency String
    The currency of the setup intent. Three letter ISO currency code.
    onDemand SetupIntentPaymentMethodOptionsKlarnaOnDemand
    On-demand details if setting up a payment method for on-demand payments.
    preferredLocale String
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    subscriptions List<SetupIntentPaymentMethodOptionsKlarnaSubscription>
    Subscription details if setting up or charging a subscription
    currency string
    The currency of the setup intent. Three letter ISO currency code.
    onDemand SetupIntentPaymentMethodOptionsKlarnaOnDemand
    On-demand details if setting up a payment method for on-demand payments.
    preferredLocale string
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    subscriptions SetupIntentPaymentMethodOptionsKlarnaSubscription[]
    Subscription details if setting up or charging a subscription
    currency str
    The currency of the setup intent. Three letter ISO currency code.
    on_demand SetupIntentPaymentMethodOptionsKlarnaOnDemand
    On-demand details if setting up a payment method for on-demand payments.
    preferred_locale str
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    subscriptions Sequence[SetupIntentPaymentMethodOptionsKlarnaSubscription]
    Subscription details if setting up or charging a subscription
    currency String
    The currency of the setup intent. Three letter ISO currency code.
    onDemand Property Map
    On-demand details if setting up a payment method for on-demand payments.
    preferredLocale String
    Preferred locale of the Klarna checkout page that the customer is redirected to.
    subscriptions List<Property Map>
    Subscription details if setting up or charging a subscription

    SetupIntentPaymentMethodOptionsKlarnaOnDemand, SetupIntentPaymentMethodOptionsKlarnaOnDemandArgs

    AverageAmount double
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    MaximumAmount double
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    MinimumAmount double
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    PurchaseInterval string
    Interval at which the customer is making purchases
    PurchaseIntervalCount double
    The number of purchase_interval between charges
    AverageAmount float64
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    MaximumAmount float64
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    MinimumAmount float64
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    PurchaseInterval string
    Interval at which the customer is making purchases
    PurchaseIntervalCount float64
    The number of purchase_interval between charges
    average_amount number
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    maximum_amount number
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    minimum_amount number
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    purchase_interval string
    Interval at which the customer is making purchases
    purchase_interval_count number
    The number of purchase_interval between charges
    averageAmount Double
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    maximumAmount Double
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    minimumAmount Double
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    purchaseInterval String
    Interval at which the customer is making purchases
    purchaseIntervalCount Double
    The number of purchase_interval between charges
    averageAmount number
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    maximumAmount number
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    minimumAmount number
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    purchaseInterval string
    Interval at which the customer is making purchases
    purchaseIntervalCount number
    The number of purchase_interval between charges
    average_amount float
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    maximum_amount float
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    minimum_amount float
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    purchase_interval str
    Interval at which the customer is making purchases
    purchase_interval_count float
    The number of purchase_interval between charges
    averageAmount Number
    Your average amount value. You can use a value across your customer base, or segment based on customer type, country, etc.
    maximumAmount Number
    The maximum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    minimumAmount Number
    The lowest or minimum value you may charge a customer per purchase. You can use a value across your customer base, or segment based on customer type, country, etc.
    purchaseInterval String
    Interval at which the customer is making purchases
    purchaseIntervalCount Number
    The number of purchase_interval between charges

    SetupIntentPaymentMethodOptionsKlarnaSubscription, SetupIntentPaymentMethodOptionsKlarnaSubscriptionArgs

    Interval string
    Unit of time between subscription charges.
    NextBilling SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling
    Describes the upcoming charge for this subscription.
    Reference string
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    IntervalCount double
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    Name string
    Name for subscription.
    Interval string
    Unit of time between subscription charges.
    NextBilling SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling
    Describes the upcoming charge for this subscription.
    Reference string
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    IntervalCount float64
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    Name string
    Name for subscription.
    interval string
    Unit of time between subscription charges.
    next_billing object
    Describes the upcoming charge for this subscription.
    reference string
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    interval_count number
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    name string
    Name for subscription.
    interval String
    Unit of time between subscription charges.
    nextBilling SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling
    Describes the upcoming charge for this subscription.
    reference String
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    intervalCount Double
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    name String
    Name for subscription.
    interval string
    Unit of time between subscription charges.
    nextBilling SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling
    Describes the upcoming charge for this subscription.
    reference string
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    intervalCount number
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    name string
    Name for subscription.
    interval str
    Unit of time between subscription charges.
    next_billing SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling
    Describes the upcoming charge for this subscription.
    reference str
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    interval_count float
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    name str
    Name for subscription.
    interval String
    Unit of time between subscription charges.
    nextBilling Property Map
    Describes the upcoming charge for this subscription.
    reference String
    A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
    intervalCount Number
    The number of intervals (specified in the interval attribute) between subscription charges. For example, interval=month and interval_count=3 charges every 3 months.
    name String
    Name for subscription.

    SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBilling, SetupIntentPaymentMethodOptionsKlarnaSubscriptionNextBillingArgs

    Amount double
    The amount of the next charge for the subscription.
    Date string
    The date of the next charge for the subscription in YYYY-MM-DD format.
    Amount float64
    The amount of the next charge for the subscription.
    Date string
    The date of the next charge for the subscription in YYYY-MM-DD format.
    amount number
    The amount of the next charge for the subscription.
    date string
    The date of the next charge for the subscription in YYYY-MM-DD format.
    amount Double
    The amount of the next charge for the subscription.
    date String
    The date of the next charge for the subscription in YYYY-MM-DD format.
    amount number
    The amount of the next charge for the subscription.
    date string
    The date of the next charge for the subscription in YYYY-MM-DD format.
    amount float
    The amount of the next charge for the subscription.
    date str
    The date of the next charge for the subscription in YYYY-MM-DD format.
    amount Number
    The amount of the next charge for the subscription.
    date String
    The date of the next charge for the subscription in YYYY-MM-DD format.
    PersistentToken string
    [Deprecated] This is a legacy parameter that no longer has any function.
    PersistentToken string
    [Deprecated] This is a legacy parameter that no longer has any function.
    persistent_token string
    [Deprecated] This is a legacy parameter that no longer has any function.
    persistentToken String
    [Deprecated] This is a legacy parameter that no longer has any function.
    persistentToken string
    [Deprecated] This is a legacy parameter that no longer has any function.
    persistent_token str
    [Deprecated] This is a legacy parameter that no longer has any function.
    persistentToken String
    [Deprecated] This is a legacy parameter that no longer has any function.

    SetupIntentPaymentMethodOptionsPaypal, SetupIntentPaymentMethodOptionsPaypalArgs

    BillingAgreementId string
    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
    The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
    billing_agreement_id string
    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
    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
    The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
    billing_agreement_id str
    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
    The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

    SetupIntentPaymentMethodOptionsPayto, SetupIntentPaymentMethodOptionsPaytoArgs

    SetupIntentPaymentMethodOptionsPaytoMandateOptions, SetupIntentPaymentMethodOptionsPaytoMandateOptionsArgs

    Amount double
    Amount that will be collected. It is required when amount_type is fixed.
    AmountType string
    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. Defaults to maximum.
    EndDate string
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    PaymentSchedule string
    The periodicity at which payments will be collected. Defaults to adhoc.
    PaymentsPerPeriod double
    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.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    StartDate string
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    Amount float64
    Amount that will be collected. It is required when amount_type is fixed.
    AmountType string
    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. Defaults to maximum.
    EndDate string
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    PaymentSchedule string
    The periodicity at which payments will be collected. Defaults to adhoc.
    PaymentsPerPeriod float64
    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.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    StartDate string
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    amount number
    Amount that will be collected. It is required when amount_type is fixed.
    amount_type string
    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. Defaults to maximum.
    end_date string
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    payment_schedule string
    The periodicity at which payments will be collected. Defaults to adhoc.
    payments_per_period number
    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.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    start_date string
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    amount Double
    Amount that will be collected. It is required when amount_type is fixed.
    amountType String
    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. Defaults to maximum.
    endDate String
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    paymentSchedule String
    The periodicity at which payments will be collected. Defaults to adhoc.
    paymentsPerPeriod Double
    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.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.
    startDate String
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    amount number
    Amount that will be collected. It is required when amount_type is fixed.
    amountType string
    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. Defaults to maximum.
    endDate string
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    paymentSchedule string
    The periodicity at which payments will be collected. Defaults to adhoc.
    paymentsPerPeriod number
    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.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    startDate string
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    amount float
    Amount that will be collected. It is required when amount_type is fixed.
    amount_type str
    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. Defaults to maximum.
    end_date str
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    payment_schedule str
    The periodicity at which payments will be collected. Defaults to adhoc.
    payments_per_period float
    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.
    purpose str
    The purpose for which payments are made. Has a default value based on your merchant category code.
    start_date str
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
    amount Number
    Amount that will be collected. It is required when amount_type is fixed.
    amountType String
    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. Defaults to maximum.
    endDate String
    Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
    paymentSchedule String
    The periodicity at which payments will be collected. Defaults to adhoc.
    paymentsPerPeriod Number
    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.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.
    startDate String
    Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.

    SetupIntentPaymentMethodOptionsPix, SetupIntentPaymentMethodOptionsPixArgs

    SetupIntentPaymentMethodOptionsPixMandateOptions, SetupIntentPaymentMethodOptionsPixMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    AmountType string
    Type of amount.
    Currency string
    Three-letter ISO currency code, in lowercase.
    EndDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    PaymentSchedule string
    Schedule at which the future payments will be charged.
    Reference string
    Subscription name displayed to buyers in their bank app.
    StartDate string
    Start date of the mandate, in YYYY-MM-DD.
    Amount float64
    Amount to be charged for future payments.
    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    AmountType string
    Type of amount.
    Currency string
    Three-letter ISO currency code, in lowercase.
    EndDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    PaymentSchedule string
    Schedule at which the future payments will be charged.
    Reference string
    Subscription name displayed to buyers in their bank app.
    StartDate string
    Start date of the mandate, in YYYY-MM-DD.
    amount number
    Amount to be charged for future payments.
    amount_includes_iof string
    Determines if the amount includes the IOF tax.
    amount_type string
    Type of amount.
    currency string
    Three-letter ISO currency code, in lowercase.
    end_date string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    payment_schedule string
    Schedule at which the future payments will be charged.
    reference string
    Subscription name displayed to buyers in their bank app.
    start_date string
    Start date of the mandate, in YYYY-MM-DD.
    amount Double
    Amount to be charged for future payments.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    amountType String
    Type of amount.
    currency String
    Three-letter ISO currency code, in lowercase.
    endDate String
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule String
    Schedule at which the future payments will be charged.
    reference String
    Subscription name displayed to buyers in their bank app.
    startDate String
    Start date of the mandate, in YYYY-MM-DD.
    amount number
    Amount to be charged for future payments.
    amountIncludesIof string
    Determines if the amount includes the IOF tax.
    amountType string
    Type of amount.
    currency string
    Three-letter ISO currency code, in lowercase.
    endDate string
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule string
    Schedule at which the future payments will be charged.
    reference string
    Subscription name displayed to buyers in their bank app.
    startDate string
    Start date of the mandate, in YYYY-MM-DD.
    amount float
    Amount to be charged for future payments.
    amount_includes_iof str
    Determines if the amount includes the IOF tax.
    amount_type str
    Type of amount.
    currency str
    Three-letter ISO currency code, in lowercase.
    end_date str
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    payment_schedule str
    Schedule at which the future payments will be charged.
    reference str
    Subscription name displayed to buyers in their bank app.
    start_date str
    Start date of the mandate, in YYYY-MM-DD.
    amount Number
    Amount to be charged for future payments.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    amountType String
    Type of amount.
    currency String
    Three-letter ISO currency code, in lowercase.
    endDate String
    Date when the mandate expires and no further payments will be charged, in YYYY-MM-DD.
    paymentSchedule String
    Schedule at which the future payments will be charged.
    reference String
    Subscription name displayed to buyers in their bank app.
    startDate String
    Start date of the mandate, in YYYY-MM-DD.

    SetupIntentPaymentMethodOptionsSepaDebit, SetupIntentPaymentMethodOptionsSepaDebitArgs

    SetupIntentPaymentMethodOptionsSepaDebitMandateOptions, SetupIntentPaymentMethodOptionsSepaDebitMandateOptionsArgs

    ReferencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    ReferencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    reference_prefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    referencePrefix String
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    referencePrefix string
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    reference_prefix str
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
    referencePrefix String
    Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.

    SetupIntentPaymentMethodOptionsUpi, SetupIntentPaymentMethodOptionsUpiArgs

    SetupIntentPaymentMethodOptionsUpiMandateOptions, SetupIntentPaymentMethodOptionsUpiMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountType string
    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.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate double
    End date of the mandate or subscription.
    Amount float64
    Amount to be charged for future payments.
    AmountType string
    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.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate float64
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amount_type string
    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.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date number
    End date of the mandate or subscription.
    amount Double
    Amount to be charged for future payments.
    amountType String
    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.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Double
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amountType string
    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.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate number
    End date of the mandate or subscription.
    amount float
    Amount to be charged for future payments.
    amount_type str
    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.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date float
    End date of the mandate or subscription.
    amount Number
    Amount to be charged for future payments.
    amountType String
    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.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Number
    End date of the mandate or subscription.

    SetupIntentPaymentMethodOptionsUsBankAccount, SetupIntentPaymentMethodOptionsUsBankAccountArgs

    financial_connections object
    mandate_options object
    networks object
    Additional fields for network related functions
    verification_method string
    Bank account verification method. The default value is automatic.
    financialConnections Property Map
    mandateOptions Property Map
    networks Property Map
    Additional fields for network related functions
    verificationMethod String
    Bank account verification method. The default value is automatic.

    SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnections, SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs

    Filters SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions List<string>
    The list of permissions to request. The payment_method permission must be included.
    Prefetches List<string>
    Data features requested to be retrieved upon account creation.
    ReturnUrl string
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    Filters SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions []string
    The list of permissions to request. The payment_method permission must be included.
    Prefetches []string
    Data features requested to be retrieved upon account creation.
    ReturnUrl string
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    filters object
    permissions list(string)
    The list of permissions to request. The payment_method permission must be included.
    prefetches list(string)
    Data features requested to be retrieved upon account creation.
    return_url string
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    filters SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.
    returnUrl String
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    filters SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions string[]
    The list of permissions to request. The payment_method permission must be included.
    prefetches string[]
    Data features requested to be retrieved upon account creation.
    returnUrl string
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    filters SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions Sequence[str]
    The list of permissions to request. The payment_method permission must be included.
    prefetches Sequence[str]
    Data features requested to be retrieved upon account creation.
    return_url str
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
    filters Property Map
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.
    returnUrl String
    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

    SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters, SetupIntentPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs

    AccountSubcategories List<string>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    AccountSubcategories []string
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories list(string)
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories string[]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories Sequence[str]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.

    SetupIntentPaymentMethodOptionsUsBankAccountMandateOptions, SetupIntentPaymentMethodOptionsUsBankAccountMandateOptionsArgs

    CollectionMethod string
    Mandate collection method
    CollectionMethod string
    Mandate collection method
    collection_method string
    Mandate collection method
    collectionMethod String
    Mandate collection method
    collectionMethod string
    Mandate collection method
    collection_method str
    Mandate collection method
    collectionMethod String
    Mandate collection method

    SetupIntentPaymentMethodOptionsUsBankAccountNetworks, SetupIntentPaymentMethodOptionsUsBankAccountNetworksArgs

    Requesteds List<string>
    Triggers validations to run across the selected networks
    Requesteds []string
    Triggers validations to run across the selected networks
    requesteds list(string)
    Triggers validations to run across the selected networks
    requesteds List<String>
    Triggers validations to run across the selected networks
    requesteds string[]
    Triggers validations to run across the selected networks
    requesteds Sequence[str]
    Triggers validations to run across the selected networks
    requesteds List<String>
    Triggers validations to run across the selected networks

    SetupIntentSingleUse, SetupIntentSingleUseArgs

    Amount double
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Amount float64
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    amount number
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    amount Double
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    amount number
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    amount float
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    amount Number
    Amount the customer is granting permission to collect later. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial