Class: GoCardlessPro::Services::BillingRequestsService

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

Overview

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

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



300
301
302
303
304
305
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 300

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

#cancel(identity, options = {}) ⇒ Object

Immediately cancels a billing request, causing all billing request flows to expire. Example URL: /billing_requests/:identity/actions/cancel

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 244

def cancel(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/cancel', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#choose_currency(identity, options = {}) ⇒ Object

This will allow for the updating of the currency and subsequently the scheme if needed for a Billing Request. This will only be available for mandate only flows which do not have the lock_currency flag set to true on the Billing Request Flow. It will also not support any request which has a payments request. Example URL: /billing_requests/:identity/actions/choose_currency

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 421

def choose_currency(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/choose_currency', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#collect_bank_account(identity, options = {}) ⇒ Object

If the billing request has a pending collect_bank_account action, this endpoint can be used to collect the details in order to complete it.

The endpoint takes the same payload as Customer Bank Accounts, but check the bank account is valid for the billing request scheme before creating and attaching it.

If the scheme is PayTo and the pay_id is available, this can be included in the payload along with the country_code.

_ACH scheme_ For compliance reasons, an extra validation step is done using a third-party provider to make sure the customer’s bank account can accept Direct Debit. If a bank account is discovered to be closed or invalid, the customer is requested to adjust the account number/routing number and succeed in this check to continue with the flow.

_BACS scheme_ [Payer Name Verification](hub.gocardless.com/s/article/Introduction-to-Payer-Name-Verification?language=en_GB) is enabled by default for UK based bank accounts, meaning we verify the account holder name and bank account number match the details held by the relevant bank. Example URL: /billing_requests/:identity/actions/collect_bank_account

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 123

def (identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/collect_bank_account', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#collect_customer_details(identity, options = {}) ⇒ Object

If the billing request has a pending collect_customer_details action, this endpoint can be used to collect the details in order to complete it.

The endpoint takes the same payload as Customers, but checks that the customer fields are populated correctly for the billing request scheme.

Whatever is provided to this endpoint is used to update the referenced customer, and will take effect immediately after the request is successful. Example URL: /billing_requests/:identity/actions/collect_customer_details

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 62

def collect_customer_details(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/collect_customer_details', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#confirm_payer_details(identity, options = {}) ⇒ Object

This is needed when you have a mandate request. As a scheme compliance rule we are required to allow the payer to crosscheck the details entered by them and confirm it. Example URL: /billing_requests/:identity/actions/confirm_payer_details

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 164

def confirm_payer_details(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/confirm_payer_details', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#create(options = {}) ⇒ Object

Example URL: /billing_requests

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 16

def create(options = {})
  path = '/billing_requests'

  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::BillingRequest.new(unenvelope_body(response.body), response)
end

#fallback(identity, options = {}) ⇒ Object

Triggers a fallback from the open-banking flow to direct debit. Note, the billing request must have fallback enabled. Example URL: /billing_requests/:identity/actions/fallback

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 376

def fallback(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/fallback', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#fulfil(identity, options = {}) ⇒ Object

If a billing request is ready to be fulfilled, call this endpoint to cause it to fulfil, executing the payment. Example URL: /billing_requests/:identity/actions/fulfil

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 204

def fulfil(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/fulfil', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#get(identity, options = {}) ⇒ Object

Fetches a billing request Example URL: /billing_requests/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 312

def get(identity, options = {})
  path = sub_url('/billing_requests/:identity', {
                   'identity' => identity
                 })

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::BillingRequest.new(unenvelope_body(response.body), response)
end

#list(options = {}) ⇒ Object

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

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 282

def list(options = {})
  path = '/billing_requests'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::BillingRequest
  )
end

#notify(identity, options = {}) ⇒ Object

Notifies the customer linked to the billing request, asking them to authorise it. Currently, the customer can only be notified by email.

This endpoint is currently supported only for Instant Bank Pay Billing Requests. Example URL: /billing_requests/:identity/actions/notify

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 336

def notify(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/notify', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end

#select_institution(identity, options = {}) ⇒ Object

Creates an Institution object and attaches it to the Billing Request Example URL: /billing_requests/:identity/actions/select_institution

Parameters:

  • identity —

    # Unique identifier, beginning with “BRQ”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/gocardless_pro/services/billing_requests_service.rb', line 460

def select_institution(identity, options = {})
  path = sub_url('/billing_requests/:identity/actions/select_institution', {
                   '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::BillingRequest.new(unenvelope_body(response.body), response)
end