Class: CyberSource::TokenizeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of TokenizeApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/tokenize_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/tokenize_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#tokenize(post_tokenize_request, opts = {}) ⇒ InlineResponse200

Tokenize | | | | | — | — | — | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **"TOKEN_CREATE"** and the types of tokens to be created. The tokenInformation section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|      |The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.
In cases where token creation encounters issues, the response includes a non-2XX status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:



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

def tokenize(post_tokenize_request, opts = {})
  data, status_code, headers = tokenize_with_http_info(post_tokenize_request, opts)
  return data, status_code, headers
end

#tokenize_with_http_info(post_tokenize_request, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Tokenize | | | | | — | — | — | |The **Tokenize API** endpoint facilitates the creation of various TMS tokens such as Customers, Payment Instruments, Shipping Addresses, and Instrument Identifiers in a single operation. The request includes a processingInformation object, which specifies **&quot;TOKEN_CREATE&quot;** and the types of tokens to be created. The tokenInformation section of the request includes detailed information relevant to each token type. This includes attributes for Customers, Payment Instruments, Shipping Addresses, Instrument Identifiers and Transient Token data. The payload is flexible, allowing for different combinations of tokens to be created in a single request.|&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;|The **API response** includes a responses array, which details the outcome of the tokenization process for each requested resource type, such as Customer, Payment Instrument, Shipping Address, and Instrument Identifier. Each entry in this array provides an HTTP status code such as **201/200 for successful creations**, and a unique identifier for the newly created token.&lt;br&gt;In cases where token creation encounters issues, the response includes a non-2XX status code and an errors array for the affected resource. Each error object in the array details the **error type and a descriptive message** providing insight into why a particular token creation was not attempted or failed.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :profile_id (String) —

    The Id of a profile containing user specific TMS configuration.

Returns:

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

    InlineResponse200 data, response status code and response headers



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
94
95
96
97
98
99
100
101
 
# File 'lib/cybersource_rest_client/api/tokenize_api.rb', line 41

def tokenize_with_http_info(post_tokenize_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: TokenizeApi.tokenize ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'post_tokenize_request' is set

  if @api_client.config.client_side_validation && post_tokenize_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_tokenize_request' when calling TokenizeApi.tokenize"
  end
  # resource path

  local_var_path = 'tms/v2/tokenize'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8'])
  # HTTP header 'Content-Type'

  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])
  header_params[:'profile-id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(post_tokenize_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'PostTokenizeRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "mandatory"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["tokenize","tokenize_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'InlineResponse200')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: TokenizeApi#tokenize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end