1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. V2CoreVaultGbBankAccount
Viewing docs for Stripe 0.3.1
published on Friday, Nov 13, 2026 by Pulumi
Stripe
Viewing docs for Stripe 0.3.1
published on Friday, Nov 13, 2026 by Pulumi

    Create V2CoreVaultGbBankAccount Resource

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

    Constructor syntax

    new V2CoreVaultGbBankAccount(name: string, args: V2CoreVaultGbBankAccountArgs, opts?: CustomResourceOptions);
    @overload
    def V2CoreVaultGbBankAccount(resource_name: str,
                                 args: V2CoreVaultGbBankAccountArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def V2CoreVaultGbBankAccount(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 currency: Optional[str] = None,
                                 account_number: Optional[str] = None,
                                 bank_account_type: Optional[str] = None,
                                 iban: Optional[str] = None,
                                 sort_code: Optional[str] = None)
    func NewV2CoreVaultGbBankAccount(ctx *Context, name string, args V2CoreVaultGbBankAccountArgs, opts ...ResourceOption) (*V2CoreVaultGbBankAccount, error)
    public V2CoreVaultGbBankAccount(string name, V2CoreVaultGbBankAccountArgs args, CustomResourceOptions? opts = null)
    public V2CoreVaultGbBankAccount(String name, V2CoreVaultGbBankAccountArgs args)
    public V2CoreVaultGbBankAccount(String name, V2CoreVaultGbBankAccountArgs args, CustomResourceOptions options)
    
    type: stripe:V2CoreVaultGbBankAccount
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "stripe_v2_core_vault_gb_bank_account" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args V2CoreVaultGbBankAccountArgs
    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 V2CoreVaultGbBankAccountArgs
    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 V2CoreVaultGbBankAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args V2CoreVaultGbBankAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args V2CoreVaultGbBankAccountArgs
    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 v2coreVaultGbBankAccountResource = new Stripe.V2CoreVaultGbBankAccount("v2coreVaultGbBankAccountResource", new()
    {
        Currency = "string",
        AccountNumber = "string",
        BankAccountType = "string",
        Iban = "string",
        SortCode = "string",
    });
    
    example, err := stripe.NewV2CoreVaultGbBankAccount(ctx, "v2coreVaultGbBankAccountResource", &stripe.V2CoreVaultGbBankAccountArgs{
    	Currency:        pulumi.String("string"),
    	AccountNumber:   pulumi.String("string"),
    	BankAccountType: pulumi.String("string"),
    	Iban:            pulumi.String("string"),
    	SortCode:        pulumi.String("string"),
    })
    
    resource "stripe_v2_core_vault_gb_bank_account" "v2coreVaultGbBankAccountResource" {
      lifecycle {
        create_before_destroy = true
      }
      currency          = "string"
      account_number    = "string"
      bank_account_type = "string"
      iban              = "string"
      sort_code         = "string"
    }
    
    var v2coreVaultGbBankAccountResource = new V2CoreVaultGbBankAccount("v2coreVaultGbBankAccountResource", V2CoreVaultGbBankAccountArgs.builder()
        .currency("string")
        .accountNumber("string")
        .bankAccountType("string")
        .iban("string")
        .sortCode("string")
        .build());
    
    v2core_vault_gb_bank_account_resource = stripe.V2CoreVaultGbBankAccount("v2coreVaultGbBankAccountResource",
        currency="string",
        account_number="string",
        bank_account_type="string",
        iban="string",
        sort_code="string")
    
    const v2coreVaultGbBankAccountResource = new stripe.V2CoreVaultGbBankAccount("v2coreVaultGbBankAccountResource", {
        currency: "string",
        accountNumber: "string",
        bankAccountType: "string",
        iban: "string",
        sortCode: "string",
    });
    
    type: stripe:V2CoreVaultGbBankAccount
    properties:
        accountNumber: string
        bankAccountType: string
        currency: string
        iban: string
        sortCode: string
    

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

    Currency string
    The currency of the bank account.
    AccountNumber string
    The Account Number of the bank account.
    BankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    Iban string
    The IBAN of the bank account.
    SortCode string
    The Sort Code of the bank account.
    Currency string
    The currency of the bank account.
    AccountNumber string
    The Account Number of the bank account.
    BankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    Iban string
    The IBAN of the bank account.
    SortCode string
    The Sort Code of the bank account.
    currency string
    The currency of the bank account.
    account_number string
    The Account Number of the bank account.
    bank_account_type string
    Closed Enum. The type of the bank account (checking or savings).
    iban string
    The IBAN of the bank account.
    sort_code string
    The Sort Code of the bank account.
    currency String
    The currency of the bank account.
    accountNumber String
    The Account Number of the bank account.
    bankAccountType String
    Closed Enum. The type of the bank account (checking or savings).
    iban String
    The IBAN of the bank account.
    sortCode String
    The Sort Code of the bank account.
    currency string
    The currency of the bank account.
    accountNumber string
    The Account Number of the bank account.
    bankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    iban string
    The IBAN of the bank account.
    sortCode string
    The Sort Code of the bank account.
    currency str
    The currency of the bank account.
    account_number str
    The Account Number of the bank account.
    bank_account_type str
    Closed Enum. The type of the bank account (checking or savings).
    iban str
    The IBAN of the bank account.
    sort_code str
    The Sort Code of the bank account.
    currency String
    The currency of the bank account.
    accountNumber String
    The Account Number of the bank account.
    bankAccountType String
    Closed Enum. The type of the bank account (checking or savings).
    iban String
    The IBAN of the bank account.
    sortCode String
    The Sort Code of the bank account.

    Outputs

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

    Archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    BankName string
    The name of the bank.
    Created string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Last4 string
    The last 4 digits of the account number or IBAN.
    Livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    Object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    Restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    SupportedCurrencies List<string>
    The list of currencies supported by this bank account.
    Archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    BankName string
    The name of the bank.
    Created string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    Last4 string
    The last 4 digits of the account number or IBAN.
    Livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    Object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    Restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    SupportedCurrencies []string
    The list of currencies supported by this bank account.
    archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bank_name string
    The name of the bank.
    created string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    last4 string
    The last 4 digits of the account number or IBAN.
    livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    supported_currencies list(string)
    The list of currencies supported by this bank account.
    archived Boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankName String
    The name of the bank.
    created String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    last4 String
    The last 4 digits of the account number or IBAN.
    livemode Boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object String
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted Boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    supportedCurrencies List<String>
    The list of currencies supported by this bank account.
    archived boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankName string
    The name of the bank.
    created string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    last4 string
    The last 4 digits of the account number or IBAN.
    livemode boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    supportedCurrencies string[]
    The list of currencies supported by this bank account.
    archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bank_name str
    The name of the bank.
    created str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    last4 str
    The last 4 digits of the account number or IBAN.
    livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object str
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    supported_currencies Sequence[str]
    The list of currencies supported by this bank account.
    archived Boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankName String
    The name of the bank.
    created String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    last4 String
    The last 4 digits of the account number or IBAN.
    livemode Boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object String
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted Boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    supportedCurrencies List<String>
    The list of currencies supported by this bank account.

    Look up Existing V2CoreVaultGbBankAccount Resource

    Get an existing V2CoreVaultGbBankAccount 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?: V2CoreVaultGbBankAccountState, opts?: CustomResourceOptions): V2CoreVaultGbBankAccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_number: Optional[str] = None,
            archived: Optional[bool] = None,
            bank_account_type: Optional[str] = None,
            bank_name: Optional[str] = None,
            created: Optional[str] = None,
            currency: Optional[str] = None,
            iban: Optional[str] = None,
            last4: Optional[str] = None,
            livemode: Optional[bool] = None,
            object: Optional[str] = None,
            restricted: Optional[bool] = None,
            sort_code: Optional[str] = None,
            supported_currencies: Optional[Sequence[str]] = None) -> V2CoreVaultGbBankAccount
    func GetV2CoreVaultGbBankAccount(ctx *Context, name string, id IDInput, state *V2CoreVaultGbBankAccountState, opts ...ResourceOption) (*V2CoreVaultGbBankAccount, error)
    public static V2CoreVaultGbBankAccount Get(string name, Input<string> id, V2CoreVaultGbBankAccountState? state, CustomResourceOptions? opts = null)
    public static V2CoreVaultGbBankAccount get(String name, Output<String> id, V2CoreVaultGbBankAccountState state, CustomResourceOptions options)
    resources:  _:    type: stripe:V2CoreVaultGbBankAccount    get:      id: ${id}
    import {
      to = stripe_v2_core_vault_gb_bank_account.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:
    AccountNumber string
    The Account Number of the bank account.
    Archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    BankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    BankName string
    The name of the bank.
    Created string
    Creation time.
    Currency string
    The currency of the bank account.
    Iban string
    The IBAN of the bank account.
    Last4 string
    The last 4 digits of the account number or IBAN.
    Livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    Object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    Restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    SortCode string
    The Sort Code of the bank account.
    SupportedCurrencies List<string>
    The list of currencies supported by this bank account.
    AccountNumber string
    The Account Number of the bank account.
    Archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    BankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    BankName string
    The name of the bank.
    Created string
    Creation time.
    Currency string
    The currency of the bank account.
    Iban string
    The IBAN of the bank account.
    Last4 string
    The last 4 digits of the account number or IBAN.
    Livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    Object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    Restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    SortCode string
    The Sort Code of the bank account.
    SupportedCurrencies []string
    The list of currencies supported by this bank account.
    account_number string
    The Account Number of the bank account.
    archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bank_account_type string
    Closed Enum. The type of the bank account (checking or savings).
    bank_name string
    The name of the bank.
    created string
    Creation time.
    currency string
    The currency of the bank account.
    iban string
    The IBAN of the bank account.
    last4 string
    The last 4 digits of the account number or IBAN.
    livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    sort_code string
    The Sort Code of the bank account.
    supported_currencies list(string)
    The list of currencies supported by this bank account.
    accountNumber String
    The Account Number of the bank account.
    archived Boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankAccountType String
    Closed Enum. The type of the bank account (checking or savings).
    bankName String
    The name of the bank.
    created String
    Creation time.
    currency String
    The currency of the bank account.
    iban String
    The IBAN of the bank account.
    last4 String
    The last 4 digits of the account number or IBAN.
    livemode Boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object String
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted Boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    sortCode String
    The Sort Code of the bank account.
    supportedCurrencies List<String>
    The list of currencies supported by this bank account.
    accountNumber string
    The Account Number of the bank account.
    archived boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankAccountType string
    Closed Enum. The type of the bank account (checking or savings).
    bankName string
    The name of the bank.
    created string
    Creation time.
    currency string
    The currency of the bank account.
    iban string
    The IBAN of the bank account.
    last4 string
    The last 4 digits of the account number or IBAN.
    livemode boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object string
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    sortCode string
    The Sort Code of the bank account.
    supportedCurrencies string[]
    The list of currencies supported by this bank account.
    account_number str
    The Account Number of the bank account.
    archived bool
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bank_account_type str
    Closed Enum. The type of the bank account (checking or savings).
    bank_name str
    The name of the bank.
    created str
    Creation time.
    currency str
    The currency of the bank account.
    iban str
    The IBAN of the bank account.
    last4 str
    The last 4 digits of the account number or IBAN.
    livemode bool
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object str
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted bool
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    sort_code str
    The Sort Code of the bank account.
    supported_currencies Sequence[str]
    The list of currencies supported by this bank account.
    accountNumber String
    The Account Number of the bank account.
    archived Boolean
    Whether this bank account object was archived. Bank account objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived bank account objects cannot be used as outbound destinations and will not appear in the outbound destination list.
    bankAccountType String
    Closed Enum. The type of the bank account (checking or savings).
    bankName String
    The name of the bank.
    created String
    Creation time.
    currency String
    The currency of the bank account.
    iban String
    The IBAN of the bank account.
    last4 String
    The last 4 digits of the account number or IBAN.
    livemode Boolean
    Has the value true if the object exists in live mode or the value false if the object exists in test mode.
    object String
    String representing the object's type. Objects of the same type share the same value of the object field.
    restricted Boolean
    Whether the GB Bank Account is currently unusable for money movement, despite potentially being correctly set up. Please reach out to Stripe Support for more information.
    sortCode String
    The Sort Code of the bank account.
    supportedCurrencies List<String>
    The list of currencies supported by this bank account.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Stripe
    Viewing docs for Stripe 0.3.1
    published on Friday, Nov 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial