Class: GoCardlessPro::Services::CustomerBankAccountsService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/gocardless_pro/services/customer_bank_accounts_service.rb

Overview

Service for making requests to the CustomerBankAccount endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request, #sub_url

Constructor Details

This class inherits a constructor from GoCardlessPro::Services::BaseService

Instance Method Details

#all(options = {}) ⇒ Object

Get a lazily enumerated list of all the items returned. This is similar to the ‘list` method but will paginate for you automatically.

Otherwise they will be the body of the request.

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



82
83
84
85
86
87
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 82

def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end

#create(options = {}) ⇒ Object

Creates a new customer bank account object.

There are three different ways to supply bank account details:

  • [Local details](#appendix-local-bank-details)

  • IBAN

  • [Customer Bank Account

Tokens](#javascript-flow-create-a-customer-bank-account-token)

For more information on the different fields required in each country, see [local bank details](#appendix-local-bank-details). Example URL: /customer_bank_accounts

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 28

def create(options = {})
  path = '/customer_bank_accounts'

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
end

#disable(identity, options = {}) ⇒ Object

Immediately cancels all associated mandates and cancellable payments.

This will return a ‘disable_failed` error if the bank account has already been disabled.

A disabled bank account can be re-enabled by creating a new bank account resource with the same details. Example URL: /customer_bank_accounts/:identity/actions/disable

Parameters:

  • identity —

    # Unique identifier, beginning with “BA”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 143

def disable(identity, options = {})
  path = sub_url('/customer_bank_accounts/:identity/actions/disable', {
                   'identity' => identity
                 })

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params]['data'] = params

  options[:retry_failures] = false

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
end

#get(identity, options = {}) ⇒ Object

Retrieves the details of an existing bank account. Example URL: /customer_bank_accounts/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BA”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 94

def get(identity, options = {})
  path = sub_url('/customer_bank_accounts/:identity', {
                   'identity' => identity
                 })

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
end

#list(options = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your bank accounts. Example URL: /customer_bank_accounts

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 64

def list(options = {})
  path = '/customer_bank_accounts'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::CustomerBankAccount
  )
end

#update(identity, options = {}) ⇒ Object

Updates a customer bank account object. Only the metadata parameter is allowed. Example URL: /customer_bank_accounts/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BA”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/gocardless_pro/services/customer_bank_accounts_service.rb', line 114

def update(identity, options = {})
  path = sub_url('/customer_bank_accounts/:identity', {
                   'identity' => identity
                 })

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  response = make_request(:put, path, options)

  return if response.body.nil?

  Resources::CustomerBankAccount.new(unenvelope_body(response.body), response)
end