Class: Stripe::V2::MoneyManagement::FinancialAccountService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/money_management/financial_account_service.rb

Defined Under Namespace

Classes: CloseParams, CreateParams, ListParams, RetrieveParams

Instance Method Summary collapse

Methods inherited from StripeService

#initialize, #request, #request_stream

Constructor Details

This class inherits a constructor from Stripe::StripeService

Instance Method Details

#close(id, params = {}, opts = {}) ⇒ Object

Closes a FinancialAccount with or without forwarding settings.

** raises NonZeroBalanceError



71
72
73
74
75
76
77
78
79
 
# File 'lib/stripe/services/v2/money_management/financial_account_service.rb', line 71

def close(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/money_management/financial_accounts/%<id>s/close", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end

#create(params = {}, opts = {}) ⇒ Object

Creates a new FinancialAccount.

** raises AlreadyExistsError ** raises FeatureNotEnabledError



85
86
87
88
89
90
91
92
93
 
# File 'lib/stripe/services/v2/money_management/financial_account_service.rb', line 85

def create(params = {}, opts = {})
  request(
    method: :post,
    path: "/v2/money_management/financial_accounts",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#list(params = {}, opts = {}) ⇒ Object

Lists FinancialAccounts in this compartment.



96
97
98
99
100
101
102
103
104
 
# File 'lib/stripe/services/v2/money_management/financial_account_service.rb', line 96

def list(params = {}, opts = {})
  request(
    method: :get,
    path: "/v2/money_management/financial_accounts",
    params: params,
    opts: opts,
    base_address: :api
  )
end

#retrieve(id, params = {}, opts = {}) ⇒ Object

Retrieves the details of an existing FinancialAccount.



107
108
109
110
111
112
113
114
115
 
# File 'lib/stripe/services/v2/money_management/financial_account_service.rb', line 107

def retrieve(id, params = {}, opts = {})
  request(
    method: :get,
    path: format("/v2/money_management/financial_accounts/%<id>s", { id: CGI.escape(id) }),
    params: params,
    opts: opts,
    base_address: :api
  )
end