Class: Stripe::Treasury::FinancialAccountService

Inherits:
StripeService show all
Defined in:
lib/stripe/services/treasury/financial_account_service.rb

Defined Under Namespace

Classes: CloseParams, CreateParams, ListParams, RetrieveParams, UpdateParams

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from StripeService

#request, #request_stream

Constructor Details

#initialize(requestor) ⇒ FinancialAccountService

Returns a new instance of FinancialAccountService.



9
10
11
12
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 9

def initialize(requestor)
  super(requestor)
  @features = Stripe::Treasury::FinancialAccountFeaturesService.new(@requestor)
end

Instance Attribute Details

#features ⇒ Object (readonly)

Returns the value of attribute features.



7
8
9
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 7

def features
  @features
end

Instance Method Details

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

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.



513
514
515
516
517
518
519
520
521
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 513

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

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

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.



524
525
526
527
528
529
530
531
532
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 524

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

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

Returns a list of FinancialAccounts.



535
536
537
538
539
540
541
542
543
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 535

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

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

Retrieves the details of a FinancialAccount.



546
547
548
549
550
551
552
553
554
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 546

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

#update(financial_account, params = {}, opts = {}) ⇒ Object

Updates the details of a FinancialAccount.



557
558
559
560
561
562
563
564
565
 
# File 'lib/stripe/services/treasury/financial_account_service.rb', line 557

def update(, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v1/treasury/financial_accounts/%<financial_account>s", { financial_account: CGI.escape() }),
    params: params,
    opts: opts,
    base_address: :api
  )
end