Class: GoCardlessPro::Services::RefundsService

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

Overview

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



86
87
88
89
90
91
 
# File 'lib/gocardless_pro/services/refunds_service.rb', line 86

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

#create(options = {}) ⇒ Object

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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# 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 = {}) ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
 
# 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 = {}) ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# 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 = {}) ⇒ Object

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



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

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