class GoCardless::Services::PaymentService

Service for making requests to the Payment 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/payment_service.rb, line 54
def all(options = {})
  Paginator.new(
    service: self,
    path: '/payments',
    options: options
  ).enumerator
end
cancel(identity, options = {}, custom_headers = {}) click to toggle source

Cancels the payment if it has not already been submitted to the banks. Any metadata supplied to this endpoint will be stored on the payment cancellation event it causes.

This will fail with a ‘cancellation_failed` error unless the payment’s status is ‘pending_submission`. Example URL: /payments/:identity/actions/cancel

@param identity # Unique identifier, beginning with “PM” @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/payment_service.rb, line 104
def cancel(identity, options = {}, custom_headers = {})
  path = sub_url('/payments/:identity/actions/cancel',           'identity' => identity)

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

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

<a name=“mandate_is_inactive”></a>Creates a new payment object.

This fails with a ‘mandate_is_inactive` error if the linked [mandate](developer.gocardless.com/pro/#api-endpoints-mandates) is cancelled. Payments can be created against `pending_submission` mandates, but they will not be submitted until the mandate becomes active. Example URL: /payments @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/payment_service.rb, line 23
def create(options = {}, custom_headers = {})
  path = '/payments'
  new_options = {}
  new_options[envelope_key] = options
  options = new_options
  response = make_request(:post, path, options, custom_headers)

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

Retrieves the details of a single existing payment. Example URL: /payments/:identity

@param identity # Unique identifier, beginning with “PM” @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/payment_service.rb, line 68
def get(identity, options = {}, custom_headers = {})
  path = sub_url('/payments/:identity',           'identity' => identity)

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

  Resources::Payment.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 payments. Example URL: /payments @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/payment_service.rb, line 39
def list(options = {}, custom_headers = {})
  path = '/payments'

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

<a name=“retry_failed”></a>Retries a failed payment if the underlying mandate is active. You will receive a ‘resubmission_requested` webhook, but after that retrying the payment follows the same process as its initial creation, so you will receive a `submitted` webhook, followed by a `confirmed` or `failed` event. Any metadata supplied to this endpoint will be stored against the payment submission event it causes.

This will return a ‘retry_failed` error if the payment has not failed. Example URL: /payments/:identity/actions/retry

@param identity # Unique identifier, beginning with “PM” @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/payment_service.rb, line 129
def retry(identity, options = {}, custom_headers = {})
  path = sub_url('/payments/:identity/actions/retry',           'identity' => identity)

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

  Resources::Payment.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/payment_service.rb, line 143
def unenvelope_body(body)
  body[envelope_key] || body['data']
end
update(identity, options = {}, custom_headers = {}) click to toggle source

Updates a payment object. This accepts only the metadata parameter. Example URL: /payments/:identity

@param identity # Unique identifier, beginning with “PM” @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/payment_service.rb, line 82
def update(identity, options = {}, custom_headers = {})
  path = sub_url('/payments/:identity',           'identity' => identity)

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

  Resources::Payment.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/payment_service.rb, line 150
def envelope_key
  'payments'
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/payment_service.rb, line 157
def sub_url(url, param_map)
  param_map.reduce(url) do |new_url, (param, value)|
    new_url.gsub(":#{param}", value)
  end
end