Class: GoCardlessPro::Services::SchemeIdentifiersService

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

Overview

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



107
108
109
110
111
112
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 107

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

#create(options = {}) ⇒ Object

Creates a new scheme identifier. The scheme identifier must be [applied to a creditor](#creditors-apply-a-scheme-identifier) before payments are taken using it. The scheme identifier must also have the status of active before it can be used. On Bacs, this will take 5 working days. On other schemes, this happens instantly.

#### Scheme identifier name validations

The name field of a scheme identifier can contain alphanumeric characters, spaces and special characters.

Its maximum length and the special characters it supports depend on the scheme:

| __scheme__ | __maximum length__ | __special characters allowed__

|

| :—————- | :—————– | :————————————————– | | bacs | 18 characters | / . ‘&` -

|

| sepa | 70 characters | / ‘?` : `(` `)` . `,` `+` `&` `<` `>` `’‘ `“` | | ach | 16 characters | / `?` : `(` `)` . `,` `’‘ `+` - | | faster_payments | 18 characters | / `?` : `(` `)` . `,` `’‘ `+` - |

The validation error that gets returned for an invalid name will contain a suggested name in the metadata that is guaranteed to pass name validations.

You should ensure that the name you set matches the legal name or the trading name of the creditor, otherwise, there is an increased risk of chargeback.

Example URL: /scheme_identifiers

Parameters:

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

    parameters as a hash, under a params key.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 53

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

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

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

Retrieves the details of an existing scheme identifier. Example URL: /scheme_identifiers/:identity

Parameters:

  • identity —

    # Unique identifier, usually beginning with “SU”.

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

    parameters as a hash, under a params key.



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 119

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

#list(options = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme identifiers. Example URL: /scheme_identifiers

Parameters:

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

    parameters as a hash, under a params key.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 89

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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