class CyberSource::RefundApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/cyberSource_client/api/refund_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_refund(id, opts = {}) click to toggle source

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details. @param id The refund ID. This ID is returned from a previous refund request. @param [Hash] opts the optional parameters @return [InlineResponse2005]

# File lib/cyberSource_client/api/refund_api.rb, line 27
def get_refund(id, opts = {})
  data, _status_code, _headers = get_refund_with_http_info(id, opts)
  return data, _status_code, _headers
end
get_refund_with_http_info(id, opts = {}) click to toggle source

Retrieve a Refund Include the refund ID in the GET request to to retrieve the refund details. @param id The refund ID. This ID is returned from a previous refund request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2005, Fixnum, Hash)>] InlineResponse2005 data, response status code and response headers

# File lib/cyberSource_client/api/refund_api.rb, line 37
def get_refund_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.get_refund ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RefundApi.get_refund"
  end
  # resource path
  local_var_path = 'pts/v2/refunds/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundApi#get_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
refund_capture(refund_capture_request, id, opts = {}) click to toggle source

Refund a Capture Include the capture ID in the POST request to refund the captured amount. @param refund_capture_request @param id The capture ID. This ID is returned from a previous capture request. @param [Hash] opts the optional parameters @return [InlineResponse2013]

# File lib/cyberSource_client/api/refund_api.rb, line 80
def refund_capture(refund_capture_request, id, opts = {})
  data, _status_code, _headers = refund_capture_with_http_info(refund_capture_request, id, opts)
  return data, _status_code, _headers
end
refund_capture_with_http_info(refund_capture_request, id, opts = {}) click to toggle source

Refund a Capture Include the capture ID in the POST request to refund the captured amount. @param refund_capture_request @param id The capture ID. This ID is returned from a previous capture request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2013, Fixnum, Hash)>] InlineResponse2013 data, response status code and response headers

# File lib/cyberSource_client/api/refund_api.rb, line 91
def refund_capture_with_http_info(refund_capture_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.refund_capture ...'
  end
  # verify the required parameter 'refund_capture_request' is set
  if @api_client.config.client_side_validation && refund_capture_request.nil?
    fail ArgumentError, "Missing the required parameter 'refund_capture_request' when calling RefundApi.refund_capture"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RefundApi.refund_capture"
  end
  # resource path
  local_var_path = 'pts/v2/captures/{id}/refunds'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(refund_capture_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2013')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundApi#refund_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
refund_payment(refund_payment_request, id, opts = {}) click to toggle source

Refund a Payment Include the payment ID in the POST request to refund the payment amount. @param refund_payment_request @param id The payment ID. This ID is returned from a previous payment request. @param [Hash] opts the optional parameters @return [InlineResponse2013]

# File lib/cyberSource_client/api/refund_api.rb, line 138
def refund_payment(refund_payment_request, id, opts = {})
  data, _status_code, _headers = refund_payment_with_http_info(refund_payment_request, id, opts)
  return data, _status_code, _headers
end
refund_payment_with_http_info(refund_payment_request, id, opts = {}) click to toggle source

Refund a Payment Include the payment ID in the POST request to refund the payment amount. @param refund_payment_request @param id The payment ID. This ID is returned from a previous payment request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2013, Fixnum, Hash)>] InlineResponse2013 data, response status code and response headers

# File lib/cyberSource_client/api/refund_api.rb, line 149
def refund_payment_with_http_info(refund_payment_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RefundApi.refund_payment ...'
  end
  # verify the required parameter 'refund_payment_request' is set
  if @api_client.config.client_side_validation && refund_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'refund_payment_request' when calling RefundApi.refund_payment"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RefundApi.refund_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/refunds'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(refund_payment_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse2013')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundApi#refund_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end