Class: SimpleClient::Gateway

Inherits:
Object
  • Object
show all
Defined in:
lib/simple/gateway.rb

Constant Summary collapse

CONTENT_TYPE =
"application/json"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context) ⇒ Gateway

Returns a new instance of Gateway.



12
13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/simple/gateway.rb', line 12

def initialize(context)
	@context = context
	@authentication_api = OpenapiClient::AuthenticationApi.new(@context.client)
	@information_lookup_api = OpenapiClient::InformationLookupApi.new(@context.client)
	@verification_api = OpenapiClient::VerificationApi.new(@context.client)
	@currency_conversion_api = OpenapiClient::CurrencyConversionApi.new(@context.client)
	@fraud_detect_api = OpenapiClient::FraudDetectApi.new(@context.client)
	@order_api = OpenapiClient::OrderApi.new(@context.client)
	@payment_api = OpenapiClient::PaymentApi.new(@context.client)
	@payment_schedules_api = OpenapiClient::PaymentSchedulesApi.new(@context.client)
	@payment_token_api = OpenapiClient::PaymentTokenApi.new(@context.client)
	@payment_url_api = OpenapiClient::PaymentURLApi.new(@context.client)
end

Class Method Details

.create(credentials, environment = "CERT") ⇒ Object



8
9
10
# File 'lib/simple/gateway.rb', line 8

def self.create(credentials, environment="CERT")
	return self.new(ClientContext.new(credentials, environment))
end

Instance Method Details

#account_info_lookup(payload:, region: nil) ⇒ Object



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/simple/gateway.rb', line 448

def (payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	opts[:message_signature] = message_signature
	return @information_lookup_api.(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#cancel_payment_schedule(order_id:, store_id: nil, region: nil) ⇒ Object

Payment Schedules API



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/simple/gateway.rb', line 235

def cancel_payment_schedule(order_id:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign 
	return @payment_schedules_api.cancel_payment_schedule(
		CONTENT_TYPE,
		signature_service.client_request_id,
		get_api_key,
		signature_service.timestamp,
		order_id,
		opts
	)
end

#card_info_lookup(payload:, region: nil) ⇒ Object

Card Info API



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
# File 'lib/simple/gateway.rb', line 432

def card_info_lookup(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	opts[:message_signature] = message_signature
	return @information_lookup_api.card_info_lookup(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#create_payment_schedule(payload:, region: nil) ⇒ Object



251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/simple/gateway.rb', line 251

def create_payment_schedule(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @payment_schedules_api.create_payment_schedule(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#create_payment_token(payload:, authorization: nil, region: nil) ⇒ Object

Payment Token API



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/simple/gateway.rb', line 301

def create_payment_token(payload:, authorization: nil, region: nil)
	opts = {}
	opts[:region] = region if region
	opts[:authorization] = authorization if authorization
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	opts[:message_signature] = message_signature
	return @payment_token_api.create_payment_token(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#create_payment_url(payload:, region: nil) ⇒ Object

Payment URL API



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/simple/gateway.rb', line 373

def create_payment_url(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	opts[:message_signature] = message_signature
	return @payment_url_api.create_payment_url(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#delete_payment_token(token_id:, authorization: nil, store_id: nil, region: nil) ⇒ Object



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'lib/simple/gateway.rb', line 353

def delete_payment_token(token_id:, authorization: nil, store_id: nil, region: nil)
	opts = {}
	opts[:region] = region if region
	opts[:store_id] = store_id if store_id
	opts[:authorization] = authorization if authorization
	signature_service = get_signature_service
	message_signature = signature_service.sign
	opts[:message_signature] = message_signature
	return @payment_token_api.delete_payment_token(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		token_id,
		opts
	)	
end

#delete_payment_url(region: nil, store_id: nil, transaction_id: nil, order_id: nil, payment_url_id: nil, transaction_time: nil) ⇒ Object



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/simple/gateway.rb', line 389

def delete_payment_url(region: nil, store_id: nil, transaction_id: nil, order_id: nil, payment_url_id: nil, transaction_time: nil)
	opts = {}
	opts[:region] = region if region
	opts[:store_id] = store_id if store_id
	opts[:transaction_id] = transaction_id if transaction_id
	opts[:order_id] = order_id if order_id
	opts[:payment_url_id] = payment_url_id if payment_url_id
	opts[:transaction_time] = transaction_time if transaction_time
	signature_service = get_signature_service
	message_signature = signature_service.sign()
	opts[:message_signature] = message_signature
	return @payment_url_api.delete_payment_url(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		opts
	)	
end

#finalize_secure_transaction(transaction_id:, payload:, region: nil) ⇒ Object



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/simple/gateway.rb', line 89

def finalize_secure_transaction(transaction_id:, payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload)
	return @payment_api.finalize_secure_transaction(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		transaction_id,
		payload,
		opts
		)
end

#fraud_client_registration_post(payload:, region: nil) ⇒ Object



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/simple/gateway.rb', line 202

def fraud_client_registration_post(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @fraud_detect_api.fraud_client_registration_post(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	

end

#fraud_payment_registration_post(payload:, region: nil) ⇒ Object



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/simple/gateway.rb', line 218

def fraud_payment_registration_post(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @fraud_detect_api.fraud_payment_registration_post(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	

end

#get_exchange_rate(payload:, region: nil) ⇒ Object

Currency Conversaion API



171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/simple/gateway.rb', line 171

def get_exchange_rate(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @currency_conversion_api.get_exchange_rate(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#get_transaction_fraud_score(payload:, region: nil) ⇒ Object

Fraud Detect API



187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/simple/gateway.rb', line 187

def get_transaction_fraud_score(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @fraud_detect_api.score_only(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#order_inquiry(order_id:, store_id: nil, region: nil) ⇒ Object

Order API



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/simple/gateway.rb', line 106

def order_inquiry(order_id:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	message_signature = signature_service.sign 
	opts[:message_signature] = message_signature
	return @order_api.order_inquiry(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		order_id,
		opts
	)
end

#payment_schedule_inquiry(order_id:, store_id: nil, region: nil) ⇒ Object



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/simple/gateway.rb', line 266

def payment_schedule_inquiry(order_id:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign
	return @payment_schedules_api.inquiry_payment_schedule(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		order_id,
		opts
	)	
end

#payment_token_inquiry(token_id:, authorization: nil, store_id: nil, region: nil) ⇒ Object



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/simple/gateway.rb', line 336

def payment_token_inquiry(token_id:, authorization: nil, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:authorization] = authorization if authorization
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign
	return @payment_token_api.get_payment_token_details(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		token_id,
		opts
	)	
end

#payment_url_detail(from_date:, to_date:, region: nil, store_id: nil, transaction_id: nil, order_id: nil, status: nil) ⇒ Object



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/simple/gateway.rb', line 409

def payment_url_detail(from_date:, to_date:, region: nil, store_id: nil, transaction_id: nil, order_id: nil, status: nil)
	opts = {}
	opts[:region] = region if region
	opts[:store_id] = store_id if store_id
	opts[:merchant_transaction_id] = transaction_id if transaction_id
	opts[:order_id] = order_id if order_id
	opts[:status] = status if status
	signature_service = get_signature_service
	message_signature = signature_service.sign()
	opts[:message_signature] = message_signature
	return @payment_url_api.payment_url_detail(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp,
		from_date,
		to_date,
		opts
	)	
end

#primary_payment_transaction(payload:, region: nil) ⇒ Object

Payment API



41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/simple/gateway.rb', line 41

def primary_payment_transaction(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload)
	return @payment_api.submit_primary_transaction(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)
end

#request_access_token(payload:) ⇒ Object

Authentication API



27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/simple/gateway.rb', line 27

def request_access_token(payload:)
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	return @authentication_api.authentication_access_tokens_post(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		{message_signature: message_signature}
	)
end

#secondary_payment_transaction(transaction_id:, payload:, store_id: nil, region: nil) ⇒ Object



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/simple/gateway.rb', line 56

def secondary_payment_transaction(transaction_id:, payload:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload)
	return @payment_api.submit_secondary_transaction(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		transaction_id,
		payload,
		opts
	)
end

#secondary_payment_transaction_by_order(order_id:, payload:, region: nil) ⇒ Object



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/simple/gateway.rb', line 123

def secondary_payment_transaction_by_order(order_id:, payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload)
	return @order_api.submit_secondary_transaction_from_order(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		order_id,
		payload,
		opts
	)
end

#transaction_inquiry(transaction_id:, store_id: nil, region: nil) ⇒ Object



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/simple/gateway.rb', line 73

def transaction_inquiry(transaction_id:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign
	return @payment_api.transaction_inquiry(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		transaction_id,
		opts
	)
end

#update_payment_schedule(order_id:, payload:, store_id: nil, region: nil) ⇒ Object



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/simple/gateway.rb', line 282

def update_payment_schedule(order_id:, payload:, store_id: nil, region: nil)
	opts = {}
	opts[:store_id] = store_id if store_id
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload)
	return @payment_schedules_api.update_payment_schedule(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		order_id,
		payload,
		opts
	)	
end

#update_payment_token(payload:, authorization: nil, region: nil) ⇒ Object

Payment Token API



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/simple/gateway.rb', line 319

def update_payment_token(payload:, authorization: nil, region: nil)
	opts = {}
	opts[:region] = region if region
	opts[:authorization] = authorization if authorization
	signature_service = get_signature_service
	message_signature = signature_service.sign(payload)
	opts[:message_signature] = message_signature
	return @payment_token_api.update_payment_token(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)	
end

#verify_account(payload:, region: nil) ⇒ Object



155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/simple/gateway.rb', line 155

def (payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @verification_api.(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)			
end

#verify_card(payload:, region: nil) ⇒ Object

Card Verification API



140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/simple/gateway.rb', line 140

def verify_card(payload:, region: nil)
	opts = {}
	opts[:region] = region if region
	signature_service = get_signature_service
	opts[:message_signature] = signature_service.sign(payload) 
	return @verification_api.verify_card(
		CONTENT_TYPE, 
		signature_service.client_request_id, 
		get_api_key, 
		signature_service.timestamp, 
		payload,
		opts
	)			
end