class GoCardless::Services::MandateService

Service for making requests to the Mandate endpoints

Public Instance Methods

all(options = {}) click to toggle source

Get a lazily enumerated list of all the items returned. This is simmilar 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.

# File lib/gocardless-pro/services/mandate_service.rb, line 49
def all(options = {})
  Paginator.new(
    service: self,
    path: '/mandates',
    options: options
  ).enumerator
end
cancel(identity, options = {}, custom_headers = {}) click to toggle source

Immediately cancels a mandate and all associated cancellable payments. Any metadata supplied to this endpoint will be stored on the mandate cancellation event it causes.

This will fail with a ‘cancellation_failed` error if the mandate is already cancelled. Example URL: /mandates/:identity/actions/cancel

@param identity # Unique identifier, beginning with “MD” @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 109
def cancel(identity, options = {}, custom_headers = {})
  path = sub_url('/mandates/:identity/actions/cancel',           'identity' => identity)

  new_options = {}
  new_options['data'] = options
  options = new_options
  response = make_request(:post, path, options, custom_headers)

  Resources::Mandate.new(unenvelope_body(response.body))
end
create(options = {}, custom_headers = {}) click to toggle source

Creates a new mandate object Example URL: /mandates @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 17
def create(options = {}, custom_headers = {})
  path = '/mandates'
  new_options = {}
  new_options[envelope_key] = options
  options = new_options
  response = make_request(:post, path, options, custom_headers)

  Resources::Mandate.new(unenvelope_body(response.body))
end
get(identity, options = {}, custom_headers = {}) click to toggle source

Retrieves the details of an existing mandate.

If you specify ‘Accept: application/pdf` on a request to this endpoint it will return a PDF complying to the relevant scheme rules, which you can present to your customer.

PDF mandates can be retrieved in Dutch, English, French, German, Italian, Portuguese and Spanish by specifying the [ISO 639-1](en.wikipedia.org/wiki/List_of_ISO_639-1_codes#Partial_ISO_639_table) language code as an ‘Accept-Language` header. Example URL: /mandates/:identity

@param identity # Unique identifier, beginning with “MD” @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 73
def get(identity, options = {}, custom_headers = {})
  path = sub_url('/mandates/:identity',           'identity' => identity)

  response = make_request(:get, path, options, custom_headers)

  Resources::Mandate.new(unenvelope_body(response.body))
end
list(options = {}, custom_headers = {}) click to toggle source

Returns a [cursor-paginated](developer.gocardless.com/pro/#overview-cursor-pagination) list of your mandates. Except where stated, these filters can only be used one at a time. Example URL: /mandates @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 34
def list(options = {}, custom_headers = {})
  path = '/mandates'

  response = make_request(:get, path, options, custom_headers)
  ListResponse.new(
    raw_response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::Mandate
  )
end
reinstate(identity, options = {}, custom_headers = {}) click to toggle source

<a name=“mandate_not_inactive”></a>Reinstates a cancelled or expired mandate to the banks. You will receive a ‘resubmission_requested` webhook, but after that reinstating the mandate follows the same process as its initial creation, so you will receive a `submitted` webhook, followed by a `reinstated` or `failed` webhook up to two working days later. Any metadata supplied to this endpoint will be stored on the `resubmission_requested` event it causes.

This will fail with a ‘mandate_not_inactive` error if the mandate is already being submitted, or is active. Example URL: /mandates/:identity/actions/reinstate

@param identity # Unique identifier, beginning with “MD” @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 135
def reinstate(identity, options = {}, custom_headers = {})
  path = sub_url('/mandates/:identity/actions/reinstate',           'identity' => identity)

  new_options = {}
  new_options['data'] = options
  options = new_options
  response = make_request(:post, path, options, custom_headers)

  Resources::Mandate.new(unenvelope_body(response.body))
end
unenvelope_body(body) click to toggle source

Unenvelope the response of the body using the service’s ‘envelope_key`

@param body [Hash]

# File lib/gocardless-pro/services/mandate_service.rb, line 149
def unenvelope_body(body)
  body[envelope_key] || body['data']
end
update(identity, options = {}, custom_headers = {}) click to toggle source

Updates a mandate object. This accepts only the metadata parameter. Example URL: /mandates/:identity

@param identity # Unique identifier, beginning with “MD” @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Else, they will be the body of the request.

# File lib/gocardless-pro/services/mandate_service.rb, line 87
def update(identity, options = {}, custom_headers = {})
  path = sub_url('/mandates/:identity',           'identity' => identity)

  new_options = {}
  new_options[envelope_key] = options
  options = new_options
  response = make_request(:put, path, options, custom_headers)

  Resources::Mandate.new(unenvelope_body(response.body))
end

Private Instance Methods

envelope_key() click to toggle source

return the key which API responses will envelope data under

# File lib/gocardless-pro/services/mandate_service.rb, line 156
def envelope_key
  'mandates'
end
sub_url(url, param_map) click to toggle source

take a URL with placeholder params and substitute them out for the acutal value @param url [String] the URL with placeholders in @param param_map [Hash] a hash of placeholders and their actual values

# File lib/gocardless-pro/services/mandate_service.rb, line 163
def sub_url(url, param_map)
  param_map.reduce(url) do |new_url, (param, value)|
    new_url.gsub(":#{param}", value)
  end
end