Class: CyberSource::UnifiedCheckoutCaptureContextApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of UnifiedCheckoutCaptureContextApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/unified_checkout_capture_context_api.rb', line 18

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.



16
17
18
 
# File 'lib/cybersource_rest_client/api/unified_checkout_capture_context_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request, opts = {}) ⇒ String

Generate Unified Checkout Capture Context Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page

Parameters:

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

    the optional parameters

Returns:

  • (String) 


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

def generate_unified_checkout_capture_context(generate_unified_checkout_capture_context_request, opts = {})
  data, status_code, headers = generate_unified_checkout_capture_context_with_http_info(generate_unified_checkout_capture_context_request, opts)
  return data, status_code, headers
end

#generate_unified_checkout_capture_context_with_http_info(generate_unified_checkout_capture_context_request, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Generate Unified Checkout Capture Context Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page

Parameters:

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

    the optional parameters

Returns:

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

    String 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
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cybersource_rest_client/api/unified_checkout_capture_context_api.rb', line 39

def generate_unified_checkout_capture_context_with_http_info(generate_unified_checkout_capture_context_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: UnifiedCheckoutCaptureContextApi.generate_unified_checkout_capture_context ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'generate_unified_checkout_capture_context_request' is set
  if @api_client.config.client_side_validation && generate_unified_checkout_capture_context_request.nil?
    fail ArgumentError, "Missing the required parameter 'generate_unified_checkout_capture_context_request' when calling UnifiedCheckoutCaptureContextApi.generate_unified_checkout_capture_context"
  end
  # resource path
  local_var_path = 'up/v1/capture-contexts'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/jwt'])
  # 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(generate_unified_checkout_capture_context_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'GenerateUnifiedCheckoutCaptureContextRequest', @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 => 'String')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: UnifiedCheckoutCaptureContextApi#generate_unified_checkout_capture_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end