class GoCardlessPro::Services::SchemeIdentifiersService
Service for making requests to the SchemeIdentifier endpoints
Public Instance Methods
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 109 def all(options = {}) Paginator.new( service: self, options: options ).enumerator end
Get a lazily enumerated list of all the items returned. This is similar 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.
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 55 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
Creates a new scheme identifier. The scheme identifier status will be ‘pending` while GoCardless is processing the request. Once the scheme identifier is ready to be used the status will be updated to `active`. At this point, GoCardless will emit a scheme identifier activated event via webhook to notify you of this change. In Bacs, it will take up to five working days for a scheme identifier to become active. On other schemes, including SEPA, 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 @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 121 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
Retrieves the details of an existing scheme identifier. Example URL: /scheme_identifiers/:identity
@param identity # Unique identifier, usually beginning with “SU”. @param options [Hash] parameters as a hash, under a params key.
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 91 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
Returns a [cursor-paginated](api-usage-cursor-pagination) list of your scheme identifiers. Example URL: /scheme_identifiers @param options [Hash] parameters as a hash, under a params key.
Private Instance Methods
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 145 def envelope_key 'scheme_identifiers' end
return the key which API responses will envelope data under
Source
# File lib/gocardless_pro/services/scheme_identifiers_service.rb, line 140 def unenvelope_body(body) body[envelope_key] || body['data'] end
Unenvelope the response of the body using the service’s ‘envelope_key`
@param body [Hash]