Class: Worldline::Connect::SDK::V1::Merchant::Payments::PaymentsClient

Inherits:
ApiResource
  • Object
show all
Defined in:
lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb

Overview

Payments client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary collapse

Constructor Details

#initialize(parent, path_context) ⇒ PaymentsClient

Returns a new instance of PaymentsClient.

Parameters:



39
40
41
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 39

def initialize(parent, path_context)
  super(parent: parent, path_context: path_context)
end

Instance Method Details

#approve(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::PaymentApprovalResponse

Resource /{merchantId}/payments/{paymentId}/approve - Approve payment

Parameters:

Returns:

Raises:



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 268

def approve(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/approve', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::PaymentApprovalResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#cancel(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CancelPaymentResponse

Resource /{merchantId}/payments/{paymentId}/cancel - Cancel payment

Parameters:

Returns:

Raises:



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 455

def cancel(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/cancel', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    Worldline::Connect::SDK::V1::Domain::CancelPaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#cancelapproval(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CancelApprovalPaymentResponse

Resource /{merchantId}/payments/{paymentId}/cancelapproval - Undo capture payment

Parameters:

Returns:

Raises:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 331

def cancelapproval(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/cancelapproval', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    Worldline::Connect::SDK::V1::Domain::CancelApprovalPaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#capture(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CaptureResponse

Resource /{merchantId}/payments/{paymentId}/capture - Capture payment

Parameters:

Returns:

Raises:



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 300

def capture(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/capture', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::CaptureResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#captures(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CapturesResponse

Resource /{merchantId}/payments/{paymentId}/captures - Get captures of payment

Parameters:

Returns:

Raises:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 362

def captures(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/captures', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::CapturesResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#complete(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CompletePaymentResponse

Resource /{merchantId}/payments/{paymentId}/complete - Complete payment

Parameters:

Returns:

Raises:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 143

def complete(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/complete', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::CompletePaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#create(body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CreatePaymentResponse

Resource /{merchantId}/payments - Create payment

Parameters:

Returns:

Raises:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 57

def create(body, context = nil)
  uri = instantiate_uri('/v1/{merchantId}/payments', nil)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::CreatePaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::PaymentErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#devicefingerprint(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::DeviceFingerprintDetails

Resource /{merchantId}/payments/{paymentId}/devicefingerprint - Get Device Fingerprint details

Parameters:

Returns:

Raises:



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 548

def devicefingerprint(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/devicefingerprint', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::DeviceFingerprintDetails,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#dispute(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::DisputeResponse

Resource /{merchantId}/payments/{paymentId}/dispute - Create dispute

Parameters:

Returns:

Raises:



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 487

def dispute(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/dispute', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::DisputeResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#disputes(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::DisputesResponse

Resource /{merchantId}/payments/{paymentId}/disputes - Get disputes

Parameters:

Returns:

Raises:



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 518

def disputes(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/disputes', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::DisputesResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#find(query, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::FindPaymentsResponse

Resource /{merchantId}/payments - Find payments

Parameters:

Returns:

Raises:



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 85

def find(query, context = nil)
  uri = instantiate_uri('/v1/{merchantId}/payments', nil)
  @communicator.get(
    uri,
    client_headers,
    query,
    Worldline::Connect::SDK::V1::Domain::FindPaymentsResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#get(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::PaymentResponse

Resource /{merchantId}/payments/{paymentId} - Get payment

Parameters:

Returns:

Raises:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 112

def get(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::PaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#processchallenged(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::PaymentResponse

Resource /{merchantId}/payments/{paymentId}/processchallenged - Approves challenged payment

Parameters:

Returns:

Raises:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 236

def processchallenged(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/processchallenged', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    Worldline::Connect::SDK::V1::Domain::PaymentResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#refund(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::RefundResponse

Resource /{merchantId}/payments/{paymentId}/refund - Create refund

Parameters:

Returns:

Raises:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 394

def refund(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/refund', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::RefundResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::RefundErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#refunds(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::RefundsResponse

Resource /{merchantId}/payments/{paymentId}/refunds - Get refunds of payment

Parameters:

Returns:

Raises:



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 425

def refunds(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/refunds', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::RefundsResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#third_party_status(payment_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::ThirdPartyStatusResponse

Resource /{merchantId}/payments/{paymentId}/thirdpartystatus - Third party status poll

Parameters:

Returns:

Raises:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 174

def third_party_status(payment_id, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/thirdpartystatus', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::ThirdPartyStatusResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#tokenize(payment_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CreateTokenResponse

Resource /{merchantId}/payments/{paymentId}/tokenize - Create a token from payment

Parameters:

Returns:

Raises:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/worldline/connect/sdk/v1/merchant/payments/payments_client.rb', line 205

def tokenize(payment_id, body, context = nil)
  path_context = {
    'paymentId'.freeze => payment_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/payments/{paymentId}/tokenize', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::CreateTokenResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end