Class: CyberSource::TransientTokenDataApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of TransientTokenDataApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_payment_credentials_for_transient_token(jti, opts = {}) ⇒ String

Get Payment Credentials Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform.

Parameters:

  • jti —

    The jti field contained within the Transient token returned from a successful Unified Checkout transaction

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

    the optional parameters

Returns:

  • (String) 


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

def get_payment_credentials_for_transient_token(jti, opts = {})
  data, status_code, headers = get_payment_credentials_for_transient_token_with_http_info(jti, opts)
  return data, status_code, headers
end

#get_payment_credentials_for_transient_token_with_http_info(jti, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get Payment Credentials Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform.

Parameters:

  • jti —

    The jti field contained within the Transient token returned from a successful Unified Checkout transaction

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
92
93
 
# File 'lib/cybersource_rest_client/api/transient_token_data_api.rb', line 40

def get_payment_credentials_for_transient_token_with_http_info(jti, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: TransientTokenDataApi.get_payment_credentials_for_transient_token ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'jti' is set
  if @api_client.config.client_side_validation && jti.nil?
    fail ArgumentError, "Missing the required parameter 'jti' when calling TransientTokenDataApi.get_payment_credentials_for_transient_token"
  end
  # resource path
  local_var_path = 'up/v1/payment-credentials/{jti}'.sub('{' + 'jti' + '}', jti.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  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 => 'String')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: TransientTokenDataApi#get_payment_credentials_for_transient_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_transaction_for_transient_token(transient_token, opts = {}) ⇒ nil

Get Transient Token Data Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN). Include the Request ID in the GET request to retrieve the transaction details.

Parameters:

  • transient_token —

    Transient Token returned by the Unified Checkout application.

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

    the optional parameters

Returns:

  • (nil) 


101
102
103
104
 
# File 'lib/cybersource_rest_client/api/transient_token_data_api.rb', line 101

def get_transaction_for_transient_token(transient_token, opts = {})
  data, status_code, headers = get_transaction_for_transient_token_with_http_info(transient_token, opts)
  return data, status_code, headers
end

#get_transaction_for_transient_token_with_http_info(transient_token, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get Transient Token Data Retrieve the data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will not return PCI payment data (PAN). Include the Request ID in the GET request to retrieve the transaction details.

Parameters:

  • transient_token —

    Transient Token returned by the Unified Checkout application.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/cybersource_rest_client/api/transient_token_data_api.rb', line 111

def get_transaction_for_transient_token_with_http_info(transient_token, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: TransientTokenDataApi.get_transaction_for_transient_token ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'transient_token' is set
  if @api_client.config.client_side_validation && transient_token.nil?
    fail ArgumentError, "Missing the required parameter 'transient_token' when calling TransientTokenDataApi.get_transaction_for_transient_token"
  end
  # resource path
  local_var_path = 'up/v1/payment-details/{transientToken}'.sub('{' + 'transientToken' + '}', transient_token.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # 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)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  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)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: TransientTokenDataApi#get_transaction_for_transient_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end