Class: CyberSource::CaptureApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/api/capture_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CaptureApi

Returns a new instance of CaptureApi.



19
20
21
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#capture_payment(capture_payment_request, id, opts = {}) ⇒ InlineResponse2012

Capture a Payment Include the payment ID in the POST request to capture the payment amount.

Parameters:

  • capture_payment_request
  • id —

    The payment ID returned from a previous payment request. This ID links the capture to the payment.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 28

def capture_payment(capture_payment_request, id, opts = {})
  data, _status_code, _headers = capture_payment_with_http_info(capture_payment_request, id, opts)
  return data, _status_code, _headers
end

#capture_payment_with_http_info(capture_payment_request, id, opts = {}) ⇒ Array<(InlineResponse2012, Fixnum, Hash)>

Capture a Payment Include the payment ID in the POST request to capture the payment amount.

Parameters:

  • capture_payment_request
  • id —

    The payment ID returned from a previous payment request. This ID links the capture to the payment.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2012, Fixnum, Hash)>) —

    InlineResponse2012 data, response status code and response headers



39
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
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 39

def capture_payment_with_http_info(capture_payment_request, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaptureApi.capture_payment ...'
  end
  # verify the required parameter 'capture_payment_request' is set
  if @api_client.config.client_side_validation && capture_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'capture_payment_request' when calling CaptureApi.capture_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 CaptureApi.capture_payment"
  end
  # resource path
  local_var_path = 'pts/v2/payments/{id}/captures'.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(capture_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 => 'InlineResponse2012')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CaptureApi#capture_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_capture(id, opts = {}) ⇒ InlineResponse2004

Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.

Parameters:

  • id —

    The capture ID returned from a previous capture request.

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

    the optional parameters

Returns:



85
86
87
88
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 85

def get_capture(id, opts = {})
  data, _status_code, _headers = get_capture_with_http_info(id, opts)
  data
end

#get_capture_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2004, Fixnum, Hash)>

Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details.

Parameters:

  • id —

    The capture ID returned from a previous capture request.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse2004, Fixnum, Hash)>) —

    InlineResponse2004 data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cyberSource_client/api/capture_api.rb', line 95

def get_capture_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaptureApi.get_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 CaptureApi.get_capture"
  end
  # resource path
  local_var_path = 'pts/v2/captures/{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 => 'InlineResponse2004')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CaptureApi#get_capture\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end