Class: PayPalCheckoutSdk::Payments::CapturesRefundRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/payments/captures_refund_request.rb

Overview

Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(capture_id) ⇒ CapturesRefundRequest

Returns a new instance of CapturesRefundRequest.



18
19
20
21
22
23
24
25
26
 
# File 'lib/payments/captures_refund_request.rb', line 18

def initialize(capture_id)
  @headers = {}
  @body = nil
  @verb = "POST"
  @path = "/v2/payments/captures/{capture_id}/refund?"

  @path = @path.gsub("{capture_id}", CGI::escape(capture_id.to_s))
  @headers["Content-Type"] = "application/json"
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



16
17
18
 
# File 'lib/payments/captures_refund_request.rb', line 16

def body
  @body
end

#headers ⇒ Object

Returns the value of attribute headers.



16
17
18
 
# File 'lib/payments/captures_refund_request.rb', line 16

def headers
  @headers
end

#path ⇒ Object

Returns the value of attribute path.



16
17
18
 
# File 'lib/payments/captures_refund_request.rb', line 16

def path
  @path
end

#verb ⇒ Object

Returns the value of attribute verb.



16
17
18
 
# File 'lib/payments/captures_refund_request.rb', line 16

def verb
  @verb
end

Instance Method Details

#pay_pal_request_id(pay_pal_request_id) ⇒ Object 



28
29
30
 
# File 'lib/payments/captures_refund_request.rb', line 28

def pay_pal_request_id(pay_pal_request_id)
  @headers["PayPal-Request-Id"] = pay_pal_request_id
end

#prefer(prefer) ⇒ Object 



32
33
34
 
# File 'lib/payments/captures_refund_request.rb', line 32

def prefer(prefer)
  @headers["Prefer"] = prefer
end

#request_body(refundRequest) ⇒ Object 



36
37
38
 
# File 'lib/payments/captures_refund_request.rb', line 36

def request_body(refundRequest)
  @body = refundRequest
end