Class: OpenapiClient::PaymentURLApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/payment_url_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentURLApi

Returns a new instance of PaymentURLApi.



19
20
21
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment_url(content_type, client_request_id, api_key, timestamp, payment_url_request, opts = {}) ⇒ PaymentUrlResponse

Create a payment URL. Use this to generate an embedding payment link.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • payment_url_request (PaymentUrlRequest) —

    Accepted request type: PaymentUrlRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:



33
34
35
36
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 33

def create_payment_url(content_type, client_request_id, api_key, timestamp, payment_url_request, opts = {})
  data, _status_code, _headers = create_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, payment_url_request, opts)
  data
end

#create_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, payment_url_request, opts = {}) ⇒ Array<(PaymentUrlResponse, Integer, Hash)>

Create a payment URL. Use this to generate an embedding payment link.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • payment_url_request (PaymentUrlRequest) —

    Accepted request type: PaymentUrlRequest.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

Returns:

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

    PaymentUrlResponse data, response status code and response headers



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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 49

def create_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, payment_url_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentURLApi.create_payment_url ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentURLApi.create_payment_url"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentURLApi.create_payment_url"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentURLApi.create_payment_url"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentURLApi.create_payment_url"
  end
  # verify the required parameter 'payment_url_request' is set
  if @api_client.config.client_side_validation && payment_url_request.nil?
    fail ArgumentError, "Missing the required parameter 'payment_url_request' when calling PaymentURLApi.create_payment_url"
  end
  # resource path
  local_var_path = '/payment-url'

  # 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'])
  # HTTP header 'Content-Type'
  # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'PaymentUrlResponse' 

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

  new_options = opts.merge(
    :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: PaymentURLApi#create_payment_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_url(content_type, client_request_id, api_key, timestamp, opts = {}) ⇒ PaymentUrlResponse

Delete a payment URL. Use this to delete an embedding payment link.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

  • :transaction_id (String) —

    Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.

  • :order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • :payment_url_id (String) —

    The ID code from the payment URL.

  • :transaction_time (String) —

    The transaction time in seconds since epoch.

Returns:



140
141
142
143
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 140

def delete_payment_url(content_type, client_request_id, api_key, timestamp, opts = {})
  data, _status_code, _headers = delete_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, opts)
  data
end

#delete_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, opts = {}) ⇒ Array<(PaymentUrlResponse, Integer, Hash)>

Delete a payment URL. Use this to delete an embedding payment link.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

  • :transaction_id (String) —

    Gateway transaction identifier as returned in the parameter ipgTransactionId or merchantTransactionId.

  • :order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • :payment_url_id (String) —

    The ID code from the payment URL.

  • :transaction_time (String) —

    The transaction time in seconds since epoch.

Returns:

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

    PaymentUrlResponse data, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 160

def delete_payment_url_with_http_info(content_type, client_request_id, api_key, timestamp, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentURLApi.delete_payment_url ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentURLApi.delete_payment_url"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentURLApi.delete_payment_url"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentURLApi.delete_payment_url"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentURLApi.delete_payment_url"
  end
  # resource path
  local_var_path = '/payment-url'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?
  query_params[:'transactionId'] = opts[:'transaction_id'] if !opts[:'transaction_id'].nil?
  query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?
  query_params[:'paymentUrlId'] = opts[:'payment_url_id'] if !opts[:'payment_url_id'].nil?
  query_params[:'transactionTime'] = opts[:'transaction_time'] if !opts[:'transaction_time'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'PaymentUrlResponse' 

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

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentURLApi#delete_payment_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_url_detail(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts = {}) ⇒ PaymentUrlDetailResponse

Retrieve the state of payment URL. Use this query to get the current state of an existing paymentURL.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • from_date (String) —

    The start date for payment URL in seconds since epoch.

  • to_date (String) —

    The end date for payment URL search query in seconds since epoch.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

  • :order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • :merchant_transaction_id (String) —

    Gateway merchant identifier as returned in the parameter merchantTransactionId.

  • :status (String) —

    The status of payment URL.

Returns:



251
252
253
254
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 251

def payment_url_detail(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts = {})
  data, _status_code, _headers = payment_url_detail_with_http_info(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts)
  data
end

#payment_url_detail_with_http_info(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts = {}) ⇒ Array<(PaymentUrlDetailResponse, Integer, Hash)>

Retrieve the state of payment URL. Use this query to get the current state of an existing paymentURL.

Parameters:

  • content_type (String) —

    Content type.

  • client_request_id (String) —

    A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.

  • api_key (String) —

    Key given to merchant after boarding associating their requests with the appropriate app in Apigee.

  • timestamp (Integer) —

    Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).

  • from_date (String) —

    The start date for payment URL in seconds since epoch.

  • to_date (String) —

    The end date for payment URL search query in seconds since epoch.

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

    the optional parameters

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.

  • :store_id (String) —

    An optional outlet ID for clients that support multiple stores in the same developer app.

  • :order_id (String) —

    Gateway order identifier as returned in the parameter orderId.

  • :merchant_transaction_id (String) —

    Gateway merchant identifier as returned in the parameter merchantTransactionId.

  • :status (String) —

    The status of payment URL.

Returns:

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

    PaymentUrlDetailResponse data, response status code and response headers



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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
 
# File 'lib/openapi_client/api/payment_url_api.rb', line 272

def payment_url_detail_with_http_info(content_type, client_request_id, api_key, timestamp, from_date, to_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentURLApi.payment_url_detail ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling PaymentURLApi.payment_url_detail"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling PaymentURLApi.payment_url_detail"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling PaymentURLApi.payment_url_detail"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling PaymentURLApi.payment_url_detail"
  end
  # verify the required parameter 'from_date' is set
  if @api_client.config.client_side_validation && from_date.nil?
    fail ArgumentError, "Missing the required parameter 'from_date' when calling PaymentURLApi.payment_url_detail"
  end
  # verify the required parameter 'to_date' is set
  if @api_client.config.client_side_validation && to_date.nil?
    fail ArgumentError, "Missing the required parameter 'to_date' when calling PaymentURLApi.payment_url_detail"
  end
  # resource path
  local_var_path = '/payment-url'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fromDate'] = from_date
  query_params[:'toDate'] = to_date
  query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?
  query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?
  query_params[:'merchantTransactionId'] = opts[:'merchant_transaction_id'] if !opts[:'merchant_transaction_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

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

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

  # return_type
  return_type = opts[:return_type] || 'PaymentUrlDetailResponse' 

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

  new_options = opts.merge(
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentURLApi#payment_url_detail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end