Class: GoCardlessPro::Services::VerificationDetailsService

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

Overview

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



34
35
36
37
38
39
 
# File 'lib/gocardless_pro/services/verification_details_service.rb', line 34

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

#create(options = {}) ⇒ Object

Verification details represent any information needed by GoCardless to verify a creditor. Currently, only UK-based companies are supported. In other words, to submit verification details for a creditor, their creditor_type must be company and their country_code must be GB. Example URL: /verification_details



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/gocardless_pro/services/verification_details_service.rb', line 48

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

  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::VerificationDetail.new(unenvelope_body(response.body), response)
end

#list(options = {}) ⇒ Object

Returns a list of verification details belonging to a creditor. Example URL: /verification_details



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/gocardless_pro/services/verification_details_service.rb', line 16

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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