class GoCardlessPro::Services::RefundsService

Service for making requests to the Refund 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/refunds_service.rb, line 86
def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end
create(options = {}) click to toggle source

Creates a new refund object.

This fails with:<a name=“total_amount_confirmation_invalid”></a><a name=“number_of_refunds_exceeded”></a><a name=“available_refund_amount_insufficient”></a>

  • `total_amount_confirmation_invalid` if the confirmation amount doesn't match

the total amount refunded for the payment. This safeguard is there to prevent two processes from creating refunds without awareness of each other.

  • `number_of_refunds_exceeded` if five or more refunds have already been

created against the payment.

  • `available_refund_amount_insufficient` if the creditor does not have

sufficient balance for refunds available to cover the cost of the requested refund.

Example URL: /refunds @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/refunds_service.rb, line 32
def create(options = {})
  path = '/refunds'

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

Retrieves all details for a single refund Example URL: /refunds/:identity

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

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

Returns a [cursor-paginated](api-usage-cursor-pagination) list of your refunds. Example URL: /refunds @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/refunds_service.rb, line 68
def list(options = {})
  path = '/refunds'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::Refund
  )
end
update(identity, options = {}) click to toggle source

Updates a refund object. Example URL: /refunds/:identity

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

# File lib/gocardless_pro/services/refunds_service.rb, line 115
def update(identity, options = {})
  path = sub_url('/refunds/: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::Refund.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/refunds_service.rb, line 141
def envelope_key
  'refunds'
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/refunds_service.rb, line 136
def unenvelope_body(body)
  body[envelope_key] || body['data']
end