Class: PayPal::SDK::Merchant::DataTypes::PaymentDetailsType

Inherits:

DataType

• Object
• Core::API::DataTypes::Base
• DataType
• PayPal::SDK::Merchant::DataTypes::PaymentDetailsType

Defined in:

lib/paypal-sdk/merchant/data_types.rb

Overview

PaymentDetailsType Information about a payment. Used by DCC and Express Checkout.

Class Method Summary

• .load_members ⇒ Object

Instance Method Summary

• #initialize(options = {}) ⇒ PaymentDetailsType constructor

  A new instance of PaymentDetailsType.

Constructor Details

#initialize(options = {}) ⇒ PaymentDetailsType

Returns a new instance of PaymentDetailsType.

# File 'lib/paypal-sdk/merchant/data_types.rb', line 2066

def initialize(options={})
  super
  self.ButtonSource ||= "PayPal_SDK"
end

Class Method Details

.load_members ⇒ Object

# File 'lib/paypal-sdk/merchant/data_types.rb', line 2071

def self.load_members
  # Total of order, including shipping, handling, and tax. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,). 
  object_of :OrderTotal, BasicAmountType, :namespace => :ebl
  # Sum of cost of all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional separator must be a comma (,).
  object_of :ItemTotal, BasicAmountType, :namespace => :ebl
  # Total shipping costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
  object_of :ShippingTotal, BasicAmountType, :namespace => :ebl
  # Total handling costs for this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
  object_of :HandlingTotal, BasicAmountType, :namespace => :ebl
  # Sum of tax for all items in this order. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. Optional Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Decimal separator must be a period (.), and the thousands separator must be a comma (,).
  object_of :TaxTotal, BasicAmountType, :namespace => :ebl
  # Description of items the customer is purchasing. Optional Character length and limitations: 127 single-byte alphanumeric characters
  object_of :OrderDescription, String, :namespace => :ebl
  # A free-form field for your own use. Optional Character length and limitations: 256 single-byte alphanumeric characters
  object_of :Custom, String, :namespace => :ebl
  # Your own invoice or tracking number. Optional Character length and limitations: 127 single-byte alphanumeric characters
  object_of :InvoiceID, String, :namespace => :ebl
  # An identification code for use by third-party applications to identify transactions. Optional Character length and limitations: 32 single-byte alphanumeric characters
  object_of :ButtonSource, String, :namespace => :ebl
  # Your URL for receiving Instant Payment Notification (IPN) about this transaction. Optional If you do not specify NotifyURL in the request, the notification URL from your Merchant Profile is used, if one exists. Character length and limitations: 2,048 single-byte alphanumeric characters
  object_of :NotifyURL, String, :namespace => :ebl
  # Address the order will be shipped to. Optional If you include the ShipToAddress element, the AddressType elements are required: Name Street1 CityName CountryCode Do not set set the CountryName element. 
  object_of :ShipToAddress, AddressType, :namespace => :ebl
  # The value 1 indicates that this payment is associated with multiple shipping addresses. Optional Character length and limitations: Four single-byte numeric characters. 
  object_of :MultiShipping, String, :namespace => :ebl
  # Thirdparty Fulfillment Reference Number. Optional Character length and limitations: 32 alphanumeric characters. 
  object_of :FulfillmentReferenceNumber, String, :namespace => :ebl
  object_of :FulfillmentAddress, AddressType, :namespace => :ebl
  object_of :PaymentCategoryType, PaymentCategoryType, :namespace => :ebl
  object_of :LocationType, LocationType, :namespace => :ebl
  object_of :ShippingMethod, ShippingServiceCodeType, :namespace => :ebl
  # Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at which address was changed by the user. 
  object_of :ProfileAddressChangeDate, DateTime, :namespace => :ebl
  # Information about the individual purchased items
  array_of :PaymentDetailsItem, PaymentDetailsItemType, :namespace => :ebl
  # Total shipping insurance costs for this order. Optional 
  object_of :InsuranceTotal, BasicAmountType, :namespace => :ebl
  # Shipping discount for this order, specified as a negative number. Optional 
  object_of :ShippingDiscount, BasicAmountType, :namespace => :ebl
  # Information about the Insurance options. 
  object_of :InsuranceOptionOffered, String, :namespace => :ebl
  # Allowed payment methods for this transaction. 
  object_of :AllowedPaymentMethod, AllowedPaymentMethodType, :namespace => :ebl
  # Enhanced Data section to accept channel specific data. Optional Refer to EnhancedPaymentDataType for details. 
  object_of :EnhancedPaymentData, EnhancedPaymentDataType, :namespace => :ebl
  # Details about the seller. Optional 
  object_of :SellerDetails, SellerDetailsType, :namespace => :ebl
  # Note to recipient/seller. Optional Character length and limitations: 127 single-byte alphanumeric characters. 
  object_of :NoteText, String, :namespace => :ebl
  # PayPal Transaction Id, returned once DoExpressCheckout is completed. 
  object_of :TransactionId, String, :namespace => :ebl
  # How you want to obtain payment. This payment action input will be used for split payments Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture. Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization and Capture. Sale indicates that this is a final sale for which you are requesting payment. IMPORTANT: You cannot set PaymentAction to Sale on SetExpressCheckoutRequest and then change PaymentAction to Authorization on the final Express Checkout API, DoExpressCheckoutPaymentRequest. Character length and limit: Up to 13 single-byte alphabetic characters 
  object_of :PaymentAction, PaymentActionCodeType, :namespace => :ebl
  # Unique identifier and mandatory for the particular payment request in case of multiple payment 
  object_of :PaymentRequestID, String, :namespace => :ebl
  # URL on Merchant site pertaining to this invoice. Optional 
  object_of :OrderURL, String, :namespace => :ebl
  # Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored. 
  object_of :SoftDescriptor, String, :namespace => :ebl
  # BranchLevel is used to identify chain payment. If BranchLevel is 0 or 1, this payment is where money moves to. If BranchLevel greater than 1, this payment contains the actual seller info. Optional 
  object_of :BranchLevel, Integer, :namespace => :ebl
  # Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored. 
  object_of :OfferDetails, OfferDetailsType, :namespace => :ebl
  # Flag to indicate the recurring transaction 
  object_of :Recurring, RecurringFlagType, :namespace => :ebl
  # Indicates the purpose of this payment like Refund 
  object_of :PaymentReason, PaymentReasonType, :namespace => :ebl
  # Location ID Specified by merchant Optional Character length and limitations: 50 single-byte alphanumeric characters 
  object_of :LocationID, String, :namespace => :ebl
  # For instance single use coupons should not be returned in future CheckIn calls once they are redeemed. 
  array_of :RedeemedOffers, DiscountInfoType, :namespace => :ebl
  # Total loyalty points for a given id accumulated by the consumre so far. 
  array_of :CummulativePoints, DiscountInfoType, :namespace => :ebl
  # Merchant Data that is passed through from Merchant to Processor 
  array_of :MerchantData, MerchantDataType, :namespace => :ebl
end