stripe-ruby/lib/stripe/services/external_account_service.rb

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  class ExternalAccountService < StripeService
    # Create an external account for a given connected account.
    def create(params = {}, opts = {})
      request(
        method: :post,
        path: "/v1/external_accounts",
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Delete a specified external account for a given account.
    def delete(id, params = {}, opts = {})
      request(
        method: :delete,
        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # List external accounts for an account.
    def list(params = {}, opts = {})
      request(
        method: :get,
        path: "/v1/external_accounts",
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Retrieve a specified external account for a given account.
    def retrieve(id, params = {}, opts = {})
      request(
        method: :get,
        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end

    # Updates the metadata, account holder name, account holder type of a bank account belonging to
    # a connected account and optionally sets it as the default for its currency. Other bank account
    # details are not editable by design.
    #
    # You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
    #
    # You can re-enable a disabled bank account by performing an update call without providing any
    # arguments or changes.
    def update(id, params = {}, opts = {})
      request(
        method: :post,
        path: format("/v1/external_accounts/%<id>s", { id: CGI.escape(id) }),
        params: params,
        opts: opts,
        base_address: :api
      )
    end
  end
end