class CyberSource::CaptureApi
Attributes
Public Class Methods
# File lib/cyberSource_client/api/capture_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Capture a Payment Include the payment ID in the POST request to capture the payment amount. @param capture_payment_request @param id The payment ID returned from a previous payment request. This ID links the capture to the payment. @param [Hash] opts the optional parameters @return [InlineResponse2012]
# 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 a Payment Include the payment ID in the POST request to capture the payment amount. @param capture_payment_request @param id The payment ID returned from a previous payment request. This ID links the capture to the payment. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2012
, Fixnum, Hash)>] InlineResponse2012
data, response status code and response headers
# 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
Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details. @param id The capture ID returned from a previous capture request. @param [Hash] opts the optional parameters @return [InlineResponse2004]
# 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
Retrieve a Capture Include the capture ID in the GET request to retrieve the capture details. @param id The capture ID returned from a previous capture request. @param [Hash] opts the optional parameters @return [Array<(InlineResponse2004
, Fixnum, Hash)>] InlineResponse2004
data, response status code and response headers
# 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