Class: Stripe::V2::Core::Vault::UsBankAccountService

Inherits:
StripeService
  • Object
show all
Defined in:
lib/stripe/services/v2/core/vault/us_bank_account_service.rb

Defined Under Namespace

Classes: ArchiveParams, CreateParams, RetrieveParams, UpdateParams

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

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

Archive a USBankAccount object. USBankAccount objects will not be automatically archived by Stripe. Archived USBankAccount objects cannot be used as outbound destinations and will not appear in the outbound destination list.

** raises ControlledByDashboardError



53
54
55
56
57
58
59
60
61
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 53

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

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

Create a USBankAccount object.

** raises BlockedByStripeError ** raises InvalidPaymentMethodError ** raises QuotaExceededError



68
69
70
71
72
73
74
75
76
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 68

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

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

Retrieve a USBankAccount object.



79
80
81
82
83
84
85
86
87
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 79

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

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

Update a USBankAccount object. This is limited to supplying a previously empty routing_number field.

** raises BlockedByStripeError ** raises InvalidPaymentMethodError ** raises QuotaExceededError



94
95
96
97
98
99
100
101
102
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 94

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