Class: CyberSource::PaymentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of PaymentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_payment(create_payment_request, opts = {}) ⇒ PtsV2PaymentsPost201Response

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment features, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

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

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 30

def create_payment(create_payment_request, opts = {})
  data, status_code, headers = create_payment_with_http_info(create_payment_request, opts)
  return data, status_code, headers
end

#create_payment_with_http_info(create_payment_request, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response, Fixnum, Hash)>

Process a Payment A payment authorizes the amount for the transaction. There are a number of supported payment features, such as E-commerce and Card Present - Credit Card/Debit Card, Echeck, e-Wallets, Level II/III Data, etc.. A payment response includes the status of the request. It also includes processor-specific information when the request is successful and errors if unsuccessful. See the [Payments Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/payments/developer/ctv/rest/payments/payments-intro.html). Authorization can be requested with Capture, Decision Manager, Payer Authentication(3ds), and Token Creation.

Parameters:

  • create_payment_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
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 40

def create_payment_with_http_info(create_payment_request, opts = {})

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

  # 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(create_payment_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreatePaymentRequest', @api_client.config.host)
  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 => 'PtsV2PaymentsPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#create_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#increment_auth(id, increment_auth_request, opts = {}) ⇒ PtsV2IncrementalAuthorizationPatch201Response

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

  • id —

    The ID returned from the original authorization request.

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

    the optional parameters

Returns:



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

def increment_auth(id, increment_auth_request, opts = {})
  data, status_code, headers = increment_auth_with_http_info(id, increment_auth_request, opts)
  return data, status_code, headers
end

#increment_auth_with_http_info(id, increment_auth_request, opts = {}) ⇒ Array<(PtsV2IncrementalAuthorizationPatch201Response, Fixnum, Hash)>

Increment an Authorization Use this service to authorize additional charges in a lodging or autorental transaction. Include the ID returned from the original authorization in the PATCH request to add additional charges to that authorization.

Parameters:

  • id —

    The ID returned from the original authorization request.

  • increment_auth_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
165
166
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 111

def increment_auth_with_http_info(id, increment_auth_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.increment_auth ...'
        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 PaymentsApi.increment_auth"
  end
  # verify the required parameter 'increment_auth_request' is set
  if @api_client.config.client_side_validation && increment_auth_request.nil?
    fail ArgumentError, "Missing the required parameter 'increment_auth_request' when calling PaymentsApi.increment_auth"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{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;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(increment_auth_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'IncrementAuthRequest', @api_client.config.host)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PtsV2IncrementalAuthorizationPatch201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#increment_auth\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#refresh_payment_status(id, refresh_payment_status_request, opts = {}) ⇒ PtsV2PaymentsPost201Response1

Check a Payment Status Checks and updates the payment status

Parameters:

  • id —

    The payment id whose status needs to be checked and updated.

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 175

def refresh_payment_status(id, refresh_payment_status_request, opts = {})
  data, status_code, headers = refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts)
  return data, status_code, headers
end

#refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts = {}) ⇒ Array<(PtsV2PaymentsPost201Response1, Fixnum, Hash)>

Check a Payment Status Checks and updates the payment status

Parameters:

  • id —

    The payment id whose status needs to be checked and updated.

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

    the optional parameters

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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
237
238
239
240
241
 
# File 'lib/cybersource_rest_client/api/payments_api.rb', line 186

def refresh_payment_status_with_http_info(id, refresh_payment_status_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PaymentsApi.refresh_payment_status ...'
        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 PaymentsApi.refresh_payment_status"
  end
  # verify the required parameter 'refresh_payment_status_request' is set
  if @api_client.config.client_side_validation && refresh_payment_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'refresh_payment_status_request' when calling PaymentsApi.refresh_payment_status"
  end
  # resource path
  local_var_path = 'pts/v2/refresh-payment-status/{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;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(refresh_payment_status_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'RefreshPaymentStatusRequest', @api_client.config.host)
  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 => 'PtsV2PaymentsPost201Response1')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PaymentsApi#refresh_payment_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end