class PayPal::SDK::REST::DataTypes::Sale

Public Class Methods

find(resource_id) click to toggle source
# File lib/paypal-sdk/rest/data_types.rb, line 820
def find(resource_id)
  raise ArgumentError.new("id required") if resource_id.to_s.strip.empty?
  path = "v1/payments/sale/#{resource_id}"
  self.new(api.get(path))
end
load_members() click to toggle source
# File lib/paypal-sdk/rest/data_types.rb, line 790
def self.load_members
  object_of :id, String
  object_of :purchase_unit_reference_id, String
  object_of :amount, Amount
  object_of :payment_mode, String
  object_of :state, String
  object_of :reason_code, String
  object_of :protection_eligibility, String
  object_of :protection_eligibility_type, String
  object_of :clearing_time, String
  object_of :recipient_fund_status, String
  object_of :payment_hold_status, String
  object_of :hold_reason, String
  object_of :transaction_fee, Currency
  object_of :receivable_amount, Currency
  object_of :exchange_rate, String
  object_of :fmf_details, FmfDetails
  object_of :receipt_id, String
  object_of :parent_payment, String
  object_of :create_time, String
  object_of :update_time, String
  array_of  :links, Links
  object_of :billing_agreement_id, String
  object_of :payment_hold_reasons, String
  object_of :processor_response, ProcessorResponse
end

Public Instance Methods

refund(refund) click to toggle source
# File lib/paypal-sdk/rest/data_types.rb, line 827
def refund(refund)
  refund = Refund.new(refund) unless refund.is_a? Refund
  path = "v1/payments/sale/#{self.id}/refund"
  response = api.post(path, refund.to_hash, http_header)
  Refund.new(response)
end
refund_request(refund_request) click to toggle source
# File lib/paypal-sdk/rest/data_types.rb, line 834
def refund_request(refund_request)
  refund_request = RefundRequest.new(refund_request) unless refund_request.is_a? RefundRequest
  path = "v1/payments/sale/#{self.id}/refund"
  response = api.post(path, refund_request.to_hash, http_header)
  DetailedRefund.new(response)
end