1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. Source
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi

    Source objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

    Stripe doesn’t recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

    Related guides: Sources API and Sources & Customers.

    Create Source Resource

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

    Constructor syntax

    new Source(name: string, args?: SourceArgs, opts?: CustomResourceOptions);
    @overload
    def Source(resource_name: str,
               args: Optional[SourceArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Source(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               amount: Optional[float] = None,
               currency: Optional[str] = None,
               customer: Optional[str] = None,
               flow: Optional[str] = None,
               mandate: Optional[SourceMandateArgs] = None,
               metadata: Optional[Mapping[str, str]] = None,
               original_source: Optional[str] = None,
               owner: Optional[SourceOwnerArgs] = None,
               receiver: Optional[SourceReceiverArgs] = None,
               redirect: Optional[SourceRedirectArgs] = None,
               source_order: Optional[SourceSourceOrderArgs] = None,
               statement_descriptor: Optional[str] = None,
               token: Optional[str] = None,
               type: Optional[str] = None,
               usage: Optional[str] = None)
    func NewSource(ctx *Context, name string, args *SourceArgs, opts ...ResourceOption) (*Source, error)
    public Source(string name, SourceArgs? args = null, CustomResourceOptions? opts = null)
    public Source(String name, SourceArgs args)
    public Source(String name, SourceArgs args, CustomResourceOptions options)
    
    type: stripe:Source
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "stripe_source" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SourceArgs
    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 SourceArgs
    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 SourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceArgs
    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 sourceResource = new Stripe.Source("sourceResource", new()
    {
        Amount = 0.0,
        Currency = "string",
        Customer = "string",
        Flow = "string",
        Mandate = new Stripe.Inputs.SourceMandateArgs
        {
            Acceptance = new Stripe.Inputs.SourceMandateAcceptanceArgs
            {
                Status = "string",
                Date = 0.0,
                Ip = "string",
                Offline = new Stripe.Inputs.SourceMandateAcceptanceOfflineArgs
                {
                    ContactEmail = "string",
                },
                Online = new Stripe.Inputs.SourceMandateAcceptanceOnlineArgs
                {
                    Date = 0.0,
                    Ip = "string",
                    UserAgent = "string",
                },
                Type = "string",
                UserAgent = "string",
            },
            Amount = 0.0,
            Currency = "string",
            Interval = "string",
            NotificationMethod = "string",
        },
        Metadata = 
        {
            { "string", "string" },
        },
        OriginalSource = "string",
        Owner = new Stripe.Inputs.SourceOwnerArgs
        {
            Address = new Stripe.Inputs.SourceOwnerAddressArgs
            {
                City = "string",
                Country = "string",
                Line1 = "string",
                Line2 = "string",
                PostalCode = "string",
                State = "string",
            },
            Email = "string",
            Name = "string",
            Phone = "string",
            VerifiedAddress = new Stripe.Inputs.SourceOwnerVerifiedAddressArgs
            {
                City = "string",
                Country = "string",
                Line1 = "string",
                Line2 = "string",
                PostalCode = "string",
                State = "string",
            },
            VerifiedEmail = "string",
            VerifiedName = "string",
            VerifiedPhone = "string",
        },
        Receiver = new Stripe.Inputs.SourceReceiverArgs
        {
            Address = "string",
            AmountCharged = 0.0,
            AmountReceived = 0.0,
            AmountReturned = 0.0,
            RefundAttributesMethod = "string",
            RefundAttributesStatus = "string",
        },
        Redirect = new Stripe.Inputs.SourceRedirectArgs
        {
            ReturnUrl = "string",
            FailureReason = "string",
            Status = "string",
            Url = "string",
        },
        SourceOrder = new Stripe.Inputs.SourceSourceOrderArgs
        {
            Amount = 0.0,
            Currency = "string",
            Email = "string",
            Items = new[]
            {
                new Stripe.Inputs.SourceSourceOrderItemArgs
                {
                    Amount = 0.0,
                    Currency = "string",
                    Description = "string",
                    Parent = "string",
                    Quantity = 0.0,
                    Type = "string",
                },
            },
            Shipping = new Stripe.Inputs.SourceSourceOrderShippingArgs
            {
                Address = new Stripe.Inputs.SourceSourceOrderShippingAddressArgs
                {
                    Line1 = "string",
                    City = "string",
                    Country = "string",
                    Line2 = "string",
                    PostalCode = "string",
                    State = "string",
                },
                Carrier = "string",
                Name = "string",
                Phone = "string",
                TrackingNumber = "string",
            },
        },
        StatementDescriptor = "string",
        Token = "string",
        Type = "string",
        Usage = "string",
    });
    
    example, err := stripe.NewSource(ctx, "sourceResource", &stripe.SourceArgs{
    	Amount:   pulumi.Float64(0),
    	Currency: pulumi.String("string"),
    	Customer: pulumi.String("string"),
    	Flow:     pulumi.String("string"),
    	Mandate: &stripe.SourceMandateArgs{
    		Acceptance: &stripe.SourceMandateAcceptanceArgs{
    			Status: pulumi.String("string"),
    			Date:   pulumi.Float64(0),
    			Ip:     pulumi.String("string"),
    			Offline: &stripe.SourceMandateAcceptanceOfflineArgs{
    				ContactEmail: pulumi.String("string"),
    			},
    			Online: &stripe.SourceMandateAcceptanceOnlineArgs{
    				Date:      pulumi.Float64(0),
    				Ip:        pulumi.String("string"),
    				UserAgent: pulumi.String("string"),
    			},
    			Type:      pulumi.String("string"),
    			UserAgent: pulumi.String("string"),
    		},
    		Amount:             pulumi.Float64(0),
    		Currency:           pulumi.String("string"),
    		Interval:           pulumi.String("string"),
    		NotificationMethod: pulumi.String("string"),
    	},
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	OriginalSource: pulumi.String("string"),
    	Owner: &stripe.SourceOwnerArgs{
    		Address: &stripe.SourceOwnerAddressArgs{
    			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"),
    		VerifiedAddress: &stripe.SourceOwnerVerifiedAddressArgs{
    			City:       pulumi.String("string"),
    			Country:    pulumi.String("string"),
    			Line1:      pulumi.String("string"),
    			Line2:      pulumi.String("string"),
    			PostalCode: pulumi.String("string"),
    			State:      pulumi.String("string"),
    		},
    		VerifiedEmail: pulumi.String("string"),
    		VerifiedName:  pulumi.String("string"),
    		VerifiedPhone: pulumi.String("string"),
    	},
    	Receiver: &stripe.SourceReceiverArgs{
    		Address:                pulumi.String("string"),
    		AmountCharged:          pulumi.Float64(0),
    		AmountReceived:         pulumi.Float64(0),
    		AmountReturned:         pulumi.Float64(0),
    		RefundAttributesMethod: pulumi.String("string"),
    		RefundAttributesStatus: pulumi.String("string"),
    	},
    	Redirect: &stripe.SourceRedirectArgs{
    		ReturnUrl:     pulumi.String("string"),
    		FailureReason: pulumi.String("string"),
    		Status:        pulumi.String("string"),
    		Url:           pulumi.String("string"),
    	},
    	SourceOrder: &stripe.SourceSourceOrderArgs{
    		Amount:   pulumi.Float64(0),
    		Currency: pulumi.String("string"),
    		Email:    pulumi.String("string"),
    		Items: stripe.SourceSourceOrderItemArray{
    			&stripe.SourceSourceOrderItemArgs{
    				Amount:      pulumi.Float64(0),
    				Currency:    pulumi.String("string"),
    				Description: pulumi.String("string"),
    				Parent:      pulumi.String("string"),
    				Quantity:    pulumi.Float64(0),
    				Type:        pulumi.String("string"),
    			},
    		},
    		Shipping: &stripe.SourceSourceOrderShippingArgs{
    			Address: &stripe.SourceSourceOrderShippingAddressArgs{
    				Line1:      pulumi.String("string"),
    				City:       pulumi.String("string"),
    				Country:    pulumi.String("string"),
    				Line2:      pulumi.String("string"),
    				PostalCode: pulumi.String("string"),
    				State:      pulumi.String("string"),
    			},
    			Carrier:        pulumi.String("string"),
    			Name:           pulumi.String("string"),
    			Phone:          pulumi.String("string"),
    			TrackingNumber: pulumi.String("string"),
    		},
    	},
    	StatementDescriptor: pulumi.String("string"),
    	Token:               pulumi.String("string"),
    	Type:                pulumi.String("string"),
    	Usage:               pulumi.String("string"),
    })
    
    resource "stripe_source" "sourceResource" {
      lifecycle {
        create_before_destroy = true
      }
      amount   = 0
      currency = "string"
      customer = "string"
      flow     = "string"
      mandate = {
        acceptance = {
          status = "string"
          date   = 0
          ip     = "string"
          offline = {
            contact_email = "string"
          }
          online = {
            date       = 0
            ip         = "string"
            user_agent = "string"
          }
          type       = "string"
          user_agent = "string"
        }
        amount              = 0
        currency            = "string"
        interval            = "string"
        notification_method = "string"
      }
      metadata = {
        "string" = "string"
      }
      original_source = "string"
      owner = {
        address = {
          city        = "string"
          country     = "string"
          line1       = "string"
          line2       = "string"
          postal_code = "string"
          state       = "string"
        }
        email = "string"
        name  = "string"
        phone = "string"
        verified_address = {
          city        = "string"
          country     = "string"
          line1       = "string"
          line2       = "string"
          postal_code = "string"
          state       = "string"
        }
        verified_email = "string"
        verified_name  = "string"
        verified_phone = "string"
      }
      receiver = {
        address                  = "string"
        amount_charged           = 0
        amount_received          = 0
        amount_returned          = 0
        refund_attributes_method = "string"
        refund_attributes_status = "string"
      }
      redirect = {
        return_url     = "string"
        failure_reason = "string"
        status         = "string"
        url            = "string"
      }
      source_order = {
        amount   = 0
        currency = "string"
        email    = "string"
        items = [{
          amount      = 0
          currency    = "string"
          description = "string"
          parent      = "string"
          quantity    = 0
          type        = "string"
        }]
        shipping = {
          address = {
            line1       = "string"
            city        = "string"
            country     = "string"
            line2       = "string"
            postal_code = "string"
            state       = "string"
          }
          carrier         = "string"
          name            = "string"
          phone           = "string"
          tracking_number = "string"
        }
      }
      statement_descriptor = "string"
      token                = "string"
      type                 = "string"
      usage                = "string"
    }
    
    var sourceResource = new Source("sourceResource", SourceArgs.builder()
        .amount(0.0)
        .currency("string")
        .customer("string")
        .flow("string")
        .mandate(SourceMandateArgs.builder()
            .acceptance(SourceMandateAcceptanceArgs.builder()
                .status("string")
                .date(0.0)
                .ip("string")
                .offline(SourceMandateAcceptanceOfflineArgs.builder()
                    .contactEmail("string")
                    .build())
                .online(SourceMandateAcceptanceOnlineArgs.builder()
                    .date(0.0)
                    .ip("string")
                    .userAgent("string")
                    .build())
                .type("string")
                .userAgent("string")
                .build())
            .amount(0.0)
            .currency("string")
            .interval("string")
            .notificationMethod("string")
            .build())
        .metadata(Map.of("string", "string"))
        .originalSource("string")
        .owner(SourceOwnerArgs.builder()
            .address(SourceOwnerAddressArgs.builder()
                .city("string")
                .country("string")
                .line1("string")
                .line2("string")
                .postalCode("string")
                .state("string")
                .build())
            .email("string")
            .name("string")
            .phone("string")
            .verifiedAddress(SourceOwnerVerifiedAddressArgs.builder()
                .city("string")
                .country("string")
                .line1("string")
                .line2("string")
                .postalCode("string")
                .state("string")
                .build())
            .verifiedEmail("string")
            .verifiedName("string")
            .verifiedPhone("string")
            .build())
        .receiver(SourceReceiverArgs.builder()
            .address("string")
            .amountCharged(0.0)
            .amountReceived(0.0)
            .amountReturned(0.0)
            .refundAttributesMethod("string")
            .refundAttributesStatus("string")
            .build())
        .redirect(SourceRedirectArgs.builder()
            .returnUrl("string")
            .failureReason("string")
            .status("string")
            .url("string")
            .build())
        .sourceOrder(SourceSourceOrderArgs.builder()
            .amount(0.0)
            .currency("string")
            .email("string")
            .items(SourceSourceOrderItemArgs.builder()
                .amount(0.0)
                .currency("string")
                .description("string")
                .parent("string")
                .quantity(0.0)
                .type("string")
                .build())
            .shipping(SourceSourceOrderShippingArgs.builder()
                .address(SourceSourceOrderShippingAddressArgs.builder()
                    .line1("string")
                    .city("string")
                    .country("string")
                    .line2("string")
                    .postalCode("string")
                    .state("string")
                    .build())
                .carrier("string")
                .name("string")
                .phone("string")
                .trackingNumber("string")
                .build())
            .build())
        .statementDescriptor("string")
        .token("string")
        .type("string")
        .usage("string")
        .build());
    
    source_resource = stripe.Source("sourceResource",
        amount=float(0),
        currency="string",
        customer="string",
        flow="string",
        mandate={
            "acceptance": {
                "status": "string",
                "date": float(0),
                "ip": "string",
                "offline": {
                    "contact_email": "string",
                },
                "online": {
                    "date": float(0),
                    "ip": "string",
                    "user_agent": "string",
                },
                "type": "string",
                "user_agent": "string",
            },
            "amount": float(0),
            "currency": "string",
            "interval": "string",
            "notification_method": "string",
        },
        metadata={
            "string": "string",
        },
        original_source="string",
        owner={
            "address": {
                "city": "string",
                "country": "string",
                "line1": "string",
                "line2": "string",
                "postal_code": "string",
                "state": "string",
            },
            "email": "string",
            "name": "string",
            "phone": "string",
            "verified_address": {
                "city": "string",
                "country": "string",
                "line1": "string",
                "line2": "string",
                "postal_code": "string",
                "state": "string",
            },
            "verified_email": "string",
            "verified_name": "string",
            "verified_phone": "string",
        },
        receiver={
            "address": "string",
            "amount_charged": float(0),
            "amount_received": float(0),
            "amount_returned": float(0),
            "refund_attributes_method": "string",
            "refund_attributes_status": "string",
        },
        redirect={
            "return_url": "string",
            "failure_reason": "string",
            "status": "string",
            "url": "string",
        },
        source_order={
            "amount": float(0),
            "currency": "string",
            "email": "string",
            "items": [{
                "amount": float(0),
                "currency": "string",
                "description": "string",
                "parent": "string",
                "quantity": float(0),
                "type": "string",
            }],
            "shipping": {
                "address": {
                    "line1": "string",
                    "city": "string",
                    "country": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string",
                },
                "carrier": "string",
                "name": "string",
                "phone": "string",
                "tracking_number": "string",
            },
        },
        statement_descriptor="string",
        token="string",
        type="string",
        usage="string")
    
    const sourceResource = new stripe.Source("sourceResource", {
        amount: 0,
        currency: "string",
        customer: "string",
        flow: "string",
        mandate: {
            acceptance: {
                status: "string",
                date: 0,
                ip: "string",
                offline: {
                    contactEmail: "string",
                },
                online: {
                    date: 0,
                    ip: "string",
                    userAgent: "string",
                },
                type: "string",
                userAgent: "string",
            },
            amount: 0,
            currency: "string",
            interval: "string",
            notificationMethod: "string",
        },
        metadata: {
            string: "string",
        },
        originalSource: "string",
        owner: {
            address: {
                city: "string",
                country: "string",
                line1: "string",
                line2: "string",
                postalCode: "string",
                state: "string",
            },
            email: "string",
            name: "string",
            phone: "string",
            verifiedAddress: {
                city: "string",
                country: "string",
                line1: "string",
                line2: "string",
                postalCode: "string",
                state: "string",
            },
            verifiedEmail: "string",
            verifiedName: "string",
            verifiedPhone: "string",
        },
        receiver: {
            address: "string",
            amountCharged: 0,
            amountReceived: 0,
            amountReturned: 0,
            refundAttributesMethod: "string",
            refundAttributesStatus: "string",
        },
        redirect: {
            returnUrl: "string",
            failureReason: "string",
            status: "string",
            url: "string",
        },
        sourceOrder: {
            amount: 0,
            currency: "string",
            email: "string",
            items: [{
                amount: 0,
                currency: "string",
                description: "string",
                parent: "string",
                quantity: 0,
                type: "string",
            }],
            shipping: {
                address: {
                    line1: "string",
                    city: "string",
                    country: "string",
                    line2: "string",
                    postalCode: "string",
                    state: "string",
                },
                carrier: "string",
                name: "string",
                phone: "string",
                trackingNumber: "string",
            },
        },
        statementDescriptor: "string",
        token: "string",
        type: "string",
        usage: "string",
    });
    
    type: stripe:Source
    properties:
        amount: 0
        currency: string
        customer: string
        flow: string
        mandate:
            acceptance:
                date: 0
                ip: string
                offline:
                    contactEmail: string
                online:
                    date: 0
                    ip: string
                    userAgent: string
                status: string
                type: string
                userAgent: string
            amount: 0
            currency: string
            interval: string
            notificationMethod: string
        metadata:
            string: string
        originalSource: string
        owner:
            address:
                city: string
                country: string
                line1: string
                line2: string
                postalCode: string
                state: string
            email: string
            name: string
            phone: string
            verifiedAddress:
                city: string
                country: string
                line1: string
                line2: string
                postalCode: string
                state: string
            verifiedEmail: string
            verifiedName: string
            verifiedPhone: string
        receiver:
            address: string
            amountCharged: 0
            amountReceived: 0
            amountReturned: 0
            refundAttributesMethod: string
            refundAttributesStatus: string
        redirect:
            failureReason: string
            returnUrl: string
            status: string
            url: string
        sourceOrder:
            amount: 0
            currency: string
            email: string
            items:
                - amount: 0
                  currency: string
                  description: string
                  parent: string
                  quantity: 0
                  type: string
            shipping:
                address:
                    city: string
                    country: string
                    line1: string
                    line2: string
                    postalCode: string
                    state: string
                carrier: string
                name: string
                phone: string
                trackingNumber: string
        statementDescriptor: string
        token: string
        type: string
        usage: string
    

    Source 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 Source resource accepts the following input properties:

    Amount double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    Currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    Customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    Flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    Mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    OriginalSource string
    The source to share.
    Owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    Receiver SourceReceiver
    Redirect SourceRedirect
    SourceOrder SourceSourceOrder
    StatementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    Token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    Type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    Usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    Amount float64
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    Currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    Customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    Flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    Mandate SourceMandateArgs
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    OriginalSource string
    The source to share.
    Owner SourceOwnerArgs
    Information about the owner of the payment instrument that may be used or required by particular source types.
    Receiver SourceReceiverArgs
    Redirect SourceRedirectArgs
    SourceOrder SourceSourceOrderArgs
    StatementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    Token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    Type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    Usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    mandate object
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    original_source string
    The source to share.
    owner object
    Information about the owner of the payment instrument that may be used or required by particular source types.
    receiver object
    redirect object
    source_order object
    statement_descriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    amount Double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    currency String
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer String
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    flow String
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    originalSource String
    The source to share.
    owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    receiver SourceReceiver
    redirect SourceRedirect
    sourceOrder SourceSourceOrder
    statementDescriptor String
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    token String
    An optional token used to create the source. When passed, token properties will override source parameters.
    type String
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage String
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    originalSource string
    The source to share.
    owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    receiver SourceReceiver
    redirect SourceRedirect
    sourceOrder SourceSourceOrder
    statementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    amount float
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    currency str
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer str
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    flow str
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    mandate SourceMandateArgs
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    original_source str
    The source to share.
    owner SourceOwnerArgs
    Information about the owner of the payment instrument that may be used or required by particular source types.
    receiver SourceReceiverArgs
    redirect SourceRedirectArgs
    source_order SourceSourceOrderArgs
    statement_descriptor str
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    token str
    An optional token used to create the source. When passed, token properties will override source parameters.
    type str
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage str
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    amount Number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    currency String
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer String
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    flow String
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    mandate Property Map
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    originalSource String
    The source to share.
    owner Property Map
    Information about the owner of the payment instrument that may be used or required by particular source types.
    receiver Property Map
    redirect Property Map
    sourceOrder Property Map
    statementDescriptor String
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    token String
    An optional token used to create the source. When passed, token properties will override source parameters.
    type String
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage String
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

    Outputs

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

    AchCreditTransfer SourceAchCreditTransfer
    AchDebit SourceAchDebit
    AcssDebit SourceAcssDebit
    Alipay SourceAlipay
    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 SourceAuBecsDebit
    Bancontact SourceBancontact
    Card SourceCard
    CardPresent SourceCardPresent
    ClientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    CodeVerification SourceCodeVerification
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Eps SourceEps
    Giropay SourceGiropay
    Id string
    The provider-assigned unique ID for this managed resource.
    Ideal SourceIdeal
    Klarna SourceKlarna
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Multibanco SourceMultibanco
    Object string
    String representing the object's type. Objects of the same type share the same value.
    P24 SourceP24
    SepaCreditTransfer SourceSepaCreditTransfer
    SepaDebit SourceSepaDebit
    Sofort SourceSofort
    Status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    ThreeDSecure SourceThreeDSecure
    Wechat SourceWechat
    AchCreditTransfer SourceAchCreditTransfer
    AchDebit SourceAchDebit
    AcssDebit SourceAcssDebit
    Alipay SourceAlipay
    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 SourceAuBecsDebit
    Bancontact SourceBancontact
    Card SourceCard
    CardPresent SourceCardPresent
    ClientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    CodeVerification SourceCodeVerification
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Eps SourceEps
    Giropay SourceGiropay
    Id string
    The provider-assigned unique ID for this managed resource.
    Ideal SourceIdeal
    Klarna SourceKlarna
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Multibanco SourceMultibanco
    Object string
    String representing the object's type. Objects of the same type share the same value.
    P24 SourceP24
    SepaCreditTransfer SourceSepaCreditTransfer
    SepaDebit SourceSepaDebit
    Sofort SourceSofort
    Status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    ThreeDSecure SourceThreeDSecure
    Wechat SourceWechat
    ach_credit_transfer object
    ach_debit object
    acss_debit object
    alipay object
    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
    bancontact object
    card object
    card_present object
    client_secret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    code_verification object
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    eps object
    giropay object
    id string
    The provider-assigned unique ID for this managed resource.
    ideal object
    klarna object
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    multibanco object
    object string
    String representing the object's type. Objects of the same type share the same value.
    p24 object
    sepa_credit_transfer object
    sepa_debit object
    sofort object
    status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    three_d_secure object
    wechat object
    achCreditTransfer SourceAchCreditTransfer
    achDebit SourceAchDebit
    acssDebit SourceAcssDebit
    alipay SourceAlipay
    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 SourceAuBecsDebit
    bancontact SourceBancontact
    card SourceCard
    cardPresent SourceCardPresent
    clientSecret String
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification SourceCodeVerification
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    eps SourceEps
    giropay SourceGiropay
    id String
    The provider-assigned unique ID for this managed resource.
    ideal SourceIdeal
    klarna SourceKlarna
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    multibanco SourceMultibanco
    object String
    String representing the object's type. Objects of the same type share the same value.
    p24 SourceP24
    sepaCreditTransfer SourceSepaCreditTransfer
    sepaDebit SourceSepaDebit
    sofort SourceSofort
    status String
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure SourceThreeDSecure
    wechat SourceWechat
    achCreditTransfer SourceAchCreditTransfer
    achDebit SourceAchDebit
    acssDebit SourceAcssDebit
    alipay SourceAlipay
    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 SourceAuBecsDebit
    bancontact SourceBancontact
    card SourceCard
    cardPresent SourceCardPresent
    clientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification SourceCodeVerification
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    eps SourceEps
    giropay SourceGiropay
    id string
    The provider-assigned unique ID for this managed resource.
    ideal SourceIdeal
    klarna SourceKlarna
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    multibanco SourceMultibanco
    object string
    String representing the object's type. Objects of the same type share the same value.
    p24 SourceP24
    sepaCreditTransfer SourceSepaCreditTransfer
    sepaDebit SourceSepaDebit
    sofort SourceSofort
    status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure SourceThreeDSecure
    wechat SourceWechat
    ach_credit_transfer SourceAchCreditTransfer
    ach_debit SourceAchDebit
    acss_debit SourceAcssDebit
    alipay SourceAlipay
    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 SourceAuBecsDebit
    bancontact SourceBancontact
    card SourceCard
    card_present SourceCardPresent
    client_secret str
    The client secret of the source. Used for client-side retrieval using a publishable key.
    code_verification SourceCodeVerification
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    eps SourceEps
    giropay SourceGiropay
    id str
    The provider-assigned unique ID for this managed resource.
    ideal SourceIdeal
    klarna SourceKlarna
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    multibanco SourceMultibanco
    object str
    String representing the object's type. Objects of the same type share the same value.
    p24 SourceP24
    sepa_credit_transfer SourceSepaCreditTransfer
    sepa_debit SourceSepaDebit
    sofort SourceSofort
    status str
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    three_d_secure SourceThreeDSecure
    wechat SourceWechat
    achCreditTransfer Property Map
    achDebit Property Map
    acssDebit Property Map
    alipay Property Map
    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
    bancontact Property Map
    card Property Map
    cardPresent Property Map
    clientSecret String
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification Property Map
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    eps Property Map
    giropay Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    ideal Property Map
    klarna Property Map
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    multibanco Property Map
    object String
    String representing the object's type. Objects of the same type share the same value.
    p24 Property Map
    sepaCreditTransfer Property Map
    sepaDebit Property Map
    sofort Property Map
    status String
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure Property Map
    wechat Property Map

    Look up Existing Source Resource

    Get an existing Source 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?: SourceState, opts?: CustomResourceOptions): Source
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ach_credit_transfer: Optional[SourceAchCreditTransferArgs] = None,
            ach_debit: Optional[SourceAchDebitArgs] = None,
            acss_debit: Optional[SourceAcssDebitArgs] = None,
            alipay: Optional[SourceAlipayArgs] = None,
            allow_redisplay: Optional[str] = None,
            amount: Optional[float] = None,
            au_becs_debit: Optional[SourceAuBecsDebitArgs] = None,
            bancontact: Optional[SourceBancontactArgs] = None,
            card: Optional[SourceCardArgs] = None,
            card_present: Optional[SourceCardPresentArgs] = None,
            client_secret: Optional[str] = None,
            code_verification: Optional[SourceCodeVerificationArgs] = None,
            created: Optional[float] = None,
            currency: Optional[str] = None,
            customer: Optional[str] = None,
            eps: Optional[SourceEpsArgs] = None,
            flow: Optional[str] = None,
            giropay: Optional[SourceGiropayArgs] = None,
            ideal: Optional[SourceIdealArgs] = None,
            klarna: Optional[SourceKlarnaArgs] = None,
            livemode: Optional[bool] = None,
            mandate: Optional[SourceMandateArgs] = None,
            metadata: Optional[Mapping[str, str]] = None,
            multibanco: Optional[SourceMultibancoArgs] = None,
            object: Optional[str] = None,
            original_source: Optional[str] = None,
            owner: Optional[SourceOwnerArgs] = None,
            p24: Optional[SourceP24Args] = None,
            receiver: Optional[SourceReceiverArgs] = None,
            redirect: Optional[SourceRedirectArgs] = None,
            sepa_credit_transfer: Optional[SourceSepaCreditTransferArgs] = None,
            sepa_debit: Optional[SourceSepaDebitArgs] = None,
            sofort: Optional[SourceSofortArgs] = None,
            source_order: Optional[SourceSourceOrderArgs] = None,
            statement_descriptor: Optional[str] = None,
            status: Optional[str] = None,
            three_d_secure: Optional[SourceThreeDSecureArgs] = None,
            token: Optional[str] = None,
            type: Optional[str] = None,
            usage: Optional[str] = None,
            wechat: Optional[SourceWechatArgs] = None) -> Source
    func GetSource(ctx *Context, name string, id IDInput, state *SourceState, opts ...ResourceOption) (*Source, error)
    public static Source Get(string name, Input<string> id, SourceState? state, CustomResourceOptions? opts = null)
    public static Source get(String name, Output<String> id, SourceState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Source    get:      id: ${id}
    import {
      to = stripe_source.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:
    AchCreditTransfer SourceAchCreditTransfer
    AchDebit SourceAchDebit
    AcssDebit SourceAcssDebit
    Alipay SourceAlipay
    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”.
    Amount double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    AuBecsDebit SourceAuBecsDebit
    Bancontact SourceBancontact
    Card SourceCard
    CardPresent SourceCardPresent
    ClientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    CodeVerification SourceCodeVerification
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    Customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    Eps SourceEps
    Flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    Giropay SourceGiropay
    Ideal SourceIdeal
    Klarna SourceKlarna
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    Multibanco SourceMultibanco
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OriginalSource string
    The source to share.
    Owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    P24 SourceP24
    Receiver SourceReceiver
    Redirect SourceRedirect
    SepaCreditTransfer SourceSepaCreditTransfer
    SepaDebit SourceSepaDebit
    Sofort SourceSofort
    SourceOrder SourceSourceOrder
    StatementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    Status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    ThreeDSecure SourceThreeDSecure
    Token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    Type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    Usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    Wechat SourceWechat
    AchCreditTransfer SourceAchCreditTransferArgs
    AchDebit SourceAchDebitArgs
    AcssDebit SourceAcssDebitArgs
    Alipay SourceAlipayArgs
    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”.
    Amount float64
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    AuBecsDebit SourceAuBecsDebitArgs
    Bancontact SourceBancontactArgs
    Card SourceCardArgs
    CardPresent SourceCardPresentArgs
    ClientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    CodeVerification SourceCodeVerificationArgs
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    Customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    Eps SourceEpsArgs
    Flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    Giropay SourceGiropayArgs
    Ideal SourceIdealArgs
    Klarna SourceKlarnaArgs
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Mandate SourceMandateArgs
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    Multibanco SourceMultibancoArgs
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OriginalSource string
    The source to share.
    Owner SourceOwnerArgs
    Information about the owner of the payment instrument that may be used or required by particular source types.
    P24 SourceP24Args
    Receiver SourceReceiverArgs
    Redirect SourceRedirectArgs
    SepaCreditTransfer SourceSepaCreditTransferArgs
    SepaDebit SourceSepaDebitArgs
    Sofort SourceSofortArgs
    SourceOrder SourceSourceOrderArgs
    StatementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    Status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    ThreeDSecure SourceThreeDSecureArgs
    Token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    Type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    Usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    Wechat SourceWechatArgs
    ach_credit_transfer object
    ach_debit object
    acss_debit object
    alipay object
    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”.
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    au_becs_debit object
    bancontact object
    card object
    card_present object
    client_secret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    code_verification object
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    eps object
    flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    giropay object
    ideal object
    klarna object
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    mandate object
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    multibanco object
    object string
    String representing the object's type. Objects of the same type share the same value.
    original_source string
    The source to share.
    owner object
    Information about the owner of the payment instrument that may be used or required by particular source types.
    p24 object
    receiver object
    redirect object
    sepa_credit_transfer object
    sepa_debit object
    sofort object
    source_order object
    statement_descriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    three_d_secure object
    token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    wechat object
    achCreditTransfer SourceAchCreditTransfer
    achDebit SourceAchDebit
    acssDebit SourceAcssDebit
    alipay SourceAlipay
    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”.
    amount Double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    auBecsDebit SourceAuBecsDebit
    bancontact SourceBancontact
    card SourceCard
    cardPresent SourceCardPresent
    clientSecret String
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification SourceCodeVerification
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer String
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    eps SourceEps
    flow String
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    giropay SourceGiropay
    ideal SourceIdeal
    klarna SourceKlarna
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    multibanco SourceMultibanco
    object String
    String representing the object's type. Objects of the same type share the same value.
    originalSource String
    The source to share.
    owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    p24 SourceP24
    receiver SourceReceiver
    redirect SourceRedirect
    sepaCreditTransfer SourceSepaCreditTransfer
    sepaDebit SourceSepaDebit
    sofort SourceSofort
    sourceOrder SourceSourceOrder
    statementDescriptor String
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    status String
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure SourceThreeDSecure
    token String
    An optional token used to create the source. When passed, token properties will override source parameters.
    type String
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage String
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    wechat SourceWechat
    achCreditTransfer SourceAchCreditTransfer
    achDebit SourceAchDebit
    acssDebit SourceAcssDebit
    alipay SourceAlipay
    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”.
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    auBecsDebit SourceAuBecsDebit
    bancontact SourceBancontact
    card SourceCard
    cardPresent SourceCardPresent
    clientSecret string
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification SourceCodeVerification
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer string
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    eps SourceEps
    flow string
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    giropay SourceGiropay
    ideal SourceIdeal
    klarna SourceKlarna
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    mandate SourceMandate
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    multibanco SourceMultibanco
    object string
    String representing the object's type. Objects of the same type share the same value.
    originalSource string
    The source to share.
    owner SourceOwner
    Information about the owner of the payment instrument that may be used or required by particular source types.
    p24 SourceP24
    receiver SourceReceiver
    redirect SourceRedirect
    sepaCreditTransfer SourceSepaCreditTransfer
    sepaDebit SourceSepaDebit
    sofort SourceSofort
    sourceOrder SourceSourceOrder
    statementDescriptor string
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    status string
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure SourceThreeDSecure
    token string
    An optional token used to create the source. When passed, token properties will override source parameters.
    type string
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage string
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    wechat SourceWechat
    ach_credit_transfer SourceAchCreditTransferArgs
    ach_debit SourceAchDebitArgs
    acss_debit SourceAcssDebitArgs
    alipay SourceAlipayArgs
    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”.
    amount float
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    au_becs_debit SourceAuBecsDebitArgs
    bancontact SourceBancontactArgs
    card SourceCardArgs
    card_present SourceCardPresentArgs
    client_secret str
    The client secret of the source. Used for client-side retrieval using a publishable key.
    code_verification SourceCodeVerificationArgs
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency str
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer str
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    eps SourceEpsArgs
    flow str
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    giropay SourceGiropayArgs
    ideal SourceIdealArgs
    klarna SourceKlarnaArgs
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    mandate SourceMandateArgs
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    multibanco SourceMultibancoArgs
    object str
    String representing the object's type. Objects of the same type share the same value.
    original_source str
    The source to share.
    owner SourceOwnerArgs
    Information about the owner of the payment instrument that may be used or required by particular source types.
    p24 SourceP24Args
    receiver SourceReceiverArgs
    redirect SourceRedirectArgs
    sepa_credit_transfer SourceSepaCreditTransferArgs
    sepa_debit SourceSepaDebitArgs
    sofort SourceSofortArgs
    source_order SourceSourceOrderArgs
    statement_descriptor str
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    status str
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    three_d_secure SourceThreeDSecureArgs
    token str
    An optional token used to create the source. When passed, token properties will override source parameters.
    type str
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage str
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    wechat SourceWechatArgs
    achCreditTransfer Property Map
    achDebit Property Map
    acssDebit Property Map
    alipay Property Map
    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”.
    amount Number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for single_use sources.
    auBecsDebit Property Map
    bancontact Property Map
    card Property Map
    cardPresent Property Map
    clientSecret String
    The client secret of the source. Used for client-side retrieval using a publishable key.
    codeVerification Property Map
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO code for the currency associated with the source. This is the currency for which the source will be chargeable once ready. Required for single_use sources.
    customer String
    The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.
    eps Property Map
    flow String
    The authentication flow of the source. flow is one of redirect, receiver, code_verification, none.
    giropay Property Map
    ideal Property Map
    klarna Property Map
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    mandate Property Map
    Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
    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.
    multibanco Property Map
    object String
    String representing the object's type. Objects of the same type share the same value.
    originalSource String
    The source to share.
    owner Property Map
    Information about the owner of the payment instrument that may be used or required by particular source types.
    p24 Property Map
    receiver Property Map
    redirect Property Map
    sepaCreditTransfer Property Map
    sepaDebit Property Map
    sofort Property Map
    sourceOrder Property Map
    statementDescriptor String
    Extra information about a source. This will appear on your customer's statement every time you charge the source.
    status String
    The status of the source, one of canceled, chargeable, consumed, failed, or pending. Only chargeable sources can be used to create a charge.
    threeDSecure Property Map
    token String
    An optional token used to create the source. When passed, token properties will override source parameters.
    type String
    The type of the source. The type is a payment method, one of ach_credit_transfer, ach_debit, alipay, bancontact, card, card_present, eps, giropay, ideal, multibanco, klarna, p24, sepa_debit, sofort, three_d_secure, or wechat. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
    usage String
    Either reusable or single_use. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.
    wechat Property Map

    Supporting Types

    SourceAchCreditTransfer, SourceAchCreditTransferArgs

    SourceAchDebit, SourceAchDebitArgs

    BankName string
    Country string
    Fingerprint string
    Last4 string
    RoutingNumber string
    Type string
    BankName string
    Country string
    Fingerprint string
    Last4 string
    RoutingNumber string
    Type string
    bank_name string
    country string
    fingerprint string
    last4 string
    routing_number string
    type string
    bankName String
    country String
    fingerprint String
    last4 String
    routingNumber String
    type String
    bankName string
    country string
    fingerprint string
    last4 string
    routingNumber string
    type string
    bankName String
    country String
    fingerprint String
    last4 String
    routingNumber String
    type String

    SourceAcssDebit, SourceAcssDebitArgs

    SourceAlipay, SourceAlipayArgs

    SourceAuBecsDebit, SourceAuBecsDebitArgs

    BsbNumber string
    Fingerprint string
    Last4 string
    BsbNumber string
    Fingerprint string
    Last4 string
    bsb_number string
    fingerprint string
    last4 string
    bsbNumber String
    fingerprint String
    last4 String
    bsbNumber string
    fingerprint string
    last4 string
    bsbNumber String
    fingerprint String
    last4 String

    SourceBancontact, SourceBancontactArgs

    SourceCard, SourceCardArgs

    AddressLine1Check string
    AddressZipCheck string
    Brand string
    Country string
    CvcCheck string
    Description string
    DynamicLast4 string
    ExpMonth double
    ExpYear double
    Fingerprint string
    Funding string
    Iin string
    Issuer string
    Last4 string
    Name string
    ThreeDSecure string
    TokenizationMethod string
    AddressLine1Check string
    AddressZipCheck string
    Brand string
    Country string
    CvcCheck string
    Description string
    DynamicLast4 string
    ExpMonth float64
    ExpYear float64
    Fingerprint string
    Funding string
    Iin string
    Issuer string
    Last4 string
    Name string
    ThreeDSecure string
    TokenizationMethod string
    address_line1_check string
    address_zip_check string
    brand string
    country string
    cvc_check string
    description string
    dynamic_last4 string
    exp_month number
    exp_year number
    fingerprint string
    funding string
    iin string
    issuer string
    last4 string
    name string
    three_d_secure string
    tokenization_method string
    addressLine1Check String
    addressZipCheck String
    brand String
    country String
    cvcCheck String
    description String
    dynamicLast4 String
    expMonth Double
    expYear Double
    fingerprint String
    funding String
    iin String
    issuer String
    last4 String
    name String
    threeDSecure String
    tokenizationMethod String
    addressLine1Check string
    addressZipCheck string
    brand string
    country string
    cvcCheck string
    description string
    dynamicLast4 string
    expMonth number
    expYear number
    fingerprint string
    funding string
    iin string
    issuer string
    last4 string
    name string
    threeDSecure string
    tokenizationMethod string
    addressLine1Check String
    addressZipCheck String
    brand String
    country String
    cvcCheck String
    description String
    dynamicLast4 String
    expMonth Number
    expYear Number
    fingerprint String
    funding String
    iin String
    issuer String
    last4 String
    name String
    threeDSecure String
    tokenizationMethod String

    SourceCardPresent, SourceCardPresentArgs

    SourceCodeVerification, SourceCodeVerificationArgs

    AttemptsRemaining double
    The number of attempts remaining to authenticate the source object with a verification code.
    Status string
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    AttemptsRemaining float64
    The number of attempts remaining to authenticate the source object with a verification code.
    Status string
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    attempts_remaining number
    The number of attempts remaining to authenticate the source object with a verification code.
    status string
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    attemptsRemaining Double
    The number of attempts remaining to authenticate the source object with a verification code.
    status String
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    attemptsRemaining number
    The number of attempts remaining to authenticate the source object with a verification code.
    status string
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    attempts_remaining float
    The number of attempts remaining to authenticate the source object with a verification code.
    status str
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).
    attemptsRemaining Number
    The number of attempts remaining to authenticate the source object with a verification code.
    status String
    The status of the code verification, either pending (awaiting verification, attempts_remaining should be greater than 0), succeeded (successful verification) or failed (failed verification, cannot be verified anymore as attempts_remaining should be 0).

    SourceEps, SourceEpsArgs

    SourceGiropay, SourceGiropayArgs

    BankCode string
    BankName string
    Bic string
    StatementDescriptor string
    BankCode string
    BankName string
    Bic string
    StatementDescriptor string
    bank_code string
    bank_name string
    bic string
    statement_descriptor string
    bankCode String
    bankName String
    bic String
    statementDescriptor String
    bankCode string
    bankName string
    bic string
    statementDescriptor string
    bankCode String
    bankName String
    bic String
    statementDescriptor String

    SourceIdeal, SourceIdealArgs

    Bank string
    Bic string
    IbanLast4 string
    StatementDescriptor string
    Bank string
    Bic string
    IbanLast4 string
    StatementDescriptor string
    bank string
    bic string
    iban_last4 string
    statement_descriptor string
    bank String
    bic String
    ibanLast4 String
    statementDescriptor String
    bank string
    bic string
    ibanLast4 string
    statementDescriptor string
    bank String
    bic String
    ibanLast4 String
    statementDescriptor String

    SourceKlarna, SourceKlarnaArgs

    SourceMandate, SourceMandateArgs

    Acceptance SourceMandateAcceptance
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    Amount double
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    Currency string
    The currency specified by the mandate. (Must match currency of the source)
    Interval string
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    NotificationMethod string
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    Acceptance SourceMandateAcceptance
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    Amount float64
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    Currency string
    The currency specified by the mandate. (Must match currency of the source)
    Interval string
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    NotificationMethod string
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    acceptance object
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    amount number
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    currency string
    The currency specified by the mandate. (Must match currency of the source)
    interval string
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    notification_method string
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    acceptance SourceMandateAcceptance
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    amount Double
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    currency String
    The currency specified by the mandate. (Must match currency of the source)
    interval String
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    notificationMethod String
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    acceptance SourceMandateAcceptance
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    amount number
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    currency string
    The currency specified by the mandate. (Must match currency of the source)
    interval string
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    notificationMethod string
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    acceptance SourceMandateAcceptance
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    amount float
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    currency str
    The currency specified by the mandate. (Must match currency of the source)
    interval str
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    notification_method str
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).
    acceptance Property Map
    The parameters required to notify Stripe of a mandate acceptance or refusal by the customer.
    amount Number
    The amount specified by the mandate. (Leave null for a mandate covering all amounts)
    currency String
    The currency specified by the mandate. (Must match currency of the source)
    interval String
    The interval of debits permitted by the mandate. Either one_time (just permitting a single debit), scheduled (with debits on an agreed schedule or for clearly-defined events), or variable(for debits with any frequency)
    notificationMethod String
    The method Stripe should use to notify the customer of upcoming debit instructions and/or mandate confirmation as required by the underlying debit network. Either email (an email is sent directly to the customer), manual (a source.mandate_notification event is sent to your webhooks endpoint and you should handle the notification) or none (the underlying debit network does not require any notification).

    SourceMandateAcceptance, SourceMandateAcceptanceArgs

    Status string
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    Date double
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    Ip string
    The IP address from which the mandate was accepted or refused by the customer.
    Offline SourceMandateAcceptanceOffline
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    Online SourceMandateAcceptanceOnline
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    Type string
    The type of acceptance information included with the mandate. Either online or offline
    UserAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    Status string
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    Date float64
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    Ip string
    The IP address from which the mandate was accepted or refused by the customer.
    Offline SourceMandateAcceptanceOffline
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    Online SourceMandateAcceptanceOnline
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    Type string
    The type of acceptance information included with the mandate. Either online or offline
    UserAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    status string
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    date number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip string
    The IP address from which the mandate was accepted or refused by the customer.
    offline object
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    online object
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    type string
    The type of acceptance information included with the mandate. Either online or offline
    user_agent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    status String
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    date Double
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip String
    The IP address from which the mandate was accepted or refused by the customer.
    offline SourceMandateAcceptanceOffline
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    online SourceMandateAcceptanceOnline
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    type String
    The type of acceptance information included with the mandate. Either online or offline
    userAgent String
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    status string
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    date number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip string
    The IP address from which the mandate was accepted or refused by the customer.
    offline SourceMandateAcceptanceOffline
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    online SourceMandateAcceptanceOnline
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    type string
    The type of acceptance information included with the mandate. Either online or offline
    userAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    status str
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    date float
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip str
    The IP address from which the mandate was accepted or refused by the customer.
    offline SourceMandateAcceptanceOffline
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    online SourceMandateAcceptanceOnline
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    type str
    The type of acceptance information included with the mandate. Either online or offline
    user_agent str
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    status String
    The status of the mandate acceptance. Either accepted (the mandate was accepted) or refused (the mandate was refused).
    date Number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip String
    The IP address from which the mandate was accepted or refused by the customer.
    offline Property Map
    The parameters required to store a mandate accepted offline. Should only be set if mandate[type] is offline
    online Property Map
    The parameters required to store a mandate accepted online. Should only be set if mandate[type] is online
    type String
    The type of acceptance information included with the mandate. Either online or offline
    userAgent String
    The user agent of the browser from which the mandate was accepted or refused by the customer.

    SourceMandateAcceptanceOffline, SourceMandateAcceptanceOfflineArgs

    ContactEmail string
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    ContactEmail string
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    contact_email string
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    contactEmail String
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    contactEmail string
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    contact_email str
    An email to contact you with if a copy of the mandate is requested, required if type is offline.
    contactEmail String
    An email to contact you with if a copy of the mandate is requested, required if type is offline.

    SourceMandateAcceptanceOnline, SourceMandateAcceptanceOnlineArgs

    Date double
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    Ip string
    The IP address from which the mandate was accepted or refused by the customer.
    UserAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    Date float64
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    Ip string
    The IP address from which the mandate was accepted or refused by the customer.
    UserAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    date number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip string
    The IP address from which the mandate was accepted or refused by the customer.
    user_agent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    date Double
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip String
    The IP address from which the mandate was accepted or refused by the customer.
    userAgent String
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    date number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip string
    The IP address from which the mandate was accepted or refused by the customer.
    userAgent string
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    date float
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip str
    The IP address from which the mandate was accepted or refused by the customer.
    user_agent str
    The user agent of the browser from which the mandate was accepted or refused by the customer.
    date Number
    The Unix timestamp (in seconds) when the mandate was accepted or refused by the customer.
    ip String
    The IP address from which the mandate was accepted or refused by the customer.
    userAgent String
    The user agent of the browser from which the mandate was accepted or refused by the customer.

    SourceMultibanco, SourceMultibancoArgs

    SourceOwner, SourceOwnerArgs

    Address SourceOwnerAddress
    Owner's address.
    Email string
    Owner's email address.
    Name string
    Owner's full name.
    Phone string
    Owner's phone number (including extension).
    VerifiedAddress SourceOwnerVerifiedAddress
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedEmail string
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedName string
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedPhone string
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    Address SourceOwnerAddress
    Owner's address.
    Email string
    Owner's email address.
    Name string
    Owner's full name.
    Phone string
    Owner's phone number (including extension).
    VerifiedAddress SourceOwnerVerifiedAddress
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedEmail string
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedName string
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    VerifiedPhone string
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    address object
    Owner's address.
    email string
    Owner's email address.
    name string
    Owner's full name.
    phone string
    Owner's phone number (including extension).
    verified_address object
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_email string
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_name string
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_phone string
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    address SourceOwnerAddress
    Owner's address.
    email String
    Owner's email address.
    name String
    Owner's full name.
    phone String
    Owner's phone number (including extension).
    verifiedAddress SourceOwnerVerifiedAddress
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedEmail String
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedName String
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedPhone String
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    address SourceOwnerAddress
    Owner's address.
    email string
    Owner's email address.
    name string
    Owner's full name.
    phone string
    Owner's phone number (including extension).
    verifiedAddress SourceOwnerVerifiedAddress
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedEmail string
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedName string
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedPhone string
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    address SourceOwnerAddress
    Owner's address.
    email str
    Owner's email address.
    name str
    Owner's full name.
    phone str
    Owner's phone number (including extension).
    verified_address SourceOwnerVerifiedAddress
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_email str
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_name str
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verified_phone str
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    address Property Map
    Owner's address.
    email String
    Owner's email address.
    name String
    Owner's full name.
    phone String
    Owner's phone number (including extension).
    verifiedAddress Property Map
    Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedEmail String
    Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedName String
    Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
    verifiedPhone String
    Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

    SourceOwnerAddress, SourceOwnerAddressArgs

    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).

    SourceOwnerVerifiedAddress, SourceOwnerVerifiedAddressArgs

    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).

    SourceP24, SourceP24Args

    Reference string
    Reference string
    reference string
    reference String
    reference string
    reference String

    SourceReceiver, SourceReceiverArgs

    Address string
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    AmountCharged double
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    AmountReceived double
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    AmountReturned double
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    RefundAttributesMethod string
    Type of refund attribute method, one of email, manual, or none.
    RefundAttributesStatus string
    Type of refund attribute status, one of missing, requested, or available.
    Address string
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    AmountCharged float64
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    AmountReceived float64
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    AmountReturned float64
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    RefundAttributesMethod string
    Type of refund attribute method, one of email, manual, or none.
    RefundAttributesStatus string
    Type of refund attribute status, one of missing, requested, or available.
    address string
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    amount_charged number
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    amount_received number
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    amount_returned number
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    refund_attributes_method string
    Type of refund attribute method, one of email, manual, or none.
    refund_attributes_status string
    Type of refund attribute status, one of missing, requested, or available.
    address String
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    amountCharged Double
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    amountReceived Double
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    amountReturned Double
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    refundAttributesMethod String
    Type of refund attribute method, one of email, manual, or none.
    refundAttributesStatus String
    Type of refund attribute status, one of missing, requested, or available.
    address string
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    amountCharged number
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    amountReceived number
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    amountReturned number
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    refundAttributesMethod string
    Type of refund attribute method, one of email, manual, or none.
    refundAttributesStatus string
    Type of refund attribute status, one of missing, requested, or available.
    address str
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    amount_charged float
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    amount_received float
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    amount_returned float
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    refund_attributes_method str
    Type of refund attribute method, one of email, manual, or none.
    refund_attributes_status str
    Type of refund attribute status, one of missing, requested, or available.
    address String
    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
    amountCharged Number
    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.
    amountReceived Number
    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.
    amountReturned Number
    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.
    refundAttributesMethod String
    Type of refund attribute method, one of email, manual, or none.
    refundAttributesStatus String
    Type of refund attribute status, one of missing, requested, or available.

    SourceRedirect, SourceRedirectArgs

    ReturnUrl string
    The URL you provide to redirect the customer to after they authenticated their payment.
    FailureReason string
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    Status string
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    Url string
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    ReturnUrl string
    The URL you provide to redirect the customer to after they authenticated their payment.
    FailureReason string
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    Status string
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    Url string
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    return_url string
    The URL you provide to redirect the customer to after they authenticated their payment.
    failure_reason string
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    status string
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    url string
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    returnUrl String
    The URL you provide to redirect the customer to after they authenticated their payment.
    failureReason String
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    status String
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    url String
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    returnUrl string
    The URL you provide to redirect the customer to after they authenticated their payment.
    failureReason string
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    status string
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    url string
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    return_url str
    The URL you provide to redirect the customer to after they authenticated their payment.
    failure_reason str
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    status str
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    url str
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.
    returnUrl String
    The URL you provide to redirect the customer to after they authenticated their payment.
    failureReason String
    The failure reason for the redirect, either user_abort (the customer aborted or dropped out of the redirect flow), declined (the authentication failed or the transaction was declined), or processing_error (the redirect failed due to a technical error). Present only if the redirect status is failed.
    status String
    The status of the redirect, either pending (ready to be used by your customer to authenticate the transaction), succeeded (successful authentication, cannot be reused) or not_required (redirect should not be used) or failed (failed authentication, cannot be reused).
    url String
    The URL provided to you to redirect a customer to as part of a redirect authentication flow.

    SourceSepaCreditTransfer, SourceSepaCreditTransferArgs

    SourceSepaDebit, SourceSepaDebitArgs

    BankCode string
    BranchCode string
    Country string
    Fingerprint string
    Last4 string
    MandateReference string
    MandateUrl string
    BankCode string
    BranchCode string
    Country string
    Fingerprint string
    Last4 string
    MandateReference string
    MandateUrl string
    bank_code string
    branch_code string
    country string
    fingerprint string
    last4 string
    mandate_reference string
    mandate_url string
    bankCode String
    branchCode String
    country String
    fingerprint String
    last4 String
    mandateReference String
    mandateUrl String
    bankCode string
    branchCode string
    country string
    fingerprint string
    last4 string
    mandateReference string
    mandateUrl string
    bankCode String
    branchCode String
    country String
    fingerprint String
    last4 String
    mandateReference String
    mandateUrl String

    SourceSofort, SourceSofortArgs

    BankCode string
    BankName string
    Bic string
    Country string
    IbanLast4 string
    PreferredLanguage string
    StatementDescriptor string
    BankCode string
    BankName string
    Bic string
    Country string
    IbanLast4 string
    PreferredLanguage string
    StatementDescriptor string
    bankCode String
    bankName String
    bic String
    country String
    ibanLast4 String
    preferredLanguage String
    statementDescriptor String
    bankCode string
    bankName string
    bic string
    country string
    ibanLast4 string
    preferredLanguage string
    statementDescriptor string
    bankCode String
    bankName String
    bic String
    country String
    ibanLast4 String
    preferredLanguage String
    statementDescriptor String

    SourceSourceOrder, SourceSourceOrderArgs

    Amount double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Email string
    The email address of the customer placing the order.
    Items List<SourceSourceOrderItem>
    List of items constituting the order.
    Shipping SourceSourceOrderShipping
    Amount float64
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    Email string
    The email address of the customer placing the order.
    Items []SourceSourceOrderItem
    List of items constituting the order.
    Shipping SourceSourceOrderShipping
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    email string
    The email address of the customer placing the order.
    items list(object)
    List of items constituting the order.
    shipping object
    amount Double
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    email String
    The email address of the customer placing the order.
    items List<SourceSourceOrderItem>
    List of items constituting the order.
    shipping SourceSourceOrderShipping
    amount number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    email string
    The email address of the customer placing the order.
    items SourceSourceOrderItem[]
    List of items constituting the order.
    shipping SourceSourceOrderShipping
    amount float
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    email str
    The email address of the customer placing the order.
    items Sequence[SourceSourceOrderItem]
    List of items constituting the order.
    shipping SourceSourceOrderShipping
    amount Number
    A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    email String
    The email address of the customer placing the order.
    items List<Property Map>
    List of items constituting the order.
    shipping Property Map

    SourceSourceOrderItem, SourceSourceOrderItemArgs

    Amount double
    The amount (price) for this order item.
    Currency string
    This currency of this order item. Required when amount is present.
    Description string
    Human-readable description for this order item.
    Parent string
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    Quantity double
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    Type string
    The type of this order item. Must be sku, tax, or shipping.
    Amount float64
    The amount (price) for this order item.
    Currency string
    This currency of this order item. Required when amount is present.
    Description string
    Human-readable description for this order item.
    Parent string
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    Quantity float64
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    Type string
    The type of this order item. Must be sku, tax, or shipping.
    amount number
    The amount (price) for this order item.
    currency string
    This currency of this order item. Required when amount is present.
    description string
    Human-readable description for this order item.
    parent string
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    quantity number
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    type string
    The type of this order item. Must be sku, tax, or shipping.
    amount Double
    The amount (price) for this order item.
    currency String
    This currency of this order item. Required when amount is present.
    description String
    Human-readable description for this order item.
    parent String
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    quantity Double
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    type String
    The type of this order item. Must be sku, tax, or shipping.
    amount number
    The amount (price) for this order item.
    currency string
    This currency of this order item. Required when amount is present.
    description string
    Human-readable description for this order item.
    parent string
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    quantity number
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    type string
    The type of this order item. Must be sku, tax, or shipping.
    amount float
    The amount (price) for this order item.
    currency str
    This currency of this order item. Required when amount is present.
    description str
    Human-readable description for this order item.
    parent str
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    quantity float
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    type str
    The type of this order item. Must be sku, tax, or shipping.
    amount Number
    The amount (price) for this order item.
    currency String
    This currency of this order item. Required when amount is present.
    description String
    Human-readable description for this order item.
    parent String
    The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).
    quantity Number
    The quantity of this order item. When type is sku, this is the number of instances of the SKU to be ordered.
    type String
    The type of this order item. Must be sku, tax, or shipping.

    SourceSourceOrderShipping, SourceSourceOrderShippingArgs

    Address SourceSourceOrderShippingAddress
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Name string
    Recipient name.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    Address SourceSourceOrderShippingAddress
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Name string
    Recipient name.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address object
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name string
    Recipient name.
    phone string
    Recipient phone (including extension).
    tracking_number string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address SourceSourceOrderShippingAddress
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name String
    Recipient name.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address SourceSourceOrderShippingAddress
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name string
    Recipient name.
    phone string
    Recipient phone (including extension).
    trackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address SourceSourceOrderShippingAddress
    carrier str
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name str
    Recipient name.
    phone str
    Recipient phone (including extension).
    tracking_number str
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address Property Map
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name String
    Recipient name.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

    SourceSourceOrderShippingAddress, SourceSourceOrderShippingAddressArgs

    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    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).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    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).

    SourceThreeDSecure, SourceThreeDSecureArgs

    AddressLine1Check string
    AddressZipCheck string
    Authenticated bool
    Brand string
    Card string
    Country string
    Customer string
    CvcCheck string
    Description string
    DynamicLast4 string
    ExpMonth double
    ExpYear double
    Fingerprint string
    Funding string
    Iin string
    Issuer string
    Last4 string
    Name string
    ThreeDSecure string
    TokenizationMethod string
    AddressLine1Check string
    AddressZipCheck string
    Authenticated bool
    Brand string
    Card string
    Country string
    Customer string
    CvcCheck string
    Description string
    DynamicLast4 string
    ExpMonth float64
    ExpYear float64
    Fingerprint string
    Funding string
    Iin string
    Issuer string
    Last4 string
    Name string
    ThreeDSecure string
    TokenizationMethod string
    address_line1_check string
    address_zip_check string
    authenticated bool
    brand string
    card string
    country string
    customer string
    cvc_check string
    description string
    dynamic_last4 string
    exp_month number
    exp_year number
    fingerprint string
    funding string
    iin string
    issuer string
    last4 string
    name string
    three_d_secure string
    tokenization_method string
    addressLine1Check String
    addressZipCheck String
    authenticated Boolean
    brand String
    card String
    country String
    customer String
    cvcCheck String
    description String
    dynamicLast4 String
    expMonth Double
    expYear Double
    fingerprint String
    funding String
    iin String
    issuer String
    last4 String
    name String
    threeDSecure String
    tokenizationMethod String
    addressLine1Check string
    addressZipCheck string
    authenticated boolean
    brand string
    card string
    country string
    customer string
    cvcCheck string
    description string
    dynamicLast4 string
    expMonth number
    expYear number
    fingerprint string
    funding string
    iin string
    issuer string
    last4 string
    name string
    threeDSecure string
    tokenizationMethod string
    addressLine1Check String
    addressZipCheck String
    authenticated Boolean
    brand String
    card String
    country String
    customer String
    cvcCheck String
    description String
    dynamicLast4 String
    expMonth Number
    expYear Number
    fingerprint String
    funding String
    iin String
    issuer String
    last4 String
    name String
    threeDSecure String
    tokenizationMethod String

    SourceWechat, SourceWechatArgs

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial