Class: CyberSource::ReversalApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of ReversalApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/reversal_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/reversal_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#auth_reversal(id, auth_reversal_request, opts = {}) ⇒ PtsV2PaymentsReversalsPost201Response

Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.

Parameters:

  • id —

    The payment ID returned from a previous payment request.

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

    the optional parameters

Returns:



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

def auth_reversal(id, auth_reversal_request, opts = {})
  data, status_code, headers = auth_reversal_with_http_info(id, auth_reversal_request, opts)
  return data, status_code, headers
end

#auth_reversal_with_http_info(id, auth_reversal_request, opts = {}) ⇒ Array<(PtsV2PaymentsReversalsPost201Response, Fixnum, Hash)>

Process an Authorization Reversal Include the payment ID in the POST request to reverse the payment amount.

Parameters:

  • id —

    The payment ID returned from a previous payment request.

  • auth_reversal_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/reversal_api.rb', line 40

def auth_reversal_with_http_info(id, auth_reversal_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: ReversalApi.auth_reversal ...'
        rescue
            puts 'Cannot write to log'
        end
  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 ReversalApi.auth_reversal"
  end
  # verify the required parameter 'auth_reversal_request' is set
  if @api_client.config.client_side_validation && auth_reversal_request.nil?
    fail ArgumentError, "Missing the required parameter 'auth_reversal_request' when calling ReversalApi.auth_reversal"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/reversals'.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(auth_reversal_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 => 'PtsV2PaymentsReversalsPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: ReversalApi#auth_reversal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#mit_reversal(mit_reversal_request, opts = {}) ⇒ PtsV2PaymentsReversalsPost201Response

Timeout Reversal This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -> transactionId in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

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

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/cybersource_rest_client/api/reversal_api.rb', line 99

def mit_reversal(mit_reversal_request, opts = {})
  data, status_code, headers = mit_reversal_with_http_info(mit_reversal_request, opts)
  return data, status_code, headers
end

#mit_reversal_with_http_info(mit_reversal_request, opts = {}) ⇒ Array<(PtsV2PaymentsReversalsPost201Response, Fixnum, Hash)>

Timeout Reversal This is to reverse a previous payment that merchant does not receive a reply(Mostly due to Timeout). To use this feature/API, make sure to pass unique value to field - clientReferenceInformation -&gt; transactionId in [/pts/v2/payments](developer.cybersource.com/api-reference-assets/index.html#payments_payments) API call and use same transactionId in this API request payload to reverse the payment.

Parameters:

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

    the optional parameters

Returns:



109
110
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
 
# File 'lib/cybersource_rest_client/api/reversal_api.rb', line 109

def mit_reversal_with_http_info(mit_reversal_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: ReversalApi.mit_reversal ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'mit_reversal_request' is set
  if @api_client.config.client_side_validation && mit_reversal_request.nil?
    fail ArgumentError, "Missing the required parameter 'mit_reversal_request' when calling ReversalApi.mit_reversal"
  end
  # resource path
  local_var_path = 'pts/v2/reversals/'

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