Class: GoCardlessPro::Services::InstitutionsService

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

Overview

Service for making requests to the Institution 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.



41
42
43
44
45
46
 
# File 'lib/gocardless_pro/services/institutions_service.rb', line 41

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

#list(options = {}) ⇒ Object

Returns a list of supported institutions.

<p class=“deprecated-notice”><strong>Deprecated</strong>: This list institutions endpoint is no longer supported. We strongly recommend using the [List Institutions For Billing Request](#institutions-list-institutions-for-billing-request) instead.</p> Example URL: /institutions



23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/gocardless_pro/services/institutions_service.rb', line 23

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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

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

Returns all institutions valid for a Billing Request.

This endpoint is currently supported only for FasterPayments. Example URL: /billing_requests/:identity/institutions



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/gocardless_pro/services/institutions_service.rb', line 55

def list_for_billing_request(identity, options = {})
  path = sub_url('/billing_requests/:identity/institutions', {
                   'identity' => identity,
                 })

  options[:retry_failures] = false

  response = make_request(:get, path, options)

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