Class: PayPalCheckoutSdk::Orders::OrdersCaptureRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb

Overview

Captures a payment for an order.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(order_id) ⇒ OrdersCaptureRequest

Returns a new instance of OrdersCaptureRequest.



13
14
15
16
17
18
19
20
21
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 13

def initialize(order_id)
  @headers = {}
  @body = nil
  @verb = "POST"
  @path = "/v2/checkout/orders/{order_id}/capture?"

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

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



11
12
13
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 11

def body
  @body
end

#headers ⇒ Object

Returns the value of attribute headers.



11
12
13
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 11

def headers
  @headers
end

#path ⇒ Object

Returns the value of attribute path.



11
12
13
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 11

def path
  @path
end

#verb ⇒ Object

Returns the value of attribute verb.



11
12
13
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 11

def verb
  @verb
end

Instance Method Details

#pay_pal_client_metadata_id(pay_pal_client_metadata_id) ⇒ Object 



23
24
25
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 23

def pay_pal_client_metadata_id(pay_pal_client_metadata_id)
  @headers["PayPal-Client-Metadata-Id"] = pay_pal_client_metadata_id
end

#pay_pal_request_id(pay_pal_request_id) ⇒ Object 



27
28
29
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 27

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

#prefer(prefer) ⇒ Object 



31
32
33
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 31

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

#request_body(order_action_request) ⇒ Object 



35
36
37
 
# File 'lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb', line 35

def request_body(order_action_request)
  @body = order_action_request
end