class GoCardlessPro::Services::CreditorBankAccountsService
Service for making requests to the CreditorBankAccount endpoints
Public Instance Methods
Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
@param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Otherwise they will be the body of the request.
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 70 def all(options = {}) Paginator.new( service: self, options: options ).enumerator end
Creates a new creditor bank account object. Example URL: /creditor_bank_accounts @param options [Hash] parameters as a hash, under a params key.
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 16 def create(options = {}) path = '/creditor_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::CreditorBankAccount.new(unenvelope_body(response.body), response) end
Immediately disables the bank account, no money can be paid out to a disabled account.
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: /creditor_bank_accounts/:identity/actions/disable
@param identity # Unique identifier, beginning with “BA”. @param options [Hash] parameters as a hash, under a params key.
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 106 def disable(identity, options = {}) path = sub_url('/creditor_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::CreditorBankAccount.new(unenvelope_body(response.body), response) end
Retrieves the details of an existing creditor bank account. Example URL: /creditor_bank_accounts/:identity
@param identity # Unique identifier, beginning with “BA”. @param options [Hash] parameters as a hash, under a params key.
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 82 def get(identity, options = {}) path = sub_url('/creditor_bank_accounts/:identity', 'identity' => identity) options[:retry_failures] = true response = make_request(:get, path, options) return if response.body.nil? Resources::CreditorBankAccount.new(unenvelope_body(response.body), response) end
Returns a [cursor-paginated](api-usage-cursor-pagination) list of your creditor bank accounts. Example URL: /creditor_bank_accounts @param options [Hash] parameters as a hash, under a params key.
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 52 def list(options = {}) path = '/creditor_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::CreditorBankAccount ) end
Private Instance Methods
return the key which API responses will envelope data under
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 148 def envelope_key 'creditor_bank_accounts' end
Unenvelope the response of the body using the service's `envelope_key`
@param body [Hash]
# File lib/gocardless_pro/services/creditor_bank_accounts_service.rb, line 143 def unenvelope_body(body) body[envelope_key] || body['data'] end