AccountStateCodeType These are the possible codes to describe the state of an account of an eBay user. Amex Visa Mastercard Reserved for internal or future use. AckCodeType This code identifies the acknowledgement code types that could be used to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application level acknowledgement element. Request processing succeeded. Request processing failed. Request processing completed with warning information being included in the response message. Request processing completed successful with some with some warning information that could be useful for the requesting application to process and/or record. Request processing failed with some error and warnining information that requesting application should process to determine cause(s) of failure. Request processing completed with Partial Success. Reserved for internal or future use. AddressOwnerCodeType This code identifies the AddressOwner code types which indicates who owns the user'a address. PayPal owns address. eBay owns address. Reserved for internal or future use. AuctionTypeCodeType - Type declaration to be used by other schema's. This includes codes indicating the type of auction for the listed item. Unknown auction type Chinese auction Dutch auction Live Auctions-type auction Ad type auction Stores Fixed-price auction (US only) Personal Offer auction Fixed Price item ("BIN only"). Reserved for internal or future use. BalanceCodeType This code identifies the types of balances in an account, e.g., a PayPal account. Custom Code Reserved for internal or future use. BuyerPaymentMethodCodeType - Type declaration to be used by other schema. The includes the codes for payment methods used by buyers to pay sellers. No payment method specified Money order/cashiers check American Express Payment See Description American Express Personal check COD Visa/Mastercard Other forms of payment. Some custom method is accepted by seller as payment method in the transaction. For Motors vehicle items, this field refers to the Deposit payment method. PayPal Discover Payment on delivery acceptable payment term. Direct transfer of money acceptable payment term. If the seller has bank account information on file, and MoneyXferAcceptedinCheckout = true, then the bank account information will be displayed in Checkout. Applicable to German site only. Online Escrow paid for by seller. Reserved for internal or future use. BuyerProtectionCodeType Item is ineligible (e.g., category not applicable). Item is eligible per standard criteria. Item marked ineligible per special criteria (e.g., seller's account closed). Item marked eligible per other criteria. Reserved for internal or future use. CheckoutStatusCodeType Checkout complete. Checkout incomplete. No details specified. Buyer requests total. Seller responded to buyer's request. Reserved for internal or future use. CountryCodeType This code list module defines the enumerated types of standard 2-letter ISO 3166 country codes. This codelist contains some additional country code not defined in the ISO 3166 country code set. NOTE: APO/FPO was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country code list for backward compatibility. NOTE: Guernsey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jan Mayen was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jersey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Tahiti was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Serbia and Montenegro was not defined in the list previously but now an ISO 3166 code has been defined. As of 41.0 this country is supported in PayPal PRO. Reserved for internal or future use. Republic of Serbia. Montenegro. ISO 4217 standard 3-letter currency code.

The following currencies are supported by PayPal.
Code CurrencyMaximum Transaction Amount
AUD Australian Dollar 12,500 AUD
CAD Canadian Dollar12,500 CAD
EUR Euro 8,000 EUR
GBP Pound Sterling 5,500 GBP
JPY Japanese Yen 1,000,000 JPY
USD U.S. Dollar 10,000 USD
CHF Czech Koruna 70,000 CHF
SEK Swedish Krona 3,50,000 SEK
NOK Norwegian Krone 4,00,000 NOK
DKK Danish Krone 3,00,000 DKK
PLN Poland Zloty 1,60,000 PLN
HUF Hungary Forint 110,00,000 HUF
SGD Singapore Dollar 80,000 SGD
HKD HongKong Dollar 3,80,000 HKD
NZD New Zealand Dollar 77,000 NZD
CZK Czech Koruna 1,20,000 CZK
Reserved for internal or future use.
DepositTypeCodeType - Type declaration to be used by other schema's. This code identifies the DepositType codes used to specify deposit types for Motors items. If the ietm listed is not a Motors item, then always return DepositType value to be "None". None Other Method Fast Deposit. Reserved for internal or future use. DetailLevelCodeType Return in response message all detail levels. Return item description. Return attributes as part of the item. This file defines re-useable base and aggregate components of the eBay Business Lanaguage (eBL) that would be used to compose message payloads for eBay APIs. This defines if the incentive is applied on Ebay or PayPal. This defines if the incentive is applied successfully or not. Represents the unique identifier for an item. To be used to specify the elements that represents an ItemID. PaymentReasonType This is the Payment Reason type (used by DoRT and SetEC for Refund of PI transaction, eBay return shipment, external dispute) Identifies a BA flow for return shipment Balance as of a given entry, can be 0.00. Credit Amount for a detail entry, can be 0.00. Date entry was posted, in GMT. Debit Amount for this detail entry, can be 0.00. Item number if transaction is associated with an auction or 0 if no item is associated with an account entry. Memo line for an account entry, can be empty string. eBay reference number for an account entry. Integer code for account details entry type. This element element specifies an index to a table of explanations for accounting charges. The AdditionalAccount component represents historical data related to accounts that the user held with a country of residency other than the current one. eBay users can have one active account at a time. For users who change their country of residency and modify their eBay registration to reflect this change, the new country of residence becomes the currently active account. Any account associated with a previous country is treated as an additional account. Because the currency for these additional accounts are different than the active account, each additional account includes an indicator of the currency for that account. Users who never change their country of residence will not have any additional accounts. Merchandizing info for an Item. This contains a list of crosssell or upsell items. Item ID for the base item. Based on this item other items are promoted. it is teh only tag that would show up in all calls that use promoted item type. some are not in soap yet, such as get and ser promotion rules URL for the picture of the promoted item. Where to display in the list of items.currentl y even forget and set does not have to be minoccur =0 but if we ever were to do revise promotion tems, it can be omitted Promotion Price. Price at which the buyer can buy the item now. Item Title for the promoted item. Merchandizing info for an Item. This contains a list of crosssell or upsell items. PrimaryScheme, PromotionMethod,SellerId,ItemId, ShippingDiscount do not have be min occur 0 Item ID for the base item. Based on this item other items are promoted. Id of the Seller who is promoting this item. Shipping Discount offered or not by the seller. Key of the Seller who is promoting this item. Store Name for the seller. Includes account summary for the user. Number of additional accounts. Amount past due, 0.00 if not past due. First four digits (with remainder Xed-out). This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Last time/day BankAccountInfo and/or BankRoutingInfo was modified, in GMT. This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Indicates the billing cycle in which eBay sends a billing invoice to the specified user. Possible values: 0 = On the last day of the month. 15 = On the 15th day of the month. Expiration date for the credit card selected as payment method, in GMT. Empty string if no credit card is on file or if account is inactive -- even if there is a credit card on file. Last four digits of user's credit card selected as payment type. Empty string if no credit is on file. This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Last date credit card or credit card expiration date was modified, in GMT. This may be an empty string depending upon the value of the payment type for the user account (e.g, Empty string if no credit card is on file. User's current balance. Can be 0.00, positive, or negative. Amount of last payment posted, 0.00 if no payments posted. Amount of last invoice. 0.00 if account not yet invoiced. Date of last invoice sent by eBay to the user, in GMT. Empty string if this account has not been invoiced yet. Date of last payment by specified user to eBay, in GMT. Empty string if no payments posted. Indicates whether the account has past due amounts outstanding. Possible values: true = Account is past due. false = Account is current. Indicates the method the specified user selected for paying eBay. The values for PaymentType vary for each SiteID. Information about user used by buying applications Information about user used by selling applications there are number of required elements - they will always show up for seller node there is not such a call to do revise seller info. only added minoccur=0 to elements that will not show up in every type of request/responce Indicates whether the user has elected to participate as a seller in the Merchandising Manager feature. Definition of an eBay Fee type. Following are the current set of eBay fee types AuctionLengthFee BoldFee BuyItNowFee CategoryFeaturedFee FeaturedFee FeaturedGalleryFee FixedPriceDurationFee GalleryFee GiftIconFee HighLightFee InsertionFee ListingDesignerFee ListingFee PhotoDisplayFee PhotoFee ReserveFee SchedulingFee ThirtyDaysAucFee Instances of this type could hold one or more supported types of fee. Calculated cost of shipping, based on shipping parameters and selected shipping service. Only returned if ShippingType = 2 (i.e., calculated shipping rate). Optional fees a seller might assess for the shipping of the item. Describes any error message associated with the attempt to calculate shipping rates. If there was no error, returns "No Error" (without the quotation marks). is unique identified of shipping carrier, without this element the whole node makes no sence Potal/zip code from where package will be shipped. Indicates an item that cannot go through the stamping machine at the shipping service office (a value of True) and requires special or fragile handling. Only returned if ShippingType = 2. contains information about shipping fees per each shipping service chosen by the seller May need to be moved into details - wait for George! The size of the package to be shipped. Possible values are: None Letter Large envelope USPS flat rate envelope Package/thick envelope USPS large package/oversize 1 Very large package/oversize 2 UPS Letter Shipping weight unit of measure (major). If unit of weight is kilogram (i.e., metric system) this would be the exact weight value in kilogram (i.e., complete decimal number, e.g., 2.23 kg). Only returned if ShippingType is 2. Shipping weight unit of measure (minor). If unit of weight is in pounds and/or ounces, this would be the exact weight value in ounces (i.e., complete decimal number, e.g., 8.2 or 8.0 ounces). Only returned if ShippingType is 2. Any additional shipping costs for the item. Amount of the sales tax to be collected for the transaction. Sales tax is only for US. Sales tax for the transaction, expressed as a percentage. Should be empty for items listed on international sites (hence, this is US-only element). Indicates whether shipping is included in the tax. Applicable if ShippingType = 1 or 2. This element is used for US-only. Specifies the shipping payment details. Indicates whether the buyer edited the payment amount. Calculated shipping rate details. If present, then the calculated shipping rate option was used. Indicates whether the payment instructions are included (e.g., for updating the details of a transaction). Flat shipping rate details. If present, then the flat shipping rate option was used. Total cost of insurance for the transaction. Indicates whether buyer selected to have insurance. Payment instuctions. Sales tax details. Sales tax applicable for only US sites. For non-US sites this sub-element should not be used. Postal/Zip code from where the seller will ship the item. URLs for item picture that are stored/hosted at eBay site. Type of display for photos used for PhotoHosting slide show. Here are display options: None = No special Picture Services features. SlideShow = Slideshow of multiple pictures. SuperSize = Super-size format picture. PicturePack = Picture Pack. Default is 'None'. This will be either "Featured" or "Gallery". URLs for item picture that are stored/hosted at eBay site. URL for a picture for the gallery. If the GalleryFeatured argument is true, a value must be supplied for either the GalleryURL or the PictureURL argument. In either case: (a) If a URL is provided for only PictureURL, it is used as the Gallery thumbnail. (b) If a URL is provided for both GalleryURL and PictureURL, then the picture indicated in GalleryURL is used as the thumbnail. The image used for the Gallery thumbnail (specified in the GalleryURL or PictureURL argument) must be in one of the graphics formats JPEG, BMP, TIF, or GIF. This will be either "Featured" or "Gallery". Specific physical attribute of an item. ValueList of the Attribute being described by the AttributeID. Constant name of the attribute that identifies a physical attribute within a set of characteristics that describe something in a formalised way. AttributeSet. Container for data on the primary category of listing. CSIDList is not present if Attributes enabled. Contains the eBay Stores-specific item attributes department number and store location. StorefrontInfo is shown for any item that belongs to an eBay Store owner, regardless of whether it is fixed price or auction type. Returned as null for international fixed price items. assumed this type is specific to add/get/revise item, then each StorefrontType nust have category id, for store details this node makes no sense to use in case or revise item for example - to change store category (department) you do not need to change store URL, so it will notbe in request Identifies the Layout and the Theme template associated with the item. in case of revision - all data can be min occur = 0 Identifies the Layout template associated with the item. A value of true for OptimalPictureSize indicates that the picture URL will be enlarged to fit description of the item. Identifies the Theme template associated with the item. Contains information about a Charity listing.in case of revision - all data can be min occur = 0 Contains the listed items price details which consists of following information: BuyItNowPrice, ConvertedBuyItNowPrice, ConvertedPrice, ConvertedStartPrice, CurrentPrice, MinimumToBid, ReservePrice, and StartPrice. need to take in account get seller events when defining minoccurs = 0 Number of bids placed so far against the item. Not returned for International Fixed Price items. Smallest amount a bid must be above the current high bid. Not returned International Fixed Price items. Converted current price of listed item. For auction-format listings, current minimum asking price or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed against the item. This field does not reflect the actual current price of the item if it's a Type=7 or Type=9 (Fixed Price) item and the price has been revised. (See StartPrice for revised asking price.) Contains one User node representing the current high bidder. GetItem returns a high bidder for auctions that have ended and have a winning bidder. For Fixed Price listings, in-progress auctions, or auction items that received no bids, GetItem returns a HighBidder node with empty tags. Applicable to ad-format items only. Indicates how many leads to potential buyers are associated with this item. For other item types (other than ad-format items), returns a value of 0 (zero). Minimum acceptable bid for the item. Not returned for International Fixed Price items. Number of items purchased so far. (Subtract from the value returned in the Quantity field to calculate the number of items remaining.) Returns true if the reserve price was met or no reserve price was specified. Contains the revise status information details (e.g., item properties information). ths node contains system set data only - always output and always all data. no minccurs needed, except for motors specific data, since it wil lnot be retruned for non motors items Indicates whether the item was revised since the auction started. If true, indicates that a Buy It Now Price was added for the item. Only returned for Motors items. Replaces BinLowered as of API version 305. If true, indicates that the Buy It Now Price was lowered for the item. Only returned for Motors items. If true, indicates that the Reserve Price was lowered for the item. Only returned for Motors items. If true, indicates that the Reserve Price was removed from the item. Only returned for eBay Motors items. Contains the listed item details which consists of following information: . Converted value of the BuyItNowPrice in the currency indicated by SiteCurrency. This value must be refreshed every 24 hours to pick up the current conversion rates. Converted value of the StartPrice field in the currency indicated by SiteCurrency. This value must be refreshed every 24 hours to pick up the current conversion rates. Indicates the converted reserve price for a reserve auction. Returned only if DetailLevel = 4. ReservePrice is only returned for auctions with a reserve price where the user calling GetItem is the item's seller. Returned as null for International Fixed Price items. For more information on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1. Indicates the new ItemID for a relisted item. When an item is relisted, the old (expired) listing is annotated with the new (relist) ItemID. This field only appears when the old listing is retrieved. The ItemID for the original listing (i.e., OriginalItemID specific to Second Chance Offer items). Time stamp for the start of the listing (in GMT). For regular items, StartTime is not sent in at listing time. Time stamp for the end of the listing (in GMT). Returns custom, application-specific data associated with the item. The data in this field is stored with the item in the items table at eBay, but is not used in any way by eBay. Use ApplicationData to store such special information as a part or SKU number. Maximum 32 characters in length. Carries one or more instances of the AttributeSet in a list. If true (1), indicates that the seller requested immediate payment for the item. False (0) if immediate payment was not requested. (Does not indicate whether the item is still a candidate for puchase via immediate payment.) Only applicable for items listed on US and UK sites in categories that support immediate payment, when seller has a Premier or Business PayPal account. Indicates the status of the item's eligibility for the Buyer Protection Program. Possible values: ItemIneligible - Item is ineligible (e.g., category not applicable) ItemEligible - Item is eligible per standard criteria ItemMarkedIneligible - Item marked ineligible per special criteria (e.g., seller's account closed) ItemMarkedIneligible - Item marked elegible per other criteria Applicable for items listed to the US site and for the Parts and Accessories category (6028) or Everything Else category (10368) (or their subcategories) on the eBay Motors site. Amount a Buyer would need to bid to take advantage of the Buy It Now feature. Not applicable to Fixed-Price items (Type = 7 or 9) or AdFormat-type listings. For Fixed-Price items, see StartPrice instead. Charity listing container. 2-letter ISO 3166 Country Code. CrossPromotions container, if applicable shows promoted items 3-letter ISO Currency Code. Item Description. Online Escrow paid for by buyer or seller. Cannot use with real estate auctions. Escrow is recommended for for transactions over $500. Escrow service, available via Escrow.com, protects both buyer and seller by acting as a trusted third-party during the transaction and managing the payment process from start to finish. Also, if escrow by seller option used, then for Motors, this means that Escrow will be negotiated at the end of the auction. If set, a generic gift icon displays in the listing's Title. GiftIcon must be set to to be able to use GiftServices options (e.g., GiftExpressShipping, GiftShipToRecipient, or GiftWrap). Gift service options offered by the seller of the listed item. Optional hit counter for the item's listing page. Possible values are: "NoHitCounter" "HonestyStyle" "GreenLED" "Hidden" The ID that uniquely identifies the item listing. Includes listing details in terms of start and end time of listing (in GMT) as well as other details (e.g., orginal item for second chance, converted start price, etc.). When an item is first listed (using AddItem), a Layout template or a Theme template (or both) can be assigned to the item. A Layout template is assigned to a new item by specifying the Layout template ID (in the AddItem input argument LayoutID). Similarly, a Theme template is assigned to the item using the ThemeID argument. Describes the number of days the auction will be active. Describes the types of enhancment supported for the item's listing. Describes the type of listing for the item a seller has chosen (e.g., Chinese, Dutch, FixedPrice, etc.). Indicates the geographical location of the item. Needed for add item only for partners. Needed for add item only for partners. List of payment methods accepted by a seller from a buyer for a (checkout) transaction. Valid PayPal e-mail address if seller has chosen PayPal as a payment method for the listed item. Container for data on the primary category of listing. Private auction. Not applicable to Fixed Price items. Number of items being sold in the auction. Region where the item is listed. See Region Table for values. If the item is listed with a Region of 0 (zero), then this return field denotes no region association with the item, meaning that it is not listing the item regionally. If true, creates a link from the old listing for the item to the new relist page, which accommodates users who might still look for the item under its old item ID. Also adds the relist ID to the old listing's record in the eBay database, which can be returned by calling GetItem for the old ItemId. If your application creates the listing page for the user, you need to add the relist link option to your application for your users. Indicates the reserve price for a reserve auction. Returned only if DetailLevel = 4. ReservePrice is only returned for auctions with a reserve price where the user calling GetItem is the item's seller. Returned as null for International Fixed Price items. For more information on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1. Revise Status contains information about the item being revised. Container for data on the secondary category of listing. Secondary category is optional. Item picture information for pictures hosted at eBay site. Seller user. Container for for selling status information (e.g., BidCount, BidIncrement, HighBidder, MinimimumToBid, etc). Specifies where the seller is willing to ship the item. Default "SiteOnly". Valid values are: SiteOnly (the default) WorldWide SitePlusRegions WillNotShip If SitePlusRegions is selected, then at least one regions argument (ShipToNorthAmerica, ShipToEurope, etc.) must also be set. Contains the shipping payment related information for the listed item. Regions that seller will ship to. Describes who pays for the delivery of an item (e.g., buyer or seller). eBay site on which item is listed. Starting price for the item. For Type=7 or Type=9 (Fixed Price) items, if the item price (MinimumBid) is revised, this field returns the new price. Storefront is shown for any item that belongs to an eBay Store owner, regardless of whether it is fixed price or auction type. Not returned for International Fixed Price items. Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. Time until the the end of the listing (e.g., the amount of time left in an active auction). Name of the item as it appears for auctions. Universally unique constraint tag. The UUID is unique to a category. VAT info container. Item picture information for pictures hosted at vendor (i.e., remote) site. Contains information about multiple individual transations. Contains information about a single transaction. A transaction contains information about the sale of a particular item. The system creates a transaction when a buyer has made a purchase (Fixed Price items) or is the winning bidder (BIN and auction items). A listing can be associated with one or more transactions in these cases: Multi-Item Fixed Price Listings Dutch Auction Listings A listing is associated with a single transaction in these cases: Single-Item Fixed Price Listings Single-Item Auction Listings The amount the buyer paid for the item or agreed to pay, depending on how far into the checkout process the item is. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by calling GetSellerTransactions or GetSellerTransactions and comparing the AmountPaid value to what the seller expected. For Motors items, AmountPaid is the amount paid by the buyer for the deposit. Container for buyer data. Includes shipping payment data. Value returned in the Transaction/AmountPaid element, converted to the currency indicated by SiteCurrency. Value returned in the Transaction/TransactionPrice element, converted to the currency indicated by SiteCurrency. For fixed-price, Stores, and BIN items indicates when the purchase (or BIN) occurred. For all other item types indicates when the transaction was created (the time when checkout was initiated). Deposit type for Motors items. If item is not a Motors item, then returns a DepositType of None. Possible values: None Other Method Fast Deposit Item info associated with the transaction. Contains the number of individual items the buyer purchased in the transaction. Shipping cost totals shown to user (for both flat and calculated rates). Container node for transaction status data. Unique identifier for a transaction. Returns 0 when Type=1 (Chinese auction). Typically, an ItemID and a TransactionID uniquely identify a checkout transaction. Unique identifier for an authorization. Price of the item, before shipping and sales tax. For Motors, TransactionPrice is the deposit amount. VAT rate for the item, if the item price includes the VAT rate. Specify the VATPercent if you want include the net price in addition to the gross price in the listing. VAT rates vary depending on the item and on the user's country of residence; therefore a business seller is responsible for entering the correct VAT rate (it will not be calculated by eBay). Indicates the success or failure of an eBay Online Payment for the transaction. If the payment failed, the value returned indicates the reason for the failure. Possible values: 0 = No payment failure. 3 = Buyer's eCheck bounced. 4 = Buyer's credit card failed. 5 = Buyer failed payment as reported by seller. 7 = Payment from buyer to seller is in PayPal process, but has not yet been completed. Indicates the current state of the checkout process for the transaction. Possible values: 0 = Checkout complete. 1 = Checkout incomplete. No details specified. 2 = Buyer requests total. 3 = Seller responded to buyer's request. Indicates last date and time checkout status or incomplete state was updated (in GMT). Payment method used by the buyer. (See BuyerPaymentCodeList/Type). Indicates whether the transaction process complete or incomplete. Possible values: 1 = Incomplete 2 = Complete Feedback scores are a quantitative expression of the desirability of dealing with that person as a Buyer or a Seller in auction transactions. Each auction transaction can result in one feedback entry for a given user (the Buyer can leave one feedback about the Seller and the Seller can leave one feedback about the Buyer). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). This rating is commonly expressed as the eBay Feedback score for the user. If present, indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See Value-Added Tax (VAT). Not returned for users whose country of residence is outside the EU. Possible values for the user's status: 2 = Residence in an EU country but user registered as VAT-exempt 3 = Residence in an EU country and user not registered as VAT-exempt Contains information required To list a business item. BusinessSeller - only for add item, the RestrictedToBusiness and VATPercent for both get and add, for revise all must be optional Contains information for Scheduling limits for the user. All dtails must be present,unless we will have revise call one day, just in case we might let's make min occur = 0 Amount of insurance. Applicable if ShippingType is Flat shipping rate orCalculated shipping rate. Indicates whether insurance fee is required. Possible values: Insurance not offered. Insurance optional. Insurance required. Insurance included in Shipping and Handling costs. Applicable if ShippingType is Flat shipping rate or Calculated shipping rate. Shipping carrier for the item. Possible values are: UPS Ground UPS 3rd Day UPS 2nd Day UPS Next Day USPS Priority USPS Parcel USPS Media USPS First Class Custom categories for subdividing the items within an eBay Store. Store owners can create up to 12 custom categories for their stores. (One Store category cannot be customized and retains the value of "Other") If specified, must be number between 0 and 12. 0=Not an eBay Store item 1=Other 2=Category 1 3=Category 2 ... 11=Category 10 12=Category 11 Returned as null for international fixed priced item. URL pointing to the seller's eBay Store page. Returned as null for International Fixed Price items. This URL follows the format below, where "####" is replaced by the seller's eBay Stores ID (that uniquely identifies the eBay Store). http://www.ebaystores.com/id=#### Inclusion of all supported eBay Business Language (eBL) Code Lists. This schema definition file contains specification for: 1) eBay Business Langauge (eBL) Abstract Request and Response Message which will be used to construct payloads for various applications; 2) Re-useable error components of the eBL that would be used to communicate application-level error messages back to the client application. These application error messages may be due to a problem detected while processing the request message. 3) Other utility components needed by various eBay buying, selling, and payment applications, e.g., address type and element. Value of the application-specific error parameter. Specifies application-specific error parameter name. Error code can be used by a receiving application to debugging a response message. These codes will need to be uniquely defined for each application. SeverityCode indicates whether the error is an application level error or if it is informational error, i.e., warning. This optional element may carry additional application-specific error variables that indicate specific information about the error condition particularly in the cases where there are multiple instances of the ErrorType which require additional context. Error code can be used by a receiving application to debugging a SOAP response message that contain one or more SOAP Fault detail objects, i.e., fault detail sub-elements. These codes will need to be uniquely defined for each fault scenario. Severity indicates whether the error is a serious fault or if it is informational error, i.e., warning. Base type definition of request payload that can carry any type of payload content with optional versioning information and detail level requirements. This specifies the required detail level that is needed by a client application pertaining to a particular data component (e.g., Item, Transaction, etc.). The detail level is specified in the DetailLevelCodeType which has all the enumerated values of the detail level for each component. This should be the standard RFC 3066 language identification tag, e.g., en_US. This refers to the version of the request payload schema. Base type definition of a response payload that can carry any type of payload content with following optional elements: - timestamp of response message, - application level acknowledgement, and - application-level errors and warnings. This value represents the date and time (GMT) when the response was generated by a service provider (as a result of processing of a request). Application level acknowledgement code. CorrelationID may be used optionally with an application level acknowledgement. This refers to the version of the response payload schema. This refers to the specific software build that was used in the deployment for processing the request and generating the response. Country code associated with this phone number. Phone number associated with this phone. Extension associated with this phone number. Person's name associated with this address.
Character length and limitations: 32 single-byte alphanumeric characters
First street address.
Character length and limitations: 300 single-byte alphanumeric characters
Second street address.
Character length and limitations: 300 single-byte alphanumeric characters
Name of city.
Character length and limitations: 120 single-byte alphanumeric characters
State or province.
Character length and limitations: 120 single-byte alphanumeric characters

For Canada and the USA, StateOrProvince must be the standard 2-character abbreviation of a state or province.

Canadian Provinces
Alberta AB
British_Columbia BC
Manitoba MB
New_Brunswick NB
Newfoundland NF
Northwest_Territories NT
Nova_Scotia NS
Nunavut NU
Ontario ON
Prince_Edward_Island PE
Quebec QC
Saskatchewan SK
Yukon YK


United States AL
Alabama
Alaska AK
American_Samoa AS
Arizona AZ
Arkansas AR
California CA
Colorado CO
Connecticut CT
Delaware DE
District_Of_Columbia DC
Federated_States_Of_Micronesia FM
Florida FL
Georgia GA
Guam GU
Hawaii HI
Idaho ID
Illinois IL
Indiana IN
Iowa IA
Kansas KS
Kentucky KY
Louisiana LA
Maine ME
Marshall_Islands MH
Maryland MD
Massachusetts MA
Michigan MI
Minnesota MN
Mississippi MS
Missouri MO
Montana MT
Nebraska NE
Nevada NV
New_Hampshire NH
New_Jersey NJ
New_Mexico NM
New_York NY
North_Carolina NC
North_Dakota ND
Northern_Mariana_Islands MP
Ohio OH
Oklahoma OK
Oregon OR
Palau PW
Pennsylvania PA
Puerto_Rico PR
Rhode_Island RI
South_Carolina SC
South_Dakota SD
Tennessee TN
Texas TX
Utah UT
Vermont VT
Virgin_Islands VI
Virginia VA
Washington WA
West_Virginia WV
Wisconsin WI
Wyoming WY
Armed_Forces_Americas AA
Armed_Forces AE
Armed_Forces_Pacific AP
ISO 3166 standard country code
Character limit: Two single-byte characters.
IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.

This element should only be used in response elements and typically should not be used in creating request messages which specify the name of a country using the Country element (which refers to a 2-letter country code).
Telephone number associated with this address IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile, or UpdateRecurringPaymentsProfile. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile. IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.

Only applicable to SellerPaymentAddress today. Seller's international name that is associated with the payment address.
IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.

Only applicable to SellerPaymentAddress today. International state and city for the seller's payment address.
IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.

Only applicable to SellerPaymentAddress today. Seller's international street address that is associated with the payment address.
Status of the address on file with PayPal.

IMPORTANT: Do not set this element for SetExpressCheckout, DoExpressCheckoutPayment, DoDirectPayment, CreateRecurringPaymentsProfile or UpdateRecurringPaymentsProfile.

Returns Normalization Status of the Address. Possible values are Normalized, Unnormalized, and None.
EscrowCodeType These are the possible codes to describe Escrow options. By Buyer By Seller. None. Reserved for internal or future use. FeedbackRatingStarCodeType No graphic displayed Yellow Star Turquoise Star Purple Star Red Star Green Star Yellow Shooting Star Turquoise Shooting Star Purple Shooting Star Red Shooting Star Blue Star Reserved for internal or future use. GalleryTypeCodeType Specifies the codes for various properties of an item. Indicates whether it is a featured item. Include in the gallery. Reserved for internal or future use. GeneralPaymentMethodCodeType - Type declaration to be used by other schema. This code identifies the general types of payment means, e.g., used by payment service provider applications. Custom Code Electronic check. ACH. Credit-card. Pay balance. Reserved for internal or future use. GiftServicesCodeType - Type declaration to be used by other schema's. Specifies the codes for the various Gift Services offered by sellers. If any of the Gift Services are offered by the seller, the generic gift icon should be used to display the item: http://pics.ebay.com/aw/pics/gift/gift.gif indicates that the seller is offering to ship the item via an express shipping method as described in the item description. indicates that the seller is offering to ship to the gift recipient, not the buyer, when payment clears. indicates that the seller is offering to wrap the item (and optionally include a card) as described in the item description. Reserved for internal or future use. HitCounterCodeType This code identifies the HitCounter codes used to specify whether a hit counter is used for the item's listing page and, if so, what type. No hit counter Honesty Style Hit Counter Green LED counter. Hidden counter. Reserved for internal or future use. InsuranceOptionCodeType These are the possible codes to describe insurance option as part of shipping service. Insurance optional. Insurance required. Insurance not offered. Insurance included in Shipping and Handling costs. Reserved for internal or future use. ListingDurationCodeType These are the possible codes to describe the number of days the auction will be active. Must be one of the values 3, 5, 7, or 10 for auction and basic Fixed-Price (Type 9) listings. Must be 30, 60, 90, 120, or GTC for Stores Fixed-Price (Type 7) listings. Specify GTC for the Good 'Til Cancel feature (eBay Stores items only). 1 Day 3 Days 5 Days 7 Days 10 Days 30 Days 60 Days 90 Days 120 Days GTC Reserved for internal or future use. ListingEnhancementsCodeType Specifies the codes for various properties of an item. Indicates whether an item will be displayed with a border that will go around the item (e.g., for category-based search result page or store search that brings up multiple items) to differentiate it from the rest of list. Indicates whether the bolding option was used. Indicates whether it is a featured item. Indicates item's listing is highlighted. Indicates item's listing is home page featured. Reserved for internal or future use. eBay Listing Enhancements Codes Code List Agency - eBay, Inc. Code List Version - 1.0 ListingTypeCodeType - Type declaration to be used by other schema. This includes codes indicating the type of auction for the listed item. Unknown Listing Type Chinese auction Dutch auction Live Auctions-type auction Ad type auction Stores Fixed-price auction (US only) Personal Offer auction Fixed Price item ("BIN only"). Reserved for internal or future use. MerchandizingPrefCodeType OptIn OptOut Reserved for internal or future use. ModifyCodeType This code identifies the types of modification you can make on an object. account. Indicate filed is to be dropped. Indicate filed is to be modified. Reserved for internal or future use. PhotoDisplayCodeType These are types of display for photos used for PhotoHosting slide show. No special Picture Services features. Slideshow of multiple pictures. Super-size format picture. Picture Pack. Reserved for internal or future use. Cross Promotion Method. Auction Item Buy It Now Reserved. Do not use. Cross Promotion Method. Manual Selection Automatic Selection Reserved. Do not use. Cross Promotion Method. Cross Sell Up Sell Reserved. Do not use. Cross Promotion Context Promotion Scheme. Item to Item Promotional Scheme Item to Item Store Scheme Store to Store Scheme Reserved. Do not use. PurchasePurposeTypeCodeType - Type declaration to be used by other schema. This code identifies the purpose of purchases, e.g., by a PayPal application. Custom Code Reserved for internal or future use. SellerLevelCodeType Bronze Silver Gold Platinum Titanium None Reserved for internal or future use. SellerPaymentMethodCodeType These are payment methods that sellers can use to pay eBay. No payment method specified - some other payment method. Amex Visa Mastercard Discover JCB Diners Reserved for internal or future use. SeverityCodeType This code identifies the Severity code types in terms of whether there is an API-level error or warning that needs to be communicated to the client. Warning or informational error. Application-level error. Partial Success. Reserved for internal or future use. ShippingOptionCodeType These are the possible codes to describe shipping options in terms of where the seller is willing to ship the item. Site only. WorldWide. SitePlusRegions. WillNotShip. Reserved for internal or future use. ShippingPackageCodeType These are the possible codes to describe shipping package options. None. Letter. LargeEnvelope USPS Large Package/Oversize 1 Very Large Package/Oversize 2 UPS Letter USPS Flat Rate Envelope Package/thick envelope Reserved for internal or future use. ShippingRatesTypeCodeType - Type declaration to be used by other schema. The includes the codes for shipping types supported by sellers to transport items sold to buyers. Flat shipping rate. Calculated shipping rate. Reserved for internal or future use. ShippingRegion CodeType This code list module defines the enumerated types of regions for shipping items (i.e., a seller may support shipment of an item). Africa Asia Carribbean Europe LatinAmerica MiddleEast NorthAmerica Oceania (i.e., Pacific region other than Asia) SouthAmerica Reserved for internal or future use. ShippingServiceCodeType These are the possible codes to describe insurance option as part of shipping service. UPS Ground UPS 3rd Day UPS 2nd Day UPS Next Day. USPS Priority. USPS Parcel. USPS Media. USPS First Class ShippingMethodStandard - used by merchant tool only ShippingMethodExpress- used by merchant tool only ShippingMethodNextDay- used by merchant tool only USPS Express Mail USPS Ground Download. Will Call Or Pick Up. Reserved for internal or future use. ShippingTermsCodeType - Type declaration to be used by other schema's. Shipping terms code describes who pays for the shipping of an item. These are the standard shipping terms, i.e., terms of delivery of an item. Seller pays all shipping costs. Buyer pays all shipping costs. Reserved for internal or future use. SiteCodeType These are site codes that buyers and sellers can use to identify their sites. USA Canada United Kingdom Australia Austria Belgium (French) France Germany Italy Belgium (Dutch) Netherlands Spain Switzerland Taiwan eBay Motors Hong Kong Singapore Reserved for internal or future use. This is to validate input if store should be visible/invisible in the store locator. If Merchant wants a store to be ENABLED, input should be "E". If Merchant wants a store to be DISABLED, input should be "D". If Merchant is not giving any input, it will be taken as "DISABLED" UnitCodeType Kilogram. Pounds. Ounces Centimeter. Inches. Feet. Reserved for internal or future use. UserStatusCodeType User properties have never been set. This value should seldom, if ever, be returned and typically represents a problem. User has been suspended from selling and buying, such as for violations of eBay terms or agreement. User has completed online registration and has properly responded to confirmation email. Most users should fall in this category. User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. . Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay. Temporary user record state indicating the record is in the process of being changed by eBay. Query user information again to get new status. Records for the specified user have been deleted. User has completed registration and confirmation, but is pending a verification of credit card information. User's account is on hold, such as for non-payment of amounts due eBay. User cannot sell or buy items. User record has been merged with another account record for the same user. User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email. User has been scheduled for account closure (typically when a user has requested to have their account closed.) A user in this state should not be considered an active user. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending. Passport User. User has completed the registration process, but the registration confirmation is still pending. Passport User Requiring Credit Card Verification. User has completed the registration process with credit card verification, but the registration confirmation is still pending. Half.com User. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending. Reserved for internal or future use. VATStatusCodeType No VAT Tax VAT Tax VAT Exempt Reserved for internal or future use. Type declaration to be used by other schemas. This is the credit card type TransactionId - Type for a PayPal Transaction ID. AuthorizationId - Type for a PayPal Authorization ID. PaymentNotificationService For SetPaymentStatus API, this value should always be eBayCN. BankID The various banks supported for China postbacks. PaymentStatus The payment statuses supported for China postbacks. 0 - None 1 - Success 2 - Pending or Suspicious 3 - Failure RefundType - Type declaration to be used by other schema. This code identifies the types of refund transactions supported. Full Refund Partial Refund External Dispute Based on NRF-ARTS Specification for Units of Measure Each Hours Days Seconds Crate of 12 bottles of beer 6Pack Gallon (UK) Gallon (US) Litre Inch Foot Millimeter Centimeter Meter Square Meter Cubic Meter Gram Kilogram Kilogram Pound Annual Degree Celcius Degree Fahrenheit RESERVED Supported API Types for DoCancel operation POS CHECKOUT AUTHORIZATION POS CHECKOUT SALE REFUND TRANSACTION IncentiveRequestType This identifies the type of request for the API call. The type of request may be used to determine whether the request is for evaluating incentives in pre-checkout or in-checkout phase. IncentiveRequestDetailLevelType This identifies the granularity of information requested by the client application. This information will be used to define the contents and details of the response. IncentiveType This identifies the type of INCENTIVE for the redemption code. 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 (,).
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.
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
Tracking URL for ebay.

Required

Character length and limitations: no limit
URL to which the customer's browser is returned after paying with giropay online.

Optional

Character length and limitations: no limit.
URL to which the customer's browser is returned after fail to pay with giropay online.

Optional

Character length and limitations: no limit.
URL to which the customer's browser can be returned in the mEFT done page.

Optional

Character length and limitations: no limit.
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
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 (,).
Description of items the customer is purchasing.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
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
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
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.
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.
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.
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.
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.
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_AU
DE or de_DE
FR or fr_FR
GB or en_GB
IT or it_IT
JP or ja_JP
US or en_US
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.
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
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
Sets the background color for the header of the payment page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
Sets the background color for the payment page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
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
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
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.
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
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.

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

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
Promo Code

Optional

List of promo codes supplied by merchant. These promo codes enable the Merchant Services Promotion Financing feature.
Default Funding option for PayLater Checkout button. Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at which address was changed by the user. 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
Funding source preferences. 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
URL for PayPal to use to retrieve shipping, handling, insurance, and tax details from your website.
Optional
Character length and limitations: 2048 characters.
Enhanced data for different industry segments.
Optional
List of other payment methods the user can pay with. Optional Refer to the OtherPaymentMethodDetailsType for more details. Details about the buyer's account.
Optional
Refer to the BuyerDetailsType for more details.
Information about the payment. List of Fall Back Shipping options provided by merchant. Information about the call back timeout override. Information about the call back version. Information about the Customer service number. Information about the Gift message enable. Information about the Gift receipt enable. Information about the Gift Wrap enable. Information about the Gift Wrap name. Information about the Gift Wrap amount. Information about the Buyer email option enable . Information about the survey enable. Information about the survey question. Information about the survey choices for survey question. Any message the seller would like to be displayed in the Mini Cart for UX. Incentive Code

Optional

List of incentive codes supplied by ebay/merchant.
Merchant specified flag which indicates whether to return Funding Instrument Details in DoEC or not.

Optional

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. An optional set of values related to flow-specific details. An optional set of values related to display-specific details. An optional set of values related to tracking for external partner. Optional element that defines relationship between buckets
On your first invocation of ExecuteCheckoutOperationsRequest, the value of this token is returned by ExecuteCheckoutOperationsResponse.

Optional

Include this element and its value only if you want to modify an existing checkout session with another invocation of ExecuteCheckoutOperationsRequest; for example, if you want the customer to edit his shipping address on PayPal.

Character length and limitations: 20 single-byte characters
All the Data required to initiate the checkout session is passed in this element. If auto authorization is required, this should be passed in with IsRequested set to yes.
It defines the enumerated types of the user channels defined in biz/User/value_object/Channel.oml
Details about Billing Agreements requested to be created. Only needed if Auto Authorization is requested. The authentication session token will be passed in here. Requests for specific buyer information like Billing Address to be returned through GetExpressCheckoutDetails should be specified under this. The value 1 indicates that you require to retrieve the customer's shipping address on file with PayPal. Any value other than 1 indicates that no such requirement. the value is required by ACS team to specify the channel which the partners are in. the channel will be used for risk assessment
the value is defined in biz/User/value_object/Channel.oml
Optional
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
Information about the payment. An optional set of values related to tracking for external partner. URI(uniform resource identifier), the source from which the request is initiated.
The Type of Approval requested - Billing Agreement or Profile The Approval subtype - Must be MerchantInitiatedBilling for BillingAgreement ApprovalType Description about the Order Directives about the type of payment Client may pass in its identification of this Billing Agreement. It used for the client's tracking purposes. If Billing Address should be returned in GetExpressCheckoutDetails response, this parameter should be set to yes here Description of the Order. Expected maximum amount that the merchant may pull using DoReferenceTransaction Type of the Payment is it Instant or Echeck or Any. Information that is used to indentify the Buyer. This is used for auto authorization. Mandatory if Authorization is requested. Correlation id related to risk process done for the device. Max length is 36 Chars. Buyer's IP Address Mobile specific buyer identification. Contains login bypass information. Identity Access Token. The Session token returned during buyer authentication. External remember-me ID returned by GetExpressCheckoutDetails on successful opt-in. The ExternalRememberMeID is a 17-character alphanumeric (encrypted) string that identifies the buyer's remembered login with a merchant and has meaning only to the merchant. If present, requests that the web flow attempt bypass of login. Identity Access token from merchant Allowable values: 0,1
The value 1 indicates that the customer can accept push funding, and 0 means they cannot.
Optional
Character length and limitations: One single-byte numeric character.
Allowable values: ELV, CreditCard, ChinaUnionPay, BML, Finance, Qiwi
This element could be used to specify the perered funding option
for a guest users. It has effect only if LandingPage element is set to Billing.
Otherwise it will be ignored.
Only needed for AutoBill billinng type. Custom annotation field for your exclusive use. The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.

Character length and limitations: 20 single-byte characters
Information about the payer A free-form field for your own use, as set by you in the Custom element of SetExpressCheckoutRequest.

Character length and limitations: 256 single-byte alphanumeric characters
Your own invoice or tracking number, as set by you in the InvoiceID element of SetExpressCheckoutRequest.

Character length and limitations: 127 single-byte alphanumeric characters
Payer's contact telephone number. PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one. Customer's billing address.

Optional

If you have credit card mapped in your account then billing address of the credit card is returned otherwise your primary address is returned , PayPal returns this address in GetExpressCheckoutDetailsResponse.
Text note entered by the buyer in PayPal flow. Returns the status of the EC checkout session.
Values include 'PaymentActionNotInitiated', 'PaymentActionFailed', 'PaymentActionInProgress', 'PaymentCompleted'.
PayPal may offer a discount or gift certificate to the buyer, which will be represented by a negativeamount. If the buyer has a negative balance, PayPal will add that amount to the current charges, which will be represented as a positive amount. Information about the individual purchased items. Information about the user selected options. Information about the incentives that were applied from Ebay RYP page and PayPal RYP page. Information about the Gift message. Information about the Gift receipt enable. Information about the Gift Wrap name. Information about the Gift Wrap amount. Information about the Buyer marketing email. Information about the survey question. Information about the survey choice selected by the user. Contains payment request information about each bucket in the cart. Response information resulting from opt-in operation or current login bypass status. Response information resulting from opt-in operation or current login bypass status. Information about the transaction Indicate the tolerance a cart can be changed. Possible values are NONE = cart cannot be changed (since financing was used and country is DE). FLEXIBLE = cart can be changed If this parameter does not exist, then assume cart can be modified. Type of the payment instrument.
If Checkout session was initialized successfully, the corresponding token is returned in this element. Status will denote whether Auto authorization was successful or not. 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 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
The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.

Required

Character length and limitations: 20 single-byte characters
Encrypted PayPal customer account identification number as returned by GetExpressCheckoutDetailsResponse.

Required

Character length and limitations: 127 single-byte characters.
URL on Merchant site pertaining to this invoice.

Optional

Unique id for each API request to prevent duplicate payments on merchant side. Passed directly back to merchant in response.

Optional
Character length and limits: 38 single-byte characters maximum.
Information about the payment

Required
Flag to indicate if previously set promoCode shall be overriden. Value 1 indicates overriding. Promotional financing code for item. Overrides any previous PromoCode setting. Contains data for enhanced data like Airline Itinerary Data. This tag became Obsolete on or after 62 version, use EnhancedPaymentData instead. Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored. Information about the user selected options. Information about the Gift message. Information about the Gift receipt enable. Information about the Gift Wrap name. Information about the Gift Wrap amount. Information about the Buyer marketing email. Information about the survey question. Information about the survey choice selected by the user. An identification code for use by third-party applications to identify transactions.

Optional

Character length and limitations: 32 single-byte alphanumeric characters
Merchant specified flag which indicates whether to create billing agreement as part of DoEC or not.

Optional

Merchant specified flag which indicates to use payment details from session if available.

Optional

Optional element that defines relationship between buckets Optional element for the passing client id Optional element for the passing product lines
The timestamped token value that was returned by SetExpressCheckoutResponse and passed on GetExpressCheckoutDetailsRequest.

Character length and limitations:20 single-byte characters
Information about the transaction Memo entered by sender in PayPal Review Page note field.

Optional

Character length and limitations: 255 single-byte alphanumeric characters
Unique id passed in the DoEC call. Redirect back to PayPal, PayPal can host the success page. Information about the user selected options. Information about Coupled Payment transactions.
The authorization identification number you specified in the request.
Character length and limits: 19 single-byte characters maximum
Information about the transaction Return msgsubid back to merchant Partner funding source id corresponding to the FS used in authorization.
How you want to obtain payment.

Required

Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.

Sale indicates that this is a final sale for which you are requesting payment.

NOTE: Order is not allowed for Direct Payment.

Character length and limit: Up to 13 single-byte alphabetic characters
Information about the payment

Required

Information about the credit card to be charged.

Required

IP address of the payer's browser as recorded in its HTTP request to your website. PayPal records this IP addresses as a means to detect possible fraud.

Required

Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???
Your customer session identification token. PayPal records this optional session identification token as an additional means to detect possible fraud.

Optional

Character length and limitations: 64 single-byte numeric characters
Use this optional parameter to pass in your business name and other data describing the transaction.

Optional
This information is usually displayed in the account holder's statement.
Example: RedCross Haiti, RedCross Uganda, Realtor.com dues, Realtor.com list fee
Length 25 characters. Alphanumeric characters and dash(-), dot(.), asterisk(*), space( )
On the customer's statement, an asterisk is used to separate the DBA name and product name. The asterisk delimiter can appear in position 4, 8, or 13.
Use this optional parameter to pass information about how consumer should contact the merchant.

Optional
This information is usually displayed in the account holder's statement.
For Ecom trx: phone, email or URL is allowed
For Retail trx: only the actual city is allowed
For details on allowed characters in Soft Descriptor City refer to the API documentation.
Type of the payment

Required
How you want to obtain payment. Defaults to Sale.

Optional

Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization and Capture.

Sale indicates that this is a final sale for which you are requesting payment.

Phone number of the user making the payment.

Required
Type of recipient specified, i.e., phone number or email address

Required
Email address of the recipient

Phone number of the recipipent

Required
Amount of item before tax and shipping

The tax charged on the transaction Tax

Optional
Per-transaction shipping charge

Optional
Name of the item being ordered

Optional

Character length and limitations: 255 single-byte alphanumeric characters
SKU of the item being ordered

Optional

Character length and limitations: 255 single-byte alphanumeric characters
Memo entered by sender in PayPal Website Payments note field.

Optional

Character length and limitations: 255 single-byte alphanumeric characters
Unique ID for the order. Required for non-P2P transactions

Optional

Character length and limitations: 255 single-byte alphanumeric characters
Indicates whether the sender's phone number will be shared with recipient

Optional
Indicates whether the sender's home address will be shared with recipient

Optional
Phone number for status inquiry URL to which the customer's browser is returned after choosing to login with PayPal.

Required

Character length and limitations: no limit.
URL to which the customer is returned if he does not approve the use of PayPal login.

Required

Character length and limitations: no limit
URL to which the customer's browser is returned after user logs out from PayPal.

Required

Character length and limitations: no limit.
The type of the flow.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
The used to decide SkipLogin allowed or not.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
The name of the field Merchant requires from PayPal after user's login.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Whether the field is required, opt-in or opt-out.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
The name of the field Merchant requires from PayPal after user's login.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Whether the field is required, opt-in or opt-out.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Locale of pages displayed by PayPal during Authentication Login.

Optional

Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase.

Allowable values:
AU or en_AU
DE or de_DE
FR or fr_FR
GB or en_GB
IT or it_IT
JP or ja_JP
US or en_US
Sets the Custom Payment Page Style for flow pages associated with this button/link. PageStyle corresponds to the HTML variable page_style for customizing flow 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.
A URL for the image you want to appear at the top left of the flow 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
Sets the border color around the header of the flow 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
Sets the background color for the header of the flow page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
Sets the background color for the payment page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
First Name of the user, this information is used if user chooses to signup with PayPal.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
Last Name of the user, this information is used if user chooses to signup with PayPal.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
User address, this information is used when user chooses to signup for PayPal.

Optional

If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.
The first name of the User.

Character length and limitations: 127 single-byte alphanumeric characters
The Last name of the user.

Character length and limitations: 127 single-byte alphanumeric characters
The email address of the user.
Character length and limitations: 256 single-byte alphanumeric characters.
Encrypted PayPal customer account identification number.

Required

Character length and limitations: 127 single-byte characters.
URL to which the customer's browser is returned after choosing to login with PayPal.

Required

Character length and limitations: no limit.
URL to which the customer is returned if he does not approve the use of PayPal login.

Required

Character length and limitations: no limit
URL to which the customer's browser is returned after user logs out from PayPal.

Required

Character length and limitations: no limit.
The type of the flow.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
The used to decide SkipLogin allowed or not.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
contains information about API Services contains information about API Services Locale of pages displayed by PayPal during Authentication Login.

Optional

Character length and limitations: Five single-byte alphabetic characters, upper- or lowercase.

Allowable values:
AU or en_AU
DE or de_DE
FR or fr_FR
GB or en_GB
IT or it_IT
JP or ja_JP
US or en_US
Sets the Custom Payment Page Style for flow pages associated with this button/link. PageStyle corresponds to the HTML variable page_style for customizing flow 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.
A URL for the image you want to appear at the top left of the flow 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
Sets the border color around the header of the flow 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
Sets the background color for the header of the flow page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
Sets the background color for the payment page.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
First Name of the user, this information is used if user chooses to signup with PayPal.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
Last Name of the user, this information is used if user chooses to signup with PayPal.

Optional

Character length and limitation: Six character HTML hexadecimal color code in ASCII
User address, this information is used when user chooses to signup for PayPal.

Optional

If you include a shipping address and set the AddressOverride element on the request, PayPal returns this same address in GetExpressCheckoutDetailsResponse.
The first name of the User.

Character length and limitations: 127 single-byte alphanumeric characters
The Last name of the user.

Character length and limitations: 127 single-byte alphanumeric characters
The email address of the user.
Character length and limitations: 256 single-byte alphanumeric characters.
contains information about API Services contains information about API Services Encrypted PayPal customer account identification number.

Required

Character length and limitations: 127 single-byte characters.
Customer's billing address.

Optional
If you have credit card mapped in your account then billing address of the credit card is returned otherwise your primary address is returned , PayPal returns this address in BAUpdateResponseDetails.
Information about the Merchant/Agreement Owner
MerchantPullPaymentResponseType Response data from the merchant pull. information about the customer Information about the transaction Specific information about the preapproved payment MerchantPullInfoType Information about the merchant pull. Current status of billing agreement Monthly maximum payment amount The value of the mp_custom variable that you specified in a FORM submission to PayPal during the creation or updating of a customer billing agreement The value of the mp_desc variable (description of goods or services) associated with the billing agreement Invoice value as set by BillUserRequest API call Custom field as set by BillUserRequest API call Note: This field is no longer used and is always empty. PaymentTransactionSearchResultType Results from a PaymentTransaction search The date and time (in UTC/GMT format) the transaction occurred The time zone of the transaction The type of the transaction The email address of the payer Display name of the payer The transaction ID of the seller The status of the transaction The total gross amount charged, including any profile shipping cost and taxes The fee that PayPal charged for the transaction The net amount of the transaction MerchantPullPayment Parameters to make initiate a pull payment The amount to charge to the customer.

Required

Only numeric characters and a decimal separator are allowed. Limit: 10 single-byte characters, including two for decimals You must set the currencyID attribute to one of the three-character currency code for any of the supported PayPal currencies.
Preapproved Payments billing agreement identification number between the PayPal customer and you.

Required

Character limit: 19 single-byte alphanumeric characters.

The format of a billing agreement identification number is the single-character prefix B, followed by a hyphen and an alphanumeric character string:

B-unique_alphanumeric_string
Specifies type of PayPal payment you require

Optional
Text entered by the customer in the Note field during enrollment

Optional
Subject line of confirmation email sent to recipient

Optional
The tax charged on the transaction

Optional
Per-transaction shipping charge

Optional
Per-transaction handling charge

Optional
Name of purchased item

Optional
Reference number of purchased item

Optional
Your invoice number

Optional
Custom annotation field for tracking or other use

Optional
An identification code for use by third-party applications to identify transactions.

Optional

Character length and limitations: 32 single-byte alphanumeric characters
Passed in soft descriptor string to be appended.

Optional

Character length and limitations: single-byte alphanumeric characters
PaymentTransactionType Information about a PayPal payment from the seller side Information about the recipient of the payment Information about the payer This field is for holding ReferenceId for shippment sent from Merchant to the 3rd Party Information about the transaction Information about an individual item in the transaction Information about an individual Offer and Coupon information in the transaction Information about Secondary Address Information about the user selected options. Information about the Gift message. Information about the Gift receipt. Information about the Gift Wrap name. Information about the Gift Wrap amount. Information about the Buyer email. Information about the survey question. Information about the survey choice selected by the user. ReceiverInfoType Receiver information. Email address or account ID of the payment recipient (the seller). Equivalent to Receiver if payment is sent to primary account.
Character length and limitations: 127 single-byte alphanumeric characters
Primary email address of the payment recipient (the seller). If you are the recipient of the payment and the payment is sent to your non-primary email address, the value of Receiver is still your primary email address.
Character length and limitations: 127 single-byte alphanumeric characters
Unique account ID of the payment recipient (the seller). This value is the same as the value of the recipient's referral ID.
PayerInfoType Payer information Email address of payer
Character length and limitations: 127 single-byte characters
Unique customer ID
Character length and limitations: 17 single-byte characters
Status of payer's email address Name of payer Payment sender's country of residence using standard two-character ISO 3166 country codes. Character length and limitations: Two single-byte characters Payer's business name.
Character length and limitations: 127 single-byte characters
Payer's business address Business contact telephone number Items such as merchant coupons, loyalty cards, and manufacturer coupons in the PayPal wallet. Details about payer's tax info.
Refer to the TaxIdDetailsType for more details.
Holds any enhanced information about the payer
PayeeInfoType Payee Information Email address of payee/agreement owner
Character length and limitations: 127 single-byte characters
Unique Merchant ID
Character length and limitations: 17 single-byte characters
InstrumentDetailsType Promotional Instrument Information. This field holds the category of the instrument only when it is promotional. Return value 1 represents BML, 2 reprasents PLCC/Cobranded. This field holds the InstrumentID issued by external party corresponding to the funding source used in payment. BMLOfferInfoType Specific information for BML. Unique identification for merchant/buyer/offer combo. OfferDetailsType Specific information for an offer. Code used to identify the promotion offer. Specific infromation for BML, Similar structure could be added for sepcific
promotion needs like CrossPromotions
PaymentInfoType Payment information. A transaction identification number.
Character length and limits: 19 single-byte characters maximum
Its Ebay transaction id.
EbayTransactionID will returned for immediate pay item transaction in ECA
Parent or related transaction identification number. This field is populated for the following transaction types:

Reversal
Capture of an authorized transaction.
Reauthorization of a transaction.
Capture of an order. The value of ParentTransactionID is the original OrderID.
Authorization of an order. The value of ParentTransactionID is the original OrderID.
Capture of an order authorization.
Void of an order. The value of ParentTransactionID is the original OrderID.

Character length and limits: 19 single-byte characters maximum
Receipt ID

Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format
The type of transaction

cart: Transaction created via the PayPal Shopping Cart feature or by Express Checkout with multiple purchased item

express-checkout: Transaction created by Express Checkout with a single purchased items

send-money: Transaction created by customer from the Send Money tab on the PayPal website.

web-accept: Transaction created by customer via Buy Now, Donation, or Auction Smart Logos.

subscr-*: Transaction created by customer via Subscription. eot means "end of subscription term."

merch-pmt: preapproved payment.

mass-pay: Transaction created via MassPay.

virtual-terminal: Transaction created via merchant virtual terminal.

credit: Transaction created via merchant virtual terminal or API to credit a customer.
The type of payment The type of funding source eCheck latest expected clear date Date and time of payment Full amount of the customer's payment, before transaction fee is subtracted Transaction fee associated with the payment Transaction financing fee associated with the payment. Total overall cost associated with this financing transaction. Monthly payment for this financing transaction. The length of this financing term, in months. Amount deposited into the account's primary balance after a currency conversion from automatic conversion through your Payment Receiving Preferences or manual conversion through manually accepting a payment. This amount is calculated after fees and taxes have been assessed. Amount of tax for transaction Exchange rate for transaction The status of the payment:

None: No status

Created: A giropay payment has been initiated.

Canceled-Reversal: A reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.

Completed: The payment has been completed, and the funds have been added successfully to your account balance.

Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

Expired: This authorization has expired and cannot be captured.

Failed: The payment has failed. This happens only if the payment was made from your customer's bank account.

In-Progress: The transaction is in process of authorization and capture.

Partially-Refunded: The transaction has been partially refunded.

Pending: The payment is pending. See "PendingReason" for more information.

Refunded: You refunded the payment.

Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.

Processed: A payment has been accepted.

Voided: This authorization has been voided.

Completed-Funds-Held: The payment has been completed, and the funds have been added successfully to your pending balance. See the "HoldDecision" field for more information.
The reason the payment is pending: none: No pending reason

address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.

authorization: You set PaymentAction to Authorization on SetExpressCheckoutRequest and have not yet captured funds.

echeck: The payment is pending because it was made by an eCheck that has not yet cleared.

intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.

multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.

unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.

upgrade: The payment is pending because it was made via credit card and you must upgrade your account to Business or Premier status in order to receive the funds. upgrade can also mean that you have reached the monthly limit for transactions on your account.

verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.

regulatory-review: This payment is pending while we make sure it meets regulatory requirements. We'll contact you again in 24-72 hours with the outcome of our review.

other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
The reason for a reversal if TransactionType is reversal: none: No reason code

chargeback: A reversal has occurred on this transaction due to a chargeback by your customer.

guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.

buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer.

refund: A reversal has occurred on this transaction because you have given the customer a refund.

other: A reversal has occurred on this transaction due to a reason not listed above.
HoldDecision is returned in the response only if PaymentStatus is Completed-Funds-Held. The reason the funds are kept in pending balance: newsellerpaymenthold: The seller is new.

paymenthold: A hold is placed on your transaction due to a reason not listed above.
Shipping method selected by the user during check-out. Protection Eligibility for this Transaction - None, SPP or ESPP Protection Eligibility details for this Transaction Receipt Reference Number for this Transaction The type of POS transaction

F: Forced post transaction. POS merchant can send transactions at a later point if connectivity is lost.

S: Single call checkout, and this is to identify PayPal Lite API usage.
Amount of shipping charged on transaction Amount of ship handling charged on transaction Amount of shipping discount on transaction Amount of Insurance amount on transaction Subject as entered in the transaction StoreID as entered in the transaction TerminalID as entered in the transaction Details about the seller.
Optional
Unique identifier and mandatory for each bucket in case of split payement Thes are filters that could result in accept/deny/pending action. This will be enhanced info for the payment: Example: UATP details This will indicate the payment status for individual payment request in case of split payment Type of the payment instrument. Offer Details. This field indicates whether the credit card number used for this transaction is in a particular bin range registered with PayPal by the merchant. This filed is optional and will be present if merchant has a registered bin range. The value of this field will be "true" if merchant has a registered bin range and the credit card used in the transaction is within the registered bin range. The value of this field will be false if merchant has a registered bin range and credit card used in the transaction outside registered bin range or the transaction is not done using a credit card. This information holds business name and other data describing the transaction.
This information is usually displayed in the CC account holder's statement.
CC Information about how consumer should contact the merchant.
This information is usually displayed in the CC account holder's statement.
SubscriptionTermsType Terms of a PayPal subscription. SubscriptionInfoType Information about a PayPal Subscription. ID generated by PayPal for the subscriber. Character length and limitations: no limit Subscription start date Date when the subscription modification will be effective Date PayPal will retry a failed subscription payment Username generated by PayPal and given to subscriber to access the subscription. Character length and limitations: 64 alphanumeric single-byte characters Password generated by PayPal and given to subscriber to access the subscription. For security, the value of the password is hashed. Character length and limitations: 128 alphanumeric single-byte characters The number of payment installments that will occur at the regular rate. Character length and limitations: no limit Subscription duration and charges AuctionInfoType Basic information about an auction. Customer's auction ID Auction's close date OptionType PayPal item options for shopping cart. EbayItemPaymentDetailsItemType - Type declaration to be used by other schemas. Information about an Ebay Payment Item. Auction ItemNumber.

Optional

Character length and limitations: 765 single-byte characters
Auction Transaction ID.

Optional

Character length and limitations: 255 single-byte characters
Ebay Order ID.

Optional

Character length and limitations: 64 single-byte characters
Ebay Cart ID.

Optional

Character length and limitations: 64 single-byte characters
PaymentDetailsItemType Information about a Payment Item. Item name.

Optional

Character length and limitations: 127 single-byte characters
Item number.

Optional

Character length and limitations: 127 single-byte characters
Item quantity.

Optional

Character length and limitations: Any positive integer
Item sales tax.

Optional

Character length and limitations: any valid currency amount; currency code is set the same as for OrderTotal.
Cost of item 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 (,).
Ebay specific details.

Optional
Promotional financing code for item. Part of the Merchant Services Promotion Financing feature. Item description.
Optional
Character length and limitations: 127 single-byte characters
Information about the Item weight. Information about the Item length. Information about the Item width. Information about the Item height. URL for the item.
Optional
Character length and limitations: no limit.
Enhanced data for each item in the cart.
Optional
Item category - physical or digital.
Optional
PaymentItemType Information about a Payment Item. eBay Auction Transaction ID of the Item
Optional

Character length and limitations: 255 single-byte characters
Item name set by you or entered by the customer.
Character length and limitations: 127 single-byte alphanumeric characters
Item number set by you.
Character length and limitations: 127 single-byte alphanumeric characters
Quantity set by you or entered by the customer.
Character length and limitations: no limit
Amount of tax charged on payment Amount of shipping charged on payment Amount of handling charged on payment Invoice item details Coupon ID Number Amount Value of The Coupon Currency of the Coupon Amount Amount of Discount on this Loyalty Card Currency of the Discount Cost of item Item options selected in PayPal shopping cart
PaymentItemInfoType Information about a PayPal item. Invoice number you set in the original transaction.

Character length and limitations: 127 single-byte alphanumeric characters
Custom field you set in the original transaction.

Character length and limitations: 127 single-byte alphanumeric characters
Memo entered by your customer in PayPal Website Payments note field.

Character length and limitations: 255 single-byte alphanumeric characters
Amount of tax charged on transaction Details about the indivudal purchased item Information about the transaction if it was created via PayPal Subcriptions Information about the transaction if it was created via an auction
OffersAndCouponsInfoType Information about a Offers and Coupons. Type of the incentive ID of the Incentive used in transaction Amount used on transaction Amount Currency PaymentDetailsType Information about a payment. Used by DCC and Express Checkout. 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 (,).
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 (,).
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 (,).
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 (,).
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 (,).
Description of items the customer is purchasing.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
A free-form field for your own use.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Your own invoice or tracking number.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
An identification code for use by third-party applications to identify transactions.

Optional

Character length and limitations: 32 single-byte alphanumeric characters
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
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.
The value 1 indicates that this payment is associated with multiple shipping addresses.

Optional

Character length and limitations: Four single-byte numeric characters.
Thirdparty Fulfillment Reference Number.
Optional
Character length and limitations: 32 alphanumeric characters.
Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at which address was changed by the user. Information about the individual purchased items Total shipping insurance costs for this order.
Optional
Shipping discount for this order, specified as a negative number.
Optional
Information about the Insurance options. Allowed payment methods for this transaction. Enhanced Data section to accept channel specific data. Applicable for version 62 and above, use this tag to pass airline itinerary data.
Optional
Refer to EnhancedPaymentDataType for details.
Details about the seller.
Optional
Note to recipient/seller.
Optional
Character length and limitations: 127 single-byte alphanumeric characters.
PayPal Transaction Id, returned once DoExpressCheckout is completed.
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
Unique identifier and mandatory for the particular payment request in case of multiple payment URL on Merchant site pertaining to this invoice.

Optional

Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored. 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
Soft Descriptor supported for Sale and Auth in DEC only. For Order this will be ignored. Flag to indicate the recurring transaction Indicates the purpose of this payment like Refund Location ID Specified by merchant

Optional

Character length and limitations: 50 single-byte alphanumeric characters
For instance single use coupons should not be returned in future CheckIn calls once they are redeemed. Total loyalty points for a given id accumulated by the consumre so far. Merchant Data that is passed through from Merchant to Processor
Information about the incentives that were applied from Ebay RYP page and PayPal RYP page. Unique Identifier consisting of redemption code, user friendly descripotion, incentive type, campaign code, incenitve application order and site redeemed o n. Defines if the incentive has been applied on Ebay or PayPal. The total discount amount for the incentive, summation of discounts up across all the buckets/items. Status of incentive processing. Sussess or Error. Error code if there are any errors. Zero otherwise. Details of incentive application on individual bucket/item. Details of incentive application on individual bucket/item. PaymentRequestID uniquely identifies a bucket. It is the "bucket id" in the world of EC API. The item id passed through by the merchant. The item transaction id passed through by the merchant. Discount offerred for this bucket or item. SubType for coupon. Details about the seller. Unique identifier for the seller.
Optional
The user name of the user at the marketplaces site.
Optional
Date when the user registered with the marketplace.
Optional
Seller Paypal Account Id contains the seller EmailId or PayerId or PhoneNo passed during the Request. Unique PayPal customer account identification number (of the seller). This feild is meant for Response. This field is ignored, if passed in the Request.
Lists the Payment Methods (other than PayPal) that the use can pay with e.g. Money Order.
Optional.
The identifier of the Payment Method. Valid values are 'Method', 'SubMethod'. The name of the Payment Method. The short description of the Payment Method, goes along with the label. The title for the long description. The long description of the Payment Method. The icon of the Payment Method. If this flag is true, then OtherPaymentMethodIcon is required to have a valid value; the label will be hidden and only ICON will be shown.
Details about the buyer's account passed in by the merchant or partner.
Optional.
The client's unique ID for this user.
The user name of the user at the marketplaces site.
Date when the user registered with the marketplace.
Details about payer's tax info.
Refer to the TaxIdDetailsType for more details.
Contains information that identifies the buyer. e.g. email address or the external remember me id.
Details about the payer's tax info passed in by the merchant or partner.
Optional.
The payer's Tax ID type; CNPJ/CPF for BR country.
The payer's Tax ID
The Common 3DS fields. Common for both GTD and DCC API's. 3DS remaining fields. 3DSecureInfoType Information about 3D Secure parameters. CreditCardDetailsType Information about a Credit Card. Fallback shipping options type. Information on user selected options CreditCardDetailsType for DCC Reference Transaction Information about a Credit Card. PaymentTransactionCodeType This is the type of a PayPal of which matches the output from IPN PaymentStatusCodeType This is the status of a PayPal Payment which matches the output from IPN AddressStatusCodeType This is the PayPal address status Normalization Status of the Address PaymentDetailsCodeType This is the PayPal payment details type (used by DCC and Express Checkout) This is various actions that a merchant can take on a FMF Pending Transaction. ChannelType - Type declaration to be used by other schemas. This is the PayPal Channel type (used by Express Checkout) TotalType - Type declaration for the label to be displayed in MiniCart for UX. SolutionTypeType This is the PayPal payment Solution details type (used by Express Checkout) AllowedPaymentMethodType This is the payment Solution merchant needs to specify for Autopay (used by Express Checkout)
Optional
Default indicates that its merchant supports all funding source
InstantPaymentOnly indicates that its merchant only supports instant payment
AnyFundingSource allow all funding methods to be chosen by the buyer irrespective of merchant's profile setting
InstantFundingSource allow only instant funding methods, block echeck, meft, elevecheck. This will override any merchant profile setting
LandingPageType This is the PayPal payment Landing Page details type (used by Express Checkout) PendingStatusCodeType The pending status for a PayPal Payment transaction which matches the output from IPN ReceiverInfoCodeType Payee identifier type for MassPay API ReversalReasonCodeType Reason for a reversal on a PayPal transaction which matches the output from IPN POSTransactionCodeType POS Transaction Code Type. F for Forced Post Transaction and S for Single Call Checkout PaymentCodeType This is the type of PayPal payment which matches the output from IPN. RefundSourceCodeType This is the type of PayPal funding source that can be used for auto refund. any - Means Merchant doesn't have any preference. PayPal can use any available funding source (Balance or eCheck) default - Means merchant's preferred funding source as configured in his profile. (Balance or eCheck) instant - Only Balance echeck - Merchant prefers echeck. If PayPal balance can cover the refund amount, we will use PayPal balance. (balance or eCheck) PayPalUserStatusCodeType PayPal status of a user Address MerchantPullPaymentCodeType Type of Payment to be initiated by the merchant MerchantPullStatusCodeType Status of the merchant pull PaymentTransactionStatusCodeType The status of the PayPal payment. PaymentTransactionClassCodeType The Type of PayPal payment. MatchStatusCodeType This is the PayPal (street/zip) match code CompleteCodeType This is the PayPal DoCapture CompleteType code TransactionEntityType This is the PayPal DoAuthorization TransactionEntityType code MobileRecipientCodeType These are the accepted types of recipients for mobile-originated transactions MobilePaymentCodeType These are the accepted types of mobile payments Custom Securiy Header. The username is the identifier for an account. Password contains the current password associated with the username. Signature for Three Token authentication. This field identifies an account (e.g., payment) on whose behalf the operation is being performed. For instance one account holder may delegate the abililty to perform certain operations to another account holder. This delegation is done through a separate mechanism. If the base username has not been authorized by the subject the request will be rejected. Authentication Session Token for authentication and authorization. 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.
Customer's billing address.

Optional

If you have a credit card mapped in your PayPal account, PayPal returns the billing address of the credit billing address otherwise your primary address as billing address in GetBillingAgreementCustomerDetails.
Device ID

Optional

Character length and limits: 256 single-byte characters
DeviceID length morethan 256 is truncated
Correlation id related to risk process done for the device. Max length is 36 Chars. Unique id for each API request to prevent duplicate payments.

Optional
Character length and limits: 38 single-byte characters maximum.
Response code from the processor when a recurring transaction is declined Return msgsubid back to merchant pending reason for IC+ interchange plus Onboarding program code given to you by PayPal.

Required

Character length and limitations: 64 alphanumeric characters
A list of comma-separated values that indicate the PayPal products you are implementing for this merchant:

Direct Payment (dp) allows payments by credit card without requiring the customer to have a PayPal account.

Express Checkout (ec) allows customers to fund transactions with their PayPal account.

Authorization and Capture (auth_settle) allows merchants to verify availability of funds in a PayPal account, but capture them at a later time.

Administrative APIs (admin_api) is a collection of the PayPal APIs for transaction searching, getting transaction details, refunding, and mass payments.

Required

Character length and limitations: 64 alphanumeric characters
Any custom information you want to store for this partner

Optional

Character length and limitations: 256 alphanumeric characters
The URL for the logo displayed on the PayPal Partner Welcome Page.

Optional

Character length and limitations: 2,048 alphanumeric characters
Marketing category tha configures the graphic displayed n the PayPal Partner Welcome page. Information about the merchantâs business Information about the merchant (the business owner) Information about the merchant's bank account
MarketingCategoryType BusinessInfoType Type of business, such as corporation or sole proprietorship Official name of business

Character length and limitations: 75 alphanumeric characters
Merchantâs business postal address Businessâs primary telephone number

Character length and limitations: 20 alphanumeric characters
Line of business, as defined in the enumerations Business sub-category, as defined in the enumerations Average transaction price, as defined by the enumerations. AverageTransactionPrice-Not-Applicable
Enumeration Meaning
AverageTransactionPrice-Range1 Less than $25 USD
AverageTransactionPrice-Range2 $25 USD to $50 USD
AverageTransactionPrice-Range3 $50 USD to $100 USD
AverageTransactionPrice-Range4 $100 USD to $250 USD
AverageTransactionPrice-Range5 $250 USD to $500 USD
AverageTransactionPrice-Range6 $500 USD to $1,000 USD
AverageTransactionPrice-Range7 $1,000 USD to $2,000 USD
AverageTransactionPrice-Range8 $2,000 USD to $5,000 USD
AverageTransactionPrice-Range9 $5,000 USD to $10,000 USD
AverageTransactionPrice-Range10 More than $10,000 USD
Average monthly sales volume, as defined by the enumerations.
Enumeration Meaning
AverageMonthlyVolume-Not-Applicable
AverageMonthlyVolume-Range1 Less than $1,000 USD
AverageMonthlyVolume-Range2 $1,000 USD to $5,000 USD
AverageMonthlyVolume-Range3 $5,000 USD to $25,000 USD
AverageMonthlyVolume-Range4 $25,000 USD to $100,000 USD
AverageMonthlyVolume-Range5 $100,000 USD to $1,000,000 USD
AverageMonthlyVolume-Range6 More than $1,000,000 USD
Main sales venue, such as eBay Primary URL of business

Character length and limitations: 2,048 alphanumeric characters
Percentage of revenue attributable to online sales, as defined by the enumerations

PercentageRevenueFromOnlineSales-Not-Applicable
Enumeration Meaning
PercentageRevenueFromOnlineSales-Range1 Less than 25%
PercentageRevenueFromOnlineSales-Range2 25% to 50%
PercentageRevenueFromOnlineSales-Range3 50% to 75%
PercentageRevenueFromOnlineSales-Range4 75% to 100%
Date the merchantâs business was established Email address to contact businessâs customer service

Character length and limitations: 127 alphanumeric characters
Telephone number to contact businessâs customer service

Character length and limitations: 32 alphanumeric characters
BusinessTypeType BusinessCategoryType BusinessSubCategoryType AverageTransactionPriceType

AverageTransactionPrice-Not-Applicable
Enumeration Meaning
AverageTransactionPrice-Range1 Less than $25 USD
AverageTransactionPrice-Range2 $25 USD to $50 USD
AverageTransactionPrice-Range3 $50 USD to $100 USD
AverageTransactionPrice-Range4 $100 USD to $250 USD
AverageTransactionPrice-Range5 $250 USD to $500 USD
AverageTransactionPrice-Range6 $500 USD to $1,000 USD
AverageTransactionPrice-Range7 $1,000 USD to $2,000 USD
AverageTransactionPrice-Range8 $2,000 USD to $5,000 USD
AverageTransactionPrice-Range9 $5,000 USD to $10,000 USD
AverageTransactionPrice-Range10 More than $10,000 USD
AverageMonthlyVolumeType
Enumeration Meaning
AverageMonthlyVolume-Not-Applicable
AverageMonthlyVolume-Range1 Less than $1,000 USD
AverageMonthlyVolume-Range2 $1,000 USD to $5,000 USD
AverageMonthlyVolume-Range3 $5,000 USD to $25,000 USD
AverageMonthlyVolume-Range4 $25,000 USD to $100,000 USD
AverageMonthlyVolume-Range5 $100,000 USD to $1,000,000 USD
AverageMonthlyVolume-Range6 More than $1,000,000 USD
SalesVenueType PercentageRevenueFromOnlineSalesType

PercentageRevenueFromOnlineSales-Not-Applicable
Enumeration Meaning
PercentageRevenueFromOnlineSales-Range1 Less than 25%
PercentageRevenueFromOnlineSales-Range2 25% to 50%
PercentageRevenueFromOnlineSales-Range3 50% to 75%
PercentageRevenueFromOnlineSales-Range4 75% to 100%
BusinessOwnerInfoType Details about the business owner Business ownerâs home telephone number

Character length and limitations: 32 alphanumeric characters
Business ownerâs mobile telephone number

Character length and limitations: 32 alphanumeric characters
Business ownerâs social security number

Character length and limitations: 9 alphanumeric characters
BankAccountDetailsType Name of bank

Character length and limitations: 192 alphanumeric characters
Type of bank account: Checking or Savings Merchantâs bank routing number

Character length and limitations: 23 alphanumeric characters
Merchantâs bank account number

Character length and limitations: 256 alphanumeric characters
BankAccountTypeType Status of merchant's onboarding process:

Completed
Cancelled
Pending

Character length and limitations: Eight alphabetic characters
Date the boarding process started Date the merchantâs status or progress was last updated Reason for merchantâs cancellation of sign-up.

Character length and limitations: 1,024 alphanumeric characters
Indicates if there is a limitation on the amount of money the business can withdraw from PayPal Custom information you set on the EnterBoarding API call

Character length and limitations: 256 alphanumeric characters
Details about the owner of the account Merchantâs PayPal API credentials The APIs that this merchant has granted the business partner permission to call on his behalf.

For example:
SetExpressCheckout,GetExpressCheckoutDetails,DoExpressCheckoutPayment
Primary email verification status. Confirmed, Unconfirmed Gives VettingStatus - Pending, Cancelled, Approved, UnderReview

Character length and limitations: 256 alphanumeric characters
Gives BankAccountVerificationStatus - Added, Confirmed

Character length and limitations: 256 alphanumeric characters
Boarding Status User Withdrawal Limit Type Type APICredentialsType Merchantâs PayPal API username Character length and limitations: 128 alphanumeric characters Merchantâs PayPal API password Character length and limitations: 40 alphanumeric characters Merchantâs PayPal API signature, if one exists.

Character length and limitations: 256 alphanumeric characters
Merchantâs PayPal API certificate in PEM format, if one exists

The certificate consists of two parts: the private key (2,048 bytes) and the certificate proper (4,000 bytes).


Character length and limitations: 6,048 alphanumeric characters
Merchantâs PayPal API authentication mechanism.

Auth-None: no authentication mechanism on file

Cert: API certificate

Sign: API signature

Character length and limitations: 9 alphanumeric characters
API Authentication Type The phone number of the buyer's mobile device, if available.

Optional
Cost of this item before tax and shipping. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Required
Tax amount for this item. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional
Shipping amount for this item. You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Optional
Description of the item that the customer is purchasing.

Required

Character length and limitations: 127 single-byte alphanumeric characters
Reference number of the item that the customer is purchasing.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
A free-form field for your own use, such as a tracking number or other value you want returned to you in IPN.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Your own unique invoice or tracking number.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
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.
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.

Optional

Character length and limitations: no limit
The value 1 indicates that you require that the customer's shipping address on file with PayPal be a confirmed address. Setting this element overrides the setting you have specified in your Merchant Account Profile.

Optional
The value 1 indicates that you require that the customer specifies a contact phone for the transactxion. Default is 0 / none required.

Optional
Customer's shipping address.

Optional
Email address of the buyer as entered during checkout. PayPal uses this value to pre-fill the login portion of the PayPal login page.

Optional

Character length and limit: 127 single-byte alphanumeric characters
A free-form field for your own use, such as a tracking number or other value you want returned to you in IPN.

Optional

Character length and limitations: 256 single-byte alphanumeric characters
Your own unique invoice or tracking number.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Information about the payer Information about the transaction
The value 'Auction' indicates that user is coming to checkout after an auction ended. A value of 'BuyItNow' indicates if the user is coming to checkout by clicking on the 'buy it now' button in a chinese auction. A value of 'FixedPriceItem' indicates that user clicked on 'Buy it now' on a fixed price item. A value of Autopay indicates autopay (or immediate pay) which is not supported at the moment.

Required
An item number assigned to the item in eBay database.

Required

Character length and limitations: 127 single-byte alphanumeric characters
An Transaction id assigned to the item in eBay database. In case of Chinese auction Item Id itself indicates Transaction Id. Transaction Id in this case is Zero.

Required

Character length and limitations: 127 single-byte alphanumeric characters
An id indicating the site on which the item was listed.

Required

Character length and limitations: 2 alphanumeric characters
Buyers ebay Id.

Required

Character length and limitations: 127 single-byte alphanumeric characters
Indicating the client type. Weather it is WAP or J2ME. A value of 'WAP' indicates WAP. A value of 'J2MEClient' indicates J2ME client.

Required
The phone number of the buyer's mobile device, if available.

Optional
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.

Optional

Character length and limitations: no limit.
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.

Optional

Character length and limitations: no limit
Specify quantity in case it is an immediate pay (or autopay) item.

Optional
Cost of this item before tax and shipping.You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.Used only for autopay items.

Optional
UATP Card Details Type UATP Card Number UATP Card expirty month UATP Card expirty year Unit of meausre for billing cycle Number of BillingPeriod that make up one billing cycle Total billing cycles in this portion of the schedule Amount to charge Additional shipping amount to charge Additional tax amount to charge Unit of meausre for billing cycle Number of BillingPeriod that make up one billing cycle Total billing cycles in this portion of the schedule Amount to charge Additional shipping amount to charge Additional tax amount to charge Schedule details for the Recurring Payment Trial period of this schedule The max number of payments the buyer can fail before this Recurring Payments profile is cancelled Subscriber name - if missing, will use name in buyer's account Subscriber address - if missing, will use address in buyer's account When does this Profile begin billing? Your own unique invoice or tracking number.

Optional

Character length and limitations: 127 single-byte alphanumeric characters
Billing Agreement token (required if Express Checkout) Information about the credit card to be charged (required if Direct Payment) Customer Information for this Recurring Payments Schedule Information for this Recurring Payments Information about the Item Details. Use this optional parameter to pass in your business name and other data describing the transaction.

Optional
This information is usually displayed in the CC account holder's statement.
Example: RedCross Haiti, RedCross Uganda, Realtor.com dues, Realtor.com list fee
Length 25 characters. Alphanumeric characters and dash(-), dot(.), asterisk(*), space( )
On the customer's statement, an asterisk is used to separate the DBA name and product name. The asterisk delimiter can appear in position 4, 8, or 13.
Use this optional parameter to pass information about how consumer should contact the merchant.

Optional
This information is usually displayed in the CC account holder's statement.
For Ecom trx: phone, email or URL is allowed
For Retail trx: only the actual city is allowed
For details on allowed characters in Soft Descriptor City refer to the API documentation.
Recurring Billing Profile ID Recurring Billing Profile Status Transaction id from DCC initial payment Response from DCC initial payment Return code if DCC initial payment fails Interchange Plus Pricing pending reason Recurring Billing Profile ID Use this optional parameter to pass in your business name and other data describing the transaction.

Optional
This information is usually displayed in the account holder's statement.
Example: RedCross Haiti, RedCross Uganda, Realtor.com dues, Realtor.com list fee
Length 25 characters. Alphanumeric characters and dash(-), dot(.), asterisk(*), space( )
On the customer's statement, an asterisk is used to separate the DBA name and product name. The asterisk delimiter can appear in position 4, 8, or 13.
Use this optional parameter to pass information about how consumer should contact the merchant.

Optional
This information is usually displayed in the account holder's statement.
For Ecom trx: phone, email or URL is allowed
For Retail trx: only the actual city is allowed
For details on allowed characters in Soft Descriptor City refer to the API documentation.
Information about the credit card to be charged (required if Direct Payment) When does this Profile begin billing? Trial period of this schedule Details of Risk Filter. Details of Risk Filter. Thes are filters that could result in accept/deny/pending action. Other Airlines Antiques Art Cameras & Photos Cars, Boats, Vehicles & Parts Cell Phones & Telecom Coins & Paper Money Collectibles Computers & Networking Consumer Electronics Jewelry & Watches Musical Instruments Real Estate Sports Memorabilia, Cards & Fan Shop Stamps Tickets Travels Gambling Alcohol Tobacco Money Transfer Software Enhanced Data Information. Example: AID for Airlines AID for Airlines Details of leg information Authorization details The status of the payment:

Pending: The payment is pending. See "PendingReason" for more information.
The reason the payment is pending: none: No pending reason

address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.

authorization: The authorization is pending at time of creation if payment is not under review

echeck: The payment is pending because it was made by an eCheck that has not yet cleared.

intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.

multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.

unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.

upgrade: The payment is pending because it was made via credit card and you must upgrade your account to Business or Premier status in order to receive the funds. upgrade can also mean that you have reached the monthly limit for transactions on your account.

verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.

payment_review: The payment is pending because it is under payment review.

other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
Protection Eligibility for this Transaction - None, SPP or ESPP Protection Eligibility Type for this Transaction
Types of button coding Creates Hosted Button Creates Encrypted Button Creates Cleartext Button Creates Token or temporary Button Types of buttons button type is BUYNOW button type is CART button type is GIFTCERTIFICATE button type is SUBSCRIBE button type is DONATE button type is UNSUBSCRIBE button type is VIEWCART button type is PAYMENTPLAN button type is AUTOBILLING button type is PAYMENT Types of button sub types button subtype is PRODUCTS button subtype is SERVICES Types of button images button image type is REG button image type is SML button image type is CC values for buynow button text button wording is BUYNOW button wording is PAYNOW values for subscribe button text button wording is BUYNOW button wording is SUBSCRIBE values for subscribe button text Changes Button Status to DELETE Option Number.
Optional
Option Quantity.
Optional
Option Select Name.
Optional
Option Quantity Delta.
Optional
Option Alert.
Optional
Option Cost.
Optional
Item Number.
Required
Option Quantity.
Optional
Item Quantity Delta.
Optional
Item Alert.
Optional
Item Cost.
Optional
Identifier of the transaction to reverse.

Required

Character length and limitations: 17 single-byte alphanumeric characters
Unique transaction identifier of the reversal transaction created.

Character length and limitations:17 single-byte characters
Status of reversal request.

Required

UserSelectedFundingSourceType User Selected Funding Source (used by Express Checkout) Physical Digital Details of incentive application on individual bucket. Incentive redemption code. Defines which bucket or item that the incentive should be applied to. Defines which bucket or item that the incentive should be applied to. The Bucket ID that the incentive is applied to. The item that the incentive is applied to. Contains payment request information for each bucket in the cart. Contains the transaction id of the bucket. Contains the bucket id. Contains the error details. E-mail address or secure merchant account ID of merchant to associate with new external remember-me. A discriminant that tells SetEC what kind of data the ExternalRememberMeOwnerID parameter contains. Currently, the owner must be either the API actor or omitted/none. In the future, we may allow the owner to be a 3rd party merchant account. Possible values are: None, ignore the ExternalRememberMeOwnerID. An empty value for this field also signifies None. Email, the owner ID is an email address SecureMerchantAccountID, the owner id is a string representing the secure merchant account ID When opting in to bypass login via remember me, this parameter specifies the merchant account associated with the remembered login. Currentl, the owner must be either the API actor or omitted/none. In the future, we may allow the owner to be a 3rd party merchant account. If the Owner ID Type field is not present or "None", this parameter is ignored. 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. 1 = opt in to external remember me. 0 or omitted = no opt-in Other values are invalid E-mail address or secure merchant account ID of merchant to associate with new external remember-me. Currently, the owner must be either the API actor or omitted/none. In the future, we may allow the owner to be a 3rd party merchant account. An optional set of values related to flow-specific details. The URL to redirect to for an unpayable transaction. This field is currently used only for the inline checkout flow. The URL to redirect to after a user clicks the "Pay" or "Continue" button on the merchant's site. This field is currently used only for the inline checkout flow. Response information resulting from opt-in operation or current login bypass status. Required field that reports status of opt-in or login bypass attempt. 0 = Success - successful opt-in or ExternalRememberMeID specified in SetExpressCheckout is valid. 1 = Invalid ID - ExternalRememberMeID specified in SetExpressCheckout is invalid. 2 = Internal Error - System error or outage during opt-in or login bypass. Can retry opt-in or login bypass next time. Flow will force full authentication and allow buyer to complete transaction. -1 = None - the return value does not signify any valid remember me status. Identifier returned on external-remember-me-opt-in to allow the merchant to request bypass of PayPal login through external remember me on behalf of the buyer in future transactions. The ExternalRememberMeID is a 17-character alphanumeric (encrypted) string. This field has meaning only to the merchant. Response information resulting from opt-in operation or current login bypass status. Required field that reports status of opt-in or login bypass attempt. 0 = Success, successful opt-in or RefreshToken corresponding to AccessToken specified in SetExpressCheckout is valid (user is still opted in). 1 = New RefreshToken was generated (user is still opted in). 2 = Invalid ID, RefreshToken corresponding to AccessToken specified in SetExpressCheckout is invalid (user is opted out). -2 = Internal Error, system error or outage during opt-in or login bypass. Can retry opt-in or login bypass next time. Flow will force full authentication and allow buyer to complete transaction. -1 = None, the field does not represent any valid value of the status. Identifier returned on external-remember-me-opt-in to allow the merchant to request bypass of PayPal login The immutable_id is the user's unique value per merchant that should never ever change for that account. This would be the key used to uniquely identify the user Contains elements that allows customization of display (user interface) elements. Optional URL to pay button image for the inline checkout flow. Currently applicable only to the inline checkout flow when the FlowControlDetails/InlineReturnURL is present. Contains elements that allow tracking for an external partner. PayPal will just log this string. There will NOT be any business logic around it, nor any decisions made based on the value of the string that is passed in. From a tracking/analytical perspective, PayPal would not infer any meaning to any specific value. We would just segment the traffic based on the value passed (Cart and None as an example) and track different metrics like risk/conversion etc based on these segments. The external partner would control the value of what gets passed and we take that value as is and generate data based on it.
Optional
Store ID

Optional

Character length and limits: 50 single-byte characters
Terminal ID

Optional

Character length and limits: 50 single-byte characters
Describes discount information Item name

Optional

Character length and limits: 127 single-byte characters
description of the discount

Optional

Character length and limits: 127 single-byte characters
amount discounted

Optional

offer type

Optional

offer ID

Optional

Character length and limits: 64 single-byte characters
Describes an individual item for an invoice. a human readable item name

Optional

Character length and limits: 127 single-byte characters
a human readable item description

Optional

Character length and limits: 127 single-byte characters
The International Article Number or Universal Product Code (UPC) for the item. Empty string is allowed. Character length and limits: 17 single-byte characters The Stock-Keeping Unit or other identification code assigned to the item. Character length and limits: 64 single-byte characters A retailer could apply different return policies on different items. Each return policy would be identified using a label or identifier. This return policy identifier should be set here. This identifier will be displayed next to the item in the e-Receipt. Character length and limits: 8 single-byte characters total price of this item price per item quantity quantity of the item (non-negative) Unit of measure for the itemCount discount applied to this item identifies whether this item is taxable or not. If not passed, this will be assumed to be true. The tax percentage applied to the item. This is only used for displaying in the receipt, it is not used in pricing calculations. Note: we have totalTax at invoice level. It's up to the caller to do the calculations for setting that other element. Additional fees to this item identifies whether this is reimbursable or not. If not pass, this will be assumed to be true. Manufacturer part number. International Standard Book Number. Reference http://en.wikipedia.org/wiki/ISBN Character length and limits: 32 single-byte characters Price Look-Up code Reference http://en.wikipedia.org/wiki/Price_Look-Up_code Character length and limits: 5 single-byte characters Character length and limits: 32 single-byte characters Character length and limits: 32 single-byte characters
Holds refunds payment status information Refund status whether it is Instant or Delayed. Tells us the reason when refund payment status is Delayed. Defines relationship between buckets Relationship Type - LifeTime (default) Identifier for this relation Defines couple relationship type between buckets The relation between buckets are for lifetime. Any post-transaction action on one affects other as well. Category of payment like international shipping Internalnation Shipping LocalDelivery BOPIS PUDO Location Type Consumer Store PickupDropOff Information about Coupled Payment transactions. ID received in the Coupled Payment Request ID that uniquely identifies this CoupledPayment. Generated by PP in Response This holds single key-value pair. Key Name.
Optional
Value for the above key.
Optional
This holds all key-value pairs which merchants wants to pass it to the open wallet(PLCC) processor. Details about an Item stored in the PayPal Wallet. (Optional)Identifies a wallet item of a given type. The format varies depending on the type. (Optional)Uniquely identifies a wallet item of given type. Format varies depending on the type. Character length and limitations: 64 single-byte characters maximum. (Optional)Description of wallet item. Character length and limitations: 512 single-byte characters maximum. Describes discount information. (Optional)Item name. Character length and limits: 127 single-byte characters (Optional)Description of the discount. Character length and limits: 127 single-byte characters (Optional)Amount discounted. The value includes an amount and a 3-character currency code. (Optional)Offer type. (Optional)Offer ID. Character length and limits: 64 single-byte characters. (Optional)Loyalty points accrued.