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

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

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 CannotProceedError ** raises ControlledByDashboardError



15
16
17
18
19
20
21
22
23
 
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 15

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

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

Confirm microdeposits amounts or descriptor code that you have received from the Send Microdeposits request. Once you correctly confirm this, this US Bank Account will be verified and eligible to transfer funds with.

** raises ControlledByAlternateResourceError



28
29
30
31
32
33
34
35
36
 
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 28

def confirm_microdeposits(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/vault/us_bank_accounts/%<id>s/confirm_microdeposits", { 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



43
44
45
46
47
48
49
50
51
 
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 43

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

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

List USBankAccount objects. Optionally filter by verification status.



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

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

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

Retrieve a USBankAccount object.



65
66
67
68
69
70
71
72
73
 
# File 'lib/stripe/services/v2/core/vault/us_bank_account_service.rb', line 65

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

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

Send microdeposits in order to verify your US Bank Account so it is eligible to transfer funds. This will start the verification process and you must Confirm Microdeposits to successfully verify your US Bank Account.

** raises ControlledByAlternateResourceError



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

def send_microdeposits(id, params = {}, opts = {})
  request(
    method: :post,
    path: format("/v2/core/vault/us_bank_accounts/%<id>s/send_microdeposits", { 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



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

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