class GoCardlessPro::Services::PayerAuthorisationsService

Service for making requests to the PayerAuthorisation endpoints

Public Instance Methods

confirm(identity, options = {}) click to toggle source

Confirms the Payer Authorisation, indicating that the resources are ready to be created. A Payer Authorisation cannot be confirmed if it hasn't been submitted yet.

<p class=“notice”>

The main use of the confirm endpoint is to enable integrators to acknowledge

the end of the setup process.

They might want to make the payers go through some other steps after they go

through our flow or make them go through the necessary verification mechanism (upcoming feature). </p> Example URL: /payer_authorisations/:identity/actions/confirm

@param identity # Unique identifier, beginning with “PA”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/payer_authorisations_service.rb, line 155
def confirm(identity, options = {})
  path = sub_url('/payer_authorisations/:identity/actions/confirm', 'identity' => identity)

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params]['data'] = params

  options[:retry_failures] = false

  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::PayerAuthorisation.new(unenvelope_body(response.body), response)
end
create(options = {}) click to toggle source

Creates a Payer Authorisation. The resource is saved to the database even if incomplete. An empty array of incomplete_fields means that the resource is valid. The ID of the resource is used for the other actions. This endpoint has been designed this way so you do not need to save any payer data on your servers or the browser while still being able to implement a progressive solution, such as a multi-step form. Example URL: /payer_authorisations @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/payer_authorisations_service.rb, line 39
def create(options = {})
  path = '/payer_authorisations'

  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::PayerAuthorisation.new(unenvelope_body(response.body), response)
end
get(identity, options = {}) click to toggle source

Retrieves the details of a single existing Payer Authorisation. It can be used for polling the status of a Payer Authorisation. Example URL: /payer_authorisations/:identity

@param identity # Unique identifier, beginning with “PA”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/payer_authorisations_service.rb, line 19
def get(identity, options = {})
  path = sub_url('/payer_authorisations/:identity', 'identity' => identity)

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

Submits all the data previously pushed to this PayerAuthorisation for verification. This time, a 200 HTTP status is returned if the resource is valid and a 422 error response in case of validation errors. After it is successfully submitted, the Payer Authorisation can no longer be edited. Example URL: /payer_authorisations/:identity/actions/submit

@param identity # Unique identifier, beginning with “PA”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/payer_authorisations_service.rb, line 108
def submit(identity, options = {})
  path = sub_url('/payer_authorisations/:identity/actions/submit', 'identity' => identity)

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params]['data'] = params

  options[:retry_failures] = false

  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::PayerAuthorisation.new(unenvelope_body(response.body), response)
end
update(identity, options = {}) click to toggle source

Updates a Payer Authorisation. Updates the Payer Authorisation with the request data. Can be invoked as many times as needed. Only fields present in the request will be modified. An empty array of incomplete_fields means that the resource is valid. This endpoint has been designed this way so you do not need to save any payer data on your servers or the browser while still being able to implement a progressive solution, such a multi-step form. <p class=“notice”> Note that in order to update the `metadata` attribute values it must be sent completely as it overrides the previously existing values. </p> Example URL: /payer_authorisations/:identity

@param identity # Unique identifier, beginning with “PA”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/payer_authorisations_service.rb, line 84
def update(identity, options = {})
  path = sub_url('/payer_authorisations/:identity', 'identity' => identity)

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  response = make_request(:put, path, options)

  return if response.body.nil?

  Resources::PayerAuthorisation.new(unenvelope_body(response.body), response)
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/payer_authorisations_service.rb, line 197
def envelope_key
  'payer_authorisations'
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/payer_authorisations_service.rb, line 192
def unenvelope_body(body)
  body[envelope_key] || body['data']
end