Class: PayPal::SDK::Merchant::DataTypes::SetExpressCheckoutRequestDetailsType

Inherits:
DataType
  • Object
show all
Defined in:
lib/paypal-sdk/merchant/data_types.rb

Overview

The total cost of the order to the customer. If shipping cost and tax charges are known, include them in OrderTotal; if not, OrderTotal should be the current sub-total of the order. 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 (,).

Class Method Summary collapse

Class Method Details

.load_members ⇒ Object 



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/paypal-sdk/merchant/data_types.rb', line 843

def self.load_members
  # The total cost of the order to the customer. If shipping cost and tax charges are known, include them in OrderTotal; if not, OrderTotal should be the current sub-total of the order. 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
  # URL to which the customer's browser is returned after choosing to pay with PayPal. PayPal recommends that the value of ReturnURL be the final review page on which the customer confirms the order and payment. Required Character length and limitations: no limit. 
  object_of :ReturnURL, String, :namespace => :ebl
  # URL to which the customer is returned if he does not approve the use of PayPal to pay you. PayPal recommends that the value of CancelURL be the original page on which the customer chose to pay with PayPal. Required Character length and limitations: no limit
  object_of :CancelURL, String, :namespace => :ebl
  # Tracking URL for ebay. Required Character length and limitations: no limit
  object_of :TrackingImageURL, String, :namespace => :ebl
  # URL to which the customer's browser is returned after paying with giropay online. Optional Character length and limitations: no limit.
  object_of :giropaySuccessURL, String, :namespace => :ebl
  # URL to which the customer's browser is returned after fail to pay with giropay online. Optional Character length and limitations: no limit.
  object_of :giropayCancelURL, String, :namespace => :ebl
  # URL to which the customer's browser can be returned in the mEFT done page. Optional Character length and limitations: no limit.
  object_of :BanktxnPendingURL, String, :namespace => :ebl
  # On your first invocation of SetExpressCheckoutRequest, the value of this token is returned by SetExpressCheckoutResponse. Optional Include this element and its value only if you want to modify an existing checkout session with another invocation of SetExpressCheckoutRequest; for example, if you want the customer to edit his shipping address on PayPal. Character length and limitations: 20 single-byte characters
  object_of :Token, String, :namespace => :ebl
  # The expected maximum total amount of the complete order, including shipping cost and tax charges. Optional 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 :MaxAmount, 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, such as a tracking number or other value you want PayPal to return on GetExpressCheckoutDetailsResponse and DoExpressCheckoutPaymentResponse. Optional Character length and limitations: 256 single-byte alphanumeric characters
  object_of :Custom, String, :namespace => :ebl
  # Your own unique invoice or tracking number. PayPal returns this value to you on DoExpressCheckoutPaymentResponse. Optional Character length and limitations: 127 single-byte alphanumeric characters
  object_of :InvoiceID, String, :namespace => :ebl
  # The value 1 indicates that you require that the customer's shipping address on file with PayPal be a confirmed address. Any value other than 1 indicates that the customer's shipping address on file with PayPal need NOT be a confirmed address. Setting this element overrides the setting you have specified in the recipient's Merchant Account Profile. Optional Character length and limitations: One single-byte numeric character.
  object_of :ReqConfirmShipping, String, :namespace => :ebl
  # The value 1 indicates that you require that the customer's billing address on file. Setting this element overrides the setting you have specified in Admin. Optional Character length and limitations: One single-byte numeric character. 
  object_of :ReqBillingAddress, String, :namespace => :ebl
  # The billing address for the buyer. Optional If you include the BillingAddress element, the AddressType elements are required: Name Street1 CityName CountryCode Do not set set the CountryName element. 
  object_of :BillingAddress, AddressType, :namespace => :ebl
  # The value 1 indicates that on the PayPal pages, no shipping address fields should be displayed whatsoever. Optional Character length and limitations: Four single-byte numeric characters.
  object_of :NoShipping, String, :namespace => :ebl
  # The value 1 indicates that the PayPal pages should display the shipping address set by you in the Address element on this SetExpressCheckoutRequest, not the shipping address on file with PayPal for this customer. Displaying the PayPal street address on file does not allow the customer to edit that address. Optional Character length and limitations: Four single-byte numeric characters.
  object_of :AddressOverride, String, :namespace => :ebl
  # Locale of pages displayed by PayPal during Express Checkout. Optional Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase. Allowable values: AU or en_AUDE or de_DEFR or fr_FRGB or en_GBIT or it_ITJP or ja_JPUS or en_US
  object_of :LocaleCode, String, :namespace => :ebl
  # Sets the Custom Payment Page Style for payment pages associated with this button/link. PageStyle corresponds to the HTML variable page_style for customizing payment pages. The value is the same as the Page Style Name you chose when adding or editing the page style from the Profile subtab of the My Account tab of your PayPal account. Optional Character length and limitations: 30 single-byte alphabetic characters. 
  object_of :PageStyle, String, :namespace => :ebl
  # A URL for the image you want to appear at the top left of the payment page. The image has a maximum size of 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server. Optional Character length and limitations: 127
  object_of :cppheaderimage, String, :name => "cpp-header-image", :namespace => :ebl
  # Sets the border color around the header of the payment page. The border is a 2-pixel perimeter around the header space, which is 750 pixels wide by 90 pixels high. Optional Character length and limitations: Six character HTML hexadecimal color code in ASCII
  object_of :cppheaderbordercolor, String, :name => "cpp-header-border-color", :namespace => :ebl
  # Sets the background color for the header of the payment page. Optional Character length and limitation: Six character HTML hexadecimal color code in ASCII
  object_of :cppheaderbackcolor, String, :name => "cpp-header-back-color", :namespace => :ebl
  # Sets the background color for the payment page. Optional Character length and limitation: Six character HTML hexadecimal color code in ASCII
  object_of :cpppayflowcolor, String, :name => "cpp-payflow-color", :namespace => :ebl
  # Sets the cart gradient color for the Mini Cart on 1X flow. Optional Character length and limitation: Six character HTML hexadecimal color code in ASCII
  object_of :cppcartbordercolor, String, :name => "cpp-cart-border-color", :namespace => :ebl
  # A URL for the image you want to appear above the mini-cart. The image has a maximum size of 190 pixels wide by 60 pixels high. PayPal recommends that you provide an image that is stored on a secure (https) server. Optional Character length and limitations: 127
  object_of :cpplogoimage, String, :name => "cpp-logo-image", :namespace => :ebl
  # Customer's shipping address. Optional If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse. 
  object_of :Address, AddressType, :namespace => :ebl
  # How you want to obtain payment. Required 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 or Order 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
  # This will indicate which flow you are choosing (expresschecheckout or expresscheckout optional) Optional None Sole indicates that you are in the ExpressO flow Mark indicates that you are in the old express flow. 
  object_of :SolutionType, SolutionTypeType, :namespace => :ebl
  # This indicates Which page to display for ExpressO (Billing or Login) Optional None Billing indicates that you are not a paypal account holder Login indicates that you are a paypal account holder 
  object_of :LandingPage, LandingPageType, :namespace => :ebl
  # Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page. Optional Character length and limit: 127 single-byte alphanumeric characters 
  object_of :BuyerEmail, String, :namespace => :ebl
  object_of :ChannelType, ChannelType, :namespace => :ebl
  array_of :BillingAgreementDetails, BillingAgreementDetailsType, :namespace => :ebl
  # Promo Code Optional List of promo codes supplied by merchant. These promo codes enable the Merchant Services Promotion Financing feature. 
  array_of :PromoCodes, String, :namespace => :ebl
  # Default Funding option for PayLater Checkout button. 
  object_of :PayPalCheckOutBtnType, String, :namespace => :ebl
  object_of :ProductCategory, ProductCategoryType, :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
  # The value 1 indicates that the customer may enter a note to the merchant on the PayPal page during checkout. The note is returned in the GetExpressCheckoutDetails response and the DoExpressCheckoutPayment response. Optional Character length and limitations: One single-byte numeric character. Allowable values: 0,1 
  object_of :AllowNote, String, :namespace => :ebl
  # Funding source preferences. 
  object_of :FundingSourceDetails, FundingSourceDetailsType, :namespace => :ebl
  # The label that needs to be displayed on the cancel links in the PayPal hosted checkout pages. Optional Character length and limit: 127 single-byte alphanumeric characters 
  object_of :BrandName, String, :namespace => :ebl
  # URL for PayPal to use to retrieve shipping, handling, insurance, and tax details from your website. Optional Character length and limitations: 2048 characters. 
  object_of :CallbackURL, String, :namespace => :ebl
  # Enhanced data for different industry segments. Optional 
  object_of :EnhancedCheckoutData, EnhancedCheckoutDataType, :namespace => :ebl
  # List of other payment methods the user can pay with. Optional Refer to the OtherPaymentMethodDetailsType for more details. 
  array_of :OtherPaymentMethods, OtherPaymentMethodDetailsType, :namespace => :ebl
  # Details about the buyer's account. Optional Refer to the BuyerDetailsType for more details. 
  object_of :BuyerDetails, BuyerDetailsType, :namespace => :ebl
  # Information about the payment. 
  array_of :PaymentDetails, PaymentDetailsType, :namespace => :ebl
  # List of Fall Back Shipping options provided by merchant. 
  array_of :FlatRateShippingOptions, ShippingOptionType, :namespace => :ebl
  # Information about the call back timeout override. 
  object_of :CallbackTimeout, String, :namespace => :ebl
  # Information about the call back version. 
  object_of :CallbackVersion, String, :namespace => :ebl
  # Information about the Customer service number. 
  object_of :CustomerServiceNumber, String, :namespace => :ebl
  # Information about the Gift message enable. 
  object_of :GiftMessageEnable, String, :namespace => :ebl
  # Information about the Gift receipt enable. 
  object_of :GiftReceiptEnable, String, :namespace => :ebl
  # Information about the Gift Wrap enable. 
  object_of :GiftWrapEnable, String, :namespace => :ebl
  # Information about the Gift Wrap name. 
  object_of :GiftWrapName, String, :namespace => :ebl
  # Information about the Gift Wrap amount. 
  object_of :GiftWrapAmount, BasicAmountType, :namespace => :ebl
  # Information about the Buyer email option enable . 
  object_of :BuyerEmailOptInEnable, String, :namespace => :ebl
  # Information about the survey enable. 
  object_of :SurveyEnable, String, :namespace => :ebl
  # Information about the survey question. 
  object_of :SurveyQuestion, String, :namespace => :ebl
  # Information about the survey choices for survey question. 
  array_of :SurveyChoice, String, :namespace => :ebl
  object_of :TotalType, TotalType, :namespace => :ebl
  # Any message the seller would like to be displayed in the Mini Cart for UX. 
  object_of :NoteToBuyer, String, :namespace => :ebl
  # Incentive Code Optional List of incentive codes supplied by ebay/merchant. 
  array_of :Incentives, IncentiveInfoType, :namespace => :ebl
  # Merchant specified flag which indicates whether to return Funding Instrument Details in DoEC or not. Optional 
  object_of :ReqInstrumentDetails, String, :namespace => :ebl
  # This element contains information that allows the merchant to request to opt into external remember me on behalf of the buyer or to request login bypass using external remember me. Note the opt-in details are silently ignored if the ExternalRememberMeID is present. 
  object_of :ExternalRememberMeOptInDetails, ExternalRememberMeOptInDetailsType, :namespace => :ebl
  # An optional set of values related to flow-specific details. 
  object_of :FlowControlDetails, FlowControlDetailsType, :namespace => :ebl
  # An optional set of values related to display-specific details. 
  object_of :DisplayControlDetails, DisplayControlDetailsType, :namespace => :ebl
  # An optional set of values related to tracking for external partner. 
  object_of :ExternalPartnerTrackingDetails, ExternalPartnerTrackingDetailsType, :namespace => :ebl
  # Optional element that defines relationship between buckets 
  array_of :CoupledBuckets, CoupledBucketsType, :namespace => :ebl
end