Module: Unit::CheckPayment

Defined in:
lib/unit/models/check_payment/get_request.rb,
lib/unit/models/check_payment/check_payment.rb,
lib/unit/models/check_payment/get_image_request.rb,
lib/unit/models/check_payment/list_check_payment_params.rb,
lib/unit/models/check_payment/return_check_payment_request.rb

Defined Under Namespace

Classes: GetImageRequest, GetRequest, ListPaymentParams, ReturnCheckPaymentRequest

Constant Summary collapse

CHECK_PAYMENT_LIMIT = 
100
CHECK_PAYMENT_OFFSET = 
0

Class Method Summary collapse

Class Method Details

.approve_payment_verification(payment_id:) ⇒ Object

Approve Check Payment Additional Verification

Parameters:

  • payment_id (String)

See Also:



69
70
71
 
# File 'lib/unit/models/check_payment/check_payment.rb', line 69

def approve_payment_verification(payment_id:)
  Unit::Resource::CheckPaymentResource.approve_payment_verification(payment_id)
end

.get_image(payment_id:, is_front_side: true) ⇒ Object

Get a check deposit image front or back side

Parameters:

  • payment_id (String)
  • is_front_side (Boolean) (defaults to: true) —

    • optional

See Also:



52
53
54
55
 
# File 'lib/unit/models/check_payment/check_payment.rb', line 52

def get_image(payment_id:, is_front_side: true)
  request = GetImageRequest.new(payment_id, is_front_side: is_front_side)
  Unit::Resource::CheckPaymentResource.get_image(request)
end

.get_payment(payment_id:, include: nil) ⇒ Object

Get a check payment by id

Parameters:

  • payment_id (String)
  • include (Array<String>) (defaults to: nil) —

    • optional

See Also:



18
19
20
21
 
# File 'lib/unit/models/check_payment/check_payment.rb', line 18

def get_payment(payment_id:, include: nil)
  request = GetRequest.new(payment_id, include)
  Unit::Resource::CheckPaymentResource.get(request)
end

.list_payment(limit: CHECK_PAYMENT_LIMIT, offset: CHECK_PAYMENT_OFFSET, account_id: nil, customer_id: nil, tags: nil, sort: nil, since: nil, _until: nil, status: nil, from_amount: nil, to_amount: nil, check_number: nil, include: nil) ⇒ Object

Request to list check payments

Parameters:

  • limit (Integer) (defaults to: CHECK_PAYMENT_LIMIT) —

    • optional

  • offset (Integer) (defaults to: CHECK_PAYMENT_OFFSET) —

    • optional

  • account_id (String) (defaults to: nil) —

    • optional

  • customer_id (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • sort (String) (defaults to: nil) —

    • optional

  • since (String) (defaults to: nil) —

    • optional

  • _until (String) (defaults to: nil) —

    • optional

  • status (Array<String>) (defaults to: nil) —

    • optional

  • from_amount (String) (defaults to: nil) —

    • optional

  • to_amount (String) (defaults to: nil) —

    • optional

  • check_number (String) (defaults to: nil) —

    • optional

  • include (Array<String>) (defaults to: nil) —

    • optional

See Also:



38
39
40
41
42
43
44
45
 
# File 'lib/unit/models/check_payment/check_payment.rb', line 38

def list_payment(limit: CHECK_PAYMENT_LIMIT, offset: CHECK_PAYMENT_OFFSET, account_id: nil,
                 customer_id: nil, tags: nil, sort: nil, since: nil, _until: nil, status: nil,
                 from_amount: nil, to_amount: nil, check_number: nil, include: nil)

  request = ListPaymentParams.new(limit, offset, , customer_id, tags, sort, since, _until,
                                  status, from_amount, to_amount, check_number, include)
  Unit::Resource::CheckPaymentResource.list(request)
end

.return_payment(payment_id:, return_reason_code:) ⇒ Object

Return check payment by id

Parameters:

  • payment_id (String)
  • return_reason_code (String)

See Also:



61
62
63
64
 
# File 'lib/unit/models/check_payment/check_payment.rb', line 61

def return_payment(payment_id:, return_reason_code:)
  request = ReturnCheckPaymentRequest.new(payment_id, return_reason_code)
  Unit::Resource::CheckPaymentResource.return_payment(request)
end