Class: CyberSource::RefundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/refund_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ RefundApi

Returns a new instance of RefundApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 19

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#refund_capture(refund_capture_request, id, opts = {}) ⇒ PtsV2PaymentsRefundPost201Response

Refund a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/id/captures](developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to refund the captured amount.

Parameters:

  • refund_capture_request
  • id —

    The capture ID. This ID is returned from a previous capture request.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 29

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 = {}) ⇒ Array<(PtsV2PaymentsRefundPost201Response, Fixnum, Hash)>

Refund a Capture Refund a capture API is only used, if you have requested Capture independenlty using [/pts/v2/payments/id/captures](developer.cybersource.com/api-reference-assets/index.html#payments_capture) API call. Include the capture ID in the POST request to refund the captured amount.

Parameters:

  • refund_capture_request
  • id —

    The capture ID. This ID is returned from a previous capture request.

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

    the optional parameters

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 40

def refund_capture_with_http_info(refund_capture_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: RefundApi.refund_capture ...'
        rescue
            puts 'Cannot write to log'
        end
  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;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # 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 => 'PtsV2PaymentsRefundPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: RefundApi#refund_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#refund_payment(refund_payment_request, id, opts = {}) ⇒ PtsV2PaymentsRefundPost201Response

Refund a Payment Refund a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to refund the payment amount.

Parameters:

  • refund_payment_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:



100
101
102
103
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 100

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 = {}) ⇒ Array<(PtsV2PaymentsRefundPost201Response, Fixnum, Hash)>

Refund a Payment Refund a Payment API is only used, if you have requested Authorization and Capture together in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call. Include the payment ID in the POST request to refund the payment amount.

Parameters:

  • refund_payment_request
  • id —

    The payment ID. This ID is returned from a previous payment request.

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

    the optional parameters

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
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
156
157
158
159
160
161
162
163
164
 
# File 'lib/cybersource_rest_client/api/refund_api.rb', line 111

def refund_payment_with_http_info(refund_payment_request, id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: RefundApi.refund_payment ...'
        rescue
            puts 'Cannot write to log'
        end
  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;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # 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 => 'PtsV2PaymentsRefundPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: RefundApi#refund_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end