Class: CityPayApiClient::DirectPostApi

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/api/direct_post_api__.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DirectPostApi

Returns a new instance of DirectPostApi.



18
19
20
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#direct_c_res_auth_request(uuid, opts = {}) ⇒ AuthResponse

Handles a CRes response from ACS, returning back the result of authorisation Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid ‘threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves.

Parameters:

  • uuid (String) —

    An identifier used to track the CReq/CRes cycle.

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

    the optional parameters

Options Hash (opts):

  • :cres (String) —

    The CRES from the ACS.

  • :three_ds_session_data (String) —

    The session data from the ACS.

Returns:



28
29
30
31
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 28

def direct_c_res_auth_request(uuid, opts = {})
  data, _status_code, _headers = direct_c_res_auth_request_with_http_info(uuid, opts)
  data
end

#direct_c_res_auth_request_with_http_info(uuid, opts = {}) ⇒ Array<(AuthResponse, Integer, Hash)>

Handles a CRes response from ACS, returning back the result of authorisation Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid &#x60;threeDSSessionData&#x60; value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a &#x60;Direct Post&#x60; integration who wish to handle the challenge flow themselves.

Parameters:

  • uuid (String) —

    An identifier used to track the CReq/CRes cycle.

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

    the optional parameters

Options Hash (opts):

  • :cres (String) —

    The CRES from the ACS.

  • :three_ds_session_data (String) —

    The session data from the ACS.

Returns:

  • (Array<(AuthResponse, Integer, Hash)>) —

    AuthResponse 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/citypay_api_client/api/direct_post_api__.rb', line 40

def direct_c_res_auth_request_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectPostApi.direct_c_res_auth_request ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling DirectPostApi.direct_c_res_auth_request"
  end
  # resource path
  local_var_path = '/direct/cres/auth/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/x-www-form-urlencoded'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['cres'] = opts[:'cres'] if !opts[:'cres'].nil?
  form_params['threeDSSessionData'] = opts[:'three_ds_session_data'] if !opts[:'three_ds_session_data'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AuthResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DirectPostApi.direct_c_res_auth_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectPostApi#direct_c_res_auth_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#direct_c_res_tokenise_request(uuid, opts = {}) ⇒ TokenisationResponseModel

Handles a CRes response from ACS, returning back a token for future authorisation Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid ‘threeDSSessionData` value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a `Direct Post` integration who wish to handle the challenge flow themselves.

Parameters:

  • uuid (String) —

    An identifier used to track the CReq/CRes cycle.

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

    the optional parameters

Options Hash (opts):

  • :cres (String) —

    The CRES from the ACS.

  • :three_ds_session_data (String) —

    The session data from the ACS.

Returns:



102
103
104
105
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 102

def direct_c_res_tokenise_request(uuid, opts = {})
  data, _status_code, _headers = direct_c_res_tokenise_request_with_http_info(uuid, opts)
  data
end

#direct_c_res_tokenise_request_with_http_info(uuid, opts = {}) ⇒ Array<(TokenisationResponseModel, Integer, Hash)>

Handles a CRes response from ACS, returning back a token for future authorisation Used to post from an ACS during a ThreeDSecure direct flow process. The endpoint requires a valid &#x60;threeDSSessionData&#x60; value which defines the unique transaction through its workflow. This endpoint may be used by merchants wishing to perform a &#x60;Direct Post&#x60; integration who wish to handle the challenge flow themselves.

Parameters:

  • uuid (String) —

    An identifier used to track the CReq/CRes cycle.

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

    the optional parameters

Options Hash (opts):

  • :cres (String) —

    The CRES from the ACS.

  • :three_ds_session_data (String) —

    The session data from the ACS.

Returns:

  • (Array<(TokenisationResponseModel, Integer, Hash)>) —

    TokenisationResponseModel data, response status code and response headers



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
164
165
166
167
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 114

def direct_c_res_tokenise_request_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectPostApi.direct_c_res_tokenise_request ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling DirectPostApi.direct_c_res_tokenise_request"
  end
  # resource path
  local_var_path = '/direct/cres/tokenise/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/x-www-form-urlencoded'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['cres'] = opts[:'cres'] if !opts[:'cres'].nil?
  form_params['threeDSSessionData'] = opts[:'three_ds_session_data'] if !opts[:'three_ds_session_data'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TokenisationResponseModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DirectPostApi.direct_c_res_tokenise_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectPostApi#direct_c_res_tokenise_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#direct_post_auth_request(direct_post_request, opts = {}) ⇒ AuthResponse

Direct Post Auth Request Used to initiate a direct post request transaction flow.

Parameters:

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

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 174

def direct_post_auth_request(direct_post_request, opts = {})
  data, _status_code, _headers = direct_post_auth_request_with_http_info(direct_post_request, opts)
  data
end

#direct_post_auth_request_with_http_info(direct_post_request, opts = {}) ⇒ Array<(AuthResponse, Integer, Hash)>

Direct Post Auth Request Used to initiate a direct post request transaction flow.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AuthResponse, Integer, Hash)>) —

    AuthResponse data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 184

def direct_post_auth_request_with_http_info(direct_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectPostApi.direct_post_auth_request ...'
  end
  # verify the required parameter 'direct_post_request' is set
  if @api_client.config.client_side_validation && direct_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'direct_post_request' when calling DirectPostApi.direct_post_auth_request"
  end
  # resource path
  local_var_path = '/direct/auth'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/x-www-form-urlencoded', 'text/xml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(direct_post_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AuthResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-domain-key', 'cp-api-key']

  new_options = opts.merge(
    :operation => :"DirectPostApi.direct_post_auth_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectPostApi#direct_post_auth_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#direct_post_tokenise_request(direct_post_request, opts = {}) ⇒ AuthResponse

Direct Post Tokenise Request Used to initiate a direct post request transaction flow.

Parameters:

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 242

def direct_post_tokenise_request(direct_post_request, opts = {})
  data, _status_code, _headers = direct_post_tokenise_request_with_http_info(direct_post_request, opts)
  data
end

#direct_post_tokenise_request_with_http_info(direct_post_request, opts = {}) ⇒ Array<(AuthResponse, Integer, Hash)>

Direct Post Tokenise Request Used to initiate a direct post request transaction flow.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AuthResponse, Integer, Hash)>) —

    AuthResponse data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 252

def direct_post_tokenise_request_with_http_info(direct_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectPostApi.direct_post_tokenise_request ...'
  end
  # verify the required parameter 'direct_post_request' is set
  if @api_client.config.client_side_validation && direct_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'direct_post_request' when calling DirectPostApi.direct_post_tokenise_request"
  end
  # resource path
  local_var_path = '/direct/tokenise'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/x-www-form-urlencoded', 'text/xml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(direct_post_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AuthResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-domain-key', 'cp-api-key']

  new_options = opts.merge(
    :operation => :"DirectPostApi.direct_post_tokenise_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectPostApi#direct_post_tokenise_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#token_request(direct_token_auth_request, opts = {}) ⇒ AuthResponse

Direct Post Token Request Perform a request for authorisation for a previously generated token. This flow will return an authorisation response stating that the transaction was approved or declined.

Parameters:

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

    the optional parameters

Returns:



310
311
312
313
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 310

def token_request(direct_token_auth_request, opts = {})
  data, _status_code, _headers = token_request_with_http_info(direct_token_auth_request, opts)
  data
end

#token_request_with_http_info(direct_token_auth_request, opts = {}) ⇒ Array<(AuthResponse, Integer, Hash)>

Direct Post Token Request Perform a request for authorisation for a previously generated token. This flow will return an authorisation response stating that the transaction was approved or declined.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AuthResponse, Integer, Hash)>) —

    AuthResponse data, response status code and response headers



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/citypay_api_client/api/direct_post_api__.rb', line 320

def token_request_with_http_info(direct_token_auth_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectPostApi.token_request ...'
  end
  # verify the required parameter 'direct_token_auth_request' is set
  if @api_client.config.client_side_validation && direct_token_auth_request.nil?
    fail ArgumentError, "Missing the required parameter 'direct_token_auth_request' when calling DirectPostApi.token_request"
  end
  # resource path
  local_var_path = '/direct/token'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml', 'application/x-www-form-urlencoded', 'text/xml'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(direct_token_auth_request)

  # return_type
  return_type = opts[:debug_return_type] || 'AuthResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-domain-key', 'cp-api-key']

  new_options = opts.merge(
    :operation => :"DirectPostApi.token_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectPostApi#token_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end