Class: GoCardlessPro::Services::BankDetailsLookupsService

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

Overview

Service for making requests to the BankDetailsLookup endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request

Constructor Details

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

Instance Method Details

#create(options = {}) ⇒ Object

Performs a bank details lookup. As part of the lookup, a modulus check and reachability check are performed.

If your request returns an [error](#api-usage-errors) or the ‘available_debit_schemes` attribute is an empty array, you will not be able to collect payments from the specified bank account. GoCardless may be able to collect payments from an account even if no `bic` is returned.

Bank account details may be supplied using [local details](#appendix-local-bank-details) or an IBAN.

Note: Usage of this endpoint is monitored. If your organisation relies on GoCardless for modulus or reachability checking but not for payment collection, please get in touch. Example URL: /bank_details_lookups

Parameters:

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

    parameters as a hash, under a params key.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/gocardless_pro/services/bank_details_lookups_service.rb', line 33

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

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

  options[:retry_failures] = true

  response = make_request(:post, path, options)

  return if response.body.nil?

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